fix: Merging of missing values in json (#40)

Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>

Author: phuongfi91

src/nitpick/plugins/json.py

@@ -87,10 +87,33 @@ def report(self, violation: ViolationEnum, blender: JsonDict, change: BaseDoc |
         if not change:
             return
         if blender:
-            blender.update(flatten_quotes(change.as_object))
+            if violation == SharedViolations.MISSING_VALUES:
+                self._update_missing_values(blender, change)
+            else:
+                blender.update(flatten_quotes(change.as_object))
             self.dirty = True
         yield self.reporter.make_fuss(violation, change.reformatted, prefix="", fixed=self.autofix)
 
+    def _update_missing_values(self, blender: JsonDict, change: BaseDoc | None):  # pylint: disable=no-self-use
+        """Update the missing values in the blender, depending on the type of each key's value."""
+        flattened_changes = flatten_quotes(change.as_object)
+        for key, change_value in flattened_changes.items():
+            if key in blender:
+                blender_value = blender[key]
+                # Check if both are of the same type
+                if isinstance(blender_value, list) and isinstance(change_value, list):
+                    # For arrays, append values without duplicates
+                    blender[key].extend(change_value)
+                elif isinstance(blender_value, dict) and isinstance(change_value, dict):
+                    # For dictionaries, update recursively
+                    blender_value.update(change_value)
+                else:
+                    # For different types or scalar values, simply replace
+                    blender[key] = change_value
+            else:
+                # Key doesn't exist in blender, simply add it
+                blender[key] = change_value
+
     @property
     def initial_contents(self) -> str:
         """Suggest the initial content for this missing file."""

tests/test_json.py

@@ -17,16 +17,8 @@ def test_suggest_initial_contents(tmp_path, datadir):
         style = ["package-json"]
         """
     ).api_check_then_fix(
-        Fuss(
-            True,
-            JAVASCRIPT_PACKAGE_JSON,
-            341,
-            " was not found. Create it with this content:",
-            expected_package_json,
-        )
-    ).assert_file_contents(
-        JAVASCRIPT_PACKAGE_JSON, expected_package_json
-    ).api_check_then_fix()
+        Fuss(True, JAVASCRIPT_PACKAGE_JSON, 341, " was not found. Create it with this content:", expected_package_json)
+    ).assert_file_contents(JAVASCRIPT_PACKAGE_JSON, expected_package_json).api_check_then_fix()
 
 
 def test_missing_different_values_with_contains_json_with_contains_keys(tmp_path, datadir):
@@ -70,9 +62,7 @@ def test_missing_different_values_with_contains_json_with_contains_keys(tmp_path
             }
             """,
         ),
-    ).assert_file_contents(
-        JAVASCRIPT_PACKAGE_JSON, expected_package_json
-    ).api_check_then_fix()
+    ).assert_file_contents(JAVASCRIPT_PACKAGE_JSON, expected_package_json).api_check_then_fix()
 
 
 def test_missing_different_values_with_contains_json_without_contains_keys(tmp_path, datadir):
