Merge pull request #1145 from alphagov/2130-short-month

2130: Format date-times on detailed case notes page with short month names

Author: ahernp

accessibility_monitoring_platform/apps/common/templatetags/common_tags.py

@@ -14,8 +14,9 @@
 
 from ..utils import (  # pylint: disable=relative-beyond-top-level
     amp_format_date,
-    amp_format_trunc_date,
+    amp_format_date_short_month,
     amp_format_datetime,
+    amp_format_datetime_short_month,
     undo_double_escapes,
 )
 
@@ -51,7 +52,7 @@ def amp_date(date_to_format: date) -> str:
 @register.filter
 def amp_date_trunc(date_to_format: date) -> str:
     """Format truncated date according to GDS style guide"""
-    return amp_format_trunc_date(date_to_format)
+    return amp_format_date_short_month(date_to_format)
 
 
 @register.filter
@@ -61,3 +62,14 @@ def amp_datetime(datetime_to_format: datetime) -> str:
         return amp_format_datetime(timezone.localtime(datetime_to_format))
     else:
         return ""
+
+
+@register.filter
+def amp_datetime_short_month(datetime_to_format: datetime) -> str:
+    """
+    Format date and time according to GDS style guide with short month name (e.g. Jan)
+    """
+    if datetime_to_format:
+        return amp_format_datetime_short_month(timezone.localtime(datetime_to_format))
+    else:
+        return ""

accessibility_monitoring_platform/apps/common/tests/test_templatetags.py

@@ -1,13 +1,16 @@
 """
 Test templatetags of common app
 """
+
 from datetime import date, datetime, timezone
 
 import pytest
 
 from ..templatetags.common_tags import (
     amp_date,
+    amp_date_trunc,
     amp_datetime,
+    amp_datetime_short_month,
     list_item_by_index,
     markdown_to_html,
 )
@@ -59,6 +62,18 @@ def test_amp_date(date_to_format, expected_result):
     assert amp_date(date_to_format) == expected_result
 
 
+@pytest.mark.parametrize(
+    "date_to_format,expected_result",
+    [
+        (date(2021, 4, 1), "1 Apr 2021"),
+        (None, ""),
+    ],
+)
+def test_amp_date_trunc(date_to_format, expected_result):
+    """Test date formatted according to GDS style guide."""
+    assert amp_date_trunc(date_to_format) == expected_result
+
+
 @pytest.mark.parametrize(
     "datetime_to_format,expected_result",
     [
@@ -70,3 +85,16 @@ def test_amp_date(date_to_format, expected_result):
 def test_amp_datetime(datetime_to_format, expected_result):
     """Test date and time formatted according to GDS style guide."""
     assert amp_datetime(datetime_to_format) == expected_result
+
+
+@pytest.mark.parametrize(
+    "datetime_to_format,expected_result",
+    [
+        (datetime(2021, 1, 4, 9, 1, 0, 0, timezone.utc), "4 Jan 2021 9:01am"),
+        (datetime(2021, 7, 4, 8, 1, 0, 0, timezone.utc), "4 Jul 2021 9:01am"),
+        (None, ""),
+    ],
+)
+def test_amp_datetime_short_month(datetime_to_format, expected_result):
+    """Test date and time formatted according to GDS style guide."""
+    assert amp_datetime_short_month(datetime_to_format) == expected_result

accessibility_monitoring_platform/apps/common/tests/test_utils.py

@@ -25,7 +25,9 @@
 from ..utils import (
     SessionExpiry,
     amp_format_date,
+    amp_format_date_short_month,
     amp_format_datetime,
+    amp_format_datetime_short_month,
     amp_format_time,
     build_filters,
     calculate_percentage,
@@ -354,6 +356,18 @@ def test_amp_format_date(date_to_format, expected_result):
     assert amp_format_date(date_to_format) == expected_result
 
 
+@pytest.mark.parametrize(
+    "date_to_format,expected_result",
+    [
+        (date(2021, 4, 1), "1 Apr 2021"),
+        (None, ""),
+    ],
+)
+def test_amp_format_date_trunc(date_to_format, expected_result):
+    """Test date formatted according to GDS style guide with a short month name"""
+    assert amp_format_date_short_month(date_to_format) == expected_result
+
+
 @pytest.mark.parametrize(
     "datetime_to_format,expected_result",
     [
@@ -378,6 +392,20 @@ def test_amp_format_datetime(datetime_to_format, expected_result):
     assert amp_format_datetime(datetime_to_format) == expected_result
 
 
+@pytest.mark.parametrize(
+    "datetime_to_format,expected_result",
+    [
+        (datetime(2021, 4, 1, 9, 1), "1 Apr 2021 9:01am"),
+        (None, ""),
+    ],
+)
+def test_amp_format_datetime_short_month(datetime_to_format, expected_result):
+    """
+    Test date and time formatted according to GDS style guide with a short month.
+    """
+    assert amp_format_datetime_short_month(datetime_to_format) == expected_result
+
+
 def test_undo_double_escapes():
     """
     Test Undo double escapes, where & has been replaced with & in escaped html

accessibility_monitoring_platform/apps/common/utils.py

@@ -173,7 +173,7 @@ def amp_format_date(date_to_format: date) -> str:
     return f"{date_to_format:%-d %B %Y}" if date_to_format else ""
 
 
-def amp_format_trunc_date(date_to_format: date) -> str:
+def amp_format_date_short_month(date_to_format: date) -> str:
     """Format date according to GDS style guide"""
     return f"{date_to_format:%-d %b %Y}" if date_to_format else ""
 
@@ -192,6 +192,17 @@ def amp_format_datetime(datetime_to_format: datetime) -> str:
     )
 
 
+def amp_format_datetime_short_month(datetime_to_format: datetime) -> str:
+    """
+    Format date and time according to GDS style guide with short month name (e.g. Jan)
+    """
+    return (
+        f"{amp_format_date_short_month(datetime_to_format)} {amp_format_time(datetime_to_format)}"
+        if datetime_to_format
+        else ""
+    )
+
+
 def undo_double_escapes(html: str) -> str:
     """Undo double escapes, where & has been replaced with & in escaped html"""
     return (

accessibility_monitoring_platform/apps/detailed/templates/detailed/forms/note_create.html

@@ -53,7 +53,7 @@
                 </b>
             </p>
             <p class="govuk-body amp-margin-bottom-5">{{ detailed_case_event.created_by.get_full_name }}</p>
-            <p class="govuk-body amp-margin-bottom-5">{{ detailed_case_event.created|amp_datetime }}</p>
+            <p class="govuk-body amp-margin-bottom-5">{{ detailed_case_event.created|amp_datetime_short_month }}</p>
             {% if detailed_case_event.event_type == 'note' %}
                 <p class="govuk-body amp-margin-bottom-5">
                     <a href="{% url 'detailed:edit-case-note' detailed_case_event.id %}"