Disable response set submission unless "complete"

A response_Set is complete when all responses have been created

Author: Themitchell

lung_cancer_screening/core/utils/delegator.py

@@ -0,0 +1,19 @@
+class Delegator(object):
+    def __getattr__(self, called_method):
+        def wrapper(*args, **kwargs):
+            delegation_config = getattr(self, 'DELEGATED_METHODS', None)
+
+            if not isinstance(delegation_config, dict):
+                raise AttributeError("'%s' object has not defined any delegated methods" % (self.__class__.__name__))
+
+            for delegate_object_str, delegated_methods in delegation_config.items():
+              if called_method in delegated_methods:
+                break
+              else:
+                raise AttributeError("'%s' object has no attribute '%s'" % (self.__class__.__name__, called_method))
+
+            delegate_object = getattr(self, delegate_object_str, None)
+
+            return getattr(delegate_object, called_method)(*args, **kwargs)
+
+        return wrapper

lung_cancer_screening/questions/jinja2/responses.jinja

@@ -42,7 +42,8 @@
       <form action="{{ request.path }}" method="post">
         {{ csrf_input }}
         {{ button({
-          "text": "Submit"
+          "text": "Submit",
+          "disabled": not response_set.is_complete()
         }) }}
       </form>
     </div>

lung_cancer_screening/questions/models/family_history_lung_cancer_response.py

@@ -15,11 +15,14 @@ class FamilyHistoryLungCancerResponse(BaseModel):
     response_set = models.OneToOneField(ResponseSet, on_delete=models.CASCADE, related_name='family_history_lung_cancer')
     value = models.CharField(max_length=1, choices=FamilyHistoryLungCancerValues.choices)
 
+    def is_truthy(self):
+        return self.value == FamilyHistoryLungCancerValues.YES
+
 
 @receiver(post_save, sender=FamilyHistoryLungCancerResponse)
 def remove_relatives_age_when_diagnosed_if_not_yes(sender, instance, **kwargs):
     if (
-        instance.value != FamilyHistoryLungCancerValues.YES
+        not instance.is_truthy()
         and instance.response_set
         and hasattr(instance.response_set, "relatives_age_when_diagnosed")
     ):

lung_cancer_screening/questions/models/response_set.py

@@ -38,18 +38,45 @@ class Meta:
                 violation_error_message="An unsubmitted response set already exists for this user"
             )
         ]
-
+q
     def clean(self):
         super().clean()
         self._validate_any_submitted_response_set_recently()
 
 
     def has_user_submitted_response_set_recently(self):
-        return self.user and self.user.has_recently_submitted_responses()
+        return self.user and self.user.has_recently_submitted_responses(excluding=self)
 
 
     def _validate_any_submitted_response_set_recently(self):
         if self.has_user_submitted_response_set_recently():
             raise ValidationError(
                 "Responses have already been submitted for this user"
             )
+
+
+    def _response_attrs(self):
+        response_attrs = [
+            'asbestos_exposure_response',
+            'cancer_diagnosis_response',
+            'check_need_appointment_response',
+            'date_of_birth_response',
+            'education_response',
+            'ethnicity_response',
+            'family_history_lung_cancer',
+            'gender_response',
+            'have_you_ever_smoked_response',
+            'height_response',
+            'respiratory_conditions_response',
+            'sex_at_birth_response',
+            'weight_response',
+        ]
+
+        if hasattr(self, 'family_history_lung_cancer') and self.family_history_lung_cancer.is_truthy():
+            response_attrs.append('relatives_age_when_diagnosed')
+
+        return response_attrs
+
+
+    def is_complete(self):
+        return all(hasattr(self, attr) for attr in self._response_attrs())

lung_cancer_screening/questions/models/user.py

@@ -36,5 +36,10 @@ class Meta:
         verbose_name = 'user'
         verbose_name_plural = 'users'
 
