refactor(converter): extract switch field method from versions folder

Author: SimonClo

converter/converter/utils.py

@@ -296,3 +296,17 @@ def add_object_to_medical_notes(
         }
 
     json_data["medicalNote"].append(new_note)
+
+
+def switch_field_name(
+    json_data: Dict[str, Any], previous_field_path: str, new_field_path: str
+):
+    if is_field_completed(json_data, previous_field_path):
+        value = get_field_value(json_data, previous_field_path)
+        logger.info(
+            "Transforming field name from %s to %s",
+            previous_field_path,
+            new_field_path,
+        )
+        set_value(json_data, new_field_path, value)
+        delete_paths(json_data, [previous_field_path])

converter/converter/versions/create_case_health/create_case_health_converter.py

@@ -6,6 +6,7 @@
     get_field_value,
     is_field_completed,
     map_to_new_value,
+    switch_field_name,
 )
 from converter.versions.base_message_converter import BaseMessageConverter
 from converter.versions.create_case_health.v1_v2.constants import V1V2Constants
@@ -16,7 +17,6 @@
 from converter.versions.create_case_health.v2_v3.constants import V2V3Constants
 from converter.versions.utils import (
     reverse_map_to_new_value,
-    switch_field_name,
 )
 
 

converter/converter/versions/resources_info/resources_info_converter.py

@@ -1,12 +1,18 @@
 from typing import Dict, Any
 import logging
 
-from converter.utils import delete_paths, get_field_value, map_to_new_value, set_value
+from converter.utils import (
+    delete_paths,
+    get_field_value,
+    map_to_new_value,
+    set_value,
+    switch_field_name,
+)
 from converter.versions.base_message_converter import BaseMessageConverter
 from converter.versions.resources_info.resources_info_constants import (
     ResourcesInfoConstants,
 )
-from converter.versions.utils import reverse_map_to_new_value, switch_field_name
+from converter.versions.utils import reverse_map_to_new_value
 
 logger = logging.getLogger(__name__)
 

converter/converter/versions/resources_status/resources_status_converter.py

@@ -1,11 +1,11 @@
 from typing import Dict, Any
 
-from converter.utils import map_to_new_value
+from converter.utils import map_to_new_value, switch_field_name
 from converter.versions.base_message_converter import BaseMessageConverter
 from converter.versions.resources_status.resources_status_constants import (
     ResourcesStatusConstants,
 )
-from converter.versions.utils import reverse_map_to_new_value, switch_field_name
+from converter.versions.utils import reverse_map_to_new_value
 
 
 class ResourcesStatusConverter(BaseMessageConverter):

converter/converter/versions/utils.py

@@ -3,10 +3,7 @@
 
 from converter.utils import (
     get_field_value,
-    is_field_completed,
     update_json_value,
-    delete_paths,
-    set_value,
 )
 
 logger = logging.getLogger(__name__)
@@ -31,20 +28,6 @@ def reverse_map_to_new_value(
             update_json_value(json_data, json_path, new_value)
 
 
-def switch_field_name(
-    json_data: Dict[str, Any], previous_field_path: str, new_field_path: str
-):
-    if is_field_completed(json_data, previous_field_path):
-        value = get_field_value(json_data, previous_field_path)
-        logger.info(
-            "Transforming field name from %s to %s",
-            previous_field_path,
-            new_field_path,
-        )
-        set_value(json_data, new_field_path, value)
-        delete_paths(json_data, [previous_field_path])
-
-
 def convert_to_float(value: Optional[str]) -> Optional[float]:
     if value is None:
         return None

converter/tests/test_utils.py

@@ -11,6 +11,7 @@
     update_json_value,
     set_value,
     extract_message_type_from_message_content,
+    switch_field_name,
 )
 import unittest
 import json
@@ -524,3 +525,37 @@ def test_non_string_values_are_supported(self):
             "status": "ok",
         }
         assert extract_message_type_from_message_content(content) == "createCaseHealth"
+
+
+class TestSwitchFieldName(unittest.TestCase):
+    def test_switch_field_name(self):
+        json_data = {"oldFieldName": "value1", "otherField": "value2"}
+        previous_field_name = "oldFieldName"
+        new_field_name = "newFieldName"
+        previous_field_path = f"$.{previous_field_name}"
+        new_field_path = f"$.{new_field_name}"
+
+        self.assertNotIn(new_field_name, json_data)
+        self.assertIn(previous_field_name, json_data)
+
+        switch_field_name(json_data, previous_field_path, new_field_path)
+
+        self.assertIn(new_field_name, json_data)
+        self.assertEqual(json_data[new_field_name], "value1")
+        self.assertNotIn(previous_field_name, json_data)
+
+    def test_switch_field_name_with_nested_field(self):
+        json_data = {"parent": {"oldFieldName": "value1"}, "otherField": "value2"}
+        previous_field_name = "oldFieldName"
+        new_field_name = "newFieldName"
+        previous_field_path = f"$.parent.{previous_field_name}"
+        new_field_path = f"$.parent.{new_field_name}"
+
+        self.assertNotIn(new_field_name, json_data["parent"])
+        self.assertIn(previous_field_name, json_data["parent"])
+
+        switch_field_name(json_data, previous_field_path, new_field_path)
+
+        self.assertIn(new_field_name, json_data["parent"])
+        self.assertEqual(json_data["parent"][new_field_name], "value1")
+        self.assertNotIn(previous_field_name, json_data["parent"])

converter/tests/versions/test_utils.py

@@ -2,44 +2,9 @@
 
 from converter.versions.utils import (
     reverse_map_to_new_value,
-    switch_field_name,
 )
 
 
-class TestSwitchFieldName(unittest.TestCase):
-    def test_switch_field_name(self):
-        json_data = {"oldFieldName": "value1", "otherField": "value2"}
-        previous_field_name = "oldFieldName"
-        new_field_name = "newFieldName"
-        previous_field_path = f"$.{previous_field_name}"
-        new_field_path = f"$.{new_field_name}"
-
-        self.assertNotIn(new_field_name, json_data)
-        self.assertIn(previous_field_name, json_data)
-
-        switch_field_name(json_data, previous_field_path, new_field_path)
-
-        self.assertIn(new_field_name, json_data)
-        self.assertEqual(json_data[new_field_name], "value1")
-        self.assertNotIn(previous_field_name, json_data)
-
-    def test_switch_field_name_with_nested_field(self):
-        json_data = {"parent": {"oldFieldName": "value1"}, "otherField": "value2"}
-        previous_field_name = "oldFieldName"
-        new_field_name = "newFieldName"
-        previous_field_path = f"$.parent.{previous_field_name}"
-        new_field_path = f"$.parent.{new_field_name}"
-
-        self.assertNotIn(new_field_name, json_data["parent"])
-        self.assertIn(previous_field_name, json_data["parent"])
-
-        switch_field_name(json_data, previous_field_path, new_field_path)
-
-        self.assertIn(new_field_name, json_data["parent"])
-        self.assertEqual(json_data["parent"][new_field_name], "value1")
-        self.assertNotIn(previous_field_name, json_data["parent"])
-
-
 class TestReverseMapToNewValue(unittest.TestCase):
     def test_reverse_map_to_new_value_with_valid_mapping(self):
         json_data = {"field": "value1"}