GH-258: Rename milestone order

Author: markhobson

schemes/domain/schemes/milestones.py

@@ -21,12 +21,12 @@ class Milestone(Enum):
     SUPERSEDED = (auto(), 10)
     REMOVED = (auto(), 11)
 
-    stage_order: int
+    milestone_order: int
 
-    def __new__(cls, value: int, stage_order: int) -> Self:
+    def __new__(cls, value: int, milestone_order: int) -> Self:
         obj = object.__new__(cls)
         obj._value_ = value
-        obj.stage_order = stage_order
+        obj.milestone_order = milestone_order
         return obj
 
 
@@ -142,7 +142,7 @@ def current_milestone(self) -> Milestone | None:
             for revision in self.current_milestone_revisions
             if revision.observation_type == ObservationType.ACTUAL
         ]
-        return max(actual_milestones, key=lambda milestone: milestone.stage_order) if actual_milestones else None
+        return max(actual_milestones, key=lambda milestone: milestone.milestone_order) if actual_milestones else None
 
     def get_current_status_date(self, milestone: Milestone, observation_type: ObservationType) -> date | None:
         current_milestone_revision = self._current_milestone_revision(milestone, observation_type)

schemes/views/schemes/milestones.py

@@ -65,7 +65,7 @@ def from_domain(cls, scheme: Scheme) -> Self:
                     actual=scheme.milestones.get_current_status_date(milestone, ObservationType.ACTUAL),
                 )
                 for milestone in sorted(
-                    scheme.milestones_eligible_for_authority_update, key=lambda milestone: milestone.stage_order
+                    scheme.milestones_eligible_for_authority_update, key=lambda milestone: milestone.milestone_order
                 )
             ]
         )
@@ -138,7 +138,7 @@ class DynamicChangeMilestoneDatesForm(ChangeMilestoneDatesForm):
             pass
 
         for milestone in sorted(
-            scheme.milestones_eligible_for_authority_update, key=lambda milestone: milestone.stage_order
+            scheme.milestones_eligible_for_authority_update, key=lambda milestone: milestone.milestone_order
         ):
             field = FormField(
                 form_class=MilestoneDatesForm.create_class(milestone, now),
@@ -162,7 +162,7 @@ def from_domain(cls, scheme: Scheme, now: datetime) -> ChangeMilestoneDatesForm:
 
     def update_domain(self, scheme: Scheme, now: datetime) -> None:
         for milestone in sorted(
-            scheme.milestones_eligible_for_authority_update, key=lambda milestone: milestone.stage_order
+            scheme.milestones_eligible_for_authority_update, key=lambda milestone: milestone.milestone_order
         ):
             field_name = self._to_field_name(milestone)
             self[field_name].form.update_domain(scheme.milestones, now, milestone)

tests/unit/domain/schemes/test_milestones.py

@@ -294,7 +294,7 @@ def test_close(self) -> None:
 
 class TestMilestone:
     @pytest.mark.parametrize(
-        "milestone, expected_stage_order",
+        "milestone, expected_milestone_order",
         [
             (Milestone.PUBLIC_CONSULTATION_COMPLETED, 0),
             (Milestone.FEASIBILITY_DESIGN_STARTED, 1),
@@ -310,5 +310,5 @@ class TestMilestone:
             (Milestone.REMOVED, 11),
         ],
     )
-    def test_stage_order(self, milestone: Milestone, expected_stage_order: int) -> None:
-        assert milestone.stage_order == expected_stage_order
+    def test_milestone_order(self, milestone: Milestone, expected_milestone_order: int) -> None:
+        assert milestone.milestone_order == expected_milestone_order