Merge pull request #125 from NHSDigital/PPHA-265-about-you-gender-page

miriam-z · web-flow · commit 54143ddf715c · 2025-10-31T15:41:43.000Z
PPHA-265: Add gender page
diff --git a/lung_cancer_screening/core/tests/acceptance/helpers/user_interaction_helpers.py b/lung_cancer_screening/core/tests/acceptance/helpers/user_interaction_helpers.py
@@ -60,3 +60,11 @@ def fill_in_and_submit_sex_at_birth(page, sex):
     page.get_by_label(sex, exact=True).check()
 
     page.click("text=Continue")
+
+def fill_in_and_submit_gender(page, gender):
+    expect(page.locator("legend")).to_have_text(
+        "Which of these best describes you?")
+
+    page.get_by_label(gender, exact=True).check()
+
+    page.click("text=Continue")
diff --git a/lung_cancer_screening/core/tests/acceptance/test_cannot_change_answers_after_submission.py b/lung_cancer_screening/core/tests/acceptance/test_cannot_change_answers_after_submission.py
@@ -10,7 +10,8 @@
     fill_in_and_submit_participant_id,
     fill_in_and_submit_smoking_eligibility,
     fill_in_and_submit_date_of_birth,
-    fill_in_and_submit_sex_at_birth
+    fill_in_and_submit_sex_at_birth,
+    fill_in_and_submit_gender,
 )
 
 class TestQuestionnaire(StaticLiveServerTestCase):
@@ -42,6 +43,7 @@ def test_cannot_change_responses_once_checked_and_submitted(self):
         fill_in_and_submit_height_metric(page, "170")
         fill_in_and_submit_weight_metric(page, "25.4")
         fill_in_and_submit_sex_at_birth(page, "Male")
+        fill_in_and_submit_gender(page, "Male")
 
         page.click("text=Submit")
 
diff --git a/lung_cancer_screening/core/tests/acceptance/test_questionnaire.py b/lung_cancer_screening/core/tests/acceptance/test_questionnaire.py
@@ -12,7 +12,8 @@
     fill_in_and_submit_date_of_birth,
     fill_in_and_submit_weight_metric,
     fill_in_and_submit_weight_imperial,
-    fill_in_and_submit_sex_at_birth
+    fill_in_and_submit_sex_at_birth,
+    fill_in_and_submit_gender
 )
 
 from .helpers.assertion_helpers import expect_back_link_to_have_url
@@ -79,8 +80,12 @@ def test_full_questionnaire_user_journey(self):
         expect_back_link_to_have_url(page, "/weight")
         fill_in_and_submit_sex_at_birth(page, "Male")
 
-        expect(page).to_have_url(f"{self.live_server_url}/responses")
+        expect(page).to_have_url(f"{self.live_server_url}/gender")
         expect_back_link_to_have_url(page, "/sex-at-birth")
+        fill_in_and_submit_gender(page, "Male")
+
+        expect(page).to_have_url(f"{self.live_server_url}/responses")
+        expect_back_link_to_have_url(page, "/gender")
 
         responses = page.locator(".responses")
         expect(responses).to_contain_text("Have you ever smoked? Yes, I used to smoke regularly")
@@ -89,6 +94,7 @@ def test_full_questionnaire_user_journey(self):
         expect(responses).to_contain_text(f"What is your height? {feet} feet {inches} inches")
         expect(responses).to_contain_text(f"What is your weight? {weight_stone} stone {weight_pound} pound")
         expect(responses).to_contain_text("What was your sex at birth? Male")
+        expect(responses).to_contain_text("Which of these best describes you? Male")
 
         page.click("text=Submit")
 
