Fixed ability to merge a list of dicts in YAML

cookie_composer/merge_files/yaml_file.py

@@ -2,6 +2,8 @@
 
 from pathlib import Path
 
+from frozendict import frozendict
+
 from cookie_composer import data_merge
 from cookie_composer.composition import (
     COMPREHENSIVE,
@@ -24,9 +26,10 @@ def merge_yaml_files(new_file: Path, existing_file: Path, merge_strategy: str):
     Raises:
         MergeError: If something goes wrong
     """
-    from ruamel.yaml import YAML, YAMLError
+    from ruamel.yaml import YAML, SafeRepresenter, YAMLError
 
     yaml = YAML(typ="safe")
+    yaml.Representer.add_representer(frozendict, SafeRepresenter.represent_dict)
 
     if merge_strategy == DO_NOT_MERGE:
         raise MergeError(

tests/fixtures/existing.json

@@ -1,6 +1,26 @@
 {
   "number": 1,
   "string": "abc",
-  "list": ["a", 1, "c"],
-  "dictionary": {"a": 1, "b": [1, 2]}
+  "list": [
+    "a",
+    1,
+    "c"
+  ],
+  "dictionary": {
+    "a": 1,
+    "b": [
+      1,
+      2
+    ]
+  },
+  "list_of_dicts": [
+    {
+      "a": 1,
+      "b": 2
+    },
+    {
+      "c": 3,
+      "d": 4
+    }
+  ]
 }

tests/fixtures/existing.toml

@@ -4,3 +4,4 @@ string = "abc"
 list = ["a", "1", "c"]
 dictionary.a = 1
 dictionary.b = [1, 2]
+list_of_dicts = [{a = 1, b = 2}, {c = 3, d = 4}]

tests/fixtures/existing.yaml

@@ -9,3 +9,8 @@ dictionary:
   "b":
     - 1
     - 2
+list_of_dicts:
+  - a: 1
+    b: 2
+  - c: 3
+    d: 4

tests/fixtures/new.json

@@ -1,6 +1,22 @@
 {
   "number": 2,
   "string": "def",
-  "list": ["a", 2],
-  "dictionary": {"b": [3, 2]}
+  "list": [
+    "a",
+    2
+  ],
+  "dictionary": {
+    "b": [
+      3,
+      2
+    ]
+  },
+  "list_of_dicts": [
+    {
+      "e": 1
+    },
+    {
+      "f": 3
+    }
+  ]
 }

tests/fixtures/new.toml

@@ -3,3 +3,4 @@ number = 2
 string = "def"
 list = ["a", "2"]
 dictionary.b = [3, 2]
+list_of_dicts = [{e = 1}, {f = 3}]

tests/fixtures/new.yaml

@@ -7,3 +7,6 @@ dictionary:
   "b":
     - 3
     - 2
+list_of_dicts:
+  - e: 1
+  - f: 3

tests/test_merge_files_json_file.py

@@ -35,6 +35,7 @@ def test_overwrite_merge(tmp_path, fixtures_path):
         "string": "def",
         "list": ["a", 2],
         "dictionary": {"b": [3, 2]},
+        "list_of_dicts": [{"e": 1}, {"f": 3}],
     }
 
 
@@ -52,6 +53,7 @@ def test_overwrite_nested_merge(tmp_path, fixtures_path):
         "string": "def",
         "list": ["a", 2],
         "dictionary": {"a": 1, "b": [3, 2]},
+        "list_of_dicts": [{"e": 1}, {"f": 3}],
     }
 
 

tests/test_merge_files_toml_file.py

@@ -38,6 +38,7 @@ def test_overwrite_merge(tmp_path, fixtures_path):
             "string": "def",
             "list": ["a", "2"],
             "dictionary": {"b": [3, 2]},
+            "list_of_dicts": [{"e": 1}, {"f": 3}],
         }
     }
 
@@ -57,6 +58,7 @@ def test_overwrite_nested_merge(tmp_path, fixtures_path):
             "string": "def",
             "list": ["a", "2"],
             "dictionary": {"a": 1, "b": [3, 2]},
+            "list_of_dicts": [{"e": 1}, {"f": 3}],
         }
     }
 

tests/test_merge_files_yaml_file.py

@@ -39,6 +39,7 @@ def test_overwrite_merge(tmp_path, fixtures_path):
         "string": "def",
         "list": ["a", 2],
         "dictionary": {"b": [3, 2]},
+        "list_of_dicts": [{"e": 1}, {"f": 3}],
     }
 
 
@@ -56,6 +57,7 @@ def test_overwrite_nested_merge(tmp_path, fixtures_path):
         "string": "def",
         "list": ["a", 2],
         "dictionary": {"a": 1, "b": [3, 2]},
+        "list_of_dicts": [{"e": 1}, {"f": 3}],
     }
 
 
@@ -73,6 +75,7 @@ def test_comprehensive_merge(tmp_path, fixtures_path):
     assert set(rendered["list"]) == {"a", 1, 2, "c"}
     assert rendered["dictionary"]["a"] == 1
     assert set(rendered["dictionary"]["b"]) == {1, 2, 3}
+    assert len(rendered["list_of_dicts"]) == 4
 
 
 def test_bad_files(tmp_path, fixtures_path):