Merge pull request #49 from ourstudio-se/48-plog-to-json-always-returns-id

to_json ID is returning only when explicitly defined

Author: znittzel

puan/logic/plog/__init__.py

@@ -658,8 +658,7 @@ def to_json(self) -> dict:
             -------
                 out : dict
         """
-        return {
-            'id': self.id,
+        d = {
             'type': self.__class__.__name__,
             'propositions': list(
                 map(
@@ -669,6 +668,10 @@ def to_json(self) -> dict:
             ),
             'value': self.value
         }
+        if not self.generated_id:
+            d['id'] = self.id
+
+        return d
 
     def to_b64(self, str_decoding: str = 'utf8') -> str:
 
@@ -810,17 +813,9 @@ def to_json(self) -> dict:
             -------
                 out : dict
         """
-        return {
-            'id': self.id,
-            'type': self.__class__.__name__,
-            'propositions': list(
-                map(
-                    operator.methodcaller("to_json"),
-                    self.propositions
-                )
-            ),
-            'value': -1*self.value
-        }
+        d = super().to_json()
+        d['value'] = -1*self.value
+        return d
 
 class All(AtLeast):
 
@@ -871,16 +866,15 @@ def to_json(self) -> dict:
             -------
                 out : dict
         """
-        return {
-            'id': self.id,
-            'type': self.__class__.__name__,
-            'propositions': list(
-                map(
-                    operator.methodcaller("to_json"),
-                    self.propositions
-                )
-            ),
-        }
+        d = super().to_json()
+        del d['value']
+        d['propositions'] = list(
+            map(
+                operator.methodcaller("to_json"),
+                self.propositions
+            )
+        )
+        return d
 
 class Any(AtLeast):
 
@@ -931,16 +925,15 @@ def to_json(self) -> dict:
             -------
                 out : dict
         """
-        return {
-            'id': self.id,
-            'type': self.__class__.__name__,
-            'propositions': list(
-                map(
-                    operator.methodcaller("to_json"),
-                    self.propositions
-                )
-            ),
-        }
+        d = super().to_json()
+        del d['value']
+        d['propositions'] = list(
+            map(
+                operator.methodcaller("to_json"),
+                self.propositions
+            )
+        )
+        return d
 
 class Imply(Any):
 
@@ -1002,12 +995,14 @@ def to_json(self) -> dict:
             -------
                 out : dict
         """
-        return {
-            'id': self.id,
+        d = {
             'type': self.__class__.__name__,
             'condition': self.condition.negate().to_json(),
             'consequence': self.consequence.to_json(),
         }
+        if not self.generated_id:
+            d['id'] = self.id
+        return d
 
     @staticmethod
     def from_cicJE(data: dict, id_ident: str = "id") -> "Imply":
@@ -1131,8 +1126,7 @@ def to_json(self) -> dict:
             -------
                 out : dict
         """
-        return {
-            'id': self.id,
+        d = {
             'type': self.__class__.__name__,
             'propositions': list(
                 map(
@@ -1141,6 +1135,9 @@ def to_json(self) -> dict:
                 )
             ) if len(self.propositions) > 0 else [],
         }
+        if not self.generated_id:
+            d['id'] = self.id
+        return d
 
 class Not():
 
@@ -1213,6 +1210,28 @@ def from_json(data: dict, class_map) -> "XNor":
     def from_list(propositions: list, variable: typing.Union[str, puan.variable] = None):
         return XNor(*propositions, variable=variable)
 
+    def to_json(self) -> dict:
+
+        """
+            Returns proposition as a readable json.
+
+            Returns
+            -------
+                out : dict
+        """
+        d = {
+            'type': self.__class__.__name__,
+            'propositions': list(
+                map(
+                    operator.methodcaller("to_json"),
+                    self.propositions[0].propositions
+                )
+            ) if len(self.propositions) > 0 else [],
+        }
+        if not self.generated_id:
+            d['id'] = self.id
+        return d
+
 def from_json(data: dict, class_map: list = [puan.variable,AtLeast,AtMost,All,Any,Xor,Not,XNor,Imply]) -> typing.Any:
 
     """

tests/test_puan.py

@@ -190,6 +190,19 @@ def test_model_json_conversion(propositions):
     _model = cc.StingyConfigurator.from_json(model.to_json())
     assert model == _model
 
+@given(cc_proposition_strategy())
+def test_to_from_b64(proposition):
+    string = proposition.to_b64()
+    _proposition = pg.from_b64(string)
+    assert proposition.id == _proposition.id
+    assert proposition.bounds == _proposition.bounds
+
+@given(proposition_strategy())
+def test_json_conversion_id_should_be_returned_if_explicitly_defined(proposition):
+    json_model = pg.from_json(proposition.to_json()).to_json()
+    # generated id (i.e. no ID was explicitly defined) implies that there shouldn't be an ID in the json
+    assert not (proposition.generated_id and 'id' in json_model)
+
 def test_json_conversion_special_cases():
 
     model = cc.StingyConfigurator(
@@ -1505,6 +1518,9 @@ def test_json_conversion():
     converted = cc.StingyConfigurator.from_json(model.to_json())
     assert model == converted
 
+    json_model = {"type": "All", "propositions": [{"id": "x", "bounds": {"lower": -10, "upper": 10}}]}
+    assert json_model == pg.from_json(json_model).to_json()
+
 def test_xnor_proposition():
 
     actual_model = pg.XNor("x","y","z") # <- meaning none or at least 2