consistency in naming

Author: timgraham

django_mongodb_backend/fields/embedded_model_array.py

@@ -1,23 +1,22 @@
 from django.db.models import Field
 
-from ..forms import EmbeddedModelArrayFormField
+from .. import forms
 from . import EmbeddedModelField
 from .array import ArrayField
 
 
 class EmbeddedModelArrayField(ArrayField):
-    def __init__(self, model, **kwargs):
-        super().__init__(EmbeddedModelField(model), **kwargs)
-        self.embedded_model = model
+    def __init__(self, embedded_model, **kwargs):
+        super().__init__(EmbeddedModelField(embedded_model), **kwargs)
+        self.embedded_model = embedded_model
 
     def deconstruct(self):
         name, path, args, kwargs = super().deconstruct()
-        if path == "django_mongodb_backend.fields.multiple_embedded_model.EmbeddedModelArrayField":
+        if path == "django_mongodb_backend.fields.embedded_model_array.EmbeddedModelArrayField":
             path = "django_mongodb_backend.fields.EmbeddedModelArrayField"
         kwargs.update(
             {
-                "model": self.base_field.embedded_model,
-                "size": self.size,
+                "embedded_model": self.embedded_model,
             }
         )
         del kwargs["base_field"]
@@ -33,7 +32,7 @@ def formfield(self, **kwargs):
         return Field.formfield(
             self,
             **{
-                "form_class": EmbeddedModelArrayFormField,
+                "form_class": forms.EmbeddedModelArrayField,
                 "model": self.base_field.embedded_model,
                 "max_length": self.max_size,
                 "prefix": self.name,

django_mongodb_backend/forms/__init__.py

@@ -1,5 +1,5 @@
 from .fields import (
-    EmbeddedModelArrayFormField,
+    EmbeddedModelArrayField,
     EmbeddedModelField,
     ObjectIdField,
     SimpleArrayField,
@@ -8,7 +8,7 @@
 )
 
 __all__ = [
-    "EmbeddedModelArrayFormField",
+    "EmbeddedModelArrayField",
     "EmbeddedModelField",
     "SimpleArrayField",
     "SplitArrayField",

django_mongodb_backend/forms/fields/__init__.py

@@ -1,10 +1,10 @@
 from .array import SimpleArrayField, SplitArrayField, SplitArrayWidget
 from .embedded_model import EmbeddedModelField
-from .embedded_model_array import EmbeddedModelArrayFormField
+from .embedded_model_array import EmbeddedModelArrayField
 from .objectid import ObjectIdField
 
 __all__ = [
-    "EmbeddedModelArrayFormField",
+    "EmbeddedModelArrayField",
     "EmbeddedModelField",
     "SimpleArrayField",
     "SplitArrayField",

django_mongodb_backend/forms/fields/embedded_model_array.py

@@ -13,7 +13,7 @@ def models_to_dicts(models):
     return [model_to_dict(model) for model in models or []]
 
 
-class EmbeddedModelArrayFormField(forms.Field):
+class EmbeddedModelArrayField(forms.Field):
     def __init__(self, model, prefix, max_length=None, length=None, *args, **kwargs):
         self.model = model
         self.prefix = prefix
@@ -23,7 +23,7 @@ def __init__(self, model, prefix, max_length=None, length=None, *args, **kwargs)
             max_num=max_length,
             extra=3,
         )
-        kwargs["widget"] = MultipleEmbeddedModelWidget()
+        kwargs["widget"] = EmbeddedModelArrayWidget()
         super().__init__(*args, **kwargs)
 
     def clean(self, value):
@@ -47,10 +47,10 @@ def has_changed(self, initial, data):
         return formset.has_changed()
 
     def get_bound_field(self, form, field_name):
-        return MultipleEmbeddedModelBoundField(form, self, field_name)
+        return EmbeddedModelArrayBoundField(form, self, field_name)
 
 
-class MultipleEmbeddedModelBoundField(forms.BoundField):
+class EmbeddedModelArrayBoundField(forms.BoundField):
     def __init__(self, form, field, name):
         super().__init__(form, field, name)
         self.formset = field.formset(
@@ -66,7 +66,7 @@ def __str__(self):
         return format_html("<table>\n{}\n</table>\n{}", body, self.formset.management_form)
 
 
-class MultipleEmbeddedModelWidget(forms.Widget):
+class EmbeddedModelArrayWidget(forms.Widget):
     """
     This widget extracts the data for EmbeddedModelArrayFormField's formset.
     It is never rendered.

tests/model_fields_/models.py

@@ -150,7 +150,7 @@ def __str__(self):
         return self.name
 
 
-# ArrayField + EmbeddedModelField
+# EmbeddedModelArrayField
 class Review(EmbeddedModel):
     title = models.CharField(max_length=255)
     rating = models.DecimalField(max_digits=6, decimal_places=1)

tests/model_fields_/test_embedded_model.py

@@ -1,7 +1,7 @@
 import operator
 from datetime import timedelta
 
-from django.core.exceptions import FieldDoesNotExist, FieldError, ValidationError
+from django.core.exceptions import FieldDoesNotExist, ValidationError
 from django.db import models
 from django.db.models import (
     Exists,
@@ -24,9 +24,7 @@
     Data,
     Holder,
     Library,
-    Movie,
     NestedData,
-    Review,
 )
 from .utils import truncate_ms
 
@@ -98,60 +96,6 @@ def test_pre_save(self):
         self.assertGreater(obj.data.auto_now, auto_now_two)
 
 
-class EmbeddedArrayTests(TestCase):
-    def test_save_load(self):
-        reviews = [
-            Review(title="The best", rating=10),
-            Review(title="Mediocre", rating=5),
-            Review(title="Horrible", rating=1),
-        ]
-        Movie.objects.create(title="Lion King", reviews=reviews)
-        movie = Movie.objects.get(title="Lion King")
-        self.assertEqual(movie.reviews[0].title, "The best")
-        self.assertEqual(movie.reviews[0].rating, 10)
-        self.assertEqual(movie.reviews[1].title, "Mediocre")
-        self.assertEqual(movie.reviews[1].rating, 5)
-        self.assertEqual(movie.reviews[2].title, "Horrible")
-        self.assertEqual(movie.reviews[2].rating, 1)
-        self.assertEqual(len(movie.reviews), 3)
-
-    def test_save_load_null(self):
-        movie = Movie.objects.create(title="Lion King")
-        movie = Movie.objects.get(title="Lion King")
-        self.assertIsNone(movie.reviews)
-
-
-class EmbeddedArrayQueryingTests(TestCase):
-    @classmethod
-    def setUpTestData(cls):
-        reviews = [
-            Review(title="The best", rating=10),
-            Review(title="Mediocre", rating=5),
-            Review(title="Horrible", rating=1),
-        ]
-        cls.clouds = Movie.objects.create(title="Clouds", reviews=reviews)
-        reviews = [
-            Review(title="Super", rating=9),
-            Review(title="Meh", rating=5),
-            Review(title="Horrible", rating=2),
-        ]
-        cls.frozen = Movie.objects.create(title="Frozen", reviews=reviews)
-        reviews = [
-            Review(title="Excellent", rating=9),
-            Review(title="Wow", rating=8),
-            Review(title="Classic", rating=7),
-        ]
-        cls.bears = Movie.objects.create(title="Bears", reviews=reviews)
-
-    def test_filter_with_field(self):
-        msg = (
-            "Unsupported lookup 'title' for EmbeddedModelArrayField or join "
-            "on the field not permitted."
-        )
-        with self.assertRaisesMessage(FieldError, msg):
-            Movie.objects.filter(reviews__title="Horrible")
-
-
 class QueryingTests(TestCase):
     @classmethod
     def setUpTestData(cls):

tests/model_fields_/test_embedded_model_array.py

@@ -0,0 +1,130 @@
+from django.core.exceptions import FieldError, ValidationError
+from django.db import models
+from django.test import SimpleTestCase, TestCase
+from django.test.utils import isolate_apps
+
+from django_mongodb_backend.fields import EmbeddedModelArrayField
+from django_mongodb_backend.models import EmbeddedModel
+
+from .models import (
+    Data,
+    Holder,
+    Movie,
+    Review,
+)
+
+
+class MethodTests(SimpleTestCase):
+    def test_deconstruct(self):
+        field = EmbeddedModelArrayField("Data", null=True)
+        name, path, args, kwargs = field.deconstruct()
+        self.assertEqual(path, "django_mongodb_backend.fields.EmbeddedModelArrayField")
+        self.assertEqual(args, [])
+        self.assertEqual(kwargs, {"embedded_model": "Data", "null": True})
+
+    def test_get_db_prep_save_invalid(self):
+        msg = "Expected instance of type <class 'model_fields_.models.Data'>, " "not <class 'int'>."
+        with self.assertRaisesMessage(TypeError, msg):
+            Holder(data=42).save()
+
+    def test_validate(self):
+        obj = Holder(data=Data(integer=None))
+        # This isn't quite right because "integer" is the subfield of data
+        # that's non-null.
+        msg = "{'data': ['This field cannot be null.']}"
+        with self.assertRaisesMessage(ValidationError, msg):
+            obj.full_clean()
+
+
+class ModelTests(TestCase):
+    def test_save_load(self):
+        reviews = [
+            Review(title="The best", rating=10),
+            Review(title="Mediocre", rating=5),
+            Review(title="Horrible", rating=1),
+        ]
+        Movie.objects.create(title="Lion King", reviews=reviews)
+        movie = Movie.objects.get(title="Lion King")
+        self.assertEqual(movie.reviews[0].title, "The best")
+        self.assertEqual(movie.reviews[0].rating, 10)
+        self.assertEqual(movie.reviews[1].title, "Mediocre")
+        self.assertEqual(movie.reviews[1].rating, 5)
+        self.assertEqual(movie.reviews[2].title, "Horrible")
+        self.assertEqual(movie.reviews[2].rating, 1)
+        self.assertEqual(len(movie.reviews), 3)
+
+    def test_save_load_null(self):
+        movie = Movie.objects.create(title="Lion King")
+        movie = Movie.objects.get(title="Lion King")
+        self.assertIsNone(movie.reviews)
+
+
+class QueryingTests(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        reviews = [
+            Review(title="The best", rating=10),
+            Review(title="Mediocre", rating=5),
+            Review(title="Horrible", rating=1),
+        ]
+        cls.clouds = Movie.objects.create(title="Clouds", reviews=reviews)
+        reviews = [
+            Review(title="Super", rating=9),
+            Review(title="Meh", rating=5),
+            Review(title="Horrible", rating=2),
+        ]
+        cls.frozen = Movie.objects.create(title="Frozen", reviews=reviews)
+        reviews = [
+            Review(title="Excellent", rating=9),
+            Review(title="Wow", rating=8),
+            Review(title="Classic", rating=7),
+        ]
+        cls.bears = Movie.objects.create(title="Bears", reviews=reviews)
+
+    def test_filter_with_field(self):
+        msg = (
+            "Unsupported lookup 'title' for EmbeddedModelArrayField or join "
+            "on the field not permitted."
+        )
+        with self.assertRaisesMessage(FieldError, msg):
+            Movie.objects.filter(reviews__title="Horrible")
+
+
+@isolate_apps("model_fields_")
+class CheckTests(SimpleTestCase):
+    def test_no_relational_fields(self):
+        class Target(EmbeddedModel):
+            key = models.ForeignKey("MyModel", models.CASCADE)
+
+        class MyModel(models.Model):
+            field = EmbeddedModelArrayField(Target)
+
+        errors = MyModel().check()
+        self.assertEqual(len(errors), 1)
+        self.assertEqual(errors[0].id, "django_mongodb_backend.array.E001")
+        msg = errors[0].msg
+        self.assertEqual(
+            msg,
+            "Base field for array has errors:\n    "
+            "Embedded models cannot have relational fields (Target.key is a ForeignKey). "
+            "(django_mongodb_backend.embedded_model.E001)",
+        )
+
+    def test_embedded_model_subclass(self):
+        class Target(models.Model):
+            pass
+
+        class MyModel(models.Model):
+            field = EmbeddedModelArrayField(Target)
+
+        errors = MyModel().check()
+        self.assertEqual(len(errors), 1)
+        self.assertEqual(errors[0].id, "django_mongodb_backend.array.E001")
+        msg = errors[0].msg
+        self.assertEqual(
+            msg,
+            "Base field for array has errors:\n    "
+            "Embedded models must be a subclass of "
+            "django_mongodb_backend.models.EmbeddedModel. "
+            "(django_mongodb_backend.embedded_model.E002)",
+        )