Merge pull request #58 from NHSDigital/extract-presenters

Extract a presenter (view model) layer

Author: MatMoore

manage_breast_screening/clinics/models.py

@@ -1,4 +1,5 @@
 from datetime import date
+from enum import StrEnum
 
 from django.db import models
 
@@ -20,7 +21,27 @@ class Setting(BaseModel):
     provider = models.ForeignKey(Provider, on_delete=models.CASCADE)
 
 
+class ClinicFilter(StrEnum):
+    TODAY = "today"
+    UPCOMING = "upcoming"
+    COMPLETED = "completed"
+    ALL = "all"
+
+
 class ClinicQuerySet(models.QuerySet):
+    def by_filter(self, filter: str):
+        match filter:
+            case ClinicFilter.TODAY:
+                return self.today()
+            case ClinicFilter.UPCOMING:
+                return self.upcoming()
+            case ClinicFilter.COMPLETED:
+                return self.completed()
+            case ClinicFilter.ALL:
+                return self
+            case _:
+                raise ValueError(filter)
+
     def today(self):
         """
         Clinics that start today
@@ -100,6 +121,15 @@ def session_type(self):
     def time_range(self):
         return {"start_time": self.starts_at, "end_time": self.ends_at}
 
+    @classmethod
+    def filter_counts(cls):
+        return {
+            ClinicFilter.ALL: cls.objects.count(),
+            ClinicFilter.TODAY: cls.objects.today().count(),
+            ClinicFilter.UPCOMING: cls.objects.upcoming().count(),
+            ClinicFilter.COMPLETED: cls.objects.completed().count(),
+        }
+
 
 class ClinicSlot(BaseModel):
     clinic = models.ForeignKey(
@@ -164,4 +194,3 @@ class Status:
     )
     reinvite = models.BooleanField(default=False)
     stopped_reasons = models.JSONField(null=True, blank=True)
-

manage_breast_screening/clinics/presenters.py

@@ -0,0 +1,46 @@
+from ..utils.date_formatting import format_date, format_time_range
+from ..utils.string_formatting import sentence_case
+from .models import Clinic
+
+
+class ClinicsPresenter:
+    def __init__(self, filtered_clinics, filter, counts_by_filter):
+        self.clinics = [ClinicPresenter(clinic) for clinic in filtered_clinics]
+        self.counts_by_filter = counts_by_filter
+        self.filter = filter
+
+    @property
+    def heading(self):
+        if self.filter == "today":
+            return "Today’s clinics"
+        elif self.filter == "upcoming":
+            return "Upcoming clinics"
+        elif self.filter == "completed":
+            return "Completed clinics this week"
+        else:
+            return "All clinics this week"
+
+
+class ClinicPresenter:
+    STATUS_COLORS = {
+        Clinic.State.SCHEDULED: "blue",  # default blue
+        Clinic.State.IN_PROGRESS: "blue",
+        Clinic.State.CLOSED: "grey",
+    }
+
+    def __init__(self, clinic):
+        self._clinic = clinic
+        self.starts_at = format_date(clinic.starts_at)
+        self.session_type = clinic.session_type().capitalize()
+        self.number_of_slots = clinic.clinic_slots.count()
+        self.location_name = sentence_case(clinic.setting.name)
+        self.time_range = format_time_range(clinic.time_range())
+        self.type = clinic.get_type_display()
+        self.risk_type = clinic.get_risk_type_display()
+
+    @property
+    def state(self):
+        return {
+            "text": self._clinic.get_state_display(),
+            "classes": "nhsuk-tag--" + self.STATUS_COLORS[self._clinic.state],
+        }

manage_breast_screening/clinics/tests/test_presenters.py

@@ -0,0 +1,38 @@
+from datetime import datetime
+from unittest.mock import MagicMock
+
+import pytest
+
+from manage_breast_screening.clinics.presenters import ClinicPresenter
+
+from ..models import Clinic
+
+
+@pytest.fixture
+def mock_clinic():
+    mock = MagicMock(spec=Clinic)
+
+    mock.starts_at = datetime(2025, 1, 1, 9)
+    mock.session_type.return_value = "All day"
+    mock.clinic_slots.count.return_value = 10
+    mock.setting.name = "Test setting"
+    mock.time_range.return_value = {
+        "start_time": datetime(2025, 1, 1, 9),
+        "end_time": datetime(2025, 1, 1, 15),
+    }
+    mock.get_type_display.return_value = "Screening"
+    mock.get_risk_type_display.return_value = "Routine"
+
+    return mock
+
+
+def test_clinic_presenter(mock_clinic):
+    presenter = ClinicPresenter(mock_clinic)
+
+    assert presenter.starts_at == "1 January 2025"
+    assert presenter.session_type == "All day"
+    assert presenter.number_of_slots == 10
+    assert presenter.location_name == "Test setting"
+    assert presenter.time_range == "9am to 3pm"
+    assert presenter.type == "Screening"
+    assert presenter.risk_type == "Routine"

manage_breast_screening/clinics/views.py

@@ -1,8 +1,8 @@
-from datetime import datetime
-
 from django.shortcuts import render
 
-from .models import Clinic, Provider, Setting
+from manage_breast_screening.clinics.presenters import ClinicsPresenter
+
+from .models import Clinic
 
 STATUS_COLORS = {
     Clinic.State.SCHEDULED: "blue",  # default blue
@@ -12,28 +12,12 @@
 
 
 def clinic_list(request, filter="today"):
-    match filter:
-        case "today":
-            clinics = Clinic.objects.today()
-        case "upcoming":
-            clinics = Clinic.objects.upcoming()
-        case "completed":
-            clinics = Clinic.objects.completed()
-        case _:
-            clinics = Clinic.objects.all()
+    clinics = Clinic.objects.prefetch_related("setting").by_filter(filter)
+    counts_by_filter = Clinic.filter_counts()
+    presenter = ClinicsPresenter(clinics, filter, counts_by_filter)
 
     return render(
         request,
         "clinics/index.html",
-        context={
-            "filter": filter,
-            "filteredClinics": clinics,
-            "filteredClinicCounts": {
-                "all": Clinic.objects.count(),
-                "today": Clinic.objects.today().count(),
-                "upcoming": Clinic.objects.upcoming().count(),
-                "completed": Clinic.objects.completed().count(),
-            },
-            "STATUS_COLORS": STATUS_COLORS,
-        },
+        context={"presenter": presenter},
     )

manage_breast_screening/config/jinja2_env.py

@@ -6,14 +6,6 @@
 from jinja2 import ChoiceLoader, Environment, PackageLoader
 from markupsafe import Markup, escape
 
-from ..utils.date_formatting import (
-    format_date,
-    format_date_time,
-    format_relative_date,
-    format_time,
-    format_time_range,
-)
-
 
 def no_wrap(value):
     """
