Tp2000 1471 task workflow

.github/pull_request_template.md

@@ -1,5 +1,6 @@
-# TP-??? Your PR title here
+# TP2000-??? Your PR title here
 <!---
+                                                  <--- 50 characters
  * Include the JIRA ticket number, eg TP-123, to automatically link.
  * Use 50 characters maximum.
  * Do not end with a full-stop.
@@ -22,12 +23,12 @@ What is this PR doing, e.g. implementations, algorithms, etc.?
 --->
 
 <!---
-Optionally let reviewers know they need to run migrations or update dependencies before
+Let reviewers know they need to run migrations or update dependencies before
 testing by adding the following section:
-## Checklist
-- Requires migrations?
-- Requires dependency updates?
 --->
+## Checklist
+- Requires migrations? Yes / No
+- Requires dependency updates? Yes / No
 
 <!---
 Links to relevant material

certificates/jinja2/includes/certificates/tabs/measures.jinja

@@ -44,18 +44,16 @@
     ]) or "" }}
   {% endfor %}
 
-  {% set base_url = url('certificate-ui-detail-measures', kwargs={"certificate_type__sid":object.certificate_type.sid, "sid":object.sid}) %}
-
   {% set commodity_code %}
-    {{ create_sortable_anchor(request, "goods_nomenclature", "Commodity code", base_url) }}
+    {{ create_sortable_anchor(request, "Commodity code", sorting_urls["goods_nomenclature"]) }}
   {% endset %}
 
   {% set geo_area %}
-    {{ create_sortable_anchor(request, "geo_area", "Geographical area", base_url) }}
+    {{ create_sortable_anchor(request, "Geographical area", sorting_urls["geo_area"]) }}
   {% endset %}
 
   {% set start_date %}
-    {{ create_sortable_anchor(request, "start_date", "Start date", base_url) }}
+    {{ create_sortable_anchor(request, "Start date", sorting_urls["start_date"]) }}
   {% endset %}
 
   {% if paginator.count > 0 %}

certificates/tests/test_views.py

@@ -373,6 +373,7 @@ def test_certificate_detail_measures_view_sorting_commodity(valid_user_client):
         )
         measures.append(measure)
     commodity_codes = [measure.goods_nomenclature.item_id for measure in measures]
+    commodity_codes.sort()
 
     url = reverse(
         "certificate-ui-detail-measures",

certificates/views.py

@@ -168,6 +168,7 @@ class CertificateDetailMeasures(SortingMixin, WithPaginationListMixin, ListView)
     paginate_by = 20
     sort_by_fields = ["goods_nomenclature", "geo_area", "start_date"]
     custom_sorting = {
+        "goods_nomenclature": "goods_nomenclature__item_id",
         "geo_area": "geographical_area__area_id",
         "start_date": "valid_between",
     }

commodities/jinja2/includes/commodities/tabs/measures-declarable.jinja

@@ -62,22 +62,20 @@
   ]) or "" }}
 {% endfor %}
 
-{% set base_url = url('commodity-ui-detail-measures-declarable', args=[commodity.sid]) %}
-
 {% set comm_code %}
-  {{ create_sortable_anchor(request, "commodity", "Commodity code", base_url) }}
+  {{ create_sortable_anchor(request, "Commodity code", sorting_urls["commodity"]) }}
 {% endset %}
 
 {% set measure_type %}
-  {{ create_sortable_anchor(request, "measure_type", "Measure type", base_url) }}
+  {{ create_sortable_anchor(request, "Measure type", sorting_urls["measure_type"]) }}
 {% endset %}
 
 {% set geo_area %}
-  {{ create_sortable_anchor(request, "geo_area", "Geographical area", base_url) }}
+  {{ create_sortable_anchor(request, "Geographical area", sorting_urls["geo_area"]) }}
 {% endset %}
 
 {% set start_date %}
-  {{ create_sortable_anchor(request, "start_date", "Start date", base_url) }}
+  {{ create_sortable_anchor(request, "Start date", sorting_urls["start_date"]) }}
 {% endset %}
 
 {% if paginator.count > 0 %}

commodities/jinja2/includes/commodities/tabs/measures-defined.jinja

@@ -56,18 +56,16 @@
   ]) or "" }}
 {% endfor %}
 
-{% set base_url = url('commodity-ui-detail-measures-as-defined', args=[commodity.sid]) %}
-
 {% set measure_type %}
-  {{ create_sortable_anchor(request, "measure_type", "Measure type", base_url) }}
+  {{ create_sortable_anchor(request, "Measure type", sorting_urls["measure_type"]) }}
 {% endset %}
 
 {% set geo_area %}
-  {{ create_sortable_anchor(request, "geo_area", "Geographical area", base_url) }}
+  {{ create_sortable_anchor(request, "Geographical area", sorting_urls["geo_area"]) }}
 {% endset %}
 
 {% set start_date %}
