Create sequential numbers for the entities like IR, CR, AP ...etc (#637)

* requirement source title related fix

* permissions settings for enforcements

Author: dinesh-aot

compliance-api/src/compliance_api/models/administrative_penalty.py

@@ -8,12 +8,13 @@
 from sqlalchemy.orm import relationship
 from sqlalchemy.sql import and_, func, not_, or_
 
-from compliance_api.models.base_model import BaseModelVersioned
+from compliance_api.models.base_model import BaseModelVersioned, db
 from compliance_api.models.case_file import CaseFile as CaseFileModel
 from compliance_api.models.inspection import Inspection as InspectionModel
 from compliance_api.models.inspection import InspectionRequirement
 from compliance_api.models.utils import with_session
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
+from compliance_api.utils.util import get_sorted_numbers_from_generated_code
 
 
 class ReferralStatusEnum(Enum):
@@ -330,6 +331,29 @@ def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int
         )
         return result.administrative_penalty_count if result else 0
 
+    @classmethod
+    def get_latest_administrative_penalty_number_count(
+        cls, case_file_id: int, project_id: int, pattern
+    ):
+        """Return administrative penalty numbers for the case file/project.
+
+        Only numbers matching the provided pattern are returned.
+        """
+        rows = (
+            db.session.query(cls.administrative_penalty_number)
+            .join(InspectionModel, InspectionModel.id == cls.inspection_id)
+            .join(CaseFileModel, CaseFileModel.id == InspectionModel.case_file_id)
+            .filter(
+                CaseFileModel.project_id == project_id,
+                InspectionModel.case_file_id == case_file_id,
+                cls.administrative_penalty_number.op("~")(pattern),
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .all()
+        )
+        return get_sorted_numbers_from_generated_code(rows, "AP")
+
     @classmethod
     def get_administrative_penalties_by_case_files(
         cls, case_file_ids: list[int], open_aps_only: bool = False

compliance-api/src/compliance_api/models/charge_recommendation.py

@@ -8,11 +8,12 @@
 from sqlalchemy.orm import relationship
 from sqlalchemy.sql import func
 
-from compliance_api.models.base_model import BaseModelVersioned
+from compliance_api.models.base_model import BaseModelVersioned, db
 from compliance_api.models.case_file import CaseFile as CaseFileModel
 from compliance_api.models.inspection import Inspection as InspectionModel
 from compliance_api.models.utils import with_session
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
+from compliance_api.utils.util import get_sorted_numbers_from_generated_code
 
 
 class ChargeRecommendationStatusEnum(Enum):
@@ -376,3 +377,26 @@ def get_count_by_project_nd_case_file_id(
             .first()
         )
         return result.charge_recommendation_count if result else 0
+
+    @classmethod
+    def get_latest_charge_recommendation_number_count(
+        cls, case_file_id: int, project_id: int, pattern
+    ):
+        """Return charge recommendation numbers for the case file/project.
+
+        Only numbers matching the provided pattern are returned.
+        """
+        rows = (
+            db.session.query(cls.charge_recommendation_number)
+            .join(InspectionModel, InspectionModel.id == cls.inspection_id)
+            .join(CaseFileModel, CaseFileModel.id == InspectionModel.case_file_id)
+            .filter(
+                CaseFileModel.project_id == project_id,
+                InspectionModel.case_file_id == case_file_id,
+                cls.charge_recommendation_number.op("~")(pattern),
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .all()
+        )
+        return get_sorted_numbers_from_generated_code(rows, "CR")

compliance-api/src/compliance_api/models/complaint/complaint.py

@@ -18,8 +18,9 @@
 from sqlalchemy.orm import relationship
 
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
+from compliance_api.utils.util import get_sorted_numbers_from_generated_code
 
-from ..base_model import BaseModelVersioned
+from ..base_model import BaseModelVersioned, db
 from ..case_file import CaseFile as CaseFileModel
 from ..utils import with_session
 
@@ -192,6 +193,25 @@ def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int
         )
         return result.complaint_count if result else 0
 
+    @classmethod
+    def get_latest_complaint_number_count(
+        cls, case_file_id: int, project_id: int, pattern
+    ):
+        """Return all ir numbers based on the case file and project id where irno follows the given pattern."""
+        rows = (
+            db.session.query(cls.complaint_number)
+            .join(CaseFileModel, CaseFileModel.id == cls.case_file_id)
+            .filter(
+                CaseFileModel.project_id == project_id,
+                cls.case_file_id == case_file_id,
+                cls.complaint_number.op("~")(pattern),
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .all()
+        )
+        return get_sorted_numbers_from_generated_code(rows, "CM")
+
     @classmethod
     @with_session
     def create_complaint(cls, complaint_obj, session=None):

compliance-api/src/compliance_api/models/inspection/inspection.py

@@ -16,6 +16,7 @@
 from sqlalchemy.orm import relationship
 
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
+from compliance_api.utils.util import get_sorted_numbers_from_generated_code
 
 from ..base_model import BaseModelVersioned, db
 from ..case_file import CaseFile as CaseFileModel
@@ -172,6 +173,22 @@ def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int
         )
         return result.inspection_count if result else 0
 
+    @classmethod
+    def get_latest_ir_number_count(cls, case_file_id: int, project_id: int, pattern):
+        """Return all ir numbers based on the case file and project id where irno follows the given pattern."""
+        rows = (
+            db.session.query(cls.ir_number)
+            .filter(
+                cls.case_file_id == case_file_id,
+                cls.project_id == project_id,
+                cls.ir_number.op("~")(pattern),
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .all()
+        )
+        return get_sorted_numbers_from_generated_code(rows, "IR")
+
     @classmethod
     @with_session
     def create_inspection(cls, inspection_obj, session=None):

compliance-api/src/compliance_api/models/order.py

@@ -6,8 +6,9 @@
 from sqlalchemy.orm import relationship
 
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
+from compliance_api.utils.util import get_sorted_numbers_from_generated_code
 
-from .base_model import BaseModelVersioned
+from .base_model import BaseModelVersioned, db
 from .case_file import CaseFile as CaseFileModel
 from .inspection import Inspection as InspectionModel
 from .utils import with_session
@@ -246,6 +247,24 @@ def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int
         )
         return result.order_count if result else 0
 
+    @classmethod
+    def get_latest_order_number_count(cls, case_file_id: int, project_id: int, pattern):
+        """Return all ir numbers based on the case file and project id where irno follows the given pattern."""
+        rows = (
+            db.session.query(cls.order_number)
+            .join(InspectionModel, InspectionModel.id == cls.inspection_id)
+            .join(CaseFileModel, CaseFileModel.id == InspectionModel.case_file_id)
+            .filter(
+                CaseFileModel.project_id == project_id,
+                InspectionModel.case_file_id == case_file_id,
+                cls.order_number.op("~")(pattern),
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .all()
+        )
+        return get_sorted_numbers_from_generated_code(rows, "OR")
+
     @classmethod
     def get_by_order_number(cls, order_number: str):
         """Find an order by order number."""

compliance-api/src/compliance_api/models/restorative_justice.py

@@ -7,10 +7,12 @@
 from sqlalchemy import ForeignKey, Index, Integer, String, Text, and_
 from sqlalchemy.orm import relationship
 
-from compliance_api.models.base_model import BaseModelVersioned
+from compliance_api.models.base_model import BaseModelVersioned, db
+from compliance_api.models.case_file import CaseFile as CaseFileModel
 from compliance_api.models.inspection import Inspection as InspectionModel
 from compliance_api.models.utils import with_session
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
+from compliance_api.utils.util import get_sorted_numbers_from_generated_code
 
 
 class RestorativeJusticeStatusEnum(Enum):
@@ -301,3 +303,26 @@ def get_count_by_project_nd_case_file_id(
             )
             .count()
         )
+
+    @classmethod
+    def get_latest_restorative_justice_number_count(
+        cls, case_file_id: int, project_id: int, pattern
+    ):
+        """Return restorative justice numbers for the case file/project.
+
+        Only numbers matching the provided pattern are returned.
+        """
+        rows = (
+            db.session.query(cls.restorative_justice_number)
+            .join(InspectionModel, InspectionModel.id == cls.inspection_id)
+            .join(CaseFileModel, CaseFileModel.id == InspectionModel.case_file_id)
+            .filter(
+                CaseFileModel.project_id == project_id,
+                InspectionModel.case_file_id == case_file_id,
+                cls.restorative_justice_number.op("~")(pattern),
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .all()
+        )
+        return get_sorted_numbers_from_generated_code(rows, "RJ")

compliance-api/src/compliance_api/models/warning_letter.py

@@ -8,11 +8,12 @@
 from sqlalchemy.orm import relationship
 from sqlalchemy.sql import func
 
-from compliance_api.models.base_model import BaseModelVersioned
+from compliance_api.models.base_model import BaseModelVersioned, db
 from compliance_api.models.case_file import CaseFile as CaseFileModel
 from compliance_api.models.inspection import Inspection as InspectionModel
 from compliance_api.models.utils import with_session
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
+from compliance_api.utils.util import get_sorted_numbers_from_generated_code
 
 
 class WarningLetterStatusEnum(Enum):
@@ -246,3 +247,26 @@ def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int
             .first()
         )
         return result.warning_letter_count if result else 0
+
+    @classmethod
+    def get_latest_warning_letter_number_count(
+        cls, case_file_id: int, project_id: int, pattern
+    ):
+        """Return warning letter numbers for the case file/project.
+
+        Only numbers matching the provided pattern are returned.
+        """
+        rows = (
+            db.session.query(cls.warning_letter_number)
+            .join(InspectionModel, InspectionModel.id == cls.inspection_id)
+            .join(CaseFileModel, CaseFileModel.id == InspectionModel.case_file_id)
+            .filter(
+                CaseFileModel.project_id == project_id,
+                InspectionModel.case_file_id == case_file_id,
+                cls.warning_letter_number.op("~")(pattern),
+                cls.is_active.is_(True),
+                cls.is_deleted.is_(False),
+            )
+            .all()
+        )
+        return get_sorted_numbers_from_generated_code(rows, "WN")

compliance-api/src/compliance_api/schemas/inspection_approval.py

@@ -1,16 +1,15 @@
 """Schema for Inspection Record Approval."""
 
-from compliance_api.schemas.common import KeyValueSchema
 from marshmallow import EXCLUDE, ValidationError, fields, post_dump, post_load, validate
 from marshmallow_enum import EnumField
 
 from compliance_api.models.inspection_record_approval import InspectionRecordApproval as InspectionRecordApprovalModel
 from compliance_api.models.inspection_record_approval import IRApprovalStatusEnum
-from compliance_api.schemas.common import KeyValueSchema
 from compliance_api.utils.constant import INPUT_DATE_TIME_FORMAT
 
 from .base_schema import AutoSchemaBase, BaseSchema
 from .staff_user import StaffUserSchema
+from . import KeyValueSchema
 
 
 class InspectionRecordApprovalSchema(

compliance-api/src/compliance_api/services/administrative_penalty.py

@@ -446,8 +446,9 @@ def _create_administrative_penalty_number(project_id: int, case_file_id: int) ->
     if case_file.project_id != project_id:
         raise UnprocessableEntityError("Given project and case file don't match")
 
-    count = AdministrativePenalty.get_count_by_project_nd_case_file_id(
-        project_id, case_file_id
+    pattern = rf"^{project_code}_{case_file.case_file_number}_AP[0-9]{{3}}$"
+    count = AdministrativePenalty.get_latest_administrative_penalty_number_count(
+        case_file_id, project_id, pattern
     )
-    serial_number = f"{count + 1:03}"
+    serial_number = f"{count:03}"
     return f"{project_code}_{case_file.case_file_number}_AP{serial_number}"

compliance-api/src/compliance_api/services/charge_recommendation.py

@@ -8,7 +8,6 @@
     ChargeRecommendation, ChargeRecommendationInspectionRequirementMap)
 from compliance_api.models.cr_sentence_type_mapping import CRSentenceTypeMapping
 from compliance_api.models.db import session_scope
-from compliance_api.models.inspection import Inspection as InspectionModel
 from compliance_api.services.service_utils import ServiceUtils
 
 
@@ -233,26 +232,6 @@ def _create_requirement_mappings(
                 mapping_data, session
             )
 
-    @classmethod
-    def _generate_charge_recommendation_number(cls, inspection_id: int) -> str:
-        """Generate a unique charge recommendation number."""
-        inspection = InspectionModel.find_by_id(inspection_id)
-        if not inspection:
-            raise ResourceNotFoundError("Given inspection doesn't exist")
-
-        project_code = ServiceUtils.get_project_abbreviation(inspection.project_id)
-        case_file = CaseFileModel.find_by_id(inspection.case_file_id)
-        if not case_file:
-            raise ResourceNotFoundError("Given case file doesn't exist")
-        if case_file.project_id != inspection.project_id:
-            raise UnprocessableEntityError("Given project and case file don't match")
-
-        count = ChargeRecommendation.get_count_by_project_nd_case_file_id(
-            inspection.project_id, inspection.case_file_id
-        )
-        serial_number = f"{count + 1:03}"
-        return f"{project_code}_{case_file.case_file_number}_CR{serial_number}"
-
 
 def _extract_cr_data(charge_recommendation_data):
     """Extract charge recommendation data."""
@@ -300,9 +279,9 @@ def _create_charge_recommendation_number(project_id: int, case_file_id: int) ->
         raise ResourceNotFoundError("Given case file doesn't exist")
     if case_file.project_id != project_id:
         raise UnprocessableEntityError("Given project and case file don't match")
-
-    count = ChargeRecommendation.get_count_by_project_nd_case_file_id(
-        project_id, case_file_id
+    pattern = rf"^{project_code}_{case_file.case_file_number}_CR[0-9]{{3}}$"
+    count = ChargeRecommendation.get_latest_charge_recommendation_number_count(
+        case_file_id, project_id, pattern
     )
-    serial_number = f"{count + 1:03}"
+    serial_number = f"{count:03}"
     return f"{project_code}_{case_file.case_file_number}_CR{serial_number}"