diff --git a/lung_cancer_screening/questions/forms/gender_form.py b/lung_cancer_screening/questions/forms/gender_form.py
@@ -0,0 +1,26 @@
+from django import forms
+
+from ...nhsuk_forms.typed_choice_field import TypedChoiceField
+from ..models.response_set import ResponseSet, GenderValues
+
+class GenderForm(forms.ModelForm):
+
+    def __init__(self, *args, **kwargs):
+        self.participant = kwargs.pop('participant')
+        super().__init__(*args, **kwargs)
+        self.instance.participant = self.participant
+
+        self.fields["gender"] = TypedChoiceField(
+            choices=GenderValues.choices,
+            widget=forms.RadioSelect,
+            label="Which of these best describes you?",
+            label_classes="nhsuk-fieldset__legend--m",
+            hint="This information is used to find your NHS number and match with your GP record.",
+            error_messages={
+                'required': 'Select the option that best describes your gender.'
+            }
+        )
+
+    class Meta:
+        model = ResponseSet
+        fields = ['gender']
diff --git a/lung_cancer_screening/questions/jinja2/gender.jinja b/lung_cancer_screening/questions/jinja2/gender.jinja
@@ -0,0 +1,28 @@
+{% extends 'layout.jinja' %}
+{% from 'nhsuk/components/button/macro.jinja' import button %}
+{% from 'nhsuk/components/back-link/macro.jinja' import backLink %}
+
+{% block beforeContent %}
+  {{
+    backLink({
+      "href": url("questions:sex_at_birth"),
+      "text": "Back"
+    })
+  }}
+{% endblock beforeContent %}
+
+{% block page_content %}
+  <div class="nhsuk-grid-row">
+    <div class="nhsuk-grid-column-two-thirds">
+      <form action="{{ request.path }}" method="POST">
+        {{ csrf_input }}
+
+        {{ form }}
+
+        {{ button({
+          "text": "Continue"
+        }) }}
+      </form>
+    </div>
+  </div>
+{% endblock %}
diff --git a/lung_cancer_screening/questions/jinja2/responses.jinja b/lung_cancer_screening/questions/jinja2/responses.jinja
@@ -5,7 +5,7 @@
 {% block beforeContent %}
   {{
     backLink({
-      "href": url("questions:sex_at_birth"),
+      "href": url("questions:gender"),
       "text": "Back"
     })
   }}
@@ -21,6 +21,7 @@
         <li>What is your height? {{ response_set.formatted_height }}</li>
         <li>What is your weight? {{ response_set.formatted_weight }}</li>
         <li>What was your sex at birth? {{ response_set.get_sex_at_birth_display() }}</li>
+        <li>Which of these best describes you? {{ response_set.get_gender_display() }}</li>
       </ul>
 
       <form action="{{ request.path }}" method="post">
diff --git a/lung_cancer_screening/questions/migrations/0014_responseset_gender.py b/lung_cancer_screening/questions/migrations/0014_responseset_gender.py
@@ -0,0 +1,18 @@
+# Generated by Django 5.2.7 on 2025-10-31 10:56
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('questions', '0013_responseset_sex_at_birth'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='responseset',
+            name='gender',
+            field=models.CharField(blank=True, choices=[('M', 'Male'), ('F', 'Female'), ('N', 'Non-binary'), ('P', 'Prefer not to say'), ('G', 'How I describe myself may not match my GP record')], max_length=1, null=True),
+        ),
+    ]
diff --git a/lung_cancer_screening/questions/models/response_set.py b/lung_cancer_screening/questions/models/response_set.py
@@ -18,6 +18,13 @@ class SexAtBirthValues(models.TextChoices):
     FEMALE = "F", 'Female'
     MALE = "M", 'Male'
 
+class GenderValues(models.TextChoices):
+    FEMALE = "F", 'Female'
+    MALE = "M", 'Male'
+    NON_BINARY = "N", 'Non-binary'
+    PREFER_NOT_TO_SAY = "P", 'Prefer not to say'
+    GP = "G", 'How I describe myself may not match my GP record'
+
 class ResponseSet(BaseModel):
     participant = models.ForeignKey(Participant, on_delete=models.CASCADE)
 
@@ -66,6 +73,13 @@ class ResponseSet(BaseModel):
         blank=True
     )
 
+    gender = models.CharField(
+        max_length=1,
+        choices=GenderValues.choices,
+        null=True,
+        blank=True
+    )
+
     submitted_at = models.DateTimeField(null=True, blank=True)
 
     class Meta:
