Allow default value in field (#34)

* Allow default value in

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

* run only on push to master and PR to master

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

* add tests

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

* run isort

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

Author: gradam

django_better_admin_arrayfield/forms/fields.py

@@ -16,6 +16,7 @@ class DynamicArrayField(forms.Field):
     def __init__(self, base_field, **kwargs):
         self.base_field = base_field
         self.max_length = kwargs.pop("max_length", None)
+        self.default = kwargs.pop("default", None)
         kwargs.setdefault("widget", DynamicArrayWidget)
         super().__init__(**kwargs)
 
@@ -36,7 +37,10 @@ def clean(self, value):
                     )
 
         if not value:
-            cleaned_data = None
+            if callable(self.default):
+                cleaned_data = self.default()
+            else:
+                cleaned_data = self.default
 
         if cleaned_data is None and self.initial is not None:
             if callable(self.initial):

tests/test_fields.py

@@ -21,3 +21,21 @@ def test_field_required():
         field.clean(data)
     data = ["12", "13"]
     field.clean(data)
+
+
+def test_default():
+    default = ["1"]
+    field = DynamicArrayField(CharField(max_length=10), required=True, default=default)
+    data = []
+    cleaned_data = field.clean(data)
+    assert cleaned_data == default
+
+
+def test_callable_default():
+    def default():
+        return ["1", "2"]
+
+    field = DynamicArrayField(CharField(max_length=10), required=True, default=default)
+    data = []
+    cleaned_data = field.clean(data)
+    assert cleaned_data == default()

tests/test_forms.py

@@ -1,15 +1,16 @@
 from typing import Type
 
-from django.forms import ModelForm
+from django.forms import IntegerField, ModelForm
 
 import pytest
 
+from django_better_admin_arrayfield.forms.fields import DynamicArrayField
 from tests.testapp.models import DefaultValueNullableModel, DefaultValueRequiredModel, NullableNoDefaultModel
 
 
-def form_factory(model) -> Type[ModelForm]:
+def form_factory(model, **attrs) -> Type[ModelForm]:
     meta = type("Meta", (), {"model": model, "fields": ["array"]})
-    return type("SampleForm", (ModelForm,), {"Meta": meta})
+    return type("SampleForm", (ModelForm,), {"Meta": meta, **attrs})
 
 
 class TestDefaultValue:
@@ -32,3 +33,28 @@ def test_default_list(self, model_class, init_value, expected_value):
         form = form_factory(model_class)(data=data)
         assert form.is_valid()
         assert form.cleaned_data["array"] == expected_value
+
+
+class TestFormDefaultField:
+    @pytest.mark.parametrize(
+        "model_class,init_value,expected_value",
+        (
+            (DefaultValueNullableModel, None, [1]),
+            (NullableNoDefaultModel, None, [1]),
+            (DefaultValueRequiredModel, None, [1]),
+            (DefaultValueNullableModel, [2], [2]),
+            (NullableNoDefaultModel, [2], [2]),
+            (DefaultValueRequiredModel, [2], [2]),
+        ),
+    )
+    def test_default_different_values(self, model_class, init_value, expected_value):
+        default = [1]
+        data = {}
+        if init_value is not None:
+            data["array"] = init_value
+
+        field = DynamicArrayField(IntegerField(), required=True, default=default)
+
+        form = form_factory(model_class, array=field)(data=data)
+        assert form.is_valid()
+        assert form.cleaned_data["array"] == expected_value