-  {{ create_sortable_anchor(request, "start_date", "Start date", base_url) }}
+  {{ create_sortable_anchor(request, "Start date", sorting_urls["start_date"]) }}
 {% endset %}
 
 {% if paginator.count > 0 %}

common/fields.py

@@ -5,6 +5,7 @@
 from dateutil.relativedelta import relativedelta
 from django.contrib.postgres.fields import DateRangeField
 from django.contrib.postgres.fields import DateTimeRangeField
+from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models.expressions import RawSQL
 from django.forms import ModelChoiceField
@@ -146,20 +147,51 @@ class TaricDateTimeRangeField(DateTimeRangeField):
 
 
 class AutoCompleteField(ModelChoiceField):
-    def __init__(self, *args, **kwargs):
-        qs = kwargs["queryset"]
-        prefix = getattr(qs.model, "url_pattern_name_prefix", None)
-        if not prefix:
-            prefix = qs.model._meta.model_name
+    """
+    A form field that provides an AutoComplete widget for selecting a model
+    instance.
+
+    Args:
+    - queryset (QuerySet): A queryset of model instances that will populate the valid choices for the field.
+    - label (str): (Optional) A label for the field.
+    - help_text (str): (Optional) Help text for the field.
+    - url_pattern_name (str): (Optional) A custom pattern name to use for resolving the API source URL of AutoCompleteWidget.
+    - attrs (dict): (Optional) Additional attributes to pass to AutoCompleteWidget, e.g  {"min-length": 2}.
+    """
+
+    def __init__(self, queryset, url_pattern_name=None, *args, **kwargs):
         self.widget = AutocompleteWidget(
             attrs={
                 "label": kwargs.get("label", ""),
                 "help_text": kwargs.get("help_text", ""),
-                "source_url": reverse_lazy(f"{prefix}-list"),
+                "source_url": reverse_lazy(
+                    self.get_url_pattern_name(queryset, url_pattern_name),
+                ),
                 **kwargs.pop("attrs", {}),
             },
         )
-        super().__init__(*args, **kwargs)
+        super().__init__(queryset=queryset, *args, **kwargs)
+
+    def get_url_pattern_name(self, queryset, url_pattern_name: str | None) -> str:
+        """
+        Determines the URL pattern name to use for resolving the API source URL
+        of AutocompleteWidget.
+
+        If a custom name isn't provided, the name will be based on the
+        attributes of the model derived from the queryset.
+        """
+
+        if url_pattern_name is not None:
+            return url_pattern_name
+
+        prefix = getattr(queryset.model, "url_pattern_name_prefix", None)
+        if not prefix:
+            prefix = queryset.model._meta.model_name
+
+        return f"{prefix}-list"
 
     def prepare_value(self, value):
-        return self.to_python(value)
+        try:
+            return self.to_python(value)
+        except ValidationError:
+            return None

common/jinja2/common/homepage.jinja

@@ -144,6 +144,25 @@
       </article>
     {% endif %}
 
+
+    {% if request.user.groups.filter(name='Tariff Managers').exists() or request.user.is_superuser %}
+      <article class="masonry-card">
+        <h3 class="govuk-heading-m">Tickets</h3>
+          <p class="govuk-body"></p>
+          <a href="{{ url('workflow:task-workflow-ui-list') }}"
+            class="govuk-link"
+          >Tickets</a>
+          </p>
+        {% if request.user.is_superuser %}
+          <p class="govuk-body"></p>
+          <a href="{{ url('workflow:task-workflow-template-ui-list') }}"
+            class="govuk-link"
+          >Ticket templates</a>
+          </p>
+        {% endif %}
+      </article>
+    {% endif %}
+
     <article class="masonry-card">
       <h3 class="govuk-heading-m">Resources</h3>
       <p class="govuk-body">

common/jinja2/components/create_sortable_anchor.jinja

@@ -1,21 +1,11 @@
-
-{% macro create_sortable_anchor(request, sort_by, title, base_url, query_params=False, fragment="") %}
-
-  {% if query_params %}
-    {% set query_string_prefix = "&"%}
-  {% else %}
-    {% set query_string_prefix = "?"%}
-  {% endif %}
-
-  {% if request.GET.sort_by == sort_by and request.GET.ordered == "desc" %}
-
-      <a class="govuk-link govuk-link--no-visited-state sort-icon--down" href="{{ base_url }}{{query_string_prefix}}sort_by={{ sort_by }}&ordered=asc{{ fragment }}">
-        {{ title }} <img src="{{ static('common/images/sort_icon.svg') }}" alt="">
-      </a>
+{% macro create_sortable_anchor(request, title, url, fragment="") %}
+  {% if request.GET.ordered == "desc" %}
+    <a class="govuk-link govuk-link--no-visited-state sort-icon--down" href="{{ url }}{{ fragment }}">
+      {{ title }} <img src="{{ static('common/images/sort_icon.svg') }}" alt="">
+    </a>
   {% else %}
