Move SexAtBirthResponse to its own model

Author: Themitchell

lung_cancer_screening/questions/forms/sex_at_birth_form.py

@@ -1,15 +1,15 @@
 from django import forms
 
 from ...nhsuk_forms.choice_field import ChoiceField
-from ..models.response_set import ResponseSet, SexAtBirthValues
+from ..models.sex_at_birth_response import SexAtBirthResponse, SexAtBirthValues
 
 
 class SexAtBirthForm(forms.ModelForm):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
-        self.fields["sex_at_birth"] = ChoiceField(
+        self.fields["value"] = ChoiceField(
             choices=SexAtBirthValues.choices,
             widget=forms.RadioSelect,
             label="What was your sex at birth?",
@@ -24,5 +24,5 @@ def __init__(self, *args, **kwargs):
         )
 
     class Meta:
-        model = ResponseSet
-        fields = ['sex_at_birth']
+        model = SexAtBirthResponse
+        fields = ['value']

lung_cancer_screening/questions/migrations/0032_sexatbirthresponse.py

@@ -0,0 +1,53 @@
+# Generated manually to create SexAtBirthResponse and copy data
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def copy_sex_at_birth_data(apps, schema_editor):
+    with schema_editor.connection.cursor() as cursor:
+        cursor.execute("""
+            INSERT INTO questions_sexatbirthresponse (created_at, updated_at, value, response_set_id)
+            SELECT NOW(), NOW(), sex_at_birth, id
+            FROM questions_responseset
+            WHERE sex_at_birth IS NOT NULL
+            ON CONFLICT (response_set_id) DO NOTHING
+        """)
+
+
+def reverse_copy_sex_at_birth_data(apps, schema_editor):
+    with schema_editor.connection.cursor() as cursor:
+        cursor.execute("""
+            UPDATE questions_responseset rs
+            SET sex_at_birth = s.value
+            FROM questions_sexatbirthresponse s
+            WHERE rs.id = s.response_set_id
+        """)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('questions', '0031_respiratoryconditionsresponse'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='SexAtBirthResponse',
+            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')], max_length=1)),
+                ('response_set', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='sex_at_birth_response', to='questions.responseset')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+        migrations.RunPython(copy_sex_at_birth_data, reverse_copy_sex_at_birth_data),
+        migrations.RemoveField(
+            model_name='responseset',
+            name='sex_at_birth',
+        ),
+    ]

lung_cancer_screening/questions/models/sex_at_birth_response.py

@@ -0,0 +1,14 @@
+from django.db import models
+
+from .base import BaseModel
+from .response_set import ResponseSet
+
+
+class SexAtBirthValues(models.TextChoices):
+    FEMALE = "F", 'Female'
+    MALE = "M", 'Male'
+
+
+class SexAtBirthResponse(BaseModel):
+    response_set = models.OneToOneField(ResponseSet, on_delete=models.CASCADE, related_name='sex_at_birth_response')
+    value = models.CharField(max_length=1, choices=SexAtBirthValues.choices)

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

@@ -1,50 +1,53 @@
 from django.test import TestCase
 
-from ...factories.user_factory import UserFactory
-from ....models.response_set import ResponseSet, SexAtBirthValues
+from ...factories.response_set_factory import ResponseSetFactory
+from ....models.sex_at_birth_response import SexAtBirthResponse, SexAtBirthValues
 from ....forms.sex_at_birth_form import SexAtBirthForm
 
 class TestSexAtBirthForm(TestCase):
     def setUp(self):
-        self.user = UserFactory()
-        self.response_set = ResponseSet(user=self.user)
+        self.response_set = ResponseSetFactory()
+        self.response = SexAtBirthResponse.objects.create(
+            response_set=self.response_set,
+            value=SexAtBirthValues.MALE
+        )
 
 
     def test_is_valid_with_a_valid_value(self):
         form = SexAtBirthForm(
-            instance=self.response_set,
+            instance=self.response,
             data={
-                "sex_at_birth": SexAtBirthValues.FEMALE
+                "value": SexAtBirthValues.FEMALE
             }
         )
         self.assertTrue(form.is_valid())
         self.assertEqual(
-            form.cleaned_data["sex_at_birth"],
+            form.cleaned_data["value"],
             SexAtBirthValues.FEMALE.value
         )
 
     def test_is_invalid_with_an_invalid_value(self):
         form = SexAtBirthForm(
-            instance=self.response_set,
+            instance=self.response,
             data={
-                "sex_at_birth": "invalid"
+                "value": "invalid"
             }
         )
         self.assertFalse(form.is_valid())
         self.assertEqual(
-            form.errors["sex_at_birth"],
+            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 = SexAtBirthForm(
-            instance=self.response_set,
+            instance=self.response,
             data={
-                "sex_at_birth": None
+                "value": None
             }
         )
         self.assertFalse(form.is_valid())
         self.assertEqual(
-            form.errors["sex_at_birth"],
+            form.errors["value"],
             ["Select your sex at birth"]
         )

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

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

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

@@ -4,9 +4,7 @@
 from django.utils import timezone
 
 from .helpers.authentication import login_user
-from lung_cancer_screening.questions.models.response_set import (
-    SexAtBirthValues
-)
+from lung_cancer_screening.questions.models.sex_at_birth_response import SexAtBirthResponse, SexAtBirthValues
 
 
 class TestGetSexAtBirth(TestCase):
@@ -54,7 +52,7 @@ class TestPostSexAtBirth(TestCase):
     def setUp(self):
         self.user = login_user(self.client)
 
-        self.valid_params = {"sex_at_birth": SexAtBirthValues.FEMALE}
+        self.valid_params = {"value": SexAtBirthValues.FEMALE}
 
     def test_post_redirects_if_the_user_is_not_logged_in(self):
         self.client.logout()
@@ -82,7 +80,7 @@ def test_post_creates_unsubmitted_response_set_when_no_response_set_exists(
         self.assertEqual(self.user.responseset_set.count(), 1)
         self.assertEqual(response_set.submitted_at, None)
         self.assertEqual(
-            response_set.sex_at_birth, self.valid_params["sex_at_birth"]
+            SexAtBirthResponse.objects.get(response_set=response_set).value, self.valid_params["value"]
         )
         self.assertEqual(response_set.user, self.user)
 
@@ -98,7 +96,7 @@ def test_post_updates_unsubmitted_response_set_when_one_exists(self):
         self.assertEqual(self.user.responseset_set.count(), 1)
         self.assertEqual(response_set.submitted_at, None)
         self.assertEqual(
-            response_set.sex_at_birth, self.valid_params["sex_at_birth"]
+            SexAtBirthResponse.objects.get(response_set=response_set).value, self.valid_params["value"]
         )
         self.assertEqual(response_set.user, self.user)
 
@@ -120,7 +118,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.sex_at_birth, self.valid_params["sex_at_birth"]
+            SexAtBirthResponse.objects.get(response_set=response_set).value, self.valid_params["value"]
         )
         self.assertEqual(response_set.user, self.user)
 
@@ -146,7 +144,7 @@ def test_post_stores_a_valid_response_for_the_user(self):
 
         response_set = self.user.responseset_set.first()
         self.assertEqual(
-            response_set.sex_at_birth, self.valid_params["sex_at_birth"]
+            SexAtBirthResponse.objects.get(response_set=response_set).value, self.valid_params["value"]
         )
         self.assertEqual(response_set.user, self.user)
 
@@ -161,7 +159,7 @@ def test_post_redirects_to_the_gender_path(self):
     def test_post_responds_with_422_if_the_response_fails_to_create(self):
         response = self.client.post(
             reverse("questions:sex_at_birth"),
-            {"sex_at_birth": "something not in list"}
+            {"value": "something not in list"}
         )
 
         self.assertEqual(response.status_code, 422)
@@ -171,7 +169,7 @@ def test_post_renders_the_sex_at_birth_page_with_an_error_if_form_invalid(
     ):
         response = self.client.post(
             reverse("questions:sex_at_birth"),
-            {"sex_at_birth": "something not in list"}
+            {"value": "something not in list"}
         )
 
         self.assertContains(

lung_cancer_screening/questions/views/sex_at_birth.py

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