TP2000-1092 reference documents v1 1 #1290

dougmills-DIT · 2024-09-12T14:08:48Z

TP2000-1092 reference documents v1 1

This work facilitates the digital creation of the data contained within reference documents, the tables of order numbers, quota definition, suspensions and preferential rates into a version of a reference document associated with a country.
Allows the versioning of a reference document as new versions are released into the public domain, for example 1.1, 1.2, 1.3 of a reference document as they are reviewed and adjusted on a yearly or ad-hoc basis.
Allows the bulk adding of preferencial quotas and quota definitions (with some limitations)
Allows the adding of a quota definition range, covering multiple quota definition periods with and a linear increment on volume
Allows the adding of a quota suspension range, covering multiple quota suspension periods
Allows a report to be ran against the reference document data and comparison with existing published TAP data, recording inconsistencies for later review.

Why

This is the first step to digitising the reference document creation process
having the facility to query and compare reference document data to live daat on TAP improves our ability to check and correct mistakes in live data.
The facility to populate and check new reference document data against existing TAP data provides a tool to improve the quality of the current process which is checked by human eyes.

What

Create and manage reference documents (associated with a geo area)
Create and manage reference document versions, with a process to review and publish data to prevent further changes.
Create and manage order numbers, quota definition, suspensions and preferential rates
Run a check against TAP data and review where differences are.
lots of testing, 96% ov lines are covered by at least one unit test

Checklist

Requires migrations? yes
Requires dependency updates? no

Links to relevant material
See: Description

…into TP2000-1186_ref_doc_data_model # Conflicts: # reference_documents/models.py # reference_documents/urls.py # reference_documents/views.py

…sion views, refactored the checks and ran the checks several times against reference document versions.

