Merge pull request #2594 from IFRCGo/feature/review-checklist

Feature/EAP Snapshots and Review checklist

Author: sudip-khanal

eap/admin.py

@@ -55,7 +55,7 @@ class SimplifiedEAPAdmin(admin.ModelAdmin):
         "eap_registration__country__name",
         "eap_registration__disaster_type__name",
     )
-    list_display = ("eap_registration",)
+    list_display = ("simplifed_eap_application", "version", "is_locked")
     autocomplete_fields = (
         "eap_registration",
         "created_by",
@@ -69,8 +69,16 @@ class SimplifiedEAPAdmin(admin.ModelAdmin):
         "selected_early_actions_file",
         "planned_operations",
         "enable_approaches",
+        "parent",
+        "is_locked",
+        "version",
     )
 
+    def simplifed_eap_application(self, obj):
+        return f"{obj.eap_registration.national_society.society_name} - {obj.eap_registration.disaster_type.name}"
+
+    simplifed_eap_application.short_description = "Simplified EAP Application"
+
     def get_queryset(self, request):
         return (
             super()

eap/migrations/0006_eapregistration_review_checklist_file_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.2.19 on 2025-11-14 10:27
+
+from django.db import migrations
+import main.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('eap', '0005_eapregistration_activated_at_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='eapregistration',
+            name='review_checklist_file',
+            field=main.fields.SecureFileField(blank=True, null=True, upload_to='eap/files/', verbose_name='Review Checklist File'),
+        ),
+        migrations.AddField(
+            model_name='simplifiedeap',
+            name='updated_checklist_file',
+            field=main.fields.SecureFileField(blank=True, null=True, upload_to='eap/files/', verbose_name='Updated Checklist File'),
+        ),
+    ]

eap/migrations/0007_alter_eapfile_options_alter_eapregistration_options_and_more.py

@@ -0,0 +1,78 @@
+# Generated by Django 4.2.19 on 2025-11-20 07:30
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("eap", "0006_eapregistration_review_checklist_file_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="eapfile",
+            options={
+                "ordering": ["-id"],
+                "verbose_name": "eap file",
+                "verbose_name_plural": "eap files",
+            },
+        ),
+        migrations.AlterModelOptions(
+            name="eapregistration",
+            options={
+                "ordering": ["-id"],
+                "verbose_name": "Development Registration EAP",
+                "verbose_name_plural": "Development Registration EAPs",
+            },
+        ),
+        migrations.AlterModelOptions(
+            name="simplifiedeap",
+            options={
+                "ordering": ["-id"],
+                "verbose_name": "Simplified EAP",
+                "verbose_name_plural": "Simplified EAPs",
+            },
+        ),
+        migrations.AddField(
+            model_name="simplifiedeap",
+            name="is_locked",
+            field=models.BooleanField(
+                default=False,
+                help_text="Indicates whether the Simplified EAP is locked for editing.",
+                verbose_name="Is Locked?",
+            ),
+        ),
+        migrations.AddField(
+            model_name="simplifiedeap",
+            name="parent",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="Reference to the parent Simplified EAP if this is a snapshot.",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="snapshots",
+                to="eap.simplifiedeap",
+                verbose_name="Parent Simplified EAP",
+            ),
+        ),
+        migrations.AddField(
+            model_name="simplifiedeap",
+            name="version",
+            field=models.IntegerField(
+                default=1,
+                help_text="Version identifier for the Simplified EAP.",
+                verbose_name="Version",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="simplifiedeap",
+            name="eap_registration",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="simplified_eap",
+                to="eap.eapregistration",
+                verbose_name="EAP Development Registration",
+            ),
+        ),
+    ]

eap/models.py

@@ -1,6 +1,6 @@
 from django.conf import settings
 from django.contrib.postgres.fields import ArrayField
-from django.db import models
+from django.db import models, transaction
 from django.utils.translation import gettext_lazy as _
 
 from api.models import Admin2, Country, DisasterType, District
@@ -206,9 +206,14 @@ class EAPBaseModel(models.Model):
         related_name="%(class)s_modified_by",
     )
 
+    # TYPING
+    id: int
+    created_by_id: int
+    modified_by_id: int
+
     class Meta:
         abstract = True
-        ordering = ["-created_at"]
+        ordering = ["-id"]
 
 
 class EAPFile(EAPBaseModel):
@@ -224,6 +229,7 @@ class EAPFile(EAPBaseModel):
     class Meta:
         verbose_name = _("eap file")
         verbose_name_plural = _("eap files")