diff --git a/lung_cancer_screening/questions/tests/unit/forms/test_gender_form.py b/lung_cancer_screening/questions/tests/unit/forms/test_gender_form.py
@@ -0,0 +1,48 @@
+from django.test import TestCase
+
+from ....models.response_set import GenderValues
+from ....models.participant import Participant
+from ....forms.gender_form import GenderForm
+
+class TestGenderForm(TestCase):
+    def setUp(self):
+        self.participant = Participant.objects.create(unique_id="1234567890")
+
+    def test_is_valid_with_a_valid_value(self):
+        form = GenderForm(
+            participant=self.participant,
+            data={
+                "gender": GenderValues.MALE
+            }
+        )
+        self.assertTrue(form.is_valid())
+        self.assertEqual(
+            form.cleaned_data["gender"],
+            GenderValues.MALE.value
+        )
+
+    def test_is_invalid_with_an_invalid_value(self):
+        form = GenderForm(
+            participant=self.participant,
+            data={
+                "gender": "invalid"
+            }
+        )
+        self.assertFalse(form.is_valid())
+        self.assertEqual(
+            form.errors["gender"],
+            ["Select a valid choice. invalid is not one of the available choices."]
+        )
+
+    def test_is_invalid_when_no_option_is_selected(self):
+        form = GenderForm(
+            participant=self.participant,
+            data={
+                "gender": None
+            }
+        )
+        self.assertFalse(form.is_valid())
+        self.assertEqual(
+            form.errors["gender"],
+            ["Select the option that best describes your gender."]
+        )
diff --git a/lung_cancer_screening/questions/tests/unit/models/test_response_set.py b/lung_cancer_screening/questions/tests/unit/models/test_response_set.py
@@ -5,7 +5,7 @@
 
 from django.core.exceptions import ValidationError
 
-from ....models.response_set import ResponseSet, HaveYouEverSmokedValues, SexAtBirthValues
+from ....models.response_set import ResponseSet, HaveYouEverSmokedValues, SexAtBirthValues, GenderValues
 from ....models.participant import Participant
 
 class TestResponseSet(TestCase):
@@ -100,6 +100,15 @@ def test_has_sex_at_birth_as_string(self):
             str
         )
 
+    def test_has_gender_as_string(self):
+        self.response_set.gender = GenderValues.MALE
+        self.response_set.save()
+
+        self.assertIsInstance(
+            self.response_set.gender,
+            str
+        )
+
     # VALIDATIONS
 
     def test_is_invalid_if_another_unsubmitted_response_set_exists(self):
@@ -231,3 +240,22 @@ def test_is_invalid_if_sex_at_birth_is_not_an_accepted_value(self):
             context.exception.messages[0],
             "Value 'X' is not a valid choice."
         )
