Rename _set_property_from_payload since it is used in other places now.

Author: adamghill

django_unicorn/views.py

@@ -62,23 +62,22 @@ def _set_property_from_data(
                 setattr(component_or_field, name, value)
 
 
-def _set_property_from_payload(
-    component: UnicornView, payload: Dict, data: Dict = {}
+def _set_property_value(
+    component: UnicornView, property_name: str, property_value: Any, data: Dict = {}
 ) -> None:
     """
-    Sets properties on the component based on the payload.
+    Sets properties on the component.
     Also updates the data dictionary which gets set back as part of the payload.
 
     Args:
         param component: Component to set attributes on.
-        param payload: Dictionary that comes with request.
+        param property_name: Name of the property.
+        param property_value: Value to set on the property.
         param data: Dictionary that gets sent back with the response. Defaults to {}.
     """
 
-    property_name = payload.get("name")
-    assert property_name is not None, "Payload name is required"
-    property_value = payload.get("value")
-    assert property_value is not None, "Payload value is required"
+    assert property_name is not None, "Property name is required"
+    assert property_value is not None, "Property value is required"
 
     component.updating(property_name, property_value)
 
@@ -258,8 +257,8 @@ def message(request: HttpRequest, component_name: str = None) -> JsonResponse:
     original_data = component_request.data.copy()
 
     # Set component properties based on request data
-    for (name, value) in component_request.data.items():
-        _set_property_from_data(component, name, value)
+    for (property_name, property_value) in component_request.data.items():
+        _set_property_from_data(component, property_name, property_value)
     component.hydrate()
 
     is_reset_called = False
@@ -269,7 +268,11 @@ def message(request: HttpRequest, component_name: str = None) -> JsonResponse:
         payload = action.get("payload", {})
 
         if action_type == "syncInput":
-            _set_property_from_payload(component, payload, component_request.data)
+            property_name = payload.get("name")
+            property_value = payload.get("value")
+            _set_property_value(
+                component, property_name, property_value, component_request.data
+            )
         elif action_type == "dbInput":
             model = payload.get("model")
             db = payload.get("db", {})
@@ -337,12 +340,10 @@ def message(request: HttpRequest, component_name: str = None) -> JsonResponse:
                     pass
 
             if setter_method:
-                # Create a fake "payload" so that nested properties will get set as expected
                 property_name = list(setter_method.keys())[0]
                 property_value = setter_method[property_name]
-                payload = {"name": property_name, "value": property_value}
 
-                _set_property_from_payload(component, payload)
+                _set_property_value(component, property_name, property_value)
             else:
                 (method_name, params) = parse_call_method_name(call_method_name)
 
@@ -368,12 +369,10 @@ def message(request: HttpRequest, component_name: str = None) -> JsonResponse:
                     is_reset_called = True
                 elif method_name == "toggle":
                     for property_name in params:
-                        # Create a fake "payload" so that nested properties will get set as expected
                         property_value = _get_property_value(component, property_name)
                         property_value = not property_value
-                        payload = {"name": property_name, "value": property_value}
 
-                        _set_property_from_payload(component, payload)
+                        _set_property_value(component, property_name, property_value)
                 elif method_name == "validate":
                     # Handle the validate special action
                     validate_all_fields = True

tests/views/test_unicorn_builtins.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 
 from django_unicorn.components import UnicornView
-from django_unicorn.views import _set_property_from_data, _set_property_from_payload
+from django_unicorn.views import _set_property_from_data, _set_property_value
 
 
 class NestedPropertyView(UnicornView):
@@ -19,12 +19,16 @@ def test_set_property_from_data_str():
     assert "property_view_updated" == component.string
 
 
-def test_set_property_from_payload_str():
+def test_set_property_value_str():
     component = NestedPropertyView(component_name="test", component_id="12345678")
     assert "property_view" == component.string
 
-    payload = {"name": "string", "value": "property_view_updated"}
-    _set_property_from_payload(component, payload, {"string": "property_view_updated"})
+    _set_property_value(
+        component,
+        "string",
+        "property_view_updated",
+        {"string": "property_view_updated"},
+    )
 
     assert "property_view_updated" == component.string
 
@@ -38,12 +42,11 @@ def test_set_property_from_data_int():
     assert 100 == component.integer
 
 
-def test_set_property_from_payload_int():
+def test_set_property_value_int():
     component = NestedPropertyView(component_name="test", component_id="12345678")
     assert 99 == component.integer
 
-    payload = {"name": "integer", "value": 100}
-    _set_property_from_payload(component, payload, {"integer": 100})
+    _set_property_value(component, "integer", 100, {"integer": 100})
 
     assert 100 == component.integer
 
@@ -57,11 +60,12 @@ def test_set_property_from_data_datetime():
     assert datetime(2020, 1, 2) == component.datetime
 
 
-def test_set_property_from_payload_datetime():
+def test_set_property_value_datetime():
     component = NestedPropertyView(component_name="test", component_id="12345678")
     assert datetime(2020, 1, 1) == component.datetime
 
-    payload = {"name": "datetime", "value": datetime(2020, 1, 2)}
-    _set_property_from_payload(component, payload, {"datetime": datetime(2020, 1, 2)})
+    _set_property_value(
+        component, "datetime", datetime(2020, 1, 2), {"datetime": datetime(2020, 1, 2)}
+    )
 
     assert datetime(2020, 1, 2) == component.datetime

tests/views/test_unicorn_dict.py

@@ -1,5 +1,5 @@
 from django_unicorn.components import UnicornView
-from django_unicorn.views import _set_property_from_data, _set_property_from_payload
+from django_unicorn.views import _set_property_from_data
 
 
 class DictPropertyView(UnicornView):

tests/views/test_unicorn_field.py

@@ -1,5 +1,5 @@
 from django_unicorn.components import UnicornField, UnicornView
-from django_unicorn.views import _set_property_from_data, _set_property_from_payload
+from django_unicorn.views import _set_property_from_data
 
 
 class NestedPropertyOne(UnicornField):