Move boolean choice to a Form object

Themitchell · Themitchell · commit 5d92c9020c52 · 2025-09-08T12:24:54.000+01:00
diff --git a/lung_cancer_screening/core/form_fields.py b/lung_cancer_screening/core/form_fields.py
@@ -278,6 +278,46 @@ def _template_name(widget):
             return "forms/select.jinja"
 
 
+class TypedChoiceField(forms.TypedChoiceField):
+    """
+    A TypedChoiceField that renders using NHS.UK design system radios/select
+    components.
+    """
+
+    widget = widgets.RadioSelect
+    bound_field_class = BoundChoiceField
+
+    def __init__(
+        self,
+        *args,
+        hint=None,
+        label_classes=None,
+        classes=None,
+        **kwargs,
+    ):
+        kwargs["template_name"] = TypedChoiceField._template_name(
+            kwargs.get("widget", self.widget)
+        )
+
+        self.hint = hint
+        self.classes = classes
+        self.label_classes = label_classes
+
+        super().__init__(*args, **kwargs)
+
+    @staticmethod
+    def _template_name(widget):
+        if (isinstance(widget, type) and widget is widgets.RadioSelect) or isinstance(
+            widget, widgets.RadioSelect
+        ):
+            return "forms/radios.jinja"
+        elif (isinstance(widget, type) and widget is widgets.Select) or isinstance(
+            widget, widgets.Select
+        ):
+            return "forms/select.jinja"
+
+
+
 class MultipleChoiceField(forms.MultipleChoiceField):
     """
     A MultipleChoiceField that renders using the NHS.UK design system checkboxes
diff --git a/lung_cancer_screening/core/jinja2/forms/radios.jinja b/lung_cancer_screening/core/jinja2/forms/radios.jinja
@@ -0,0 +1,37 @@
+{% from 'components/radios/macro.jinja' import radios %}
+{% set unbound_field = field.field %}
+{% if field.errors %}
+  {% set error_message = {"text": field.errors | first} %}
+{% endif %}
+{% set ns = namespace(items=[]) %}
+{% for value, text in unbound_field.choices %}
+  {% set conditional_html = field.conditional_html(value) %}
+  {% set ns.items = ns.items + [{
+    "id": field.auto_id if loop.first,
+    "value": value,
+    "text": text,
+    "checked": field.value() == value,
+    "conditional": {
+      "html": conditional_html
+    } if conditional_html else undefined
+  }] %}
+  {% set divider = field.get_divider_after(value) %}
+  {% if divider %}
+    {% set ns.items = ns.items + [{"divider": divider}] %}
+  {% endif %}
+{% endfor %}
+{{ radios({
+  "name": field.html_name,
+  "idPrefix": field.auto_id,
+  "fieldset":  {
+    "legend": {
+      "text": field.label,
+      "classes": unbound_field.label_classes
+    }
+  },
+  "errorMessage": error_message,
+  "hint": {
+    "html": unbound_field.hint|e
+  } if unbound_field.hint,
+  "items": ns.items
+}) }}
diff --git a/lung_cancer_screening/core/tests/acceptance/test_questionnaire_validation_errors.py b/lung_cancer_screening/core/tests/acceptance/test_questionnaire_validation_errors.py
@@ -0,0 +1,55 @@
+import os
+from django.contrib.staticfiles.testing import StaticLiveServerTestCase
+from playwright.sync_api import sync_playwright, expect
+
+class TestQuestionnaireValidationErrors(StaticLiveServerTestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        os.environ["DJANGO_ALLOW_ASYNC_UNSAFE"] = "true"
+        super().setUpClass()
+        cls.playwright = sync_playwright().start()
+        cls.browser = cls.playwright.chromium.launch()
+
+    @classmethod
+    def tearDownClass(cls):
+        super().tearDownClass()
+        cls.browser.close()
+        cls.playwright.stop()
+
+    def test_full_questionaire_user_journey_with_validation_errors(self):
+        participant_id = '123'
+
+        page = self.browser.new_page()
+        page.goto(f"{self.live_server_url}/start")
+
+        page.fill("input[name='participant_id']", participant_id)
+
+        page.click('text=Start now')
+
+        expect(page).to_have_url(
+            f"{self.live_server_url}/have-you-ever-smoked")
+
+        expect(page.locator("legend")).to_have_text(
+            "Have you ever smoked?")
+
+        page.get_by_label('Yes').check()
+
+        page.click("text=Continue")
+
+        expect(page).to_have_url(f"{self.live_server_url}/date-of-birth")
+
+        expect(page.locator("legend")).to_have_text(
+            "What is your date of birth?")
+
+        page.get_by_label("Day").fill("100")
+        page.get_by_label("Month").fill("100")
+        page.get_by_label("Year").fill("some string")
+
+        page.click("text=Continue")
+
+        expect(page).to_have_url(f"{self.live_server_url}/date-of-birth")
+
+        expect(page.locator(".nhsuk-error-message")).to_contain_text(
+            "Day should be between 1 and 31"
+        )
diff --git a/lung_cancer_screening/core/tests/unit/test_form_fields.py b/lung_cancer_screening/core/tests/unit/test_form_fields.py
@@ -18,6 +18,7 @@
     IntegerField,
     MultipleChoiceField,
     SplitDateField,
+    TypedChoiceField,
 )
 
 
@@ -541,6 +542,116 @@ def test_adding_dividers_via_boundfield(self, form_class):
         assert bound_field.get_divider_after("a") == "or"
 
 
+class TestTypedChoiceField:
+    @pytest.fixture
+    def form_class(self):
+        class TestForm(Form):
+            field = TypedChoiceField(
+                label="Abc",
+                label_classes="app-abc",
+                choices=(("a", "A"), ("b", "B")),
+                hint="Pick either one",
+            )
+            select_field = TypedChoiceField(
+                label="Select",
+                label_classes="app-select",
+                choices=(("a", "A"), ("b", "B")),
+                hint="Pick either one",
+                widget=Select,
+            )
+            details = CharField(label="Abc", initial="")
+
+        return TestForm
+
+    def test_renders_nhs_radios(self, form_class):
+        assertHTMLEqual(
+            form_class()["field"].as_field_group(),
+            """
+            <div class="nhsuk-form-group">
+                <fieldset aria-describedby="id_field-hint" class="nhsuk-fieldset">
+                    <legend class="nhsuk-fieldset__legend app-abc">
+                        Abc
+                    </legend>
+                    <div class="nhsuk-hint" id="id_field-hint">
+                        Pick either one
+                    </div>
+                    <div class="nhsuk-radios" data-module="nhsuk-radios">
+                        <div class="nhsuk-radios__item">
+                            <input class="nhsuk-radios__input" id="id_field" name="field" type="radio" value="a">
+                            <label class="nhsuk-label nhsuk-radios__label" for="id_field">A</label>
+                        </div>
+                        <div class="nhsuk-radios__item">
+                            <input class="nhsuk-radios__input" id="id_field-2" name="field" type="radio" value="b">
+                            <label class="nhsuk-label nhsuk-radios__label" for="id_field-2">B</label>
+                        </div>
+                    </div>
+                </fieldset>
+            </div>
+            """,
+        )
+
+    def test_renders_radios_with_conditional_html(self, form_class):
+        form = form_class()
+        form["field"].add_conditional_html("b", "<p>Hello</p>")
+
+        assertHTMLEqual(
+            form["field"].as_field_group(),
+            """
+            <div class="nhsuk-form-group">
+                <fieldset aria-describedby="id_field-hint" class="nhsuk-fieldset">
+                    <legend class="nhsuk-fieldset__legend app-abc">
+                        Abc
+                    </legend>
+                    <div class="nhsuk-hint" id="id_field-hint">
+                        Pick either one
+                    </div>
+                    <div class="nhsuk-radios nhsuk-radios--conditional" data-module="nhsuk-radios">
+                        <div class="nhsuk-radios__item">
+                            <input class="nhsuk-radios__input" id="id_field" name="field" type="radio" value="a">
+                            <label class="nhsuk-label nhsuk-radios__label" for="id_field">A</label>
+                        </div>
+                        <div class="nhsuk-radios__item">
+                            <input aria-controls="conditional-id_field-2" aria-expanded="false" class="nhsuk-radios__input" id="id_field-2" name="field" type="radio" value="b">
+                            <label class="nhsuk-label nhsuk-radios__label" for="id_field-2">B</label>
+                        </div>
+                        <div class="nhsuk-radios__conditional nhsuk-radios__conditional--hidden" id="conditional-id_field-2">
+                            <p>Hello</p>
+                        </div>
+                    </div>
+                </fieldset>
+            </div>
+            """,
+        )
+
+    def test_renders_nhs_select(self, form_class):
+        assertHTMLEqual(
+            form_class()["select_field"].as_field_group(),
+            """
+            <div class="nhsuk-form-group">
+                <label class="nhsuk-label app-select"  for="id_select_field">Select</label>
+                <div class="nhsuk-hint" id="id_select_field-hint">
+                    Pick either one
+                </div>
+                <select aria-describedby="id_select_field-hint" class="nhsuk-select" id="id_select_field" name="select_field">
+                    <option value="a">A</option>
+                    <option value="b">B</option>
+                </select>
+            </div>
+            """,
+        )
+
+    def test_renders_select_with_conditional_html(self, form_class):
+        form = form_class()
+
+        with pytest.raises(ValueError):
+            form["select_field"].add_conditional_html("b", "<p>Hello</p>")
+
+    def test_adding_dividers_via_boundfield(self, form_class):
+        bound_field = form_class()["field"]
+        bound_field.add_divider_after("a", "or")
+        assert bound_field.get_divider_after("a") == "or"
+
+
 class TestMultipleChoiceField:
     @pytest.fixture
     def form_class(self):
diff --git a/lung_cancer_screening/questions/forms/boolean_response_form.py b/lung_cancer_screening/questions/forms/boolean_response_form.py
@@ -0,0 +1,25 @@
+from django import forms
+
+from lung_cancer_screening.core.form_fields import TypedChoiceField
+from ..models.boolean_response import BooleanResponse
+
+class BooleanResponseForm(forms.ModelForm):
+    CHOICES = [
+        (True, "Yes"),
+        (False, "No")
+    ]
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.fields["value"] = TypedChoiceField(
+            choices=self.CHOICES,
+            widget=forms.RadioSelect,
+            coerce=lambda x: x == 'True',
+            label="Have you ever smoked?",
+            label_classes="nhsuk-fieldset__legend--m",
+        )
+
+    class Meta:
+        model = BooleanResponse
+        fields = ['value']
diff --git a/lung_cancer_screening/questions/jinja2/have_you_ever_smoked.jinja b/lung_cancer_screening/questions/jinja2/have_you_ever_smoked.jinja
@@ -8,26 +8,8 @@
       <form action="{{ request.path }}" method="POST">
         {{ csrf_input }}
 
-        {{ radios({
-          "name": "value",
-          "fieldset": {
-            "legend": {
-              "text": "Have you ever smoked?",
-              "classes": "nhsuk-fieldset__legend--l",
-              "isPageHeading": true
-            }
-          },
-          "items": [
-            {
-              "value": "1",
-              "text": "Yes"
-            },
-            {
-              "value": "0",
-              "text": "No"
-            }
-          ]
-        }) }}
+        {{ form.value.as_field_group() }}
+
 
         {{ button({
             "text": "Continue"
diff --git a/lung_cancer_screening/questions/tests/unit/forms/test_boolean_response_form.py b/lung_cancer_screening/questions/tests/unit/forms/test_boolean_response_form.py
@@ -0,0 +1,16 @@
+from django.test import TestCase
+from ....forms.boolean_response_form import BooleanResponseForm
+
+class TestBooleanResponseForm(TestCase):
+    def test_is_valid(self):
+        form = BooleanResponseForm(data={"value": True})
+        self.assertTrue(form.is_valid())
+
+    def test_is_invalid(self):
+        form = BooleanResponseForm(data={"value": "invalid"})
+        self.assertFalse(form.is_valid())
+
+    def test_returns_a_boolean_type(self):
+        form = BooleanResponseForm(data={"value": True})
+        form.is_valid()
+        self.assertIsInstance(form.cleaned_data["value"], bool)
diff --git a/lung_cancer_screening/questions/tests/unit/views/test_have_you_ever_smoked.py b/lung_cancer_screening/questions/tests/unit/views/test_have_you_ever_smoked.py
@@ -7,7 +7,7 @@
 class TestHaveYouEverSmoked(TestCase):
     def setUp(self):
         self.participant = Participant.objects.create(unique_id="12345")
-        self.valid_params = { "value": 1 }
+        self.valid_params = { "value": True }
 
         session = self.client.session
         session['participant_id'] = self.participant.unique_id
@@ -87,7 +87,7 @@ def test_post_does_not_create_a_date_response_if_the_user_is_not_a_smoker(self):
     def test_post_redirects_if_the_user_not_a_smoker(self):
         response = self.client.post(
             reverse("questions:have_you_ever_smoked"),
-            {"value": 0}
+            {"value": False }
         )
 
         self.assertRedirects(response, reverse("questions:non_smoker_exit"))
diff --git a/lung_cancer_screening/questions/views/have_you_ever_smoked.py b/lung_cancer_screening/questions/views/have_you_ever_smoked.py