@@ -37,44 +29,6 @@ def as_hint(value):
     return Markup(f'<span class="app-text-grey">{value}</span>' if value else "")
 
 
-def sentence_case(value):
-    """
-    Capitalise the first letter of a sentence.
-
-    >>> sentence_case('a quick brown fox jumps over the lazy dog')
-    'A quick brown fox jumps over the lazy dog'
-
-    Unlike the built in `capitalize` filter, this will preserve
-    capital letters already in the string:
-
-    >>> sentence_case('not in PACS')
-    'Not in PACS'
-    """
-    if not value:
-        return ""
-
-    return value[0].upper() + value[1:]
-
-
-def format_nhs_number(value):
-    """
-    Format an NHS number with spaces
-
-    >>> format_nhs_number('9998887777')
-    '999 888 7777'
-    """
-    if not value:
-        return ""
-
-    digits = re.sub(r"\s", "", value)
-
-    return f"{digits[:3]} {digits[3:6]} {digits[6:]}"
-
-
-def format_age(value: int) -> str:
-    return f"{value} years old"
-
-
 def environment(**options):
     env = Environment(**options, extensions=["jinja2.ext.do"])
     if env.loader:
@@ -92,14 +46,7 @@ def environment(**options):
     env.globals.update(
         {"static": static, "url": reverse, "STATIC_URL": settings.STATIC_URL}
     )
-    env.filters["noWrap"] = no_wrap
-    env.filters["asHint"] = as_hint
-    env.filters["formatAge"] = format_age
-    env.filters["formatDate"] = format_date
-    env.filters["formatDateTime"] = format_date_time
-    env.filters["formatNhsNumber"] = format_nhs_number
-    env.filters["formatRelativeDate"] = format_relative_date
-    env.filters["formatTimeRange"] = format_time_range
-    env.filters["formatTimeString"] = format_time
-    env.filters["sentenceCase"] = sentence_case
+    env.filters["no_wrap"] = no_wrap
+    env.filters["as_hint"] = as_hint
+
     return env

