From e4e538d26843a62035c63128e7e86554046f0893 Mon Sep 17 00:00:00 2001
From: Antoine LAURENT <antoine.c.laurent.pro@gmail.com>
Date: Tue, 16 Jul 2024 09:56:19 +0200
Subject: [PATCH] approvals: Improve remainder display

---
 itou/approvals/admin.py                       |  8 ++---
 itou/approvals/models.py                      | 31 +++++++++++++++++++
 .../approvals/email/deliver_body.txt          |  2 +-
 .../approvals/includes/list_card.html         |  8 +----
 itou/templates/approvals/includes/status.html |  2 +-
 .../approvals/printable_approval.html         |  2 +-
 tests/approvals/tests.py                      | 21 +++++++++++--
 tests/job_applications/tests.py               |  2 +-
 .../__snapshots__/test_includes.ambr          |  6 ++--
 tests/www/approvals_views/test_detail.py      |  6 ++--
 tests/www/approvals_views/test_display.py     |  2 +-
 tests/www/approvals_views/test_list.py        |  6 ++--
 12 files changed, 67 insertions(+), 29 deletions(-)

diff --git a/itou/approvals/admin.py b/itou/approvals/admin.py
index dce4455582c..69224db8464 100644
--- a/itou/approvals/admin.py
+++ b/itou/approvals/admin.py
@@ -232,7 +232,7 @@ class ApprovalAdmin(InconsistencyCheckMixin, ItouModelAdmin):
         "origin_sender_kind",
         "origin_siae_kind",
         "origin_siae_siret",
-        "remainder",
+        "get_remainder_display",
     )
     fieldsets = (
         (
@@ -242,7 +242,7 @@ class ApprovalAdmin(InconsistencyCheckMixin, ItouModelAdmin):
                     "number",
                     "start_at",
                     "end_at",
-                    "remainder",
+                    "get_remainder_display",
                     "user",
                     "eligibility_diagnosis",
                     "assigned_company",
@@ -391,10 +391,6 @@ def assigned_company(self, obj):
             )
         return "-"
 
-    @admin.display(description="Reliquat")
-    def remainder(self, obj):
-        return f"{obj.remainder.days} jour{pluralizefr(obj.duration.days)}"
-
 
 class IsInProgressFilter(admin.SimpleListFilter):
     title = "En cours"
diff --git a/itou/approvals/models.py b/itou/approvals/models.py
index b23b019d22a..a5fe49388a3 100644
--- a/itou/approvals/models.py
+++ b/itou/approvals/models.py
@@ -27,6 +27,7 @@
 from itou.utils.apis.pole_emploi import DATE_FORMAT, PoleEmploiAPIBadResponse, PoleEmploiAPIException
 from itou.utils.db import or_queries
 from itou.utils.models import DateRange
+from itou.utils.templatetags.str_filters import pluralizefr
 from itou.utils.validators import alphanumeric, validate_siret
 
 from . import enums, notifications
@@ -134,6 +135,28 @@ def _get_obj_remainder(self, obj):
             datetime.timedelta(0),
         ) - max(obj.start_at - timezone.localdate(), datetime.timedelta(0))
 
+    def _get_human_readable_estimate(self, days):
+        split = []
+        years = days // 365
+        if years:
+            split.append(f"{years} an{pluralizefr(years)}")
+        days = days % 365
+        months = days // 30
+        if months:
+            split.append(f"{months} mois")
+        if years:
+            return "Environ " + " et ".join(split)
+        days = days % 30
+        weeks = days // 7
+        if weeks:
+            split.append(f"{weeks} semaine{pluralizefr(weeks)}")
+        if months:
+            return "Environ " + " et ".join(split)
+        days = days % 7
+        if days:
+            split.append(f"{days} jour{pluralizefr(days)}")
+        return " et ".join(split)
+
     @cached_property
     def remainder(self):
         """
@@ -149,6 +172,14 @@ def remainder(self):
             )
         return result
 
+    def get_remainder_display(self):
+        remainder_display = f"{self.remainder.days} jour{pluralizefr(self.remainder.days)}"
+        if self.remainder.days:
+            remainder_display += f" ({self._get_human_readable_estimate(self.remainder.days)})"
+        return remainder_display
+
+    get_remainder_display.short_description = "Reliquat"
+
     @property
     def remainder_as_date(self):
         """