-    def has_recently_submitted_responses(self):
-        return self.responseset_set.recently_submitted().exists()
+    def has_recently_submitted_responses(self, excluding=None):
+        query = self.responseset_set.recently_submitted()
+
+        if excluding:
+            query = query.exclude(id=excluding.id)
+
+        return query.exists()

lung_cancer_screening/questions/presenters/response_set_presenter.py

@@ -1,13 +1,20 @@
 from decimal import Decimal
 from django.urls import reverse
 
+from lung_cancer_screening.core.utils.delegator import Delegator
 from ..models.education_response import EducationValues
 from ..models.respiratory_conditions_response import RespiratoryConditionValues
 from ..models.family_history_lung_cancer_response import FamilyHistoryLungCancerValues
 
-class ResponseSetPresenter:
+class ResponseSetPresenter(Delegator):
     DATE_FORMAT = "%-d %B %Y" # eg 8 September 2000
 
+    DELEGATED_METHODS = {
+        "response_set": [
+            "is_complete",
+        ]
+    }
+
     def __init__(self, response_set):
         self.response_set = response_set
 
@@ -218,6 +225,7 @@ def family_history_responses_items(self):
         return items
 
 
+
     def _list_to_sentence(self, list, final_separator = "and"):
         if len(list) == 0:
             return ''

lung_cancer_screening/questions/tests/factories/response_set_factory.py

@@ -9,3 +9,63 @@ class Meta:
         model = ResponseSet
 
     user = factory.SubFactory(UserFactory)
+
+    class Params:
+        complete = factory.Trait(
+            asbestos_exposure_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.asbestos_exposure_response_factory.AsbestosExposureResponseFactory",
+                factory_related_name="response_set"
+            ),
+            cancer_diagnosis_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.cancer_diagnosis_response_factory.CancerDiagnosisResponseFactory",
+                factory_related_name="response_set"
+            ),
+            check_need_appointment_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.check_need_appointment_response_factory.CheckNeedAppointmentResponseFactory",
+                factory_related_name="response_set"
+            ),
+            date_of_birth_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.date_of_birth_response_factory.DateOfBirthResponseFactory",
+                factory_related_name="response_set"
+            ),
+            education_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.education_response_factory.EducationResponseFactory",
+                factory_related_name="response_set"
+            ),
+            ethnicity_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.ethnicity_response_factory.EthnicityResponseFactory",
+                factory_related_name="response_set"
+            ),
+            family_history_lung_cancer_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.family_history_lung_cancer_response_factory.FamilyHistoryLungCancerResponseFactory",
+                factory_related_name="response_set"
+            ),
+            gender_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.gender_response_factory.GenderResponseFactory",
+                factory_related_name="response_set"
+            ),
+            have_you_ever_smoked_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.have_you_ever_smoked_response_factory.HaveYouEverSmokedResponseFactory",
+                factory_related_name="response_set"
+            ),
+            height_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.height_response_factory.HeightResponseFactory",
+                factory_related_name="response_set"
+            ),
+            relatives_age_when_diagnosed_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.relatives_age_when_diagnosed_response_factory.RelativesAgeWhenDiagnosedResponseFactory",
+                factory_related_name="response_set"
+            ),
+            respiratory_conditions_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.respiratory_conditions_response_factory.RespiratoryConditionsResponseFactory",
+                factory_related_name="response_set"
+            ),
+            sex_at_birth_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.sex_at_birth_response_factory.SexAtBirthResponseFactory",
+                factory_related_name="response_set"
+            ),
+            weight_response=factory.RelatedFactory(
+                "lung_cancer_screening.questions.tests.factories.weight_response_factory.WeightResponseFactory",
+                factory_related_name="response_set"
+            ),
+        )

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

@@ -40,6 +40,22 @@ def test_has_value_as_string(self):
         self.assertIsInstance(response.value, str)
 
 