-      <a class="govuk-link govuk-link--no-visited-state sort-icon--up" href="{{ base_url }}{{query_string_prefix}}sort_by={{ sort_by }}&ordered=desc{{ fragment }}">
+    <a class="govuk-link govuk-link--no-visited-state sort-icon--up" href="{{ url }}{{ fragment }}">
       {{ title }} <img src="{{ static('common/images/sort_icon.svg') }}" alt="">
     </a>
   {% endif %}
-
 {% endmacro %}

common/jinja2/layouts/detail.jinja

@@ -1,4 +1,6 @@
 {% extends "layouts/layout.jinja" %}
+
+{% from "components/tabs/macro.njk" import govukTabs %}
 {% from "components/breadcrumbs.jinja" import breadcrumbs %}
 
 {% block breadcrumb %}

common/migrations/0014_alter_user_managers.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.18 on 2025-02-11 15:48
+
+from django.db import migrations
+
+import common.models.user
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("common", "0013_versiongroup_common_vers_current_04c358_idx"),
+    ]
+
+    operations = [
+        migrations.AlterModelManagers(
+            name="user",
+            managers=[
+                ("objects", common.models.user.TamatoUserManager()),
+            ],
+        ),
+    ]

common/models/mixins/__init__.py

@@ -1,6 +1,7 @@
 """Mixins for models."""
 
 from django.db import models
+from django.db.models import signals
 
 
 class TimestampedMixin(models.Model):
@@ -11,3 +12,37 @@ class TimestampedMixin(models.Model):
 
     class Meta:
         abstract = True
+
+
+class WithSignalManagerMixin:
+    """A mixin that overrides default Manager methods to send pre_save signals
+    for model instances."""
+
+    def bulk_create(self, objs, **kwargs) -> list:
+        for obj in objs:
+            signals.pre_save.send(sender=self.model, instance=obj)
+        return super().bulk_create(objs, **kwargs)
+
+
+class WithSignalQuerysetMixin:
+    """A mixin that overrides default QuerySet methods to send pre_save signals
+    for model instances."""
+
+    def update(self, **kwargs) -> int:
+        old_instances_map = {}
+        pk_list = []
+        for old_instance in self.iterator():
+            old_instances_map[old_instance.pk] = old_instance
+            pk_list.append(old_instance.pk)
+
+        rows_updated = super().update(**kwargs)
+
+        for new_instance in self.model.objects.filter(pk__in=pk_list):
+            old_instance = old_instances_map.get(new_instance.pk)
+            signals.pre_save.send(
+                sender=self.model,
+                instance=new_instance,
+                old_instance=old_instance,
+            )
+
+        return rows_updated

common/models/user.py

@@ -1,10 +1,32 @@
 from django.contrib.auth.models import AbstractUser
+from django.contrib.auth.models import UserManager
 from django.db import models
 
 
+class UserQuerySet(models.QuerySet):
+    def active_tms(self) -> models.QuerySet | list["User"]:
+        """Return a QuerySet of active users that may take the tariff manager
+        role."""
+        return (
+            self.filter(
+                models.Q(groups__name__in=["Tariff Managers", "Tariff Lead Profile"])
+                | models.Q(is_superuser=True),
+            )
+            .filter(is_active=True)
+            .distinct()
+            .order_by("first_name", "last_name")
+        )
+
+
+class TamatoUserManager(UserManager.from_queryset(UserQuerySet)):
+    use_in_migrations = True
+
+
 class User(AbstractUser):
     """Custom user model."""
 
+    objects = TamatoUserManager()
+
     current_workbasket = models.ForeignKey(
         "workbaskets.WorkBasket",
         on_delete=models.SET_NULL,

common/static/common/js/application.js

@@ -26,6 +26,7 @@ import initTapDebounce from "./buttonDebounce";
 import { setupQuotaOriginFormset } from "./components/QuotaOriginFormset/index";
 import { setupGeoAreaForm } from "./components/GeoAreaForm/index";
 import { setupWorkbasketUserAssignment } from "./components/WorkbasketUserAssignment/index";
+import { setupTaskUserAssignment } from "./components/TaskUserAssignment/index";
 import { initMasonry } from "./masonry";
 
 showHideCheckboxes();
@@ -46,4 +47,5 @@ initTapDebounce();
 setupQuotaOriginFormset();
 setupGeoAreaForm();
 setupWorkbasketUserAssignment();
+setupTaskUserAssignment();
 initMasonry();