diff --git a/itou/templates/approvals/email/deliver_body.txt b/itou/templates/approvals/email/deliver_body.txt
index 44ad02c1bfc..03605e924a6 100644
--- a/itou/templates/approvals/email/deliver_body.txt
+++ b/itou/templates/approvals/email/deliver_body.txt
@@ -5,7 +5,7 @@
 Merci d'avoir confirmé l'embauche d'un candidat sur les emplois de l'inclusion. Vous trouverez ci-dessous votre PASS IAE (il équivaut à l'agrément Pôle emploi conformément aux articles L 5132-1 à L 5132-17 du code du travail) :
 
 PASS IAE N° : {{ job_application.approval.number_with_spaces }}
-Nombre de jours restants sur le PASS IAE débutant le {{ job_application.approval.start_at|date:"d/m/Y" }} : {{ job_application.approval.remainder.days }} jours*.
+Nombre de jours restants sur le PASS IAE débutant le {{ job_application.approval.start_at|date:"d/m/Y" }} : {{ job_application.approval.get_remainder_display }}*.
 
 Délivré pour l'embauche de :
 Nom : {{ job_application.approval.user.last_name|upper }}
diff --git a/itou/templates/approvals/includes/list_card.html b/itou/templates/approvals/includes/list_card.html
index f4b6dc9659c..707f25d4d73 100644
--- a/itou/templates/approvals/includes/list_card.html
+++ b/itou/templates/approvals/includes/list_card.html
@@ -49,13 +49,7 @@ <h3>{{ approval.user.get_full_name }}</h3>
                     <i class="ri-information-line text-info"
                        data-bs-toggle="tooltip"
                        title="Le reliquat est calculé sur la base d'un nombre de jours calendaires. Si le PASS IAE n'est pas suspendu, il décroît donc tous les jours (samedi, dimanche et jours fériés compris)."></i></small>
-                <strong class="text-success">
-                    {% if approval.is_valid %}
-                        {{ approval.remainder.days }} jour{{ approval.remainder.days|pluralizefr }}
-                    {% else %}
-                        0 jour
-                    {% endif %}
-                </strong>
+                <strong class="text-success">{{ approval.get_remainder_display }}</strong>
 
             </li>
 
diff --git a/itou/templates/approvals/includes/status.html b/itou/templates/approvals/includes/status.html
index f0291e17a63..e7f2f815fb2 100644
--- a/itou/templates/approvals/includes/status.html
+++ b/itou/templates/approvals/includes/status.html
@@ -53,7 +53,7 @@
         <p class="mb-1">Date de début : {{ common_approval.start_at|date:"d/m/Y" }}</p>
         <ul class="list-unstyled">
             <li class="h4 mt-4 mb-2">
-                Nombre de jours restants sur le PASS IAE : {{ common_approval.remainder.days }} jour{{ common_approval.remainder.days|pluralizefr }}
+                Nombre de jours restants sur le PASS IAE : {{ common_approval.get_remainder_display }}
                 <i class="ri-information-line ri-xl text-info"
                    data-bs-toggle="tooltip"
                    title="Le reliquat est calculé sur la base d'un nombre de jours calendaires. Si le PASS IAE n'est pas suspendu, il décroît donc tous les jours (samedi, dimanche et jours fériés compris)."></i>
diff --git a/itou/templates/approvals/printable_approval.html b/itou/templates/approvals/printable_approval.html
index a655c05b588..d2bad5074fe 100644
--- a/itou/templates/approvals/printable_approval.html
+++ b/itou/templates/approvals/printable_approval.html
@@ -78,7 +78,7 @@ <h1 class="ff-base fs-base">
                 un PASS IAE pour un parcours d'insertion par l'activité économique,
                 conformément aux dispositions des articles L 5132-1 à L 5132-17 du code du travail.
             </p>
-            <p>Nombre de jours restants sur le PASS IAE : {{ approval.remainder.days }} jours*.</p>
+            <p>Nombre de jours restants sur le PASS IAE : {{ approval.get_remainder_display }}*.</p>
             <p class="font-italic">
                 * Le reliquat est calculé sur la base d’un nombre de jours calendaires. Si le PASS IAE n'est pas suspendu, il décroit
                 donc tous les jours (samedi, dimanche et jours fériés compris).
diff --git a/tests/approvals/tests.py b/tests/approvals/tests.py
index 856d94b6151..c08c644a2f1 100644
--- a/tests/approvals/tests.py
+++ b/tests/approvals/tests.py
@@ -529,6 +529,7 @@ def test_remainder(self):
             end_at=datetime.date(2023, 3, 24),
         )
         assert approval.remainder == datetime.timedelta(days=123)