+        ordering = ["-id"]
 
 
 class OperationActivity(models.Model):
@@ -377,7 +383,7 @@ class EAPStatus(models.IntegerChoices):
     """Initial status when an EAP is being created."""
 
     UNDER_REVIEW = 20, _("Under Review")
-    """ EAP has been submitted by NS. It is under review by IFRC and/or technical partners."""
+    """EAP has been submitted by NS. It is under review by IFRC and/or technical partners."""
 
     NS_ADDRESSING_COMMENTS = 30, _("NS Addressing Comments")
     """NS is addressing comments provided during the review process.
@@ -471,6 +477,14 @@ class EAPRegistration(EAPBaseModel):
         help_text=_("Upload the validated budget file once the EAP is technically validated."),
     )
 
+    # Review checklist
+    review_checklist_file = SecureFileField(
+        verbose_name=_("Review Checklist File"),
+        upload_to="eap/files/",
+        null=True,
+        blank=True,
+    )
+
     # Contacts
     # National Society
     national_society_contact_name = models.CharField(
@@ -537,6 +551,7 @@ class EAPRegistration(EAPBaseModel):
     class Meta:
         verbose_name = _("Development Registration EAP")
         verbose_name_plural = _("Development Registration EAPs")
+        ordering = ["-id"]
 
     def __str__(self):
         # NOTE: Use select_related in admin get_queryset for national_society field to avoid extra queries
@@ -546,7 +561,9 @@ def __str__(self):
     def has_eap_application(self) -> bool:
         """Check if the EAP Registration has an associated EAP application."""
         # TODO(susilnem): Add FULL EAP check, when model is created.
-        return hasattr(self, "simplified_eap")
+        if hasattr(self, "simplified_eap") and self.simplified_eap.exists():
+            return True
+        return False
 
     @property
     def get_status_enum(self) -> EAPStatus:
@@ -574,7 +591,7 @@ def update_eap_type(self, eap_type: EAPType, commit: bool = True):
 class SimplifiedEAP(EAPBaseModel):
     """Model representing a Simplified EAP."""
 
-    eap_registration = models.OneToOneField[EAPRegistration, EAPRegistration](
+    eap_registration = models.ForeignKey[EAPRegistration, EAPRegistration](
         EAPRegistration,
         on_delete=models.CASCADE,
         verbose_name=_("EAP Development Registration"),
@@ -865,13 +882,70 @@ class SimplifiedEAP(EAPBaseModel):
         blank=True,
     )
 
+    # Review Checklist
+    updated_checklist_file = SecureFileField(
+        verbose_name=_("Updated Checklist File"),
+        upload_to="eap/files/",
+        null=True,
+        blank=True,
+    )
+
+    # NOTE: Snapshot fields
+    version = models.IntegerField(
+        verbose_name=_("Version"),
+        help_text=_("Version identifier for the Simplified EAP."),
+        default=1,
+    )
+    is_locked = models.BooleanField(
+        verbose_name=_("Is Locked?"),
+        help_text=_("Indicates whether the Simplified EAP is locked for editing."),
+        default=False,
+    )
+    parent = models.ForeignKey(
+        "self",
+        on_delete=models.SET_NULL,
+        verbose_name=_("Parent Simplified EAP"),
+        help_text=_("Reference to the parent Simplified EAP if this is a snapshot."),
+        null=True,
+        blank=True,
+        related_name="snapshots",
+    )
+
     # TYPING
     eap_registration_id: int
+    parent_id: int
     id = int
 
     class Meta:
         verbose_name = _("Simplified EAP")
         verbose_name_plural = _("Simplified EAPs")
+        ordering = ["-id"]
 
     def __str__(self):
-        return f"Simplified EAP for {self.eap_registration}"
+        return f"Simplified EAP for {self.eap_registration}- version:{self.version}"
+
+    def generate_snapshot(self):
+        """
+        Generate a snapshot of the given Simplified EAP.
+        """
+
+        from eap.utils import copy_model_instance
+
+        with transaction.atomic():
+            copy_model_instance(
+                self,
+                overrides={
+                    "parent_id": self.id,
+                    "version": self.version + 1,
+                    "created_by_id": self.created_by_id,
+                    "modified_by_id": self.modified_by_id,
+                    "updated_checklist_file": None,
+                },
+                exclude_clone_m2m_fields=[
+                    "admin2",
+                ],
+            )
+
+            # Setting Parent as locked
+            self.is_locked = True
+            self.save(update_fields=["is_locked"])