feat: show simple shift statistics

tapir/shifts/templates/shifts/shift_detail.html

@@ -29,6 +29,10 @@
                 <h5>
                     <span id="shift_card_title">{% translate 'Shift' %}: {{ shift.get_display_name }}</span>
                 </h5>
+                {% if total_valid_attendances and total_hours and no_of_past_shifts %}
+                    <span data-bs-toggle="tooltip"
+                          title="Total Hours: {{ total_hours }}, Number of Past Shifts: {{ no_of_past_shifts }}, First Shift Date: {{ first_shift_date|date:'d.m.y' }}"></span>
+                {% endif %}
                 <span class="d-flex justify-content-end flex-wrap gap-2">
                     {% if request.user|user_watching_shift:shift %}
                         <form style="display: inline"

tapir/shifts/templatetags/shifts.py

@@ -1,4 +1,5 @@
 import datetime
+import random
 
 import tapir.shifts.config
 from django import template

tapir/shifts/tests/test_get_past_shifts_data.py

@@ -0,0 +1,102 @@
+import datetime
+
+from django.utils import timezone
+
+from tapir.accounts.tests.factories.factories import TapirUserFactory
+from tapir.shifts.models import (
+    ShiftTemplate,
+    ShiftAttendance,
+    Shift,
+)
+from tapir.shifts.tests.factories import ShiftFactory, ShiftTemplateFactory
+from tapir.shifts.views import ShiftDetailView
+from tapir.utils.tests_utils import TapirFactoryTestBase
+
+
+class ShiftGetPastShiftsStatisticsTests(TapirFactoryTestBase):
+
+    def test_getPastShiftsData_differentStatesOfAttendance_onlyCountDoneState(self):
+        user_done = TapirUserFactory.create()
+        user_excused = TapirUserFactory.create()
+
+        shift_template: ShiftTemplate = ShiftTemplateFactory.create(nb_slots=2)
+        shift: Shift = ShiftFactory.create(
+            start_time=timezone.now() - datetime.timedelta(days=1),
+            nb_slots=2,
+            shift_template=shift_template,
+        )
+        slots = list(shift.slots.all())
+        ShiftAttendance.objects.create(
+            state=ShiftAttendance.State.DONE, user=user_done, slot=slots[0]
+        )
+        ShiftAttendance.objects.create(
+            state=ShiftAttendance.State.MISSED_EXCUSED,
+            user=user_excused,
+            slot=slots[1],
+        )
+
+        context = ShiftDetailView.get_past_shifts_data(shift.shift_template)
+        self.assertEqual(context["no_of_past_shifts"], 1)
+        self.assertEqual(context["total_valid_attendances"], 1)
+        self.assertEqual(
+            context["total_hours"],
+            (shift.end_time - shift.start_time).total_seconds() / 3600,
+        )
+
+    def test_getPastShiftsData_multipleAttendandances_correctValues(self):
+        users = TapirUserFactory.create_batch(5)
+        shift_template = ShiftTemplateFactory.create(nb_slots=len(users))
+        shifts: list[Shift] = [
+            ShiftFactory.create(
+                start_time=timezone.now() - datetime.timedelta(days=i + 1),
+                nb_slots=len(users),
+                shift_template=shift_template,
+            )
+            for i in range(5)
+        ]
+
+        for shift in shifts:
+            slots = list(shift.slots.all())
+            for i, user in enumerate(users):
+                ShiftAttendance.objects.create(
+                    state=ShiftAttendance.State.DONE, user=user, slot=slots[i]
+                )
+        context = ShiftDetailView.get_past_shifts_data(shift_template)
+
+        self.assertEqual(context["no_of_past_shifts"], len(shifts))
+        self.assertEqual(context["total_valid_attendances"], len(users) * len(shifts))
+        self.assertEqual(
+            context["total_hours"],
+            70.0,
+            "The value should have been calculated by "
+            "len(users)* sum((shift.end_time - shift.start_time).total_seconds() / 3600 for shift in shifts)",
+        )
+
+    def test_getPastShiftsData_changedShiftTemplateDuration_correctSum(self):
+        shift_template: ShiftTemplate = ShiftTemplateFactory.create(
+            start_time=datetime.time(hour=10, tzinfo=datetime.timezone.utc),
+            end_time=datetime.time(hour=12, tzinfo=datetime.timezone.utc),
+        )
+        shift_2_hours = shift_template.create_shift_if_necessary(
+            timezone.now() - datetime.timedelta(days=7)
+        )
+        ShiftAttendance.objects.create(
+            user=TapirUserFactory.create(),
+            slot=shift_2_hours.slots.first(),
+            state=ShiftAttendance.State.DONE,
+        )
+
+        shift_template.end_time = datetime.time(hour=15, tzinfo=datetime.timezone.utc)
+        shift_template.save()
+
+        shift_5_hours = shift_template.create_shift_if_necessary(
+            timezone.now() - datetime.timedelta(days=14)
+        )
+        ShiftAttendance.objects.create(
+            user=TapirUserFactory.create(),
+            slot=shift_5_hours.slots.first(),
+            state=ShiftAttendance.State.DONE,
+        )
+
+        context = ShiftDetailView.get_past_shifts_data(shift_template)
+        self.assertAlmostEqual(context["total_hours"], 7.0)

tapir/shifts/views/views.py

@@ -242,6 +242,9 @@ def get_context_data(self, **kwargs):
             .prefetch_related("slot_template__attendance_template__user")
         )
 
+        if shift.shift_template:
+            self.get_past_shifts_data(shift.shift_template, context)
+
         for slot in slots:
             slot.can_self_register = slot.user_can_attend(self.request.user)
             slot.can_self_unregister = slot.user_can_self_unregister(self.request.user)
@@ -262,6 +265,45 @@ def get_context_data(self, **kwargs):
             Shift.NB_DAYS_FOR_SELF_LOOK_FOR_STAND_IN
         )
         context["SHIFT_ATTENDANCE_STATES"] = SHIFT_ATTENDANCE_STATES
+
+        return context
+
+    @staticmethod
+    def get_past_shifts_data(shift_template: ShiftTemplate, context: dict = None):
+        if context is None:
+            context = {}
+        past_shifts = (
+            Shift.objects.filter(
+                shift_template=shift_template, end_time__lt=timezone.now()
+            )
+            .annotate(
+                valid_attendance_count=Count(
+                    "slots__attendances",
+                    filter=Q(
+                        slots__attendances__state__in=[
+                            ShiftAttendance.State.DONE,
+                        ]
+                    ),
+                )
+            )
+            .order_by("start_time")
+        )
+        context["no_of_past_shifts"] = past_shifts.count()
+
+        # Sum valid attendances for related shifts
+        total_valid_attendances = sum(s.valid_attendance_count for s in past_shifts)
+
+        context["total_valid_attendances"] = total_valid_attendances
+
+        # Calculate total working hours
+        total_hours = sum(
+            (s.end_time - s.start_time).total_seconds()
+            * s.valid_attendance_count
+            / 3600
+            for s in past_shifts
+        )
+        context["total_hours"] = round(total_hours)
+        context["first_shift_date"] = past_shifts.first().start_time.date()
         return context