+        assert approval.get_remainder_display() == "123 jours (Environ 4 mois)"
 
         # Futur prolongation, adding 4 days to approval.end_date.
         ProlongationFactory(
@@ -553,6 +554,7 @@ def test_remainder(self):
         approval.refresh_from_db()
         prolonged_remainder = 123 + 4 + 5 + 30
         assert approval.remainder == datetime.timedelta(days=prolonged_remainder)
+        assert approval.get_remainder_display() == "162 jours (Environ 5 mois et 1 semaine)"
 
         # Past suspension (ignored), adding 5 days to approval.end_date.
         SuspensionFactory(
@@ -571,6 +573,21 @@ def test_remainder(self):
         approval.refresh_from_db()
         # Substract to remainder the remaining suspension time
         assert approval.remainder == datetime.timedelta(days=(prolonged_remainder + 5 + 30 - 10))
+        assert approval.get_remainder_display() == "187 jours (Environ 6 mois et 1 semaine)"
+
+    def test_human_readable_estimate(self):
+        assert Approval()._get_human_readable_estimate(730) == "Environ 2 ans"
+        assert Approval()._get_human_readable_estimate(705) == "Environ 1 an et 11 mois"
+        assert Approval()._get_human_readable_estimate(380) == "Environ 1 an"
+        assert Approval()._get_human_readable_estimate(235) == "Environ 7 mois et 3 semaines"
+        assert Approval()._get_human_readable_estimate(158) == "Environ 5 mois et 1 semaine"
+        assert Approval()._get_human_readable_estimate(121) == "Environ 4 mois"
+        assert Approval()._get_human_readable_estimate(15) == "2 semaines et 1 jour"
+        assert Approval()._get_human_readable_estimate(14) == "2 semaines"
+        assert Approval()._get_human_readable_estimate(13) == "1 semaine et 6 jours"
+        assert Approval()._get_human_readable_estimate(7) == "1 semaine"
+        assert Approval()._get_human_readable_estimate(6) == "6 jours"
+        assert Approval()._get_human_readable_estimate(1) == "1 jour"
 
     @freeze_time("2023-04-26")
     def test_remainder_as_date(self):
@@ -730,12 +747,12 @@ def test_is_valid(self):
             assert approval.is_valid()
 
     @freeze_time("2022-11-22")
-    def test_remainder(self):
+    def test_get_remainder_display(self):
         pole_emploi_approval = PoleEmploiApprovalFactory(
             start_at=datetime.date(2021, 3, 25),
             end_at=datetime.date(2023, 3, 24),
         )
-        assert pole_emploi_approval.remainder == datetime.timedelta(days=123)
+        assert pole_emploi_approval.get_remainder_display() == "123 jours (Environ 4 mois)"
 
 
 class PoleEmploiApprovalManagerTest(TestCase):
diff --git a/tests/job_applications/tests.py b/tests/job_applications/tests.py
index a6b82d3b2b5..e9ca2b26044 100644
--- a/tests/job_applications/tests.py
+++ b/tests/job_applications/tests.py
@@ -1036,7 +1036,7 @@ def test_notifications_deliver_approval(self):
         assert approval.user.get_full_name() in email.subject
         assert approval.number_with_spaces in email.body
         assert approval.start_at.strftime("%d/%m/%Y") in email.body
-        assert f"{approval.remainder.days} jours" in email.body
+        assert approval.get_remainder_display() in email.body
         assert approval.user.last_name.upper() in email.body
         assert approval.user.first_name.title() in email.body
         assert approval.user.birthdate.strftime("%d/%m/%Y") in email.body
diff --git a/tests/www/approvals_views/__snapshots__/test_includes.ambr b/tests/www/approvals_views/__snapshots__/test_includes.ambr
index ebb2e7159a1..3b27009d48e 100644
--- a/tests/www/approvals_views/__snapshots__/test_includes.ambr
+++ b/tests/www/approvals_views/__snapshots__/test_includes.ambr
@@ -208,7 +208,7 @@
           <p class="mb-1">Date de début : 01/01/2000</p>
           <ul class="list-unstyled">
               <li class="h4 mt-4 mb-2">
-                  Nombre de jours restants sur le PASS IAE : 357199 jours
+                  Nombre de jours restants sur le PASS IAE : 357199 jours (Environ 978 ans et 7 mois)
                   <i class="ri-information-line ri-xl text-info"
                      data-bs-toggle="tooltip"
                      title="Le reliquat est calculé sur la base d'un nombre de jours calendaires. Si le PASS IAE n'est pas suspendu, il décroît donc tous les jours (samedi, dimanche et jours fériés compris)."></i>
@@ -274,7 +274,7 @@
           <p class="mb-1">Date de début : 01/01/2000</p>
           <ul class="list-unstyled">
               <li class="h4 mt-4 mb-2">
-                  Nombre de jours restants sur le PASS IAE : 357199 jours
+                  Nombre de jours restants sur le PASS IAE : 357199 jours (Environ 978 ans et 7 mois)
                   <i class="ri-information-line ri-xl text-info"
                      data-bs-toggle="tooltip"
                      title="Le reliquat est calculé sur la base d'un nombre de jours calendaires. Si le PASS IAE n'est pas suspendu, il décroît donc tous les jours (samedi, dimanche et jours fériés compris)."></i>
@@ -340,7 +340,7 @@
           <p class="mb-1">Date de début : 01/01/2000</p>
           <ul class="list-unstyled">
               <li class="h4 mt-4 mb-2">
-                  Nombre de jours restants sur le PASS IAE : 357199 jours
+                  Nombre de jours restants sur le PASS IAE : 357199 jours (Environ 978 ans et 7 mois)
                   <i class="ri-information-line ri-xl text-info"
                      data-bs-toggle="tooltip"
                      title="Le reliquat est calculé sur la base d'un nombre de jours calendaires. Si le PASS IAE n'est pas suspendu, il décroît donc tous les jours (samedi, dimanche et jours fériés compris)."></i>
diff --git a/tests/www/approvals_views/test_detail.py b/tests/www/approvals_views/test_detail.py
index 62543596700..69653dc40f7 100644
--- a/tests/www/approvals_views/test_detail.py
+++ b/tests/www/approvals_views/test_detail.py
@@ -127,7 +127,7 @@ def test_approval_status_includes(self, client, snapshot):
             + 1  # approval.suspension active today
             + 1  # Suspension.can_be_handled_by_siae >> get_user_last_accepted_siae_job_application()
             + 1  # select latest approval for user (can_be_prolonged)
-            + 1  # approval.remainder fetches approval suspensions to compute remaining days.
+            + 1  # approval.get_remainder_display fetches approval suspensions to compute remaining days.
             + 1  # release savepoint before the template rendering
             + 1  # template: approval.suspensions_for_status_card lists approval suspensions
             + 1  # template: approval prolongations list.
@@ -151,7 +151,7 @@ def test_approval_status_includes(self, client, snapshot):
         response = client.get(url)
         assertContains(response, format_approval_number(approval))
         assertContains(response, approval.start_at.strftime("%d/%m/%Y"))
-        assertContains(response, f"{approval.remainder.days} jours")
+        assertContains(response, approval.get_remainder_display())
         assertNotContains(
             response,
             "PASS IAE valide jusqu’au 24/04/2025, si le contrat démarre aujourd’hui.",
@@ -212,7 +212,7 @@ def test_approval_status_includes(self, client, snapshot):
             # context processors
             + 1  # siae membership (get_context_siae)
             # template: approvals/includes/status.html
-            + 1  # template: approval.remainder fetches approval suspensions to compute remaining days
+            + 1  # template: approval.get_remainder_display fetches approval suspensions to compute remaining days
             + 1  # template: approval.prolongations_for_status_card
             + 1  # template: approval.prolongation_requests_for_status_card lists not accepted prolongation requests
             # template: eligibility_diagnosis.html
diff --git a/tests/www/approvals_views/test_display.py b/tests/www/approvals_views/test_display.py
index c9878fe26c6..06d5706c4ec 100644
--- a/tests/www/approvals_views/test_display.py
+++ b/tests/www/approvals_views/test_display.py
@@ -30,7 +30,7 @@ def test_display_job_app_approval(self, *args, **kwargs):
         self.assertContains(response, global_constants.ITOU_HELP_CENTER_URL)
         self.assertContains(response, "Imprimer ce PASS IAE")
         self.assertContains(response, job_application.approval.start_at.strftime("%d/%m/%Y"))
-        self.assertContains(response, f"{job_application.approval.remainder.days} jours")
+        self.assertContains(response, job_application.approval.get_remainder_display())
 
     def test_display_approval_multiple_job_applications(self, *args, **kwargs):
         job_application = JobApplicationFactory(with_approval=True)
diff --git a/tests/www/approvals_views/test_list.py b/tests/www/approvals_views/test_list.py
index 9873f5674fe..a586f78e091 100644
--- a/tests/www/approvals_views/test_list.py
+++ b/tests/www/approvals_views/test_list.py
@@ -234,11 +234,11 @@ def test_approval_state_filters(self, client):
         )
 
         # Check IAE pass remainder days
-        assertContains(response, "367 jours")
+        assertContains(response, "367 jours (Environ 1 an)")
 
-        assertContains(response, "365 jours")
+        assertContains(response, "365 jours (Environ 1 an)")
 
-        assertContains(response, "730 jours")
+        assertContains(response, "730 jours (Environ 2 ans)")
 
         assertContains(response, "0 jour")