Tp2000 1129 reference documents megabranch

.gitignore

@@ -166,3 +166,4 @@ _dumped_cache.pkl
 
 # Database dumps
 *.sql
+/.vscode/settings.json

README.rst

@@ -398,6 +398,21 @@ This tool is available as an importer alternative found within the web front end
 
 This tool addresses several short falls that the current importer has.
 
+Reference document data import
+------------------------------
+
+WARNING: this feature is in alpha : do not use in production until this feature has been
+fully tested.
+
+In order to populate the reference document data from extracted data from an external tool
+you can use the management command ref_doc_csv_importer
+
+Example:
+
+   .. code:: sh
+
+      $ python manage.py ref_doc_csv_importer "/absolute/path/to/duties.csv" "/absolute/path/to/quotas.csv"
+
 Using the exporter
 ------------------
 

common/forms.py

@@ -249,6 +249,32 @@ def compress(self, data_list):
             return None
 
 
+class DateInputFieldTakesParameters(DateInputField):
+    def __init__(self, day, month, year, **kwargs):
+        error_messages = {
+            "required": "Enter the day, month and year",
+            "incomplete": "Enter the day, month and year",
+        }
+        fields = (day, month, year)
+
+        forms.MultiValueField.__init__(
+            self,
+            error_messages=error_messages,
+            fields=fields,
+            **kwargs,
+        )
+
+    def compress(self, data_list):
+        day, month, year = data_list or [None, None, None]
+        if day and month and year:
+            try:
+                return date(day=int(day), month=int(month), year=int(year))
+            except ValueError as e:
+                raise ValidationError(str(e).capitalize()) from e
+        else:
+            return None
+
+
 class GovukDateRangeField(DateRangeField):
     base_field = DateInputFieldFixed
 

common/jinja2/common/edit.jinja

@@ -13,7 +13,7 @@
 {% endblock %}
 
 {% block form %}
-  {% call django_form(action=object.get_url("edit")) %}
+  {% call django_form() %}
     {{ crispy(form) }}
   {% endcall %}
 {% endblock %}

common/static/common/js/addNewQuotaDefinitionForm.js

@@ -0,0 +1,55 @@
+import { removeQuotaDefinitionForm } from "./removeQuotaDefinitionForm.js"
+
+let formCounter = 1
+
+const addNewForm = (event) => {
+    event.preventDefault();
+
+    let fieldset  = document.querySelector(".quota-definition-row");
+    let formset = fieldset.parentNode;
+    let newForm = fieldset.cloneNode(true);
+
+    let new_class = "quota-definition-row-" + formCounter
+    newForm.classList.add(new_class)
+
+    newForm.innerHTML = newForm.innerHTML.replaceAll('name="volume_0"', 'name="volume_' + formCounter + '"');
+    newForm.innerHTML = newForm.innerHTML.replaceAll('name="start_date_0_0"', 'name="start_date_' + formCounter + '_0"');
+    newForm.innerHTML = newForm.innerHTML.replaceAll('name="start_date_0_1"', 'name="start_date_' + formCounter + '_1"');
+    newForm.innerHTML = newForm.innerHTML.replaceAll('name="start_date_0_2"', 'name="start_date_' + formCounter + '_2"');
+    newForm.innerHTML = newForm.innerHTML.replaceAll('name="end_date_0_0"', 'name="end_date_' + formCounter + '_0"');
+    newForm.innerHTML = newForm.innerHTML.replaceAll('name="end_date_0_1"', 'name="end_date_' + formCounter + '_1"');
+    newForm.innerHTML = newForm.innerHTML.replaceAll('name="end_date_0_2"', 'name="end_date_' + formCounter + '_2"');
+
+    let removeFormID = "form-remove_" + formCounter;
+    newForm.insertAdjacentHTML("beforeend", `<div><a id="${removeFormID}" class="govuk-link govuk-form-group remove-quota-definition" href="#" style="font-size:19px" >Remove</a><br></div>`);
+    let remove_button = newForm.lastChild
+    remove_button.addEventListener("click", removeQuotaDefinitionForm);
+
+    let formFields = newForm.querySelectorAll("input");
+    for (let field of formFields.values()) {
+      field.value = "";
+    }
+
+    let buttonGroup = document.querySelector('.govuk-button-group');
+    formset.insertBefore(newForm, buttonGroup);
+
+    let numForms = document.querySelectorAll(".quota-definition-row").length;
+
+    let addNewButton = document.querySelector("#add-new-definition");
+    addNewButton.scrollIntoView(false);
+    formCounter += 1;
+    if (numForms >= 10) {
+      addNewButton.style.display = "none";
+    }
+
+  }
+
+const initAddNewDefinition = () => {
+    const btn = document.querySelector("#add-new-definition");
+
+    if (btn) {
+      btn.addEventListener("click", addNewForm);
+    }
+  }
+
+export { initAddNewDefinition }

common/static/common/js/application.js

@@ -5,6 +5,7 @@ require.context('govuk-frontend/govuk/assets');
 import showHideCheckboxes from './showHideCheckboxes';
 import { initAutocomplete } from './autocomplete';
 import { initAutocompleteProgressiveEnhancement } from './autocompleteProgressiveEnhancement';
