Handle default values

Signed-off-by: Jakub Semik <[email protected]>

Author: gradam

django_better_admin_arrayfield/forms/fields.py

@@ -22,22 +22,33 @@ def __init__(self, base_field, **kwargs):
     def clean(self, value):
         cleaned_data = []
         errors = []
-        value = list(filter(None, value))
+        if value is not None:
+            value = [x for x in value if x]
+
+            for index, item in enumerate(value):
+                try:
+                    cleaned_data.append(self.base_field.clean(item))
+                except forms.ValidationError as error:
+                    errors.append(
+                        prefix_validation_error(
+                            error, self.error_messages["item_invalid"], code="item_invalid", params={"nth": index}
+                        )
+                    )
+
         if not value:
             cleaned_data = None
-        for index, item in enumerate(value):
-            try:
-                cleaned_data.append(self.base_field.clean(item))
-            except forms.ValidationError as error:
-                errors.append(
-                    prefix_validation_error(
-                        error, self.error_messages["item_invalid"], code="item_invalid", params={"nth": index}
-                    )
-                )
+
+        if cleaned_data is None and self.initial is not None:
+            if callable(self.initial):
+                cleaned_data = self.initial()
+            else:
+                cleaned_data = self.initial
+
         if errors:
             raise forms.ValidationError(list(chain.from_iterable(errors)))
         if not cleaned_data and self.required:
             raise forms.ValidationError(self.error_messages["required"])
+
         return cleaned_data
 
     def has_changed(self, initial, data):

sample_project/docker-compose.yml renamed to docker-compose.yml

@@ -1,4 +1,4 @@
 bumpversion==0.6.0
 wheel==0.34.2
 pre-commit==2.6.0
-black==19.10b0
+black==19.10b0psycopg2-binary==2.8.5

requirements_dev.txt

@@ -26,3 +26,4 @@ max-line-length = 119
 
 [tool:pytest]
 DJANGO_SETTINGS_MODULE = tests.settings
+django_find_project = false

setup.cfg

@@ -14,6 +14,7 @@
     "django.contrib.contenttypes",
     "django.contrib.sites",
     "django_better_admin_arrayfield",
+    "tests.testapp.apps.TestAppConfig",
 ]
 
 TEMPLATES = [{"BACKEND": "django.template.backends.django.DjangoTemplates", "APP_DIRS": True}]

tests/settings.py

@@ -0,0 +1,33 @@
+from typing import Type
+
+import pytest
+from django.forms import ModelForm
+
+from tests.testapp.models import DefaultValueNullableModel, NullableNoDefaultModel, DefaultValueRequiredModel
+
+
+def form_factory(model) -> Type[ModelForm]:
+    meta = type("Meta", (), {"model": model, "fields": ["array"]})
+    return type("SampleForm", (ModelForm,), {"Meta": meta})
+
+
+class TestDefaultValue:
+    @pytest.mark.parametrize(
+        "model_class,init_value,expected_value",
+        (
+            (DefaultValueNullableModel, None, []),
+            (NullableNoDefaultModel, None, None),
+            (DefaultValueRequiredModel, None, []),
+            (DefaultValueNullableModel, [1], [1]),
+            (NullableNoDefaultModel, [1], [1]),
+            (DefaultValueRequiredModel, [1], [1]),
+        ),
+    )
+    def test_default_list(self, model_class, init_value, expected_value):
+        data = {}
+        if init_value is not None:
+            data["array"] = init_value
+
+        form = form_factory(model_class)(data=data)
+        assert form.is_valid()
+        assert form.cleaned_data["array"] == expected_value

tests/test_forms.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class TestAppConfig(AppConfig):
+    name = "tests.testapp"
+    verbose_name = "TestApp"

tests/testapp/apps.py

@@ -0,0 +1,15 @@
+from django.db import models
+
+from django_better_admin_arrayfield.models.fields import ArrayField
+
+
+class DefaultValueNullableModel(models.Model):
+    array = ArrayField(models.IntegerField(), blank=True, null=True, default=list)
+
+
+class DefaultValueRequiredModel(models.Model):
+    array = ArrayField(models.IntegerField(), blank=True, default=list)
+
+
+class NullableNoDefaultModel(models.Model):
+    array = ArrayField(models.IntegerField(), blank=True, null=True)