'
- '
'
- '
'
- '
Help
'
+ '
",
]
)
diff --git a/tests/urls.py b/tests/urls.py
index 10877f70..225f73f6 100644
--- a/tests/urls.py
+++ b/tests/urls.py
@@ -1,7 +1,7 @@
from django.contrib import admin
from django.urls import include, re_path
-from wagtail.admin import urls as wagtailadmin_urls
from wagtail import urls as wagtail_urls
+from wagtail.admin import urls as wagtailadmin_urls
urlpatterns = [
re_path(r"^admin/", admin.site.urls),
diff --git a/tox.ini b/tox.ini
index 44273018..d87f2fdd 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,28 +1,24 @@
[tox]
envlist =
flake8
- py{311,312}-dj{41}-wt{41,50,51,52}
+ py{312}-dj{51}-wt{60,63}
[gh-actions]
python =
- "3.11": py311
"3.12": py312
[testenv]
deps =
coverage
mock
- dj41: Django>=4.1,<4.2
- wt41: wagtail>=4.1,<4.2
- wt50: wagtail>=5.0,<5.1
- wt51: wagtail>=5.1,<5.2
- wt52: wagtail>=5.2,<5.3
+ dj51: Django>=5.1,<5.2
+ wt60: wagtail>=6.0,<6.1
+ wt63: wagtail>=6.3,<6.4
commands =
- coverage run manage.py test
+ coverage run --parallel-mode manage.py test
basepython =
- py311: python3.11
py312: python3.12
setenv =
@@ -33,19 +29,19 @@ setenv =
passenv = TOX_*
[testenv:wagtaildev]
-basepython = python3.11
+basepython = python3.12
install_command = pip install -e ".[test]" -U {opts} {packages}
deps =
git+https://github.com/wagtail/wagtail.git@master
coverage
mock
- django>=3.2
+ django>=5.1
commands =
coverage run manage.py test
ignore_errors = True
[testenv:flake8]
-basepython = python3.11
+basepython = python3.12
deps = flake8
commands = flake8 wagtailstreamforms
@@ -63,7 +59,7 @@ exclude =
max-line-length = 120
[testenv:coverage-report]
-basepython = python3.11
+basepython = python3.12
deps = coverage[toml]
skip_install = true
commands =
@@ -72,7 +68,7 @@ commands =
coverage report
[testenv:format]
-basepython = python3.11
+basepython = python3.12
deps =
isort
black
diff --git a/wagtailstreamforms/blocks.py b/wagtailstreamforms/blocks.py
index b29ca153..00046eb0 100644
--- a/wagtailstreamforms/blocks.py
+++ b/wagtailstreamforms/blocks.py
@@ -42,7 +42,7 @@ class WagtailFormBlock(blocks.StructBlock):
)
class Meta:
- icon = "icon icon-form"
+ icon = "form"
template = None
def render(self, value, context=None):
diff --git a/wagtailstreamforms/conf.py b/wagtailstreamforms/conf.py
index 245bd5b5..551dd212 100644
--- a/wagtailstreamforms/conf.py
+++ b/wagtailstreamforms/conf.py
@@ -24,7 +24,7 @@
"singlefile",
"multifile",
),
- "FORM_TEMPLATES": (("streamforms/form_block.html", "Default Form Template"),),
+ "FORM_TEMPLATES": [("streamforms/form_block.html", "Default Form Template")],
}
diff --git a/wagtailstreamforms/fields.py b/wagtailstreamforms/fields.py
index 2d682013..5e8bcb43 100644
--- a/wagtailstreamforms/fields.py
+++ b/wagtailstreamforms/fields.py
@@ -25,7 +25,6 @@ class SingleLineTextField(BaseField):
"""
if cls is None:
-
def decorator(cls):
register(field_name, cls)
return cls
@@ -147,24 +146,60 @@ def get_options(self, block_value):
"initial": self.get_formfield_initial(block_value),
}
+ def get_form_block_class(self):
+ """
+ The StreamField block class to be created for this field. This is
+ almost always a StructBlock, but conceptually it could be any structural block.
+
+ Override this method and return a subclass of a structural block for further
+ control over the block class, such as overriding the clean() method to provide
+ custom validation.
+ :return: The ``wagtail.blocks.StructBlock`` to be used in the StreamField
+ """
+ return blocks.StructBlock
+
+ def get_form_block_kwargs(self):
+ """The kwargs to be passed into the StreamField block class.
+
+ Override this to provide additional kwargs to the StreamField block class.
+
+ :return: The kwargs to be passed into the StreamField block class
+ """
+ return {
+ "icon": self.icon,
+ "label": self.label,
+ }
+
def get_form_block(self):
- """The StreamField StructBlock.
+ """The StreamField block class.
Override this to provide additional fields in the StreamField.
- :return: The ``wagtail.core.blocks.StructBlock`` to be used in the StreamField
- """
- return blocks.StructBlock(
- [
- ("label", blocks.CharBlock()),
- ("help_text", blocks.CharBlock(required=False)),
- ("required", blocks.BooleanBlock(required=False)),
- ("default_value", blocks.CharBlock(required=False)),
- ],
- icon=self.icon,
- label=self.label,
+ :return: The resuld of calling get_form_block_class() is to be used in the
+ StreamField
+ """
+ return self.get_form_block_class()(
+ self.get_local_blocks(),
+ **self.get_form_block_kwargs(),
)
+ def get_local_blocks(self):
+ """The blocks that should be added to the StructBlock for this field.
+
+ Override this to add blocks to, or remove blocks from, the StructBlock
+ before it is instantiated. This is useful because adding blocks to the
+ StructBlock after instantiation requires mucking with the StructBlock's
+ internal, undocumented API.
+
+ :return: A list of tuples containing the block name and block instance.
+ """
+ return [
+ ("label", blocks.CharBlock()),
+ ("help_text", blocks.CharBlock(required=False)),
+ ("required", blocks.BooleanBlock(required=False)),
+ ("default_value", blocks.CharBlock(required=False)),
+ ]
+
class HookMultiSelectFormField(forms.MultipleChoiceField):
widget = forms.CheckboxSelectMultiple
diff --git a/wagtailstreamforms/forms.py b/wagtailstreamforms/forms.py
index 08805315..754d1831 100644
--- a/wagtailstreamforms/forms.py
+++ b/wagtailstreamforms/forms.py
@@ -26,20 +26,8 @@ def formfields(self):
formfields = OrderedDict()
- registered_fields = get_fields()
-
for field in self.fields:
- field_type = field.get("type")
- field_value = field.get("value")
-
- # check we have the field
- if field_type not in registered_fields:
- raise AttributeError("Could not find a registered field of type %s" % field_type)
-
- # get the field
- registered_cls = registered_fields[field_type]()
- field_name = registered_cls.get_formfield_name(field_value)
- field_cls = registered_cls.get_formfield(field_value)
+ field_name, field_cls = self.create_field_class(field)
formfields[field_name] = field_cls
# add fields to uniquely identify the form
@@ -48,6 +36,45 @@ def formfields(self):
return formfields
+ def create_field_class(self, field):
+ """
+ Encapsulates the field_cls creation such that there is a method to override
+ when the field_cls needs to be modified.
+
+ :param field: StreamBlock representing a form field; an item in
+ fields.stream_data
+ :return: a tuple of field_name - the name to use in the html form for this
+ field, and field_cls - in instantiated field class that may be added to a form
+ """
+ registered_fields = get_fields()
+
+ field_type = field.get("type")
+ field_value = field.get("value")
+ # check we have the field
+ if field_type not in registered_fields:
+ raise AttributeError(
+ "Could not find a registered field of type %s" % field_type
+ )
+
+ # get the field
+ registered_cls = registered_fields[field_type]()
+ field_cls = registered_cls.get_formfield(field_value)
+ field_name = self.create_field_name(registered_cls, field)
+ return field_name, field_cls
+
+ def create_field_name(self, registered_cls, field):
+ """
+ Encapsulates the field_name creation such that there is a method to override
+ when the field_name needs to be modified.
+
+ :param field: StreamBlock representing a form field; an item in
+ fields.stream_data
+ :param registered_cls: The subclass of wagtailstreamforms.fields.BaseField
+ that defined this form field
+ :return: a name to use in the html form for this field
+ """
+ return registered_cls.get_formfield_name(field.get("value"))
+
def get_form_class(self):
return type(str("StreamformsForm"), (BaseForm,), self.formfields)
diff --git a/wagtailstreamforms/migrations/0001_initial.py b/wagtailstreamforms/migrations/0001_initial.py
index 01eba326..90151c1e 100644
--- a/wagtailstreamforms/migrations/0001_initial.py
+++ b/wagtailstreamforms/migrations/0001_initial.py
@@ -1,9 +1,8 @@
# Generated by Django 2.0.5 on 2018-05-30 23:03
import django.db.models.deletion
-from wagtail import blocks
-
from django.db import migrations, models
+from wagtail import blocks
import wagtailstreamforms.conf
import wagtailstreamforms.fields
diff --git a/wagtailstreamforms/migrations/0003_alter_form_fields.py b/wagtailstreamforms/migrations/0003_alter_form_fields.py
index cb9e2318..a486033c 100644
--- a/wagtailstreamforms/migrations/0003_alter_form_fields.py
+++ b/wagtailstreamforms/migrations/0003_alter_form_fields.py
@@ -1,7 +1,8 @@
# Generated by Django 4.1.8 on 2023-04-14 05:21
-from django.db import migrations
import wagtail.blocks
+from django.db import migrations
+
import wagtailstreamforms.streamfield
diff --git a/wagtailstreamforms/models/form.py b/wagtailstreamforms/models/form.py
index fa7358e9..2409e074 100644
--- a/wagtailstreamforms/models/form.py
+++ b/wagtailstreamforms/models/form.py
@@ -43,7 +43,11 @@ class AbstractForm(models.Model):
template_name = models.CharField(
_("Template"), max_length=255, choices=get_setting("FORM_TEMPLATES")
)
- fields = FormFieldsStreamField([], use_json_field=True, verbose_name=_("Fields"))
+ fields = FormFieldsStreamField(
+ [],
+ verbose_name=_("Fields"),
+ use_json_field=True,
+ )
submit_button_text = models.CharField(
_("Submit button text"), max_length=100, default="Submit"
)
diff --git a/wagtailstreamforms/streamfield.py b/wagtailstreamforms/streamfield.py
index 2269527a..a511aaa8 100644
--- a/wagtailstreamforms/streamfield.py
+++ b/wagtailstreamforms/streamfield.py
@@ -26,13 +26,21 @@ def __init__(self, local_blocks=None, **kwargs):
"'%s' must be a subclass of '%s'" % (field_class, BaseField)
)
- # assign the block
- block = field_class().get_form_block()
- block.set_name(name)
- self._child_blocks[name] = block
+ # assign the block if instantiation returns non None
+ if block := self.instantiate_block(field_class, name):
+ self._child_blocks[name] = block
self._dependencies = self._child_blocks.values()
+ def instantiate_block(self, field_class, name):
+ """
+ Provides an extension point for changing attributes of blocks, like the
+ meta.group
+ """
+ block = field_class().get_form_block()
+ block.set_name(name)
+ return block
+
@property
def child_blocks(self):
return self._child_blocks
diff --git a/wagtailstreamforms/templates/streamforms/advanced_settings.html b/wagtailstreamforms/templates/streamforms/advanced_settings.html
index a90254c5..e3f81f28 100644
--- a/wagtailstreamforms/templates/streamforms/advanced_settings.html
+++ b/wagtailstreamforms/templates/streamforms/advanced_settings.html
@@ -13,7 +13,7 @@
{% block visible_fields %}
{% for field in form.visible_fields %}
- {% include "wagtailadmin/shared/field_as_li.html" %}
+ {% include "wagtailadmin/shared/field.html" %}
{% endfor %}
{% endblock %}
-
diff --git a/wagtailstreamforms/templates/streamforms/confirm_copy.html b/wagtailstreamforms/templates/streamforms/confirm_copy.html
index 4d9a7ce6..dca0d89c 100644
--- a/wagtailstreamforms/templates/streamforms/confirm_copy.html
+++ b/wagtailstreamforms/templates/streamforms/confirm_copy.html
@@ -14,7 +14,7 @@
{% block visible_fields %}
{% for field in form.visible_fields %}
- {% include "wagtailadmin/shared/field_as_li.html" %}
+ {% include "wagtailadmin/shared/field.html" %}
{% endfor %}
{% endblock %}
-
diff --git a/wagtailstreamforms/templates/streamforms/index_submissions.html b/wagtailstreamforms/templates/streamforms/index_submissions.html
index 8a6f50da..054706f6 100644
--- a/wagtailstreamforms/templates/streamforms/index_submissions.html
+++ b/wagtailstreamforms/templates/streamforms/index_submissions.html
@@ -77,7 +77,7 @@