+import { initAddNewDefinition } from './addNewQuotaDefinitionForm';
 import { initAddNewEnhancement } from './addNewForm';
 import { initCopyToNextDuties } from './copyDuties';
 import { initAll } from 'govuk-frontend';
@@ -21,6 +22,7 @@ showHideCheckboxes();
 // Initialise accessible-autocomplete components without a `name` attr in order
 // to avoid the "dummy" autocomplete field being submitted as part of the form
 // to the server.
+initAddNewDefinition();
 initAddNewEnhancement();
 initAutocomplete(false);
 initCopyToNextDuties();

common/static/common/js/removeQuotaDefinitionForm.js

@@ -0,0 +1,19 @@
+const removeQuotaDefinitionForm = (event) => {
+    event.preventDefault();
+    let remove_id = event.target.id;
+    let remove_number = remove_id.split('_').at(-1)
+
+    let fieldset_id = 'quota-definition-row-' + remove_number
+
+    let fieldset_to_remove = document.querySelector(".quota-definition-row-" + remove_number)
+    fieldset_to_remove.remove()
+
+    let addNewButton = document.querySelector("#add-new-definition");
+    let numForms = document.querySelectorAll(".quota-definition-row").length;
+    if (numForms < 10) {
+      addNewButton.style.display = "inline"
+    }
+
+  }
+
+export { removeQuotaDefinitionForm }

common/static/common/scss/application.scss

@@ -27,6 +27,7 @@ $govuk-image-url-function: frontend-image-url;
 @import "publishing";
 @import "regulations";
 @import "workbaskets";
+@import "reference_documents";
 @import "versions";
 @import "fake-link";
 @import "violations";

pyproject.toml

@@ -97,5 +97,6 @@ norecursedirs = [
     "venv",
 ]
 markers = [
-    "importer_v2"
+    "importer_v2",
+    "reference_documents"
 ]

reference_documents/admin.py

@@ -0,0 +1 @@
+# Register your models here.

reference_documents/alignment_checks.py

@@ -0,0 +1,102 @@
+from commodities.models import GoodsNomenclature
+from geo_areas.models import GeographicalArea
+from datetime import date
+
+from commodities.models import GoodsNomenclature
+from geo_areas.models import GeographicalArea
+from geo_areas.models import GeographicalAreaDescription
+from reference_documents.models import PreferentialRate
+
+
+class BaseCheck:
+    def run_check(self):
+        raise NotImplemented("Please implement on child classes")
+
+
+class BasePreferentialRateCheck(BaseCheck):
+    def __init__(self, preferential_rate: PreferentialRate):
+        self.preferential_rate = preferential_rate
+
+    def comm_code(self):
+        goods = GoodsNomenclature.objects.latest_approved().filter(
+            item_id=self.preferential_rate.commodity_code,
+            valid_between__contains=self.ref_doc_version_eif_date(),
+            suffix=80,
+        )
+
+        if len(goods) == 0:
+            return None
+
+        return goods.first()
+
+    def geo_area(self):
+        return (
+            GeographicalArea.objects.latest_approved()
+            .filter(
+                area_id=self.preferential_rate.reference_document_version.reference_document.area_id,
+            )
+            .first()
+        )
+
+    def geo_area_description(self):
+        geo_area_desc = (
+            GeographicalAreaDescription.objects.latest_approved()
+            .filter(described_geographicalarea=self.geo_area())
+            .last()
+        )
+        return geo_area_desc.description
+
+    def ref_doc_version_eif_date(self):
+        eif_date = (
+            self.preferential_rate.reference_document_version.entry_into_force_date
+        )
+
+        # todo : make sure EIf dates are all populated correctly - and remove this
+        if eif_date is None:
+            eif_date = date.today()
+
+        return eif_date
+
+    def related_measures(self):
+        return (
+            self.comm_code()
+            .measures.latest_approved()
+            .filter(
+                geographical_area=self.geo_area(),
+                valid_between__contains=self.ref_doc_version_eif_date(),
+            )
+        )
+
+    def run_check(self):
+        raise NotImplementedError("Please implement on child classes")
+
+
+class CheckPreferentialRateCommCode(BasePreferentialRateCheck):
+    def run_check(self):
+        # comm code live on EIF date
+        if not self.comm_code():
+            print(
+                "FAIL",
+                self.preferential_rate.commodity_code,
+                self.geo_area_description(),
+                "comm code not live",
+            )
+            return False
+
+        measures = self.related_measures()
+
+        if len(measures) == 1:
+            print("PASS", self.comm_code(), self.geo_area_description())
+            return True
+
+        if len(measures) == 0:
+            print("FAIL", self.comm_code(), self.geo_area_description())
+            return False
+
+        if len(measures) > 1:
+            print(
+                "WARNING - multiple measures",
+                self.comm_code(),
+                self.geo_area_description(),
+            )
+            return True

reference_documents/apps.py

@@ -0,0 +1,5 @@
+from common.app_config import CommonConfig
+
+
+class ReferenceDocumentsConfig(CommonConfig):
+    name = "reference_documents"