Support model binding to a foreign key.

Author: adamghill

django_unicorn/views/action_parsers/utils.py

@@ -61,7 +61,23 @@ class TestView(UnicornView):
                     if hasattr(component, updating_function_name):
                         getattr(component, updating_function_name)(property_value)
 
-                    setattr(component_or_field, property_name_part, property_value)
+                    is_relation_field = False
+
+                    # Set the id property for ForeignKeys
+                    if hasattr(component_or_field, "_meta"):
+                        for field in component_or_field._meta.fields:
+                            if field.name == property_name_part:
+                                if field.is_relation:
+                                    setattr(
+                                        component_or_field,
+                                        field.attname,
+                                        property_value,
+                                    )
+                                    is_relation_field = True
+                                    break
+
+                    if not is_relation_field:
+                        setattr(component_or_field, property_name_part, property_value)
 
                     if hasattr(component, updated_function_name):
                         getattr(component, updated_function_name)(property_value)
@@ -77,19 +93,12 @@ class TestView(UnicornView):
             else:
                 component_or_field = component_or_field[property_name_part]
                 data_or_dict = data_or_dict.get(property_name_part, {})
-        elif isinstance(component_or_field, list):
+        elif isinstance(component_or_field, list) or isinstance(
+            component_or_field, QuerySet
+        ):
             # TODO: Check for iterable instad of list? `from collections.abc import Iterable`
             property_name_part = int(property_name_part)
 
-            if idx == len(property_name_parts) - 1:
-                component_or_field[property_name_part] = property_value
-                data_or_dict[property_name_part] = property_value
-            else:
-                component_or_field = component_or_field[property_name_part]
-                data_or_dict = data_or_dict[property_name_part]
-        elif isinstance(component_or_field, QuerySet):
-            property_name_part = int(property_name_part)
-
             if idx == len(property_name_parts) - 1:
                 component_or_field[property_name_part] = property_value
                 data_or_dict[property_name_part] = property_value

example/unicorn/components/models.py

@@ -24,3 +24,9 @@ def save(self, flavor_idx: int):
     def delete(self, flavor_to_delete: Flavor):
         flavor_to_delete.delete()
         self.refresh_flavors()
+
+    def available_flavors(self):
+        return Flavor.objects.all()
+
+    class Meta:
+        javascript_exclude = ("available_flavors",)

example/unicorn/templates/unicorn/models.html

@@ -44,6 +44,16 @@ <h4>{{ flavor.pk }}</h4>
                 {{ flavor.decimal_value }}
                 <br />
 
+                <label>Parent</label>
+                <select unicorn:model="flavors.{{ forloop.counter0 }}.parent">
+                    <option value="">n/a</option>
+                    {% for available_flavor in available_flavors %}
+                    <option value="{{ available_flavor.pk }}">{{ available_flavor.name }}</option>
+                    {% endfor %}
+                </select>
+                {{ flavor.parent.name }}
+                <br />
+
                 <button unicorn:click="save({{ forloop.counter0 }})">save(flavor_idx)</button>
                 <button unicorn:click="delete({{ flavor.pk }})">delete(flavor.pk)</button>
             </div>

tests/management/__init__.py

@@ -59,3 +59,22 @@ def test_set_property_value_array():
     )
 
     assert component.flavors[0].name == "test 1"
+
+
+@pytest.mark.django_db
+def test_set_property_value_foreign_key():
+    flavor = Flavor(name="initial 1")
+    flavor.save()
+    parent = Flavor(name="initial 2")
+    parent.save()
+    component = FakeComponent(component_name="test", component_id="12345678")
+
+    set_property_value(
+        component,
+        "flavors.0.parent",
+        parent.pk,
+        {"flavors": [{"name": flavor.name, "parent": None},]},
+    )
+
+    assert component.flavors[0].parent_id == parent.pk
+    assert component.flavors[0].parent.pk == parent.pk