… review tabs (#1133) * Add sub-quotas nested review tab * Add quota blocking periods nested review tab * Add quota suspension periods nested review tab * Use tab title instead of model verbose name * Add blocking period and suspension period SID to table

…reports with multiple tabs (#1134)

* Add MAINTENANCE_MODE setting and middleware * Fix middleware removal and recursive redirect * Add template view and url * Add tests * Update contact us form link for other pages * Update text wording * Remove database route during maintenance * Update maintenance page template/url name --------- Co-authored-by: Dale Cannon <[email protected]>

* record seq number & message id fix * fix taricXMLRenderer, pass in value of counter

…ce-documents_v1-1

all views, forms, models, checks etc tested

…ocument versions

…v1-1' into TP2000-1092-reference-documents_v1-1

…ce-documents_v1-1 # Conflicts: # quotas/business_rules.py

…ce-documents_v1-1 # Conflicts: # reference_documents/tests/test_ref_order_number_forms.py

eadpearce · 2024-09-30T14:27:54Z

common/util.py

@@ -190,6 +190,12 @@ def overlaps(self, compared_date_range: TaricDateRange):

        return False

+    def contains(self, compared_date_range: TaricDateRange):


Could contained_date_range be used here?

eadpearce · 2024-09-30T14:29:40Z

reference_documents/check/check_runner.py

+    QuotaSuspensionChecks,
+)
+
+# import additional checks


Commented code

Oh wait I misread. Do we need this comment?

eadpearce · 2024-09-30T14:30:54Z

reference_documents/check/check_runner.py

+from reference_documents.check.base import BaseQuotaSuspensionCheck
+from reference_documents.check.base import BaseRateCheck
+from reference_documents.check.ref_order_numbers import OrderNumberChecks  # noqa
+from reference_documents.check.ref_quota_definitions import (  # noqa


These could be on one line if it's only one import in the brackets

eadpearce · 2024-09-30T14:41:35Z

reference_documents/urls.py

+from reference_documents.views.rate_views import RefRateCreate
+from reference_documents.views.rate_views import RefRateDelete
+from reference_documents.views.rate_views import RefRateEdit
+from reference_documents.views.reference_document_version_views import (


The formatting of these imports is kinda weird. Usually we don't use brackets like this

eadpearce · 2024-09-30T14:45:01Z

reference_documents/static/reference_documents/scss/_reference_documents.scss

@@ -1,3 +1,34 @@
+.check-passing {
+  color: #1d640f;


Should be using the govuk design system colours here. govuk-colour("green")

eadpearce · 2024-09-30T14:45:10Z

reference_documents/static/reference_documents/scss/_reference_documents.scss

+}
+
+.check-failing {
+  color: #671111;


govuk-colour("red")

eadpearce · 2024-09-30T14:46:12Z

reference_documents/static/reference_documents/scss/_reference_documents.scss

+}
+
+input[type=number].govuk-input--width-20 {
+  font-family: "GDS Transport", arial, sans-serif;


All this could probably be done with a class instead. What is this styling overriding?

eadpearce · 2024-09-30T14:48:31Z

reference_documents/jinja2/includes/tabs/preferential_quotas.jinja

@@ -3,44 +3,175 @@

 <div class="quota__core-data govuk-grid-row">
    <div class="quota__core-data__content govuk-grid-column-three-quarters">
-        {% for key, value in reference_document_version_quotas.items() %}
-            {% if value["quota_order_number"] != None %}
+        {% for on_ctx in order_numbers %}


What is on_ctx here?

Oh it's an OrderNumberContext instance. This abbreviation had me a bit confused

LaurenMullally and others added 30 commits November 22, 2023 10:28

Add reference_documents app

d5d6424

WIP - Templates >:(

3de7ad2

Get a template of some sort working

60a332b

Add reference document detail path and templates

6e60fba

add date filters to the get_context_data function

6bcfc51

WiP

512ff93

Rough commit - working tabs - need cleaning up

e668d14

Add button to home form

b8b73db

Add comm code links to table

93adf29

Merge branch 'master' into TP2000-1129-reference-documents-megabranch

aa67405

initial commit - ref doc data model

71da90c

initial commit - ref doc data model

eb2cd34

wip commit

1246355

Merge remote-tracking branch 'origin/TP2000-1186_ref_doc_data_model' …

2cb2cf2

…into TP2000-1186_ref_doc_data_model # Conflicts: # reference_documents/models.py # reference_documents/urls.py # reference_documents/views.py

initial commit - ref doc data model

22f444f

wip commit

d1d49cf

initial commit - ref doc data model

627ae6e

wip commit

24ede2f

wip commit

b547381

wip commit

864fc89

wip commit

a622c35

added alignment report, reference document and reference document ver…

9418199

…sion views, refactored the checks and ran the checks several times against reference document versions.

Feat: expand expiring quotas report to include tabs (#1131)

b34a5cd

feat: invoke UI changes to reports and create new URL path to handle …

38e4f01

…reports with multiple tabs (#1134)

feat: Add both CSV and excel types for charts exporting (#1136)

c861f24

Increment message id & record sequence number correctly (#1083)

ee7da3c

* record seq number & message id fix * fix taricXMLRenderer, pass in value of counter

feat: implement URLs for quota reports to ease navigation (#1135)

d7f9611

Update readme with maintenance mode instructions. (#1140)

bafbc72

dougmills-DIT and others added 19 commits July 26, 2024 12:20

testing updates

b166b5c

testing updates

c9ff0ee

testing updates

d0d01da

Merge remote-tracking branch 'origin/master' into TP2000-1092-referen…

fdba2b4

…ce-documents_v1-1

LOTS of additional tests - 96% of lines covered

c2816e7

all views, forms, models, checks etc tested

prevented checks from being performed against unpublished reference d…

5154215

…ocument versions

added duty rate checks with tests

1b13e06

added duty rate checks with tests

3cf643a

added duty rate checks with tests

a780897

updates to tests + check import

2986369

updates to tests + minor changes to UI

053437d

minor UI update and fix for poor import data in checks

713b437

removed commented out code

092848c

Merge branch 'master' into TP2000-1092-reference-documents_v1-1

8bd4de9

removed commented out code

e89539c

Merge remote-tracking branch 'origin/TP2000-1092-reference-documents_…

fa3a853

…v1-1' into TP2000-1092-reference-documents_v1-1

pre-commit hook

7ed4066

fix changes that pre-commit hooks made

b4b6ea9

Merge remote-tracking branch 'origin/master' into TP2000-1092-referen…

ff4c11c

…ce-documents_v1-1 # Conflicts: # quotas/business_rules.py

dougmills-DIT marked this pull request as ready for review September 17, 2024 07:50

dougmills-DIT requested a review from a team as a code owner September 17, 2024 07:50

Merge remote-tracking branch 'origin/master' into TP2000-1092-referen…

319ae1c

…ce-documents_v1-1 # Conflicts: # reference_documents/tests/test_ref_order_number_forms.py

eadpearce reviewed Sep 30, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TP2000-1092 reference documents v1 1 #1290

TP2000-1092 reference documents v1 1 #1290

dougmills-DIT commented Sep 12, 2024 •

edited

Loading

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

eadpearce Sep 30, 2024

		@@ -190,6 +190,12 @@ def overlaps(self, compared_date_range: TaricDateRange):

		return False

		def contains(self, compared_date_range: TaricDateRange):

TP2000-1092 reference documents v1 1 #1290

Are you sure you want to change the base?

TP2000-1092 reference documents v1 1 #1290

Conversation

dougmills-DIT commented Sep 12, 2024 • edited Loading

Why

What

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dougmills-DIT commented Sep 12, 2024 •

edited

Loading