wagtail-flexible-forms-hg 2.2.0__tar.gz

wagtail_flexible_forms_hg-2.2.0/LICENSE.txt

@@ -0,0 +1,30 @@
+BSD 3-Clause License
+
+Copyright (c) 2018, NoriPyt
+Copyright (c) 2025, CodeRed LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

wagtail_flexible_forms_hg-2.2.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: wagtail-flexible-forms-hg
+Version: 2.2.0
+Summary: Wagtail StreamField-based form builder.
+Author: Bertrand Bordage
+Author-email: CodeRed LLC <info@coderedcorp.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2018, NoriPyt
+        Copyright (c) 2025, CodeRed LLC
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        * Redistributions of source code must retain the above copyright notice, this
+          list of conditions and the following disclaimer.
+        
+        * Redistributions in binary form must reproduce the above copyright notice,
+          this list of conditions and the following disclaimer in the documentation
+          and/or other materials provided with the distribution.
+        
+        * Neither the name of the copyright holder nor the names of its
+          contributors may be used to endorse or promote products derived from
+          this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Source, https://github.com/happygrizzly/wagtail-flexible-forms
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Framework :: Django
+Classifier: Framework :: Wagtail
+Classifier: Framework :: Wagtail :: 6
+Classifier: Framework :: Wagtail :: 7
+Classifier: Framework :: Wagtail :: 8
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: wagtail<8.2,>=6
+Dynamic: license-file
+
+Wagtail Flexible Forms
+======================
+
+Wagtail flexible forms provides a more robust StreamField-based form builder (sometimes called a "StreamForm") with similar functionality to `wagtail.contrib.forms`.
+
+
+Installation & Usage
+--------------------
+
+Read the [documentation](https://docs.coderedcorp.com/wagtail-flexible-forms/), which includes a video demo and example project.
+
+
+History & Future of This Project
+--------------------------------
+
+This project was [originally developed by Bertrand Bordage of NoriPyt](https://www.kickstarter.com/projects/noripyt/wagtails-first-hatch) with the intention of being merged into Wagtail as `wagtail.contrib.stream_forms`.
+
+In 2019, CodeRed used the code as part of Wagtail CRX (`coderedcms`) to and began providing ongoing maintenance as part of that package.
+
+In 2025, with renewed interest from the Wagtail community and the Wagtail core team, CodeRed took ownership of the repository and backported the vendored code from `coderedcms` to produce a stable version of `wagtail-flexible-forms` as its own pip package.
+
+Stay tuned as we work to add more documentation, examples, and unit tests with the goal of eventually merging the package into Wagtail as the official "stream forms" implementation. It is a fantastic package and we are excited to be investing in it to share with the Wagtail community!

wagtail_flexible_forms_hg-2.2.0/README.md

@@ -0,0 +1,22 @@
+Wagtail Flexible Forms
+======================
+
+Wagtail flexible forms provides a more robust StreamField-based form builder (sometimes called a "StreamForm") with similar functionality to `wagtail.contrib.forms`.
+
+
+Installation & Usage
+--------------------
+
+Read the [documentation](https://docs.coderedcorp.com/wagtail-flexible-forms/), which includes a video demo and example project.
+
+
+History & Future of This Project
+--------------------------------
+
+This project was [originally developed by Bertrand Bordage of NoriPyt](https://www.kickstarter.com/projects/noripyt/wagtails-first-hatch) with the intention of being merged into Wagtail as `wagtail.contrib.stream_forms`.
+
+In 2019, CodeRed used the code as part of Wagtail CRX (`coderedcms`) to and began providing ongoing maintenance as part of that package.
+
+In 2025, with renewed interest from the Wagtail community and the Wagtail core team, CodeRed took ownership of the repository and backported the vendored code from `coderedcms` to produce a stable version of `wagtail-flexible-forms` as its own pip package.
+
+Stay tuned as we work to add more documentation, examples, and unit tests with the goal of eventually merging the package into Wagtail as the official "stream forms" implementation. It is a fantastic package and we are excited to be investing in it to share with the Wagtail community!

wagtail_flexible_forms_hg-2.2.0/pyproject.toml

@@ -0,0 +1,79 @@
+# -- PACKAGE INFO ---------------------
+
+[build-system]
+requires = ["setuptools >= 65.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+authors = [
+    {name = "CodeRed LLC", email = "info@coderedcorp.com"},
+    {name = "Bertrand Bordage"},
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Framework :: Django",
+    "Framework :: Wagtail",
+    "Framework :: Wagtail :: 6",
+    "Framework :: Wagtail :: 7",
+    "Framework :: Wagtail :: 8",
+]
+dependencies = [
+    "wagtail>=6,<8.2",
+]
+description = "Wagtail StreamField-based form builder."
+dynamic = ["version"]
+license = {file = "LICENSE.txt"}
+name = "wagtail-flexible-forms-hg"
+readme = "README.md"
+requires-python = ">=3.9"
+
+[project.urls]
+Source = "https://github.com/happygrizzly/wagtail-flexible-forms"
+
+[tool.setuptools]
+packages = ["wagtail_flexible_forms"]
+
+[tool.setuptools.dynamic]
+version = {attr = "wagtail_flexible_forms.__version__"}
+
+
+# -- TOOLS ----------------------------
+
+[tool.codespell]
+ignore-words-list = ["doubleclick"]
+
+[tool.django-stubs]
+django_settings_module = "testproject.settings"
+
+[tool.mypy]
+ignore_missing_imports = true
+check_untyped_defs = true
+exclude = [
+    '^\..*',
+    'migrations',
+    'node_modules',
+    'venv',
+]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "testproject.settings"
+junit_family = "xunit2"
+addopts = "--cov wagtail-flexible-forms --cov-report html --cov-report xml --junitxml junit/test-results.xml"
+python_files = "tests.py test_*.py"
+
+[tool.ruff]
+extend-exclude = ["build", "migrations"]
+line-length = 80
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.ruff.lint.isort]
+case-sensitive = false
+force-single-line = true
+lines-after-imports = 2

wagtail_flexible_forms_hg-2.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wagtail_flexible_forms_hg-2.2.0/wagtail_flexible_forms/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.2.0"

wagtail_flexible_forms_hg-2.2.0/wagtail_flexible_forms/blocks.py

@@ -0,0 +1,288 @@
+from anyascii import anyascii
+from django import forms
+from django.db.models import BLANK_CHOICE_DASH
+from django.utils.dateparse import parse_datetime
+from django.utils.text import slugify
+from django.utils.translation import gettext_lazy as _
+from wagtail.blocks import BooleanBlock
+from wagtail.blocks import CharBlock
+from wagtail.blocks import ChoiceBlock
+from wagtail.blocks import DateBlock
+from wagtail.blocks import DateTimeBlock
+from wagtail.blocks import ListBlock
+from wagtail.blocks import RichTextBlock
+from wagtail.blocks import StreamBlock
+from wagtail.blocks import StructBlock
+from wagtail.blocks import TextBlock
+from wagtail.blocks import TimeBlock
+
+
+class FormFieldBlock(StructBlock):
+    field_label = CharBlock(label=_("Label"))
+    help_text = TextBlock(required=False, label=_("Help text"))
+
+    field_class = forms.CharField
+    widget = None
+
+    def get_slug(self, struct_value):
+        return slugify(anyascii(struct_value["field_label"]))
+
+    def get_field_class(self, struct_value):
+        return self.field_class
+
+    def get_widget(self, struct_value):
+        return self.widget
+
+    def get_field_kwargs(self, struct_value):
+        kwargs = {
+            "label": struct_value["field_label"],
+            "help_text": struct_value["help_text"],
+            "required": struct_value.get("required", False),
+        }
+        if "default_value" in struct_value:
+            kwargs["initial"] = struct_value["default_value"]
+        form_widget = self.get_widget(struct_value)
+        if form_widget is not None:
+            kwargs["widget"] = form_widget
+        return kwargs
+
+    def get_field(self, struct_value):
+        return self.get_field_class(struct_value)(
+            **self.get_field_kwargs(struct_value)
+        )
+
+
+class OptionalFormFieldBlock(FormFieldBlock):
+    required = BooleanBlock(label=_("Required"), required=False)
+
+
+CHARFIELD_FORMATS = [
+    ("email", _("Email")),
+    ("url", _("URL")),
+]
+try:
+    from phonenumber_field.formfields import PhoneNumberField
+except ImportError:
+    pass
+else:
+    CHARFIELD_FORMATS.append(("phone", _("Phone")))
+
+
+class CharFieldBlock(OptionalFormFieldBlock):
+    format = ChoiceBlock(
+        choices=CHARFIELD_FORMATS, required=False, label=_("Format")
+    )
+    default_value = CharBlock(required=False, label=_("Default value"))
+
+    class Meta:
+        label = _("Text field (single line)")
+        icon = "pilcrow"
+
+    def get_field_class(self, struct_value):
+        text_format = struct_value["format"]
+        if text_format == "url":
+            return forms.URLField
+        if text_format == "email":
+            return forms.EmailField
+        if text_format == "phone":
+            return PhoneNumberField
+        return super().get_field_class(struct_value)
+
+
+class TextFieldBlock(OptionalFormFieldBlock):
+    default_value = TextBlock(required=False, label=_("Default value"))
+
+    widget = forms.Textarea(attrs={"rows": 5})
+
+    class Meta:
+        label = _("Text field (multi line)")
+        icon = "pilcrow"
+
+
+class NumberFieldBlock(OptionalFormFieldBlock):
+    default_value = CharBlock(required=False, label=_("Default value"))
+
+    widget = forms.NumberInput
+
+    class Meta:
+        label = _("Number field")
+        icon = "decimal"
+
+
+class CheckboxFieldBlock(FormFieldBlock):
+    default_value = BooleanBlock(required=False)
+
+    field_class = forms.BooleanField
+
+    class Meta:
+        label = _("Checkbox field")
+        icon = "tick-inverse"
+
+
+class RadioButtonsFieldBlock(OptionalFormFieldBlock):
+    choices = ListBlock(CharBlock(label=_("Choice")))
+
+    field_class = forms.ChoiceField
+    widget = forms.RadioSelect
+
+    class Meta:
+        label = _("Radio buttons")
+        icon = "radio-empty"
+
+    def get_field_kwargs(self, struct_value):
+        kwargs = super().get_field_kwargs(struct_value)
+        kwargs["choices"] = [
+            (choice, choice) for choice in struct_value["choices"]
+        ]
+        return kwargs
+
+
+class DropdownFieldBlock(RadioButtonsFieldBlock):
+    widget = forms.Select
+
+    class Meta:
+        label = _("Dropdown field")
+        icon = "list-ul"
+
+    def get_field_kwargs(self, struct_value):
+        kwargs = super(DropdownFieldBlock, self).get_field_kwargs(struct_value)
+        kwargs["choices"].insert(0, BLANK_CHOICE_DASH[0])
+        return kwargs
+
+
+class CheckboxesFieldBlock(OptionalFormFieldBlock):
+    checkboxes = ListBlock(CharBlock(label=_("Checkbox")))
+
+    field_class = forms.MultipleChoiceField
+    widget = forms.CheckboxSelectMultiple
+
+    class Meta:
+        label = _("Multiple checkboxes field")
+        icon = "tasks"
+
+    def get_field_kwargs(self, struct_value):
+        kwargs = super(CheckboxesFieldBlock, self).get_field_kwargs(
+            struct_value
+        )
+        kwargs["choices"] = [
+            (choice, choice) for choice in struct_value["checkboxes"]
+        ]
+        return kwargs
+
+
+class DatePickerInput(forms.DateInput):
+    def __init__(self, *args, **kwargs):
+        attrs = kwargs.get("attrs")
+        if attrs is None:
+            attrs = {}
+        attrs.update(
+            {
+                "data-provide": "datepicker",
+                "data-date-format": "yyyy-mm-dd",
+            }
+        )
+        kwargs["attrs"] = attrs
+        super().__init__(*args, **kwargs)
+
+
+class DateFieldBlock(OptionalFormFieldBlock):
+    default_value = DateBlock(required=False)
+
+    field_class = forms.DateField
+    widget = DatePickerInput
+
+    class Meta:
+        label = _("Date field")
+        icon = "date"
+
+
+class HTML5TimeInput(forms.TimeInput):
+    input_type = "time"
+
+
+class TimeFieldBlock(OptionalFormFieldBlock):
+    default_value = TimeBlock(required=False)
+
+    field_class = forms.TimeField
+    widget = HTML5TimeInput
+
+    class Meta:
+        label = _("Time field")
+        icon = "time"
+
+
+class DateTimePickerInput(forms.SplitDateTimeWidget):
+    def __init__(self, attrs=None, date_format=None, time_format=None):
+        super().__init__(
+            attrs=attrs, date_format=date_format, time_format=time_format
+        )
+        self.widgets = (
+            DatePickerInput(attrs=attrs, format=date_format),
+            HTML5TimeInput(attrs=attrs, format=time_format),
+        )
+
+    def decompress(self, value):
+        if isinstance(value, str):
+            value = parse_datetime(value)
+        return super().decompress(value)
+
+
+class DateTimeFieldBlock(OptionalFormFieldBlock):
+    default_value = DateTimeBlock(required=False)
+
+    field_class = forms.SplitDateTimeField
+    widget = DateTimePickerInput
+
+    class Meta:
+        label = _("Date+time field")
+        icon = "date"
+
+
+class ImageFieldBlock(OptionalFormFieldBlock):
+    field_class = forms.ImageField
+
+    class Meta:
+        label = _("Image field")
+        icon = "image"
+
+
+class FileFieldBlock(OptionalFormFieldBlock):
+    field_class = forms.FileField
+
+    class Meta:
+        label = _("File field")
+        icon = "upload"
+
+
+class FormFieldsBlock(StreamBlock):
+    char = CharFieldBlock(group=_("Fields"))
+    text = TextFieldBlock(group=_("Fields"))
+    number = NumberFieldBlock(group=_("Fields"))
+    checkbox = CheckboxFieldBlock(group=_("Fields"))
+    radios = RadioButtonsFieldBlock(group=_("Fields"))
+    dropdown = DropdownFieldBlock(group=_("Fields"))
+    checkboxes = CheckboxesFieldBlock(group=_("Fields"))
+    date = DateFieldBlock(group=_("Fields"))
+    time = TimeFieldBlock(group=_("Fields"))
+    datetime = DateTimeFieldBlock(group=_("Fields"))
+    image = ImageFieldBlock(group=_("Fields"))
+    file = FileFieldBlock(group=_("Fields"))
+    text_markup = RichTextBlock(group=_("Other"))
+
+    class Meta:
+        label = _("Form fields")
+
+
+class FormStepBlock(StructBlock):
+    name = CharBlock(label=_("Name"), required=False)
+    form_fields = FormFieldsBlock()
+
+    class Meta:
+        label = _("Form step")
+
+
+class FormStepsBlock(StreamBlock):
+    step = FormStepBlock()
+
+    class Meta:
+        label = _("Form steps")

wagtail_flexible_forms_hg-2.2.0/wagtail_flexible_forms/edit_handlers.py

@@ -0,0 +1,35 @@
+from django.template.loader import render_to_string
+from django.utils.safestring import mark_safe
+from django.utils.translation import gettext as _
+from wagtail.admin.panels import EditHandler
+
+
+class FormSubmissionsPanel(EditHandler):
+    template = "wagtailforms/edit_handlers/form_responses_panel.html"
+
+    def bind_to(self, model=None, instance=None, request=None, form=None):
+        new = super().bind_to(model=model)
+        if self.heading is None:
+            new.heading = _("{} submissions").format(model.get_verbose_name())
+        return new
+
+    def render(self):
+        Submission = self.model.get_submission_class()
+        submissions = Submission.objects.filter(page=self.instance)
+        submission_count = submissions.count()
+
+        if not submission_count:
+            return ""
+
+        return mark_safe(
+            render_to_string(
+                self.template,
+                {
+                    "self": self,
+                    "submission_count": submission_count,
+                    "last_submit_time": (
+                        submissions.order_by("submit_time").last().submit_time
+                    ),
+                },
+            )
+        )