Merge pull request #5 from PedalPi/data

Support for custom data in pedalboard

pluginsmanager/model/effect.py

@@ -34,8 +34,8 @@ class Effect(metaclass=ABCMeta):
     :param Pedalboard pedalboard: Pedalboard where the effect lies.
     """
 
-    def __init__(self, pedalboard=None):
-        self.pedalboard = pedalboard
+    def __init__(self):
+        self.pedalboard = None
         self._active = True
 
         self._params = ()

pluginsmanager/model/lv2/lv2_param.py

@@ -28,3 +28,10 @@ def minimum(self):
     @property
     def symbol(self):
         return self._param['symbol']
+
+    @property
+    def __dict__(self):
+        dictionary = super(Lv2Param, self).__dict__
+        dictionary['index'] = self._param['index']
+
+        return dictionary

pluginsmanager/model/param.py

@@ -119,7 +119,7 @@ def json(self):
     @property
     def __dict__(self):
         return {
-            'index': self._param['index'],
+            'index': self.effect.params.index(self),
             'minimum': self.minimum,
             'maximum': self.maximum,
             'symbol': self.symbol,

pluginsmanager/model/pedalboard.py

@@ -31,11 +31,18 @@ class Pedalboard(object):
         >>> reverb.outputs[1].connect(sys_effect.inputs[0])
         ObservableList: [<Connection object as 'system.capture_1 -> GxFuzzFaceFullerMod.In' at 0x7f60f45f3f60>, <Connection object as 'GxFuzzFaceFullerMod.Out -> Calf Reverb.In L' at 0x7f60f45f57f0>, <Connection object as 'Calf Reverb.Out R -> system.playback_1' at 0x7f60f45dacc0>]
 
+        >>> pedalboard.data
+        {}
+        >>> pedalboard.data = {'my-awesome-component': True}
+        >>> pedalboard.data
+        {'my-awesome-component': True}
+
     For load the pedalboard for play the songs with it::
 
         >>> mod_host.pedalboard = pedalboard
 
-    All changes in the pedalboard will be reproduced in mod-host
+    All changes¹ in the pedalboard will be reproduced in mod-host.
+    ¹ Except in data attribute, changes in this does not interfere with anything.
 
     :param string name: Pedalboard name
     """
@@ -51,6 +58,8 @@ def __init__(self, name):
 
         self.bank = None
 
+        self.data = {}
+
     @property
     def observer(self):
         return self._observer
@@ -98,7 +107,8 @@ def __dict__(self):
         return {
             'name': self.name,
             'effects': [effect.json for effect in self.effects],
-            'connections': [connection.json for connection in self.connections]
+            'connections': [connection.json for connection in self.connections],
+            'data': self.data
         }
 
     def append(self, effect):

pluginsmanager/util/persistence_decoder.py

@@ -54,6 +54,9 @@ def read(self, json):
         for connection_json in json['connections']:
             pedalboard.connections.append(connection_reader.read(connection_json))
 
+        if 'data' in json:
+            pedalboard.data = json['data']
+
         return pedalboard
 
 
@@ -100,23 +103,25 @@ def read(self, json):
         return Connection(connection_output, connection_input)
 
     def read_output(self, json):
-        index = json['symbol']
-
         effect_index = json['effect']
         effect = self.pedalboard.effects[effect_index]
 
-        return effect.outputs[index]
+        return self.generic_system_output(effect, json['symbol'])
 
     def read_input(self, json):
-        index = json['symbol']
-
         effect_index = json['effect']
         effect = self.pedalboard.effects[effect_index]
 
-        return effect.inputs[index]
+        return self.generic_system_input(effect, json['symbol'])
 
     def read_system_output(self, json):
-        return self.system_effect.outputs[json['symbol']]
+        return self.generic_system_output(self.system_effect, json['symbol'])
 
     def read_system_input(self, json):
-        return self.system_effect.inputs[json['symbol']]
+        return self.generic_system_input(self.system_effect, json['symbol'])
+
+    def generic_system_output(self, effect, symbol):
+        return effect.outputs[symbol]
+
+    def generic_system_input(self, effect, symbol):
+        return effect.inputs[symbol]

test/model/patch_test.py → test/model/pedalboard_test.py

@@ -153,3 +153,12 @@ def test_delete_effect_remove_your_connections(self):
         self.assertEqual(1, len(pedalboard.connections))
         for connection in fuzz_connections:
             pedalboard.observer.on_connection_updated.assert_any_call(connection, UpdateType.DELETED)
+
+    def test_data(self):
+        pedalboard = Pedalboard('Bank 1')
+        pedalboard.observer = MagicMock()
+
+        self.assertEqual({}, pedalboard.data)
+        data = {'my-awesome-component': True}
+        pedalboard.data = data
+        self.assertEqual(data, pedalboard.data)

test/util/persistence_decoder_test.py

@@ -57,6 +57,7 @@ def test_read(self):
         bank = self.bank
         bank_readed = util.read(bank.json)
 
+        self.maxDiff = None
         self.assertEqual(bank.json, bank_readed.json)
 
     def test_read_unknown_technology(self):