manage_breast_screening/record_a_mammogram/presenters.py

@@ -0,0 +1,131 @@
+import re
+
+from django.urls import reverse
+
+from ..clinics.models import Appointment
+from ..utils.date_formatting import format_date, format_relative_date, format_time
+from ..utils.string_formatting import format_age, format_nhs_number, sentence_case
+
+Status = Appointment.Status
+
+
+def status_colour(status):
+    """
+    Color to render the status tag
+    """
+    match status:
+        case Status.CHECKED_IN:
+            return ""  # no colour will get solid dark blue
+        case Status.SCREENED:
+            return "green"
+        case Status.DID_NOT_ATTEND | Status.CANCELLED:
+            return "red"
+        case Status.ATTENDED_NOT_SCREENED | Status.PARTIALLY_SCREENED:
+            return "orange"
+        case _:
+            return "blue"  # default blue
+
+
+def present_secondary_nav(id):
+    """
+    Build a secondary nav for reviewing the information of screened/partially screened appointments.
+    """
+    return [
+        {
+            "id": "all",
+            "text": "Appointment details",
+            "href": reverse("record_a_mammogram:start_screening", kwargs={"id": id}),
+            "current": True,
+        },
+        {"id": "medical_information", "text": "Medical information", "href": "#"},
+        {"id": "images", "text": "Images", "href": "#"},
+    ]
+
+
+class AppointmentPresenter:
+    def __init__(self, appointment):
+        self._appointment = appointment
+        self._last_known_screening = appointment.screening_episode.previous()
+
+        self.allStatuses = Status
+        self.id = appointment.id
+        self.clinic_slot = ClinicSlotPresenter(appointment.clinic_slot)
+        self.participant = ParticipantPresenter(
+            appointment.screening_episode.participant
+        )
+
+    @property
+    def status(self):
+        colour = status_colour(self._appointment.status)
+
+        return {
+            "classes": f"nhsuk-tag--{colour} app-nowrap" if colour else "app-nowrap",
+            "text": self._appointment.get_status_display(),
+            "key": self._appointment.status,
+            "is_confirmed": self._appointment.status == Status.CONFIRMED,
+        }
+
+    @property
+    def last_known_screening(self):
+        return (
+            {
+                "date": format_date(self._last_known_screening.created_at),
+                "relative_date": format_relative_date(
+                    self._last_known_screening.created_at
+                ),
+                # TODO: the current model doesn't allow for knowing the type and location of a historical screening
+                # if it is not tied to one of our clinic slots.
+                "location": None,
+                "type": None,
+            }
+            if self._last_known_screening
+            else {}
+        )
+
+
+class ClinicSlotPresenter:
+    def __init__(self, clinic_slot):
+        self._clinic_slot = clinic_slot
+        self._clinic = clinic_slot.clinic
+
+        self.clinic_id = self._clinic.id
+
+    @property
+    def clinic_type(self):
+        return self._clinic.get_type_display().capitalize()
+
+    @property
+    def slot_time_and_clinic_date(self):
+        clinic_slot = self._clinic_slot
+        clinic = self._clinic
+
+        return f"{format_time(clinic_slot.starts_at)} ({ clinic_slot.duration_in_minutes } minutes) - { format_date(clinic.starts_at) } ({ format_relative_date(clinic.starts_at) })"
+
+
+class ParticipantPresenter:
+    def __init__(self, participant):
+        self._participant = participant
+
+        self.extra_needs = participant.extra_needs
+        self.ethnic_group = participant.ethnic_group
+        self.full_name = participant.full_name
+        self.nhs_number = format_nhs_number(participant.nhs_number)
+        self.date_of_birth = format_date(participant.date_of_birth)
+        self.age = format_age(participant.age())
+        self.risk_level = sentence_case(participant.risk_level)
+
+    @property
+    def ethnic_group_category(self):
+        category = self._participant.ethnic_group_category()
+        if category:
+            return category.replace("Any other", "any other")
+        else:
+            return None
+
+    @property
+    def address(self):
+        address = self._participant.address
+        if not address:
+            return {}
+
+        return {"lines": address.lines, "postcode": address.postcode}