Incorporate fix for many-to-many relationship for both directions based on code from @mbacicc in #186 (comment).

Author: adamghill

django_unicorn/serializer.py

@@ -75,7 +75,11 @@ def _get_model_dict(model: Model) -> dict:
 
     for field in model._meta.get_fields():
         if field.is_relation and field.many_to_many:
-            related_name = field.related_name or f"{field.name}_set"
+            related_name = field.name
+
+            if field.auto_created:
+                related_name = field.related_name or f"{field.name}_set"
+
             pks = []
 
             try:

django_unicorn/views/action_parsers/utils.py

@@ -68,7 +68,12 @@ class TestView(UnicornView):
                     if hasattr(component_or_field, "_meta"):
                         for field in component_or_field._meta.get_fields():
                             if field.is_relation and field.many_to_many:
-                                related_name = field.related_name or f"{field.name}_set"
+                                related_name = field.name
+
+                                if field.auto_created:
+                                    related_name = (
+                                        field.related_name or f"{field.name}_set"
+                                    )
 
                                 if related_name == property_name_part:
                                     related_descriptor = getattr(

example/coffee/admin.py

@@ -1,6 +1,8 @@
 from django.contrib import admin
 
-from .models import Flavor
+from .models import Flavor, Origin, Taste
 
 
 admin.site.register(Flavor)
+admin.site.register(Taste)
+admin.site.register(Origin)

tests/serializer/test_dumps.py

@@ -8,7 +8,7 @@
 
 from django_unicorn import serializer
 from django_unicorn.utils import dicts_equal
-from example.coffee.models import Flavor
+from example.coffee.models import Flavor, Taste
 
 
 class SimpleTestModel(models.Model):
@@ -260,6 +260,48 @@ def test_get_model_dict():
     assert expected == actual
 
 
+@pytest.mark.django_db
+def test_get_model_dict_many_to_many_is_referenced():
+    taste = Taste(name="Bitter")
+    taste.save()
+    flavor_one = Flavor(name="name1", label="label1")
+    flavor_one.save()
+    flavor_one.taste_set.add(taste)
+    actual = serializer._get_model_dict(flavor_one)
+
+    expected = {
+        "pk": 1,
+        "name": "name1",
+        "label": "label1",
+        "parent": None,
+        "decimal_value": None,
+        "float_value": None,
+        "uuid": str(flavor_one.uuid),
+        "date": None,
+        "datetime": None,
+        "time": None,
+        "duration": None,
+        "taste_set": [taste.pk],
+        "origins": [],
+    }
+
+    assert expected == actual
+
+
+@pytest.mark.django_db
+def test_get_model_dict_many_to_many_references_model():
+    taste = Taste(name="Bitter")
+    taste.save()
+    flavor_one = Flavor(name="name1", label="label1")
+    flavor_one.save()
+    flavor_one.taste_set.add(taste)
+    actual = serializer._get_model_dict(taste)
+
+    expected = {"name": taste.name, "flavor": [flavor_one.pk], "pk": taste.pk}
+
+    assert expected == actual
+
+
 def test_float():
     expected = '{"name":"0.0"}'
     actual = serializer.dumps({"name": 0.0})

tests/views/action_parsers/utils/test_set_property_value.py

@@ -5,7 +5,7 @@
 
 from django_unicorn.components import UnicornView
 from django_unicorn.views.action_parsers.utils import set_property_value
-from example.coffee.models import Flavor
+from example.coffee.models import Flavor, Taste
 
 
 class FakeComponent(UnicornView):
@@ -15,54 +15,63 @@ class FakeComponent(UnicornView):
     array: List[str] = []
     model = Flavor(name="initial-flavor")
     queryset = Flavor.objects.none()
+    taste = Taste(name="bitter")
 
 
 def test_set_property_value_str():
     component = FakeComponent(component_name="test", component_id="12345678")
     assert "property_view" == component.string
 
+    string = "property_view_updated"
+    data = {"string": "property_view_updated"}
+
     set_property_value(
-        component,
-        "string",
-        "property_view_updated",
-        {"string": "property_view_updated"},
+        component, "string", string, data,
     )
 
-    assert "property_view_updated" == component.string
+    assert component.string == string
+    assert data["string"] == string
 
 
 def test_set_property_value_int():
     component = FakeComponent(component_name="test", component_id="12345678")
     assert 99 == component.integer
 
-    set_property_value(component, "integer", 100, {"integer": 100})
+    integer = 100
+    data = {"integer": None}
+
+    set_property_value(component, "integer", integer, data)
 
-    assert 100 == component.integer
+    assert component.integer == integer
+    assert data["integer"] == integer
 
 
 def test_set_property_value_datetime():
     component = FakeComponent(component_name="test", component_id="12345678")
     assert datetime(2020, 1, 1) == component.datetime
 
-    set_property_value(
-        component, "datetime", datetime(2020, 1, 2), {"datetime": datetime(2020, 1, 2)}
-    )
+    dt = datetime(2020, 1, 2)
+    data = {"datetime": None}
 
-    assert datetime(2020, 1, 2) == component.datetime
+    set_property_value(component, "datetime", dt, data)
+
+    assert component.datetime == dt
+    assert data["datetime"] == dt
 
 
 def test_set_property_value_model():
     component = FakeComponent(component_name="test", component_id="12345678")
     assert "initial-flavor" == component.model.name
 
+    model = Flavor(name="test-flavor")
+    data = {"model": {}}
+
     set_property_value(
-        component,
-        "model",
-        Flavor(name="test-flavor"),
-        {"model": {"name": "test-flavor"}},
+        component, "model", model, data,
     )
 
-    assert "test-flavor" == component.model.name
+    assert component.model.name == model.name
+    assert data["model"] == model
 
 
 @pytest.mark.django_db
@@ -75,12 +84,55 @@ def test_set_property_value_queryset():
     flavor_two = Flavor(name="test-flavor-two")
     flavor_two.save()
     queryset = Flavor.objects.all()[:2]
+    data = {"queryset": []}
 
     set_property_value(
-        component,
-        "queryset",
-        queryset,
-        {"queryset": [{"name": "test-flavor-one"}, {"name": "test-flavor-two"}]},
+        component, "queryset", queryset, data,
     )
 
     assert len(queryset) == 2
+    assert data["queryset"] == queryset
+
+
+@pytest.mark.django_db
+def test_set_property_value_many_to_many_is_referenced():
+    component = FakeComponent(component_name="test", component_id="12345678")
+    component.model.save()
+    assert component.model.taste_set.count() == 0
+
+    taste = Taste(name="Bitter")
+    taste.save()
+    flavor = Flavor(name="test-flavor")
+    flavor.save()
+    flavor.taste_set.add(taste)
+
+    data = {"model": {}}
+
+    set_property_value(
+        component, "model.taste_set", [taste.pk], data,
+    )
+
+    assert data["model"]["taste_set"] == [taste.pk]
+    assert component.model.taste_set.count() == 1
+
+
+@pytest.mark.django_db
+def test_set_property_value_many_to_many_references_model():
+    component = FakeComponent(component_name="test", component_id="12345678")
+    component.taste.save()
+    assert component.taste.flavor.count() == 0
+
+    taste = Taste(name="Bitter")
+    taste.save()
+    flavor = Flavor(name="test-flavor")
+    flavor.save()
+    flavor.taste_set.add(taste)
+
+    data = {"taste": {}}
+
+    set_property_value(
+        component, "taste.flavor", [flavor.pk], data,
+    )
+
+    assert data["taste"]["flavor"] == [flavor.pk]
+    assert component.taste.flavor.count() == 1