TP2000-1503 Auto end-date measures

common/tests/util.py

@@ -706,6 +706,7 @@ class Dates:
         "normal_first_half": (relativedelta(), relativedelta(days=+14)),
         "starts_1_month_ago_to_delta": (relativedelta(months=-1), relativedelta()),
         "starts_delta_to_1_month_ahead": (relativedelta(), relativedelta(months=1)),
+        "starts_delta_to_2_months_ahead": (relativedelta(), relativedelta(months=2)),
         "starts_1_month_ago_to_1_month_ahead": (
             relativedelta(months=-1),
             relativedelta(months=1),

geo_areas/views.py

@@ -141,7 +141,7 @@ def get_context_data(self, *args, **kwargs):
 
 class GeoAreaDetailMeasures(SortingMixin, WithPaginationListMixin, ListView):
     """Displays a paginated list of measures for a geo area as a simulated tab
-    on regulation detail view."""
+    on geo area detail view."""
 
     model = Measure
     template_name = "includes/geo_areas/tabs/measures.jinja"

settings/common.py

@@ -647,6 +647,9 @@
     "workbaskets.tasks.check_workbasket": {
         "queue": "rule-check",
     },
+    "workbaskets.tasks.call_end_measures": {
+        "queue": "standard",
+    },
     "workbaskets.tasks.transition": {
         "queue": "standard",
     },

workbaskets/jinja2/workbaskets/auto_end_date_measures.jinja

@@ -0,0 +1,87 @@
+{% extends "layouts/layout.jinja" %}
+{% from "components/create_sortable_anchor.jinja" import create_sortable_anchor %}
+{% from "components/table/macro.njk" import govukTable %}
+{% from "components/button/macro.njk" import govukButton %}
+
+
+{% set page_title %}
+  Workbasket {{ workbasket.id if workbasket else request.user.current_workbasket.id }} - Auto end-date measures
+{% endset %}
+
+{% block content %}
+    <h1 class="govuk-heading-xl govuk-!-margin-bottom-3">{{ page_title }}</h1>
+
+ {% set table_rows = [] %}
+  {% for measure in object_list %}
+    {% set measure_link %}
+      <a class="govuk-link govuk-!-font-weight-bold" href="{{ url('measure-ui-detail', kwargs={'sid': measure.sid}) }}">{{ measure.sid }}</a>
+    {% endset %}
+
+    {% set commodity_link %}
+      <a class="govuk-link govuk-!-font-weight-bold" href="{{ url('commodity-ui-detail', args=[measure.goods_nomenclature.sid]) }}">{{ measure.goods_nomenclature.item_id }}</a>
+    {% endset %}
+
+    {% set action %}
+      {% if measure.valid_between.lower > today %}To be deleted{% else %}To be end-dated{% endif %}
+    {% endset %}
+
+    {{ table_rows.append([
+      {"text": measure_link},
+      {"html": commodity_link if measure.goods_nomenclature else "-"},
+      {"text": "{:%d %b %Y}".format(measure.goods_nomenclature.version_at(workbasket.transactions.last()).valid_between.upper) if measure.goods_nomenclature.version_at(workbasket.transactions.last()).valid_between.upper else "-" },
+      {"text": "{:%d %b %Y}".format(measure.valid_between.lower) },
+      {"text": "{:%d %b %Y}".format(measure.effective_end_date) if measure.effective_end_date else '-' },
+      {"text": action},
+    ]) or "" }}
+  {% endfor %}
+
+  {% set base_url = url('workbaskets:workbasket-ui-auto-end-date-measures') %}
+
+  {% set commodity_code %}
+    {{ create_sortable_anchor(request, "goods_nomenclature", "Commodity code", base_url) }}
+  {% endset %}
+
+  {% set start_date %}
+    {{ create_sortable_anchor(request, "start_date", "Measure start date", base_url) }}
+  {% endset %}
+
+  {% set measure_sid %}
+    {{ create_sortable_anchor(request, "sid", "Measure SID", base_url) }}
+  {% endset %}
+
+  {% if object_list %}
+    <p>The following measures are linked to commodity codes that have been end-dated in your workbasket. Click submit to automatically end-date or delete these measures.</p>
+    {{ govukTable({
+      "head": [
+        {"text": measure_sid},
+        {"text": commodity_code},
+        {"text": "Commodity end date"},
+        {"text": start_date},
+        {"text": 'Measure end date'},
+        {"text": "Action"},
+      ],
+      "rows": table_rows
+    }) }}
+
+    <form
+    method="post"
+  >
+    <input type="hidden" name="csrfmiddlewaretoken" value="{{ csrf_token }}">
+    <input type="hidden" name="workbasket_id" value="{{ workbasket.id }}">
+    {{ govukButton({
+        'text': "Submit",
+        'preventDoubleClick': true,
+        "name": "action",
+        "value": "auto-end-date-measures",
+}) }}
+  </form>
+
+
+
+  {% else %}
+    <p class="govuk-body">There are no current measures related to commodity codes updated in this workbasket.</p>
+  {% endif %}
+  {% include "includes/common/pagination.jinja" %}
+
+
+{% endblock %}

workbaskets/jinja2/workbaskets/confirm_auto_end_date_measures.jinja

@@ -0,0 +1,34 @@
+{% extends "layouts/layout.jinja" %}
+
+{% from "components/breadcrumbs/macro.njk" import govukBreadcrumbs %}
+{% from "components/panel/macro.njk" import govukPanel %}
+{% from "components/button/macro.njk" import govukButton %}
+
+{% set page_title = "Measures submitted to be ended" %}
+
+{% block breadcrumb %}
+  {{ govukBreadcrumbs({
+    "items": [
+      {"text": "Home", "href": url("home")},
+      {"text": "Workbasket " ~ request.user.current_workbasket.id, "href": url("workbaskets:edit-workbasket")},
+      {"text": "Workbasket " ~ request.user.current_workbasket.id ~ " auto end date measures"},
+      {"text": page_title}
+    ]
+  }) }}
+{% endblock %}
+
+{% set measure_count = request.session['count_ended_measures'] if request.session['count_ended_measures'] else '0'%}
+
+{% block content %}
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      {{ govukPanel({
+        "titleText": measure_count ~ " measure" ~ measure_count|pluralize ~ " will be ended",
+        "text": "You have successfully submitted " ~ measure_count ~ " measure" ~ measure_count|pluralize ~ " to be end-dated or deleted and added to workbasket " ~ request.user.current_workbasket.id ~ " when complete.",
+        "classes": "govuk-!-margin-bottom-7"
+      }) }}
+      <h2 class="govuk-heading-m">Next steps</h2>
+      <a href="{{ url('workbaskets:edit-workbasket') }}" class="govuk-button govuk-button--primary">Continue to workbasket</a>
+    </div>
+  </div>
+{% endblock %}

workbaskets/jinja2/workbaskets/summary-workbasket.jinja

@@ -169,6 +169,16 @@
         {% endif %}
       </div>
     {% endif %}
+    <div class="govuk-summary-list__row">
+      <dt class="govuk-summary-list__key">Auto end-date measures</dt>
+      <dd class="govuk-summary-list__value">Automatically end-date measures on commodities which have been ended in this workbasket.</dd>
+      <dd class="govuk-summary-list__actions">
+        <a
+          class="govuk-link"
+          href="{{ url('workbaskets:workbasket-ui-auto-end-date-measures') }}"
+        >Auto end-date measures</a>
+      </dd>
+    </div>
   </dl>
 
   {% if comments and can_view_comment %}

workbaskets/tasks.py

@@ -1,12 +1,21 @@
+from datetime import date
+
 from celery import group
 from celery import shared_task
 from celery.utils.log import get_task_logger
+from django.db.models import F
 from django.db.transaction import atomic
 
 from checks.tasks import check_transaction
 from checks.tasks import check_transaction_sync
+from commodities.models.orm import GoodsNomenclature
 from common.celery import app
+from common.models.transactions import Transaction
+from common.util import TaricDateRange
+from common.validators import UpdateType
+from measures.models.tracked_models import Measure
 from workbaskets.models import WorkBasket
+from workbaskets.validators import WorkflowStatus
 
 # Celery logger adds the task id and status and outputs via the worker.
 logger = get_task_logger(__name__)
@@ -64,3 +73,68 @@ def call_check_workbasket_sync(self, workbasket_id: int):
     workbasket: WorkBasket = WorkBasket.objects.get(pk=workbasket_id)
     workbasket.delete_checks()
     check_workbasket_sync(workbasket)
+
+
+def promote_measure_to_top(promoted_measure, workbasket_transactions):
+    """Set the transaction order of `promoted_measure` to be first in the
+    workbasket, demoting the transactions that came before it."""
+
+    top_transaction = workbasket_transactions.first()
+
+    if (
+        not promoted_measure
+        or not top_transaction
+        or promoted_measure == top_transaction
+    ):
+        return
+
+    current_position = promoted_measure.order
+    top_position = top_transaction.order
+    workbasket_transactions.filter(order__lt=current_position).update(
+        order=F("order") + 1,
+    )
+    promoted_measure.order = top_position
+    promoted_measure.save(update_fields=["order"])
+
+
+def end_measures(measures, workbasket):
+    """Iterate through measures on commodities, end-date those which have
+    already began and delete those which have not yet started."""
+    for measure in measures:
+        workbasket_transactions = Transaction.objects.filter(
+            workbasket=workbasket,
+            workbasket__status=WorkflowStatus.EDITING,
+        ).order_by("order")
+        commodity = (
+            GoodsNomenclature.objects.all()
+            .filter(
+                sid=measure.goods_nomenclature.sid,
+                transaction__workbasket=workbasket,
+            )
+            .last()
+        )
+        if measure.valid_between.lower > min(
+            date.today(),
+            commodity.valid_between.upper,
+        ):
+            new_measure_version = measure.new_version(
+                workbasket=workbasket,
+                update_type=UpdateType.DELETE,
+            )
+        else:
+            new_measure_version = measure.new_version(
+                workbasket=workbasket,
+                update_type=UpdateType.UPDATE,
+                valid_between=TaricDateRange(
+                    measure.valid_between.lower,
+                    commodity.valid_between.upper,
+                ),
+            )
+        promote_measure_to_top(new_measure_version.transaction, workbasket_transactions)
+
+
+@app.task
+def call_end_measures(measure_pks, workbasket_pk):
+    workbasket = WorkBasket.objects.all().get(pk=workbasket_pk)
+    measures = Measure.objects.all().filter(pk__in=measure_pks)
+    end_measures(measures, workbasket)