Issue 49 (#54)

* python in progress

* runtime vars refined

* closes #49

---------

Co-authored-by: Gupta <[email protected]>

Author: SubhenduShekhar

python/cjson/src/cjson.py

@@ -26,11 +26,6 @@ def __init__(self, file_path: str):
         self.__obj = None
         self.__file_path = file_path
         self.__content = read(self.__file_path)
-        self.__decode_keywords()
-        '''Call this object to unlock native JSON functions
-        '''
-        self.json = Json(self.__obj)
-        self.__decode_relative_paths(self.__content)
 
     def __decode_keywords(self):
         is_changed: bool = False
@@ -85,6 +80,23 @@ def __decode_relative_paths(self, content: str):
         self.__refine_obj(content=content)
 
     def deserialize(self):
+        ''' Deserializes CJSON context and returns dictionary object in JSON context.
+
+            Please Note, if any key is detected for runtime variable injections is
+            replaced with `<-tag->`. No error/warning is thrown.
+
+            To inject runtime variables, use `inject` function
+        '''
+        self.__decode_keywords()
+
+        runtime_keys: list[str] = re.findall(Keywords.runtime_vals_regex, self.__content)
+        '''Call this object to unlock native JSON functions
+        '''
+        self.__content = self.__refine_runtime_vals(self.__content, runtime_keys=runtime_keys)
+        self.json = Json(self.__obj)
+        
+        self.__decode_relative_paths(self.__content)
+
         ''' Returns the JSON compiled object for the given `CJSON` file. '''
         return self.__obj
 
@@ -102,3 +114,53 @@ def __decode_single_line_comment(self, line_item: str):
         for i in range(0, len(line_split)):
             if line_split[i].strip() != "" and line_split[i].strip().startswith(Keywords.single_line_comment):
                 self.__content = self.__content.replace(line_split[i], "")
+    
+    def __refine_runtime_vals(self, content: str, runtime_keys: list[str]):
+        unique_keys: list[str] = []
+
+        for each_runtime_keys in runtime_keys:
+            if(each_runtime_keys not in unique_keys):
+                unique_keys.append(each_runtime_keys)
+        
+        for each_runtime_keys in unique_keys:
+            content = content.replace(each_runtime_keys, "\"<-" + each_runtime_keys.split("<")[1].split(">")[0] + "->\"")
+        
+        return content
+
+    def inject(self, injecting_obj: dict):
+        self.__decode_keywords()
+
+        runtime_keys: list[str] = re.findall(Keywords.runtime_vals_regex, self.__content)
+        
+        self.__content = self.__refine_runtime_vals(content=self.__content, runtime_keys=runtime_keys)
+        '''Call this object to unlock native JSON functions
+        '''
+        self.json = Json(self.__obj)
+        self.__decode_relative_paths(self.__content)
+        
+        for each_key in injecting_obj.keys():
+            if type(injecting_obj[each_key]) != str:
+                self.__content = self.__content.replace("\"<-" + each_key + "->\"", json.dumps(injecting_obj[each_key]))
+            else:
+                self.__content = self.__content.replace("<-" + each_key + "->", str(injecting_obj[each_key]))
+        
+        self.__refine_obj(self.__content)
+
+        return self.__obj
+    
+
+# cjson = Cjson(r"C:\Users\632400\Desktop\projects\cjson\tests\test-files\VariableInjection.cjson")
+# injec_data = {
+#             "fruit": "apple",
+#             "quantity": 1,
+#             "jsonTypeData": {
+#                 "secondaryData": {
+#                     "type": "fruit",
+#                     "seeds": "yes"
+#                 }
+#             }
+#         }
+
+# data = cjson.inject(injecting_obj=injec_data)
+
+# print(data)

python/cjson/src/utils/_json.py

@@ -1,4 +1,5 @@
 from utils import file
+from utils.keywords import Keywords
 import json
 from typing import Union
 from types import NoneType

python/cjson/src/utils/keywords.py

@@ -4,4 +4,5 @@ class Keywords:
     multiLine_comment_start: str = "/*"
     multiLine_comment_end: str = "*/"
     relative_jpath: str = "$."
-    relative_jpath_regex: str = "[$][.][.A-Za-z0-9]*"
+    relative_jpath_regex: str = "[$][.][.A-Za-z0-9]*"
+    runtime_vals_regex: str = "[<][A-Za-z0-9]*[>]"

python/setup.py

@@ -5,8 +5,8 @@
 
 setuptools.setup(
     name="codedjson",
-    version="1.1.1",
-    description="Coded JSON files. Save your files with .cjson extension to unlock these features",
+    version="1.2.0",
+    description="CJSON is a data file format(inspired from JSON), but supports logical expressions too. Having extended language support to NodeJS, Python and Java, users has experienced data reusability. For features and examples, please refer to this documentation as base document.",
     long_description=__description,
     long_description_content_type="text/markdown",
     author="Shubhendu Shekhar Gupta",

tests/python/cjson_tests.py

@@ -11,6 +11,7 @@ def get_file_path(file_name: str):
 json_file_path = get_file_path("source.json")
 pure_json_file_path = get_file_path("pure.json")
 relative_target_cjson = get_file_path("targetRelativeCalls.cjson")
+variable_injection = get_file_path("VariableInjection.cjson")
 
 class Result(Enum):
     Pass = "Pass"
@@ -61,6 +62,27 @@ def test4(self):
             self.assertEqual(digit_array_import[i], cjson.json.parse("target.digitArrayImport")[i])
 
         add_resut(Result.Pass, "I should be able to deserialize relative path to local variable")
+    
+    def test5(self):
+        cjson = Cjson(variable_injection)
+
+        injec_data = {
+            "fruit": "apple",
+            "quantity": 1,
+            "jsonTypeData": {
+                "secondaryData": {
+                    "type": "fruit",
+                    "seeds": "yes"
+                }
+            }
+        }
+
+        data = cjson.inject(injecting_obj=injec_data)
+        
+        self.assertEqual(cjson.json.parse("target.fruit"), injec_data["fruit"])
+        self.assertEqual(cjson.json.parse("target.quantity"), injec_data["quantity"])
+        self.assertEqual(cjson.json.parse("jsonInjection.secondaryData.type"), injec_data["jsonTypeData"]["secondaryData"]["type"])
+
 
 class JSONTests(unittest.TestCase):
     def test1(self):
@@ -70,12 +92,14 @@ def test1(self):
 
     def test2(self):
         cjson = Cjson(cjson_file_path)
+        cjson.deserialize()
         value = cjson.json.parse("source.quiz.sport.q1.question")
         self.assertEqual(value, "Which one is correct team name in NBA?")
         add_resut(Result.Pass, "I should be able to parse jpath using `obj< Cjson >.json.parse(\"Valid.JPATH\")`")
 
     def test3(self):
         cjson = Cjson(cjson_file_path)
+        cjson.deserialize()
         value = cjson.json.parse()
         self.assertEqual(value, cjson.deserialize())
 

tests/test-files/VariableInjection.cjson

@@ -2,6 +2,7 @@
     "target": {
         "types": "asd",
         "fruit": <fruit>,
+        "quantity": <quantity>,
         "size": "Large",
         "fruitType": $.target.fruit,
         "color": "Red",