Move GenderResponse to its own model

Author: Themitchell

lung_cancer_screening/questions/forms/gender_form.py

@@ -1,15 +1,15 @@
 from django import forms
 
 from ...nhsuk_forms.choice_field import ChoiceField
-from ..models.response_set import ResponseSet, GenderValues
+from ..models.gender_response import GenderResponse, GenderValues
 
 
 class GenderForm(forms.ModelForm):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-        self.fields["gender"] = ChoiceField(
+        self.fields["value"] = ChoiceField(
             choices=GenderValues.choices,
             widget=forms.RadioSelect,
             label="Which of these best describes you?",
@@ -25,5 +25,5 @@ def __init__(self, *args, **kwargs):
         )
 
     class Meta:
-        model = ResponseSet
-        fields = ['gender']
+        model = GenderResponse
+        fields = ['value']

lung_cancer_screening/questions/migrations/0029_genderresponse.py

@@ -0,0 +1,53 @@
+# Generated manually to create GenderResponse and copy data
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def copy_gender_data(apps, schema_editor):
+    with schema_editor.connection.cursor() as cursor:
+        cursor.execute("""
+            INSERT INTO questions_genderresponse (created_at, updated_at, value, response_set_id)
+            SELECT NOW(), NOW(), gender, id
+            FROM questions_responseset
+            WHERE gender IS NOT NULL
+            ON CONFLICT (response_set_id) DO NOTHING
+        """)
+
+
+def reverse_copy_gender_data(apps, schema_editor):
+    with schema_editor.connection.cursor() as cursor:
+        cursor.execute("""
+            UPDATE questions_responseset rs
+            SET gender = g.value
+            FROM questions_genderresponse g
+            WHERE rs.id = g.response_set_id
+        """)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('questions', '0028_ethnicityresponse'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='GenderResponse',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('value', models.CharField(choices=[('F', 'Female'), ('M', 'Male'), ('N', 'Non-binary'), ('P', 'Prefer not to say'), ('G', 'How I describe myself may not match my GP record')], max_length=1)),
+                ('response_set', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='gender_response', to='questions.responseset')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+        migrations.RunPython(copy_gender_data, reverse_copy_gender_data),
+        migrations.RemoveField(
+            model_name='responseset',
+            name='gender',
+        ),
+    ]

lung_cancer_screening/questions/models/__init__.py

@@ -4,3 +4,4 @@
 from .asbestos_exposure_response import AsbestosExposureResponse # noqa: F401
 from .date_of_birth_response import DateOfBirthResponse # noqa: F401
 from .ethnicity_response import EthnicityResponse # noqa: F401
+from .gender_response import GenderResponse # noqa: F401

lung_cancer_screening/questions/models/gender_response.py

@@ -0,0 +1,17 @@
+from django.db import models
+
+from .base import BaseModel
+from .response_set import ResponseSet
+
+
+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 GenderResponse(BaseModel):
+    response_set = models.OneToOneField(ResponseSet, on_delete=models.CASCADE, related_name='gender_response')
+    value = models.CharField(max_length=1, choices=GenderValues.choices)

lung_cancer_screening/questions/tests/unit/forms/test_gender_form.py

@@ -1,50 +1,53 @@
 from django.test import TestCase
 
-from ...factories.user_factory import UserFactory
-from ....models.response_set import ResponseSet, GenderValues
+from ...factories.response_set_factory import ResponseSetFactory
+from ....models.gender_response import GenderResponse, GenderValues
 from ....forms.gender_form import GenderForm
 
 
 class TestGenderForm(TestCase):
     def setUp(self):
-        self.user = UserFactory()
-        self.response_set = ResponseSet(user=self.user)
+        self.response_set = ResponseSetFactory()
+        self.response = GenderResponse.objects.create(
+            response_set=self.response_set,
+            value=GenderValues.MALE
+        )
 
     def test_is_valid_with_a_valid_value(self):
         form = GenderForm(
-            instance=self.response_set,
+            instance=self.response,
             data={
-                "gender": GenderValues.MALE
+                "value": GenderValues.MALE
             }
         )
         self.assertTrue(form.is_valid())
         self.assertEqual(
-            form.cleaned_data["gender"],
+            form.cleaned_data["value"],
             GenderValues.MALE.value
         )
 
     def test_is_invalid_with_an_invalid_value(self):
         form = GenderForm(
-            instance=self.response_set,
+            instance=self.response,
             data={
-                "gender": "invalid"
+                "value": "invalid"
             }
         )
         self.assertFalse(form.is_valid())
         self.assertEqual(
-            form.errors["gender"],
+            form.errors["value"],
             ["Select a valid choice. invalid is not one of the available choices."]
         )
 
     def test_is_invalid_when_no_option_is_selected(self):
         form = GenderForm(
-            instance=self.response_set,
+            instance=self.response,
             data={
-                "gender": None
+                "value": None
             }
         )
         self.assertFalse(form.is_valid())
         self.assertEqual(
-            form.errors["gender"],
+            form.errors["value"],
             ["Select the option that best describes your gender"]
         )

lung_cancer_screening/questions/tests/unit/models/test_gender_response.py

@@ -0,0 +1,24 @@
+from django.test import TestCase
+
+from ...factories.response_set_factory import ResponseSetFactory
+from ....models.gender_response import GenderResponse, GenderValues
+
+
+class TestGenderResponse(TestCase):
+    def test_has_response_set_as_foreign_key(self):
+        response_set = ResponseSetFactory()
+        response = GenderResponse.objects.create(
+            response_set=response_set,
+            value=GenderValues.MALE
+        )
+
+        self.assertEqual(response.response_set, response_set)
+
+    def test_has_value_as_string(self):
+        response_set = ResponseSetFactory()
+        response = GenderResponse.objects.create(
+            response_set=response_set,
+            value=GenderValues.MALE
+        )
+
+        self.assertIsInstance(response.value, str)

lung_cancer_screening/questions/tests/unit/views/test_gender.py

@@ -3,7 +3,7 @@
 from dateutil.relativedelta import relativedelta
 from django.utils import timezone
 
-from lung_cancer_screening.questions.models.response_set import GenderValues
+from lung_cancer_screening.questions.models.gender_response import GenderResponse, GenderValues
 from .helpers.authentication import login_user
 
 
@@ -52,7 +52,7 @@ class TestPostGender(TestCase):
     def setUp(self):
         self.user = login_user(self.client)
 
-        self.valid_params = {"gender": GenderValues.MALE}
+        self.valid_params = {"value": GenderValues.MALE}
 
     def test_post_redirects_if_the_user_is_not_logged_in(self):
         self.client.logout()
@@ -79,7 +79,7 @@ def test_post_creates_unsubmitted_response_set_when_no_response_set_exists(
         response_set = self.user.responseset_set.first()
         self.assertEqual(self.user.responseset_set.count(), 1)
         self.assertEqual(response_set.submitted_at, None)
-        self.assertEqual(response_set.gender, self.valid_params["gender"])
+        self.assertEqual(GenderResponse.objects.get(response_set=response_set).value, self.valid_params["value"])
         self.assertEqual(response_set.user, self.user)
 
     def test_post_updates_unsubmitted_response_set_when_one_exists(self):
@@ -93,7 +93,7 @@ def test_post_updates_unsubmitted_response_set_when_one_exists(self):
         response_set.refresh_from_db()
         self.assertEqual(self.user.responseset_set.count(), 1)
         self.assertEqual(response_set.submitted_at, None)
-        self.assertEqual(response_set.gender, self.valid_params["gender"])
+        self.assertEqual(GenderResponse.objects.get(response_set=response_set).value, self.valid_params["value"])
         self.assertEqual(response_set.user, self.user)
 
     def test_post_creates_new_unsubmitted_response_set_when_submitted_exists_over_year_ago(  # noqa: E501
@@ -113,7 +113,7 @@ def test_post_creates_new_unsubmitted_response_set_when_submitted_exists_over_ye
 
         response_set = self.user.responseset_set.last()
         self.assertEqual(response_set.submitted_at, None)
-        self.assertEqual(response_set.gender, self.valid_params["gender"])
+        self.assertEqual(GenderResponse.objects.get(response_set=response_set).value, self.valid_params["value"])
         self.assertEqual(response_set.user, self.user)
 
     def test_post_redirects_when_submitted_response_set_exists_within_last_year(  # noqa: E501
@@ -137,7 +137,7 @@ def test_post_stores_a_valid_response_for_the_user(self):
         )
 
         response_set = self.user.responseset_set.first()
-        self.assertEqual(response_set.gender, self.valid_params["gender"])
+        self.assertEqual(GenderResponse.objects.get(response_set=response_set).value, self.valid_params["value"])
         self.assertEqual(response_set.user, self.user)
 
     def test_post_redirects_to_the_ethnicity_path(self):
@@ -151,7 +151,7 @@ def test_post_redirects_to_the_ethnicity_path(self):
     def test_post_responds_with_422_if_the_response_fails_to_create(self):
         response = self.client.post(
             reverse("questions:gender"),
-            {"gender": "something not in list"}
+            {"value": "something not in list"}
         )
 
         self.assertEqual(response.status_code, 422)
@@ -161,7 +161,7 @@ def test_post_renders_the_gender_page_with_an_error_if_form_invalid(
     ):
         response = self.client.post(
             reverse("questions:gender"),
-            {"gender": "something not in list"}
+            {"value": "something not in list"}
         )
 
         self.assertContains(

lung_cancer_screening/questions/views/gender.py

@@ -5,25 +5,31 @@
 
 from .mixins.ensure_response_set import EnsureResponseSet
 from ..forms.gender_form import GenderForm
+from ..models.gender_response import GenderResponse
 
 
 class GenderView(LoginRequiredMixin, EnsureResponseSet, View):
     def get(self, request):
+        response, _ = GenderResponse.objects.get_or_build(
+            response_set=request.response_set
+        )
         return render_template(
             request,
-            GenderForm(instance=request.response_set),
+            GenderForm(instance=response),
         )
 
     def post(self, request):
+        response, _ = GenderResponse.objects.get_or_build(
+            response_set=request.response_set
+        )
         form = GenderForm(
-            instance=request.response_set,
+            instance=response,
             data=request.POST
         )
 
         if form.is_valid():
-            response_set = request.response_set
-            response_set.gender = form.cleaned_data["gender"]
-            response_set.save()
+            response.value = form.cleaned_data["value"]
+            response.save()
             return redirect(reverse("questions:ethnicity"))
         else:
             return render_template(