+
+    def test_is_valid_if_gender_is_null(self):
+        self.response_set.gender = None
+        self.response_set.save()
+
+        self.assertIsNone(
+            self.response_set.gender
+        )
+
+    def test_is_invalid_if_gender_is_not_an_accepted_value(self):
+        self.response_set.gender = "X"
+
+        with self.assertRaises(ValidationError) as context:
+            self.response_set.full_clean()
+
+        self.assertEqual(
+            context.exception.messages[0],
+            "Value 'X' is not a valid choice."
+        )
diff --git a/lung_cancer_screening/questions/tests/unit/views/test_gender.py b/lung_cancer_screening/questions/tests/unit/views/test_gender.py
@@ -0,0 +1,92 @@
+from django.test import TestCase
+from django.urls import reverse
+
+from lung_cancer_screening.questions.models.participant import Participant
+from lung_cancer_screening.questions.models.response_set import GenderValues
+
+
+class TestGender(TestCase):
+    def setUp(self):
+        self.participant = Participant.objects.create(unique_id="12345")
+        self.participant.responseset_set.create()
+        self.valid_params = { "gender": GenderValues.MALE }
+
+        session = self.client.session
+        session['participant_id'] = self.participant.unique_id
+        session.save()
+
+    def test_get_redirects_if_the_participant_does_not_exist(self):
+        session = self.client.session
+        session['participant_id'] = "somebody none existant participant"
+        session.save()
+
+        response = self.client.get(
+            reverse("questions:gender")
+        )
+
+        self.assertRedirects(response, reverse("questions:start"))
+
+    def test_get_responds_successfully(self):
+        response = self.client.get(reverse("questions:gender"))
+
+        self.assertEqual(response.status_code, 200)
+
+    def test_get_contains_the_correct_form_fields(self):
+        response = self.client.get(reverse("questions:gender"))
+
+        self.assertContains(response, "Which of these best describes you?")
+
+    def test_post_redirects_if_the_participant_does_not_exist(self):
+        session = self.client.session
+        session['participant_id'] = "somebody none existant participant"
+        session.save()
+
+        response = self.client.post(
+            reverse("questions:gender"),
+            self.valid_params
+        )
+
+        self.assertRedirects(response, reverse("questions:start"))
+
+    def test_post_stores_a_valid_response_for_the_participant(self):
+        self.client.post(
+            reverse("questions:gender"),
+            self.valid_params
+        )
+
+        response_set = self.participant.responseset_set.first()
+        self.assertEqual(response_set.gender, self.valid_params["gender"])
+        self.assertEqual(response_set.participant, self.participant)
+
+    def test_post_sets_the_participant_id_in_session(self):
+        self.client.post(
+            reverse("questions:gender"),
+            self.valid_params
+        )
+
+        self.assertEqual(self.client.session["participant_id"], "12345")
+
+    def test_post_redirects_to_the_responses_path(self):
+        response = self.client.post(
+            reverse("questions:gender"),
+            self.valid_params
+        )
+
+        self.assertRedirects(response, reverse("questions:responses"))
+
+    def test_post_responds_with_422_if_the_date_response_fails_to_create(self):
+        response = self.client.post(
+            reverse("questions:gender"),
+            {"gender": "something not in list"}
+        )
+
+        self.assertEqual(response.status_code, 422)
+
+    def test_post_renders_the_gender_page_with_an_error_if_the_form_is_invalid(self):
+        response = self.client.post(
+            reverse("questions:gender"),
+            {"gender": "something not in list"}
+        )
+
+        self.assertContains(response, "Which of these best describes you?", status_code=422)
+        self.assertContains(response, "nhsuk-error-message", status_code=422)
diff --git a/lung_cancer_screening/questions/tests/unit/views/test_sex_at_birth.py b/lung_cancer_screening/questions/tests/unit/views/test_sex_at_birth.py
@@ -71,7 +71,7 @@ def test_post_redirects_to_the_responses_path(self):
             self.valid_params
         )
 
-        self.assertRedirects(response, reverse("questions:responses"))
+        self.assertRedirects(response, reverse("questions:gender"))
 
     def test_post_responds_with_422_if_the_date_response_fails_to_create(self):
         response = self.client.post(
diff --git a/lung_cancer_screening/questions/urls.py b/lung_cancer_screening/questions/urls.py
@@ -25,6 +25,7 @@
 from .views.height import height
 from .views.weight import weight
 from .views.sex_at_birth import sex_at_birth
+from .views.gender import gender
 
 urlpatterns = [
     path('start', start, name='start'),
@@ -33,6 +34,7 @@
     path('height', height, name='height'),
     path('weight', weight, name='weight'),
     path('sex-at-birth', sex_at_birth, name='sex_at_birth'),
+    path('gender', gender, name='gender'),
     path('responses', responses, name='responses'),
     path('age-range-exit', age_range_exit, name='age_range_exit'),
     path('non-smoker-exit', non_smoker_exit, name='non_smoker_exit'),
diff --git a/lung_cancer_screening/questions/views/gender.py b/lung_cancer_screening/questions/views/gender.py
diff --git a/lung_cancer_screening/questions/views/sex_at_birth.py b/lung_cancer_screening/questions/views/sex_at_birth.py
