Add crispy forms example

django_unicorn/components/unicorn_view.py

@@ -21,7 +21,7 @@
 
 from .. import serializer
 from ..decorators import timed
-from ..errors import ComponentLoadError, UnicornCacheError
+from ..errors import ComponentLoadError, MissingFormError, UnicornCacheError
 from ..settings import get_setting
 from ..utils import get_cacheable_component, is_non_string_sequence
 from .fields import UnicornField
@@ -140,9 +140,6 @@ def construct_component(
     return component
 
 
-from django.utils.decorators import classonlymethod
-
-
 class UnicornView(TemplateView):
     response_class = UnicornTemplateResponse
     component_name: str = ""
@@ -391,8 +388,6 @@ def get_frontend_context_variables(self) -> str:
         form = self._get_form(attributes)
 
         if form:
-            form.is_valid()
-
             for key in attributes.keys():
                 if key in form.fields:
                     field = form.fields[key]
@@ -434,6 +429,16 @@ def _get_form(self, data):
             except Exception as e:
                 logger.exception(e)
 
+    def get_form(self, **kwargs):
+        if hasattr(self, "form_class"):
+            # TODO: what to do with kwargs and attributes?
+            if kwargs:
+                return self._get_form(**kwargs)
+            else:
+                return self._get_form(self._attributes())
+
+        raise MissingFormError(f"{self.component_name} is missing a `form_class` field")
+
     @timed
     def get_context_data(self, **kwargs):
         """
@@ -671,6 +676,7 @@ def _is_public(self, name: str) -> bool:
             "call",
             "calls",
             "component_cache_key",
+            "get_form",
         )
         excludes = []
 

django_unicorn/errors.py

@@ -24,3 +24,7 @@ class MissingComponentViewElement(Exception):
 
 class ComponentNotValid(Exception):
     pass
+
+
+class MissingFormError(Exception):
+    pass

example/project/settings.py

@@ -14,6 +14,8 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    # Include `django-crispy-forms` for testing
+    "crispy_forms",
     # Internal apps
     "books",
     "coffee",

example/unicorn/components/crispy.py

@@ -0,0 +1,76 @@
+from django import forms
+
+from crispy_forms.helper import FormHelper
+from crispy_forms.layout import Submit
+
+from django_unicorn.components import UnicornView
+
+
+class ExampleForm(forms.Form):
+    like_website = forms.TypedChoiceField(
+        label="Do you like this website?",
+        choices=((1, "Yes"), (0, "No")),
+        coerce=lambda x: bool(int(x)),
+        widget=forms.RadioSelect,
+        initial="1",
+        required=True,
+    )
+
+    favorite_food = forms.CharField(
+        label="What is your favorite food?",
+        max_length=80,
+        required=True,
+    )
+
+    favorite_color = forms.CharField(
+        label="What is your favorite color?",
+        max_length=80,
+        required=True,
+    )
+
+    favorite_number = forms.IntegerField(
+        label="Favorite number",
+        required=False,
+    )
+
+    notes = forms.CharField(
+        label="Additional notes or feedback",
+        required=False,
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.helper = FormHelper()
+        self.helper.form_id = "id-exampleForm"
+        self.helper.form_class = "blueForms"
+        self.helper.form_method = "post"
+        self.helper.form_action = "submit_survey"
+
+        self.helper.add_input(Submit("submit", "Submit"))
+
+
+class UnicornFormMixin:
+    # form_class: forms.Form = None
+
+    class Meta:
+        javascript_exclude = ("form",)
+
+    def __init__(self, **kwargs):
+        # print("l", self.form)
+        # print("m", self.get_form())
+
+        self.form = self.get_form()
+
+        for field_name, field in self.form.fields.items():
+            # set the classes Unicorn attrs dynamically
+            setattr(self.__class__, field_name, "")
+            field.widget.attrs["unicorn:model.lazy"] = field_name
+
+        super().__init__(**kwargs)
+
+
+class CrispyView(UnicornFormMixin, UnicornView):
+    like_website = False
+    favorite_food = "Blueberries"
+
+    form_class = ExampleForm

example/unicorn/components/direct_view.py

@@ -1,5 +1,3 @@
-from django.utils.timezone import now
-
 from django_unicorn.components import UnicornView
 
 

example/unicorn/templates/unicorn/crispy-direct-view.html

@@ -0,0 +1,12 @@
+{% extends "www/base.html" %}
+{% load crispy_forms_tags unicorn %}
+
+{% block content %}
+
+<div unicorn:view>
+  <h2>Crispy</h2>
+
+  {% crispy view.form_class %}
+</div>
+
+{% endblock content %}

example/unicorn/templates/unicorn/crispy.html

@@ -0,0 +1,12 @@
+{% extends "www/base.html" %}
+{% load crispy_forms_tags unicorn %}
+
+{% block content %}
+
+<div unicorn:view>
+  <h2>Crispy</h2>
+
+  {% crispy view.form_class view.form_class.helper %}
+</div>
+
+{% endblock content %}

example/www/templates/www/base.html

@@ -42,6 +42,8 @@ <h1>django-unicorn</h1>
       <li><a href="{% url 'www:template' 'nested' %}">Nested components (table)</a></li>
       <li><a href="{% url 'www:template' 'js' %}">JavaScript integration</a></li>
       <li><a href="{% url 'www:direct-view' %}">Direct View</a></li>
+      <li><a href="{% url 'www:template' 'crispy' %}">Crispy form</a></li>
+      <li><a href="{% url 'www:crispy' %}">Crispy form (direct view)</a></li>
     </ul>
 
     {% block content %}{% endblock content %}

example/www/templates/www/crispy.html

@@ -0,0 +1,8 @@
+{% extends "www/base.html" %}
+{% load unicorn %}
+
+{% block content %}
+
+{% unicorn 'crispy' %}
+
+{% endblock content %}

example/www/urls.py

@@ -1,5 +1,6 @@
 from django.urls import path
 
+from example.unicorn.components.crispy import CrispyView
 from example.unicorn.components.direct_view import DirectViewView
 
 from . import views
@@ -14,5 +15,10 @@
         DirectViewView.as_view(),
         name="direct-view",
     ),
+    path(
+        "crispy-direct-view",
+        CrispyView.as_view(template_name="unicorn/crispy-direct-view.html"),
+        name="crispy",
+    ),
     path("<str:name>", views.template, name="template"),
 ]