@@ -124,9 +114,184 @@ def test_missing_different_values_with_contains_json_without_contains_keys(tmp_p
             }
             """,
         ),
-    ).assert_file_contents(
-        "my.json", datadir / "3-expected.json"
-    ).api_check_then_fix()
+    ).assert_file_contents("my.json", datadir / "3-expected.json").api_check_then_fix()
+
+
+def test_missing_value_with_doubly_single_quoted_dotted_key_should_be_added_and_kept_flatten(tmp_path):
+    """A dotted key wrapped in double single quotes should be added and preserved without getting unflatten."""
+    ProjectMock(tmp_path).style(
+        """
+        ["my.json".contains_json]
+        "''some.dotted.key''" = \"\"\"
+            "some_value"
+        \"\"\"
+        """
+    ).save_file("my.json", """{ "project_name": "my-project" }""").api_fix().assert_file_contents(
+        "my.json",
+        """
+        {
+          "project_name": "my-project",
+          "some.dotted.key": "some_value"
+        }
+        """,
+    )
+
+
+def test_missing_value_with_dotted_key_should_be_added_and_unflatten(tmp_path):
+    """A dotted key should be added and unflatten."""
+    ProjectMock(tmp_path).style(
+        """
+        ["my.json".contains_json]
+        "some.dotted.key" = \"\"\"
+            "some_value"
+        \"\"\"
+        """
+    ).save_file("my.json", """{ "project_name": "my-project" }""").api_fix().assert_file_contents(
+        "my.json",
+        """
+        {
+          "project_name": "my-project",
+          "some": {
+            "dotted": {
+              "key": "some_value"
+            }
+          }
+        }
+        """,
+    )
+
+
+def test_missing_values_in_array_should_be_appended(tmp_path):
+    """Test missing values in array should be appended."""
+    ProjectMock(tmp_path).style(
+        """
+        ["my.json".contains_json]
+        "some_key" = \"\"\"
+            [
+                "val_1",
+                "val_2",
+                "val_3"
+            ]
+        \"\"\"
+        """
+    ).save_file(
+        "my.json",
+        """
+        {
+            "project_name": "my-project",
+            "some_key": [
+                "val_1"
+            ]
+        }
+        """,
+    ).api_fix().assert_file_contents(
+        "my.json",
+        """
+        {
+          "project_name": "my-project",
+          "some_key": [
+            "val_1",
+            "val_2",
+            "val_3"
+          ]
+        }
+        """,
+    )
+
+
+def test_different_values_in_dict_should_be_updated(tmp_path):
+    """Test different values in dict should be appended."""
+    ProjectMock(tmp_path).style(
+        """
+        ["my.json".contains_json]
+        "some_key" = \"\"\"
+            {
+                "key_1": "val_1_updated",
+                "key_2": "val_2",
+                "key_3": {
+                    "k": "v"
+                }
+            }
+        \"\"\"
+        """
+    ).save_file(
+        "my.json",
+        """
+        {
+            "project_name": "my-project",
+            "some_key": {
+                "key_1": "val_1"
+            }
+        }
+        """,
+    ).api_fix().assert_file_contents(
+        "my.json",
+        """
+        {
+          "project_name": "my-project",
+          "some_key": {
+            "key_1": "val_1_updated",
+            "key_2": "val_2",
+            "key_3": {
+              "k": "v"
+            }
+          }
+        }
+        """,
+    )
+
+
+def test_missing_values_in_nested_dict_and_array_should_also_be_updated_and_appended(tmp_path):
+    """Test missing values in nested dict and array should also be updated and appended."""
+    ProjectMock(tmp_path).style(
+        """
+        ["my.json".contains_json]
+        "some_key" = \"\"\"
+            {
+                "key_dict": {
+                    "k": "v"
+                },
+                "key_array": [
+                    "val_2",
+                    "val_3"
+                ]
+            }
+        \"\"\"
+        """
+    ).save_file(
+        "my.json",
+        """
+        {
+            "project_name": "my-project",
+            "some_key": {
+                "key_dict": {
+                    "existing_k": "existing_v"
+                },
+                "key_array": [
+                    "val_1"
+                ]
+            }
+        }
+        """,
+    ).api_fix().assert_file_contents(
+        "my.json",
+        """
+        {
+          "project_name": "my-project",
+          "some_key": {
+            "key_array": [
+              "val_1",
+              "val_2",
+              "val_3"
+            ],
+            "key_dict": {
+              "existing_k": "existing_v",
+              "k": "v"
+            }
+          }
+        }
+        """,
+    )
 
 
 def test_invalid_json(tmp_path, datadir):

tests/test_json/2-actual-package.json

@@ -3,6 +3,6 @@
   "version": "0.0.1",
   "something": "else",
   "commitlint": {
-    "extends": ["wrong-plugin-should-be-replaced", "another-wrong-plugin"]
+    "extends": ["some-plugin-should-be-kept", "another-plugin-should-be-kept"]
   }
 }

tests/test_json/2-expected-package.json

@@ -1,6 +1,8 @@
 {
   "commitlint": {
     "extends": [
+      "some-plugin-should-be-kept",
+      "another-plugin-should-be-kept",
       "@commitlint/config-conventional"
     ]
   },