Extract presenters for clinics page

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):
     """
@@ -54,10 +46,7 @@ def environment(**options):
     env.globals.update(
         {"static": static, "url": reverse, "STATIC_URL": settings.STATIC_URL}
     )
+    env.filters["no_wrap"] = no_wrap
     env.filters["as_hint"] = as_hint
 
-    # TODO: format all dates and times in the presenter layer
-    env.filters["format_date"] = format_date
-    env.filters["format_time_range"] = format_time_range
-
     return env

manage_breast_screening/record_a_mammogram/presenters.py

@@ -4,48 +4,11 @@
 
 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 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 status_colour(status):
     """
     Color to render the status tag

manage_breast_screening/templates/_components/secondary-navigation/macro.jinja

@@ -1,3 +1,3 @@
-{% macro app_secondary_navigation(visually_hidden_title, items) %}
+{% macro appSecondaryNavigation(params) %}
   {%- include "_components/secondary-navigation/template.jinja" -%}
 {% endmacro %}

manage_breast_screening/templates/clinics/index.html

@@ -4,44 +4,32 @@
 {% from '_components/count/macro.jinja' import appCount %}
 {% from '_components/secondary-navigation/macro.jinja' import appSecondaryNavigation %}
 
-{% set pageHeading %}
-{% if filter == 'today' %}
-Today’s clinics
-{% elif filter == 'upcoming' %}
-Upcoming clinics
-{% elif filter == 'completed' %}
-Completed clinics this week
-{% else %}
-All clinics this week
-{% endif %}
-{% endset %}
-
 {% block content %}
-<h1>{{pageHeading}}</h1>
+<h1>{{ presenter.heading }}</h1>
 
 {% set ns = namespace() %}
 {% set ns.secondaryNavItems = [] %}
 
 {% for item in [
-{ "id": 'today', "label": 'Today' },
-{ "id": 'upcoming', "label": 'Upcoming' },
-{ "id": 'completed', "label": 'Completed' },
-{ "id": 'all', "label": 'All' }
+  { "id": 'today', "label": 'Today' },
+  { "id": 'upcoming', "label": 'Upcoming' },
+  { "id": 'completed', "label": 'Completed' },
+  { "id": 'all', "label": 'All' }
 ] %}
 {% set href %}/clinics/{{ item.id }}{% endset %}
 {% set ns.secondaryNavItems = ns.secondaryNavItems + [{
-"text": (item.label + " " + appCount(filteredClinicCounts[item.id])) | safe,
-"href": href | trim,
-"current": true if item.id == filter
+  "text": (item.label + " " + appCount(presenter.counts_by_filter[item.id])) | safe,
+  "href": href | trim,
+  "current": true if item.id == presenter.filter
 }] %}
 {% endfor %}
 
 {{ appSecondaryNavigation({
-"visuallyHiddenTitle": "Secondary menu",
-"items": ns.secondaryNavItems
+  "visuallyHiddenTitle": "Secondary menu",
+  "items": ns.secondaryNavItems
 }) }}
 
-{% if filteredClinics | length == 0 %}
+{% if presenter.clinics | length == 0 %}
 <p>No clinics found.</p>
 {% else %}
 <table class="nhsuk-table">
@@ -55,39 +43,31 @@ <h1>{{pageHeading}}</h1>
     </tr>
   </thead>
   <tbody class="nhsuk-table__body">
-    {% for clinic in filteredClinics | sort(false, false, 'starts_at') %}
-    {% set location = clinic.setting %}
-    {% set events = clinic.slots %}
+    {% for clinic in presenter.clinics %}
     <tr>
       <td>
         <a href="/clinics/{{ clinic.id }}" class="nhsuk-link">
-          {#- FIXME-#}
-          {% if location.type == 'mobile_unit' %}
-          {{ location.name }} at {{ clinic.siteName }}
-          {% else %}
-          {{ location.name }}
-          {% endif %}
+          {{ clinic.location_name }}
           <br>
-          ({{ clinic.session_type() | capitalize }})
+          ({{ clinic.session_type }})
         </a>
       </td>
-      <td>{{ clinic.starts_at | format_date | noWrap }}<br>
-        {{clinic.time_range() | format_time_range | as_hint }}
+      <td>{{ clinic.starts_at | no_wrap }}<br>
+        {{clinic.time_range | as_hint }}
       </td>
       <td>
-        {{ clinic.get_type_display() | capitalize }}
+        {{ clinic.type }}
         <br>
-        <span class="app-text-grey">{{ clinic.get_risk_type_display() | capitalize }}</span>
-
+        <span class="app-text-grey">{{ clinic.risk_type }}</span>
       </td>
 
       <td class="nhsuk-table__cell--numeric">
-        {{ events | length }}
+        {{ clinic.number_of_slots }}
       </td>
-      <td class="nhsuk-table__cell--numeric">
+      <td>
         {{ tag({
-        "html": clinic.get_state_display() | noWrap,
-        "classes": "nhsuk-tag--" + STATUS_COLORS[clinic.state]
+          "html": clinic.state.text | no_wrap,
+          "classes": clinic.state.classes
         })}}
       </td>
     </tr>