+    def test_is_truthy_returns_true_if_value_is_yes(self):
+        response = FamilyHistoryLungCancerResponseFactory(
+            value=FamilyHistoryLungCancerValues.YES
+        )
+
+        self.assertTrue(response.is_truthy())
+
+
+    def test_is_truthy_returns_false_if_value_is_no(self):
+        response = FamilyHistoryLungCancerResponseFactory(
+            value=FamilyHistoryLungCancerValues.NO
+        )
+
+        self.assertFalse(response.is_truthy())
+
+
     def test_deletes_family_age_when_diagnosed_if_response_is_no(self):
         RelativesAgeWhenDiagnosedResponseFactory.create(response_set=self.response_set)
 

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

@@ -1,4 +1,4 @@
-from django.test import TestCase
+from django.test import TestCase, tag
 from datetime import datetime
 from dateutil.relativedelta import relativedelta
 from django.utils import timezone
@@ -9,7 +9,10 @@
 from ...factories.response_set_factory import ResponseSetFactory
 from ....models.user import User
 from ....models.response_set import ResponseSet
+from ....models.family_history_lung_cancer_response import FamilyHistoryLungCancerValues
 
+
+@tag("ResponseSet")
 class TestResponseSet(TestCase):
     def setUp(self):
         self.user = UserFactory()
@@ -80,7 +83,16 @@ def test_is_invalid_if_another_response_set_was_submitted_within_the_recently_su
             "Responses have already been submitted for this user"
         )
 
-# Query managers
+
+    def test_submitted_response_set_is_valid_on_update(self):
+        self.response_set.submitted_at = timezone.now()
+        self.response_set.save()
+
+        self.response_set.full_clean()
+
+
+    # Query managers
+
     def test_objects_returns_all_response_sets(self):
         unsubmitted_response_set = ResponseSetFactory()
         submitted_response_set = ResponseSetFactory(submitted_at=timezone.now())
@@ -95,6 +107,7 @@ def test_objects_returns_all_response_sets(self):
             response_sets,
         )
 
+
     def test_unsubmitted_returns_only_unsubmitted_response_sets(self):
         unsubmitted_response_set = ResponseSetFactory()
         submitted_response_set = ResponseSetFactory(submitted_at=timezone.now())
@@ -144,3 +157,29 @@ def test_submitted_recently_returns_only_submitted_response_sets_in_the_recently
             old_submitted_response,
             recently_submitted_response_sets,
         )
+
+
+    def test_is_complete_returns_true_if_all_questions_are_answered(self):
+        response_set = ResponseSetFactory.create(complete=True)
+
+        self.assertTrue(response_set.is_complete())
+
+
+    def test_is_complete_returns_false_if_a_single_question_is_not_answered(self):
+        response_set = ResponseSetFactory.create(complete=True)
+        response_set.asbestos_exposure_response.delete()
+        response_set.refresh_from_db()
+
+        self.assertFalse(response_set.is_complete())
+
+
+    def test_is_complete_returns_true_if_family_history_cancer_no_and_none_age_diagnosed(self):
+        response_set = ResponseSetFactory.create(complete=True)
+
+        family_history = response_set.family_history_lung_cancer
+        family_history.value = FamilyHistoryLungCancerValues.NO
+        family_history.save()
+
+        response_set.refresh_from_db()
+
+        self.assertTrue(response_set.is_complete())

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

@@ -80,12 +80,14 @@ def test_raises_a_validation_error_if_nhs_number_is_duplicate(self):
             context.exception.messages
         )
 
+
     def test_has_recently_submitted_responses_returns_true_if_has_recently_submitted_response_set(self):
         self.user.responseset_set.create(
             submitted_at=timezone.now() - timedelta(days=ResponseSet.RECENTLY_SUBMITTED_PERIOD_DAYS - 1)
         )
         self.assertTrue(self.user.has_recently_submitted_responses())
 
+
     def test_has_recently_submitted_responses_returns_false_if_has_no_recently_submitted_response_set(self):
         self.user.responseset_set.create(
             submitted_at=timezone.now() - timedelta(days=ResponseSet.RECENTLY_SUBMITTED_PERIOD_DAYS)