From 3aa6830f43fe45f7d90b6791882a9bc0031403b5 Mon Sep 17 00:00:00 2001 From: Christopher Pettinga Date: Tue, 25 Feb 2025 15:11:09 +0000 Subject: [PATCH 1/5] working on link --- .../apply_for_a_licence/tasklist/__init__.py | 22 +++ .../tasklist/base_classes.py | 52 +++++ .../apply_for_a_licence/tasklist/sub_tasks.py | 185 ++++++++++++++++++ .../apply_for_a_licence/tasklist/tasks.py | 62 ++++++ .../dashboard/dashboard.html | 2 +- .../form_steps/check_your_answers.html | 16 +- .../apply_for_a_licence/tasklist.html | 49 +++++ django_app/apply_for_a_licence/urls.py | 9 +- django_app/apply_for_a_licence/utils.py | 14 +- .../views/views_documents.py | 4 +- .../views/views_existing_licence.py | 10 +- .../views/views_grounds_purpose.py | 2 +- .../views/views_individual.py | 13 +- .../views/views_recipients.py | 6 +- .../views/views_services.py | 3 +- .../apply_for_a_licence/views/views_start.py | 24 +-- .../views/views_tasklist.py | 50 +++++ .../views/views_yourself.py | 2 +- django_app/core/forms/base_forms.py | 9 +- .../core/templates/core/base_form_step.html | 2 +- django_app/core/views/base_views.py | 8 +- 21 files changed, 491 insertions(+), 53 deletions(-) create mode 100644 django_app/apply_for_a_licence/tasklist/__init__.py create mode 100644 django_app/apply_for_a_licence/tasklist/base_classes.py create mode 100644 django_app/apply_for_a_licence/tasklist/sub_tasks.py create mode 100644 django_app/apply_for_a_licence/tasklist/tasks.py create mode 100644 django_app/apply_for_a_licence/templates/apply_for_a_licence/tasklist.html create mode 100644 django_app/apply_for_a_licence/views/views_tasklist.py diff --git a/django_app/apply_for_a_licence/tasklist/__init__.py b/django_app/apply_for_a_licence/tasklist/__init__.py new file mode 100644 index 00000000..6e2ee361 --- /dev/null +++ b/django_app/apply_for_a_licence/tasklist/__init__.py @@ -0,0 +1,22 @@ +from .tasks import ( + AboutTheServicesTask, + AboutYouTask, + RecipientsTask, + ReviewAndSubmitTask, + WhoTheLicenceCoversTask, +) + + +class Tasklist: + def __init__(self, licence): + self.licence = licence + + def get_tasks(self): + tasks = [AboutYouTask(licence=self.licence)] + if self.licence.who_do_you_want_the_licence_to_cover != "myself": + tasks.append(WhoTheLicenceCoversTask(licence=self.licence)) + + tasks.append(AboutTheServicesTask(licence=self.licence)) + tasks.append(RecipientsTask(licence=self.licence)) + tasks.append(ReviewAndSubmitTask(licence=self.licence)) + return tasks diff --git a/django_app/apply_for_a_licence/tasklist/base_classes.py b/django_app/apply_for_a_licence/tasklist/base_classes.py new file mode 100644 index 00000000..a220cb82 --- /dev/null +++ b/django_app/apply_for_a_licence/tasklist/base_classes.py @@ -0,0 +1,52 @@ +from typing import Literal + + +class BaseTask: + name: str = "" + + def __init__(self, licence, *args, **kwargs): + self.licence = licence + super().__init__(*args, **kwargs) + + @property + def id(self) -> str: + return self.name.lower().replace(" ", "-") + + def get_sub_tasks(self): + raise NotImplementedError() + + def can_start_sub_task(self) -> bool: + return True + + +class BaseSubTask: + name: str = "" + help_text: str = "" + status: Literal["cannot_start", "not_started", "in_progress", "complete"] = "cannot_start" + url: str = "" + tag_colour: str = "blue" + + def __init__(self, licence, *args, **kwargs): + self.licence = licence + super().__init__(*args, **kwargs) + + @property + def id(self) -> str: + return self.name.lower().replace(" ", "-") + + @property + def should_show_tag(self) -> bool: + return self.status == "not_started" + + @property + def can_start(self) -> bool: + return self.status in ["not_started", "in_progress", "complete"] + + def get_human_readable_status(self) -> str: + status_mapping = { + "cannot_start": "Cannot start yet", + "not_started": "Not yet started", + "in_progress": "In progress", + "complete": "Complete", + } + return status_mapping[self.status] diff --git a/django_app/apply_for_a_licence/tasklist/sub_tasks.py b/django_app/apply_for_a_licence/tasklist/sub_tasks.py new file mode 100644 index 00000000..127f9d63 --- /dev/null +++ b/django_app/apply_for_a_licence/tasklist/sub_tasks.py @@ -0,0 +1,185 @@ +import uuid + +from apply_for_a_licence import choices +from apply_for_a_licence.models import Individual +from apply_for_a_licence.tasklist.base_classes import BaseSubTask +from django.urls import reverse, reverse_lazy + + +class YourDetailsSubTask(BaseSubTask): + name = "Your details" + + @property + def help_text(self): + if self.licence.who_do_you_want_the_licence_to_cover == "myself": + return "Your name and address, details of anyone else you want to add" + else: + return "" + + @property + def url(self): + if self.licence.who_do_you_want_the_licence_to_cover == "myself": + try: + applicant_individual = self.licence.individuals.filter(is_applicant=True).get() + return reverse("add_yourself", kwargs={"yourself_uuid": applicant_individual.pk}) + except Individual.DoesNotExist: + return reverse("add_yourself", kwargs={"yourself_uuid": uuid.uuid4()}) + else: + return reverse("are_you_third_party") + + @property + def status(self): + status = "not_started" + if self.licence.applicant_full_name: + status = "complete" + + return status + + +class DetailsOfTheEntityYouWantToCoverSubTask(BaseSubTask): + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.is_business = ( + self.licence.who_do_you_want_the_licence_to_cover == choices.WhoDoYouWantTheLicenceToCoverChoices.business + ) + + @property + def name(self) -> str: + if self.is_business: + return "Details of the business you want to cover" + else: + return "Details of the individual you want to cover" + + @property + def help_text(self): + if self.is_business: + return "Name and address of business" + else: + return "Name, address, business they work for" + + @property + def url(self): + if self.is_business: + if self.licence.organisations.filter(type_of_relationship=choices.TypeOfRelationshipChoices.business).exists(): + return reverse("business_added") + else: + return reverse("is_the_business_registered_with_companies_house", kwargs={"business_uuid": str(uuid.uuid4())}) + else: + if self.licence.individuals.filter(is_applicant=False).exists(): + return reverse("individual_added") + else: + return reverse("add_an_individual", kwargs={"individual_uuid": str(uuid.uuid4())}) + + @property + def status(self): + status = "not_started" + + if self.is_business: + if self.licence.organisations.filter(type_of_relationship=choices.TypeOfRelationshipChoices.business).exists(): + status = "complete" + else: + if self.licence.individuals.filter(is_applicant=False).exists(): + status = "complete" + + return status + + +class PreviousLicensesHeldSubTask(BaseSubTask): + name = "Previous licences" + help_text = "Any previous licence numbers" + url = reverse_lazy("previous_licence") + + @property + def status(self): + status = "cannot_start_yet" + if self.licence.held_existing_licence: + status = "complete" + entity_details_subtask = DetailsOfTheEntityYouWantToCoverSubTask(self.licence) + if entity_details_subtask.status == "complete": + status = "not_started" + + return status + + +class ServicesYouWantToProvideSubTask(BaseSubTask): + name = "The services you want to provide" + help_text = "Description of your services" + url = reverse_lazy("type_of_service") + + @property + def status(self): + status = "not_started" + if self.licence.type_of_service: + status = "complete" + + return status + + +class PurposeForProvidingServicesSubTask(BaseSubTask): + name = "Your purpose for providing the services" + help_text = "Licensing grounds or alignment with sanctions regulations" + + @property + def status(self): + status = "cannot_start" + if self.licence.type_of_service: + status = "not_started" + if self.licence.purpose_of_provision: + status = "complete" + + return status + + @property + def url(self): + if self.licence.type_of_service == choices.TypeOfServicesChoices.professional_and_business: + return reverse("licensing_grounds") + else: + return reverse("purpose_of_provision") + + +class UploadDocumentsSubTask(BaseSubTask): + name = "Upload documents" + help_text = "Attach files to support your application" + url = reverse_lazy("upload_documents") + + @property + def status(self): + status = "not_started" + if self.licence.documents.exists(): + status = "complete" + + return status + + +class RecipientContactDetailsSubTask(BaseSubTask): + name = "Recipient contact details" + + @property + def status(self): + status = "not_started" + if self.licence.recipients.exists(): + status = "complete" + + return status + + @property + def url(self) -> str: + if self.licence.recipients.exists(): + return reverse("recipient_added") + else: + return reverse("where_is_the_recipient_located", kwargs={"recipient_uuid": uuid.uuid4()}) + + +class CheckYourAnswersSubTask(BaseSubTask): + name = "Check your answers before you submit your application" + url = reverse_lazy("check_your_answers") + + @property + def status(self): + status = "cannot_start" + if self.licence.recipients.exists(): + status = "not_started" + if self.licence.status == "submitted": + status = "complete" + + return status diff --git a/django_app/apply_for_a_licence/tasklist/tasks.py b/django_app/apply_for_a_licence/tasklist/tasks.py new file mode 100644 index 00000000..fe45f9b7 --- /dev/null +++ b/django_app/apply_for_a_licence/tasklist/tasks.py @@ -0,0 +1,62 @@ +from apply_for_a_licence.tasklist.base_classes import BaseTask +from apply_for_a_licence.tasklist.sub_tasks import ( + CheckYourAnswersSubTask, + DetailsOfTheEntityYouWantToCoverSubTask, + PreviousLicensesHeldSubTask, + PurposeForProvidingServicesSubTask, + RecipientContactDetailsSubTask, + ServicesYouWantToProvideSubTask, + UploadDocumentsSubTask, + YourDetailsSubTask, +) + + +class AboutYouTask(BaseTask): + name = "About you" + + def get_sub_tasks(self): + sub_tasks = [YourDetailsSubTask(licence=self.licence)] + if self.licence.who_do_you_want_the_licence_to_cover == "myself": + sub_tasks.append(PreviousLicensesHeldSubTask(licence=self.licence)) + return sub_tasks + + +class WhoTheLicenceCoversTask(BaseTask): + name = "Who the licence covers" + + def get_sub_tasks(self): + sub_tasks = [ + DetailsOfTheEntityYouWantToCoverSubTask(licence=self.licence), + PreviousLicensesHeldSubTask(licence=self.licence), + ] + return sub_tasks + + +class AboutTheServicesTask(BaseTask): + name = "About the services" + + def get_sub_tasks(self): + sub_tasks = [ + ServicesYouWantToProvideSubTask(licence=self.licence), + PurposeForProvidingServicesSubTask(licence=self.licence), + UploadDocumentsSubTask(licence=self.licence), + ] + return sub_tasks + + +class RecipientsTask(BaseTask): + name = "Recipients of the services" + + def get_sub_tasks(self): + sub_tasks = [ + RecipientContactDetailsSubTask(licence=self.licence), + ] + return sub_tasks + + +class ReviewAndSubmitTask(BaseTask): + name = "Review and submit" + + def get_sub_tasks(self): + sub_tasks = [CheckYourAnswersSubTask(licence=self.licence)] + return sub_tasks diff --git a/django_app/apply_for_a_licence/templates/apply_for_a_licence/dashboard/dashboard.html b/django_app/apply_for_a_licence/templates/apply_for_a_licence/dashboard/dashboard.html index f094d0df..6485e56d 100644 --- a/django_app/apply_for_a_licence/templates/apply_for_a_licence/dashboard/dashboard.html +++ b/django_app/apply_for_a_licence/templates/apply_for_a_licence/dashboard/dashboard.html @@ -51,7 +51,7 @@

Your applications

Continue + href="{% url 'triage' licence_pk=application.pk %}">Continue
diff --git a/django_app/apply_for_a_licence/templates/apply_for_a_licence/form_steps/check_your_answers.html b/django_app/apply_for_a_licence/templates/apply_for_a_licence/form_steps/check_your_answers.html index 033ef147..947fb314 100644 --- a/django_app/apply_for_a_licence/templates/apply_for_a_licence/form_steps/check_your_answers.html +++ b/django_app/apply_for_a_licence/templates/apply_for_a_licence/form_steps/check_your_answers.html @@ -345,7 +345,7 @@

Overview of the services

{% for each in licence.get_professional_or_business_services_display %} {{ each }} {% if not forloop.last %} -
+

{% endif %} {% endfor %} @@ -360,7 +360,12 @@

Overview of the services

What is the sanctions regime?
- {{ licence.regimes | linebreaksbr }} + {% for each in licence.regimes %} + {{ each }} + {% if not forloop.last %} +

+ {% endif %} + {% endfor %}
Purpose of the services Licensing grounds for other services (not legal advisory)
- {% include "apply_for_a_licence/partials/truncated_text.html" with text=licence.get_licensing_grounds_legal_advisory_display|linebreaksbr %} + {% for each in licence.get_licensing_grounds_legal_advisory_display %} + {{ each }} + {% if not forloop.last %} +

+ {% endif %} + {% endfor %}
Task list +

Apply for a licence to provide sanctioned trade services

+ {% if licence.who_do_you_want_the_licence_to_cover == "business" %} +

You have selected to apply for a licence for a business.

+ {% elif licence.who_do_you_want_the_licence_to_cover == "individual" %} +

You have selected to apply for a licence for a named individual.

+ {% elif licence.who_do_you_want_the_licence_to_cover == "myself" %} +

You have selected to apply for a licence for yourself.

+ {% endif %} + {% for task in tasklist %} +

{{ task.name }}

+ + {% endfor %} +{% endblock column_content %} diff --git a/django_app/apply_for_a_licence/urls.py b/django_app/apply_for_a_licence/urls.py index 9a8e9309..b8b6e9ec 100644 --- a/django_app/apply_for_a_licence/urls.py +++ b/django_app/apply_for_a_licence/urls.py @@ -9,10 +9,16 @@ views_recipients, views_services, views_start, + views_tasklist, views_yourself, ) from django.urls import path +views_misc_urls = [ + path("task-list", views_tasklist.TasklistView.as_view(), name="tasklist"), + path("triage/", views_tasklist.TriageView.as_view(), name="triage"), +] + views_dashboard_urls = [ path("", views_dashboard.DashboardView.as_view(), name="dashboard"), path("new-application", views_dashboard.NewApplicationView.as_view(), name="new_application"), @@ -157,7 +163,8 @@ ] urlpatterns = ( - views_dashboard_urls + views_misc_urls + + views_dashboard_urls + views_start_urls + views_business_urls + views_individual_urls diff --git a/django_app/apply_for_a_licence/utils.py b/django_app/apply_for_a_licence/utils.py index dd5a0e67..02242fc2 100644 --- a/django_app/apply_for_a_licence/utils.py +++ b/django_app/apply_for_a_licence/utils.py @@ -1,9 +1,11 @@ from typing import TYPE_CHECKING +from apply_for_a_licence.choices import StatusChoices from django.conf import settings if TYPE_CHECKING: - from apply_for_a_licence.models import Document + from apply_for_a_licence.models import Document, Licence + from django.contrib.auth.models import User def craft_apply_for_a_licence_url(path: str) -> str: @@ -24,3 +26,13 @@ def get_active_regimes() -> list[dict[str, str]]: def get_file_s3_key(instance: "Document", filename: str) -> str: """Generate a unique S3 key for the file, with the licence ID as a prefix.""" return f"{instance.licence.pk}/{filename}" + + +def can_user_view_licence(user: "User", licence: "Licence") -> bool: + """Check if the user can view the licence application.""" + return user == licence.user + + +def can_user_edit_licence(user: "User", licence: "Licence") -> bool: + """Check if the user can edit the licence application.""" + return can_user_view_licence(user, licence) and licence.status == StatusChoices.draft diff --git a/django_app/apply_for_a_licence/views/views_documents.py b/django_app/apply_for_a_licence/views/views_documents.py index 375e7c89..3e0e1a42 100644 --- a/django_app/apply_for_a_licence/views/views_documents.py +++ b/django_app/apply_for_a_licence/views/views_documents.py @@ -22,7 +22,7 @@ class UploadDocumentsView(BaseSaveAndReturnFormView): form_class = forms.UploadDocumentsForm template_name = "apply_for_a_licence/form_steps/upload_documents.html" - success_url = reverse_lazy("check_your_answers") + success_url = reverse_lazy("tasklist") def get_context_data(self, **kwargs: object) -> dict[str, Any]: """Retrieve the already uploaded files from the session storage and add them to the context.""" @@ -79,7 +79,7 @@ def post(self, *args: object, **kwargs: object) -> HttpResponse: if licence_object.user != self.request.user: raise Http404() - if licence_object.status != StatusChoices.submitted: + if licence_object.status != StatusChoices.draft: raise Http404() document_object.delete() diff --git a/django_app/apply_for_a_licence/views/views_existing_licence.py b/django_app/apply_for_a_licence/views/views_existing_licence.py index b8fb21b4..a0e66022 100644 --- a/django_app/apply_for_a_licence/views/views_existing_licence.py +++ b/django_app/apply_for_a_licence/views/views_existing_licence.py @@ -1,10 +1,9 @@ import logging from typing import Any -from apply_for_a_licence import choices from apply_for_a_licence.forms import forms_existing_licence as forms from core.views.base_views import BaseSaveAndReturnLicenceModelFormView -from django.urls import reverse +from django.urls import reverse_lazy logger = logging.getLogger(__name__) @@ -12,12 +11,7 @@ class PreviousLicenceView(BaseSaveAndReturnLicenceModelFormView): form_class = forms.ExistingLicencesForm template_name = "apply_for_a_licence/form_steps/conditional_radios_form.html" - - def get_success_url(self) -> str: - success_url = reverse("type_of_service") - if self.instance.who_do_you_want_the_licence_to_cover == choices.WhoDoYouWantTheLicenceToCoverChoices.individual: - success_url = reverse("business_employing_individual") - return success_url + success_url = reverse_lazy("tasklist") def get_context_data(self, **kwargs: object) -> dict[str, Any]: context = super().get_context_data() diff --git a/django_app/apply_for_a_licence/views/views_grounds_purpose.py b/django_app/apply_for_a_licence/views/views_grounds_purpose.py index 3967e864..bbfea4ba 100644 --- a/django_app/apply_for_a_licence/views/views_grounds_purpose.py +++ b/django_app/apply_for_a_licence/views/views_grounds_purpose.py @@ -80,4 +80,4 @@ def get_form(self, form_class=None): class PurposeOfProvisionView(BaseSaveAndReturnLicenceModelFormView): form_class = forms.PurposeOfProvisionForm - success_url = reverse_lazy("upload_documents") + success_url = reverse_lazy("tasklist") diff --git a/django_app/apply_for_a_licence/views/views_individual.py b/django_app/apply_for_a_licence/views/views_individual.py index d1ee12c8..185a7ec3 100644 --- a/django_app/apply_for_a_licence/views/views_individual.py +++ b/django_app/apply_for_a_licence/views/views_individual.py @@ -2,6 +2,7 @@ import uuid from typing import Any, Dict, Type +from apply_for_a_licence import choices from apply_for_a_licence.choices import ( NationalityAndLocation, TypeOfRelationshipChoices, @@ -96,7 +97,7 @@ def dispatch(self, request, *args, **kwargs): # only allow access to this page if an individual has been added return super().dispatch(request, *args, **kwargs) else: - return redirect("add_an_individual", kwargs={"individual_uuid": uuid.uuid4()}) + return redirect(reverse("add_an_individual", kwargs={"individual_uuid": uuid.uuid4()})) def get_context_data(self, **kwargs) -> Dict[str, Any]: context = super().get_context_data(**kwargs) @@ -106,14 +107,18 @@ def get_context_data(self, **kwargs) -> Dict[str, Any]: def get_success_url(self): add_individual = self.form.cleaned_data["do_you_want_to_add_another_individual"] if add_individual: - return reverse("add_an_individual", kwargs={"individual_uuid": uuid.uuid4()}) + "?change=yes" + success_url = reverse("add_an_individual", kwargs={"individual_uuid": uuid.uuid4()}) + "?change=yes" + elif self.licence_object.who_do_you_want_the_licence_to_cover == choices.WhoDoYouWantTheLicenceToCoverChoices.individual: + success_url = reverse("business_employing_individual") else: - return reverse("previous_licence") + success_url = reverse("tasklist") + + return success_url class BusinessEmployingIndividualView(BaseSaveAndReturnModelFormView): form_class = forms.BusinessEmployingIndividualForm - success_url = reverse_lazy("type_of_service") + success_url = reverse_lazy("tasklist") @property def object(self) -> Organisation: diff --git a/django_app/apply_for_a_licence/views/views_recipients.py b/django_app/apply_for_a_licence/views/views_recipients.py index cec6ced4..30ea1b35 100644 --- a/django_app/apply_for_a_licence/views/views_recipients.py +++ b/django_app/apply_for_a_licence/views/views_recipients.py @@ -2,7 +2,7 @@ import uuid from typing import Type -from apply_for_a_licence.choices import TypeOfRelationshipChoices, TypeOfServicesChoices +from apply_for_a_licence.choices import TypeOfRelationshipChoices from apply_for_a_licence.forms import forms_recipients as forms from apply_for_a_licence.models import Organisation from apply_for_a_licence.views.base_views import AddAnEntityView, DeleteAnEntityView @@ -87,11 +87,13 @@ def get_success_url(self) -> str: if add_recipient: success_url = reverse("where_is_the_recipient_located", kwargs={"recipient_uuid": uuid.uuid4()}) + "?new=yes" else: + success_url = reverse("tasklist") + """ if self.licence_object.type_of_service == TypeOfServicesChoices.professional_and_business.value: success_url = reverse("licensing_grounds") else: success_url = reverse("purpose_of_provision") - + """ return success_url diff --git a/django_app/apply_for_a_licence/views/views_services.py b/django_app/apply_for_a_licence/views/views_services.py index 099b52f1..2e484df8 100644 --- a/django_app/apply_for_a_licence/views/views_services.py +++ b/django_app/apply_for_a_licence/views/views_services.py @@ -1,5 +1,4 @@ import logging -import uuid from apply_for_a_licence.choices import TypeOfServicesChoices from apply_for_a_licence.forms import forms_services as forms @@ -79,7 +78,7 @@ def redirect_after_post(self) -> bool: return True def get_success_url(self) -> str: - success_url = reverse("where_is_the_recipient_located", kwargs={"recipient_uuid": uuid.uuid4()}) + success_url = reverse("tasklist") if self.update: success_url = reverse("purpose_of_provision") diff --git a/django_app/apply_for_a_licence/views/views_start.py b/django_app/apply_for_a_licence/views/views_start.py index 488b6dbb..9b723023 100644 --- a/django_app/apply_for_a_licence/views/views_start.py +++ b/django_app/apply_for_a_licence/views/views_start.py @@ -1,10 +1,9 @@ import logging -import uuid from apply_for_a_licence.forms import forms_start as forms from core.decorators import reset_last_activity_session_timestamp from core.views.base_views import BaseSaveAndReturnLicenceModelFormView -from django.urls import reverse, reverse_lazy +from django.urls import reverse_lazy from django.utils.decorators import method_decorator logger = logging.getLogger(__name__) @@ -34,14 +33,7 @@ def get_success_url(self): @method_decorator(reset_last_activity_session_timestamp, name="dispatch") class StartView(BaseSaveAndReturnLicenceModelFormView): form_class = forms.StartForm - - def get_success_url(self) -> str | None: - answer = self.form.cleaned_data["who_do_you_want_the_licence_to_cover"] - if answer in ["business", "individual"]: - return reverse("are_you_third_party") - elif answer == "myself": - return reverse("add_yourself", kwargs={"yourself_uuid": str(uuid.uuid4())}) - return None + success_url = reverse_lazy("tasklist") class ThirdPartyView(BaseSaveAndReturnLicenceModelFormView): @@ -51,14 +43,4 @@ class ThirdPartyView(BaseSaveAndReturnLicenceModelFormView): class YourDetailsView(BaseSaveAndReturnLicenceModelFormView): form_class = forms.YourDetailsForm - - def get_success_url(self): - if self.instance.who_do_you_want_the_licence_to_cover == "business": - return reverse("is_the_business_registered_with_companies_house", kwargs={"business_uuid": str(uuid.uuid4())}) - else: - return reverse( - "add_an_individual", - kwargs={ - "individual_uuid": str(uuid.uuid4()), - }, - ) + success_url = reverse_lazy("tasklist") diff --git a/django_app/apply_for_a_licence/views/views_tasklist.py b/django_app/apply_for_a_licence/views/views_tasklist.py new file mode 100644 index 00000000..44743428 --- /dev/null +++ b/django_app/apply_for_a_licence/views/views_tasklist.py @@ -0,0 +1,50 @@ +from typing import Literal, TypedDict + +from apply_for_a_licence.models import Licence +from apply_for_a_licence.tasklist import Tasklist +from apply_for_a_licence.utils import can_user_edit_licence +from core.views.base_views import BaseSaveAndReturnView, BaseView +from django.core.exceptions import SuspiciousOperation +from django.shortcuts import get_object_or_404, redirect +from django.urls import reverse +from django.views.generic import TemplateView + + +class SubTask(TypedDict): + name: str + help_text: str + status: Literal["complete", "incomplete"] + url: str + + +class Task(TypedDict): + title: str + sub_tasks: list[SubTask] + + +class TriageView(BaseView): + """Triage view to take users to where they need to be. + + Checks that the licence belongs to them and that they can edit it. If so assign the PK to the session + so that the user can continue to the tasklist and subsequent views.""" + + def dispatch(self, request, *args, **kwargs): + licence_object = get_object_or_404(Licence, pk=kwargs["licence_pk"]) + if can_user_edit_licence(request.user, licence_object): + request.session["licence_id"] = licence_object.pk + return redirect(reverse("tasklist")) + else: + raise SuspiciousOperation("User does not have permission to edit this licence") + + +class TasklistView(BaseSaveAndReturnView, TemplateView): + template_name = "apply_for_a_licence/tasklist.html" + + def get_context_data(self, **kwargs): + context = super().get_context_data(**kwargs) + licence = self.licence_object + tasklist = Tasklist(licence).get_tasks() + + context["tasklist"] = tasklist + context["licence"] = licence + return context diff --git a/django_app/apply_for_a_licence/views/views_yourself.py b/django_app/apply_for_a_licence/views/views_yourself.py index 08f61ebc..9001edb2 100644 --- a/django_app/apply_for_a_licence/views/views_yourself.py +++ b/django_app/apply_for_a_licence/views/views_yourself.py @@ -114,7 +114,7 @@ def get_success_url(self): + "?change=yes" ) else: - return reverse("previous_licence") + return reverse("tasklist") class DeleteIndividualFromYourselfView(DeleteAnEntityView): diff --git a/django_app/core/forms/base_forms.py b/django_app/core/forms/base_forms.py index 4569f526..7b4fab58 100644 --- a/django_app/core/forms/base_forms.py +++ b/django_app/core/forms/base_forms.py @@ -2,9 +2,10 @@ from typing import Any, List from crispy_forms_gds.helper import FormHelper -from crispy_forms_gds.layout import Layout, Size, Submit +from crispy_forms_gds.layout import HTML, Layout, Size, Submit from django import forms from django.http import HttpRequest +from django.urls import reverse from utils.companies_house import get_formatted_address @@ -55,7 +56,11 @@ def __init__(self, *args: object, **kwargs) -> None: if self.bold_labels: self.helper.label_size = Size.LARGE - self.helper.layout = Layout(*self.fields) + skip_link_html = HTML( + f"Skip for now and return to task list" + ) + self.helper.layout = Layout(*self.fields, skip_link_html) # clearing the form data if 'change' is passed as a query parameter, and it's a GET request if self.request and self.request.method == "GET" and (self.request.GET.get("change") or self.request.GET.get("update")): diff --git a/django_app/core/templates/core/base_form_step.html b/django_app/core/templates/core/base_form_step.html index 7aea8364..79f24576 100644 --- a/django_app/core/templates/core/base_form_step.html +++ b/django_app/core/templates/core/base_form_step.html @@ -26,7 +26,7 @@

{{ form.form_h1_header }}

{% csrf_token %} {% block form_content %} {% crispy form %} - + Skip for now and return to task list {% endblock form_content %} {% endblock column_content %} diff --git a/django_app/core/views/base_views.py b/django_app/core/views/base_views.py index b6a6dcf9..624fe59b 100644 --- a/django_app/core/views/base_views.py +++ b/django_app/core/views/base_views.py @@ -1,6 +1,7 @@ import datetime from apply_for_a_licence.models import Licence +from apply_for_a_licence.utils import can_user_edit_licence from authentication.mixins import LoginRequiredMixin from core.forms.base_forms import BaseForm, BaseModelForm from django.conf import settings @@ -28,10 +29,11 @@ def licence_object(self) -> Licence | None: if licence_id := self.request.session.get("licence_id"): try: licence = Licence.objects.get(pk=licence_id) - if licence.user != self.request.user: + if not can_user_edit_licence(self.request.user, licence): raise Http404() - self._licence_object = licence - return licence + else: + self._licence_object = licence + return licence except Licence.DoesNotExist: return None else: From 72049cef40d1556bd1003d084390fe60047ab0e0 Mon Sep 17 00:00:00 2001 From: Christopher Pettinga Date: Thu, 27 Feb 2025 10:03:16 +0000 Subject: [PATCH 2/5] Adding draft status to entities --- django_app/apply_for_a_licence/choices.py | 5 +++ ...25_historicalindividual_status_and_more.py | 33 +++++++++++++++++++ django_app/apply_for_a_licence/models.py | 6 ++++ .../apply_for_a_licence/tasklist/__init__.py | 4 +++ .../tasklist/base_classes.py | 11 +++++-- .../apply_for_a_licence/tasklist/sub_tasks.py | 19 ++++++++--- .../apply_for_a_licence/tasklist/tasks.py | 9 ++++- .../views/views_individual.py | 28 +++++++++++++--- django_app/core/forms/base_forms.py | 10 +++--- .../core/static/core/stylesheets/common.css | 12 +++++++ .../core/templates/core/base_form_step.html | 1 - django_app/core/views/base_views.py | 6 ++++ 12 files changed, 124 insertions(+), 20 deletions(-) create mode 100644 django_app/apply_for_a_licence/migrations/0025_historicalindividual_status_and_more.py diff --git a/django_app/apply_for_a_licence/choices.py b/django_app/apply_for_a_licence/choices.py index e8b7ea40..2a0e11b4 100644 --- a/django_app/apply_for_a_licence/choices.py +++ b/django_app/apply_for_a_licence/choices.py @@ -122,6 +122,11 @@ class StatusChoices(models.TextChoices): submitted = "submitted", "Submitted" +class EntityStatusChoices(models.TextChoices): + draft = "draft", "Draft" + complete = "complete", "Complete" + + class WhereIsTheAddressChoices(models.TextChoices): outside_uk = "outside-uk", "Outside the UK" in_uk = "in-uk", "In the UK" diff --git a/django_app/apply_for_a_licence/migrations/0025_historicalindividual_status_and_more.py b/django_app/apply_for_a_licence/migrations/0025_historicalindividual_status_and_more.py new file mode 100644 index 00000000..5522ee01 --- /dev/null +++ b/django_app/apply_for_a_licence/migrations/0025_historicalindividual_status_and_more.py @@ -0,0 +1,33 @@ +# Generated by Django 4.2.19 on 2025-02-26 16:00 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ("apply_for_a_licence", "0024_historicalindividual_is_applicant_and_more"), + ] + + operations = [ + migrations.AddField( + model_name="historicalindividual", + name="status", + field=models.CharField(choices=[("draft", "Draft"), ("complete", "Complete")], default="draft", max_length=10), + ), + migrations.AddField( + model_name="historicalorganisation", + name="status", + field=models.CharField(choices=[("draft", "Draft"), ("complete", "Complete")], default="draft", max_length=10), + ), + migrations.AddField( + model_name="individual", + name="status", + field=models.CharField(choices=[("draft", "Draft"), ("complete", "Complete")], default="draft", max_length=10), + ), + migrations.AddField( + model_name="organisation", + name="status", + field=models.CharField(choices=[("draft", "Draft"), ("complete", "Complete")], default="draft", max_length=10), + ), + ] diff --git a/django_app/apply_for_a_licence/models.py b/django_app/apply_for_a_licence/models.py index 7472a617..cad8228f 100644 --- a/django_app/apply_for_a_licence/models.py +++ b/django_app/apply_for_a_licence/models.py @@ -187,6 +187,9 @@ class Meta: relationship_provider = models.TextField( blank=False, null=True, db_comment="what is the relationship between the provider and the recipient?" ) + status = models.CharField( + max_length=10, choices=choices.EntityStatusChoices.choices, default=choices.EntityStatusChoices.draft + ) def readable_address(self) -> str: """If we have registered_office_address, use that instead of the address fields""" @@ -219,6 +222,9 @@ class Individual(BaseModelID, AddressMixin): blank=True, null=True, db_comment="what is the relationship between the provider and the recipient?" ) is_applicant = models.BooleanField(default=False) + status = models.CharField( + max_length=10, choices=choices.EntityStatusChoices.choices, default=choices.EntityStatusChoices.draft + ) @property def full_name(self) -> str: diff --git a/django_app/apply_for_a_licence/tasklist/__init__.py b/django_app/apply_for_a_licence/tasklist/__init__.py index 6e2ee361..f313fadb 100644 --- a/django_app/apply_for_a_licence/tasklist/__init__.py +++ b/django_app/apply_for_a_licence/tasklist/__init__.py @@ -3,6 +3,7 @@ AboutYouTask, RecipientsTask, ReviewAndSubmitTask, + UploadDocumentsTask, WhoTheLicenceCoversTask, ) @@ -17,6 +18,9 @@ def get_tasks(self): tasks.append(WhoTheLicenceCoversTask(licence=self.licence)) tasks.append(AboutTheServicesTask(licence=self.licence)) + tasks.append(RecipientsTask(licence=self.licence)) + tasks.append(UploadDocumentsTask(licence=self.licence)) + tasks.append(ReviewAndSubmitTask(licence=self.licence)) return tasks diff --git a/django_app/apply_for_a_licence/tasklist/base_classes.py b/django_app/apply_for_a_licence/tasklist/base_classes.py index a220cb82..1320a0b7 100644 --- a/django_app/apply_for_a_licence/tasklist/base_classes.py +++ b/django_app/apply_for_a_licence/tasklist/base_classes.py @@ -24,19 +24,26 @@ class BaseSubTask: help_text: str = "" status: Literal["cannot_start", "not_started", "in_progress", "complete"] = "cannot_start" url: str = "" - tag_colour: str = "blue" def __init__(self, licence, *args, **kwargs): self.licence = licence super().__init__(*args, **kwargs) + @property + def tag_colour(self) -> str: + if self.status == "in_progress": + return "light-blue" + elif self.status == "cannot_start": + return "blue" + return "blue" + @property def id(self) -> str: return self.name.lower().replace(" ", "-") @property def should_show_tag(self) -> bool: - return self.status == "not_started" + return self.status in ["not_started", "in_progress"] @property def can_start(self) -> bool: diff --git a/django_app/apply_for_a_licence/tasklist/sub_tasks.py b/django_app/apply_for_a_licence/tasklist/sub_tasks.py index 127f9d63..f2da7139 100644 --- a/django_app/apply_for_a_licence/tasklist/sub_tasks.py +++ b/django_app/apply_for_a_licence/tasklist/sub_tasks.py @@ -73,12 +73,21 @@ def url(self): @property def status(self): status = "not_started" - if self.is_business: - if self.licence.organisations.filter(type_of_relationship=choices.TypeOfRelationshipChoices.business).exists(): - status = "complete" + entity_qs = self.licence.organisations.filter(type_of_relationship=choices.TypeOfRelationshipChoices.business) + else: - if self.licence.individuals.filter(is_applicant=False).exists(): + entity_qs = self.licence.individuals.filter(is_applicant=False) + + # checking if any draft entities have been created but not completed yet + if entity_qs.filter(status="draft").exists(): + status = "in_progress" + elif entity_qs.filter(status="complete").exists(): + # checking if the business the individual(s) work for exists, only then are we complete + if self.licence.organisations.filter( + type_of_relationship=choices.TypeOfRelationshipChoices.named_individuals, + status=choices.EntityStatusChoices.complete, + ).exists(): status = "complete" return status @@ -91,7 +100,7 @@ class PreviousLicensesHeldSubTask(BaseSubTask): @property def status(self): - status = "cannot_start_yet" + status = "cannot_start" if self.licence.held_existing_licence: status = "complete" entity_details_subtask = DetailsOfTheEntityYouWantToCoverSubTask(self.licence) diff --git a/django_app/apply_for_a_licence/tasklist/tasks.py b/django_app/apply_for_a_licence/tasklist/tasks.py index fe45f9b7..5f64c3fd 100644 --- a/django_app/apply_for_a_licence/tasklist/tasks.py +++ b/django_app/apply_for_a_licence/tasklist/tasks.py @@ -39,7 +39,6 @@ def get_sub_tasks(self): sub_tasks = [ ServicesYouWantToProvideSubTask(licence=self.licence), PurposeForProvidingServicesSubTask(licence=self.licence), - UploadDocumentsSubTask(licence=self.licence), ] return sub_tasks @@ -60,3 +59,11 @@ class ReviewAndSubmitTask(BaseTask): def get_sub_tasks(self): sub_tasks = [CheckYourAnswersSubTask(licence=self.licence)] return sub_tasks + + +class UploadDocumentsTask(BaseTask): + name = "Upload documents" + + def get_sub_tasks(self): + sub_tasks = [UploadDocumentsSubTask(licence=self.licence)] + return sub_tasks diff --git a/django_app/apply_for_a_licence/views/views_individual.py b/django_app/apply_for_a_licence/views/views_individual.py index 185a7ec3..c7a376e8 100644 --- a/django_app/apply_for_a_licence/views/views_individual.py +++ b/django_app/apply_for_a_licence/views/views_individual.py @@ -34,7 +34,10 @@ class AddAnIndividualView(BaseIndividualFormView): redirect_with_query_parameters = True def dispatch(self, request, *args, **kwargs): - Individual.objects.get_or_create(pk=self.kwargs["individual_uuid"], defaults={"licence": self.licence_object}) + Individual.objects.get_or_create( + pk=self.kwargs["individual_uuid"], + defaults={"licence": self.licence_object, "status": choices.EntityStatusChoices.draft}, + ) return super().dispatch(request, *args, **kwargs) def get_success_url(self): @@ -83,6 +86,13 @@ def get_success_url(self): success_url = reverse("yourself_and_individual_added") return success_url + def save_form(self, form): + instance = form.save(commit=False) + # the individual should now be marked as 'complete' + instance.status = choices.EntityStatusChoices.complete + instance.save() + return instance + class IndividualAddedView(BaseSaveAndReturnFormView): form_class = forms.IndividualAddedForm @@ -123,17 +133,25 @@ class BusinessEmployingIndividualView(BaseSaveAndReturnModelFormView): @property def object(self) -> Organisation: instance, _ = Organisation.objects.get_or_create( - licence=self.licence_object, type_of_relationship=TypeOfRelationshipChoices.named_individuals + licence=self.licence_object, + type_of_relationship=TypeOfRelationshipChoices.named_individuals, + defaults={"status": choices.EntityStatusChoices.draft}, ) return instance def get_form_kwargs(self): kwargs = super().get_form_kwargs() - if Individual.objects.filter(licence=self.licence_object).count() == 1: - kwargs["form_h1_header"] = "Details of the business employing the individual" - else: + if Individual.objects.filter(licence=self.licence_object).count() > 1: kwargs["form_h1_header"] = "Details of the business employing the individuals" + else: + kwargs["form_h1_header"] = "Details of the business employing the individual" kwargs["instance"] = self.object return kwargs + + def save_form(self, form): + instance = form.save(commit=False) + instance.status = choices.EntityStatusChoices.complete + instance.save() + return instance diff --git a/django_app/core/forms/base_forms.py b/django_app/core/forms/base_forms.py index 7b4fab58..79be96f7 100644 --- a/django_app/core/forms/base_forms.py +++ b/django_app/core/forms/base_forms.py @@ -2,10 +2,9 @@ from typing import Any, List from crispy_forms_gds.helper import FormHelper -from crispy_forms_gds.layout import HTML, Layout, Size, Submit +from crispy_forms_gds.layout import Layout, Size, Submit from django import forms from django.http import HttpRequest -from django.urls import reverse from utils.companies_house import get_formatted_address @@ -56,11 +55,10 @@ def __init__(self, *args: object, **kwargs) -> None: if self.bold_labels: self.helper.label_size = Size.LARGE - skip_link_html = HTML( - f"Skip for now and return to task list" + self.helper.add_input( + Submit("skip_link", "Skip for now and return to task list", css_class="govuk-button govuk-button--secondary ml-2") ) - self.helper.layout = Layout(*self.fields, skip_link_html) + self.helper.layout = Layout(*self.fields) # clearing the form data if 'change' is passed as a query parameter, and it's a GET request if self.request and self.request.method == "GET" and (self.request.GET.get("change") or self.request.GET.get("update")): diff --git a/django_app/core/static/core/stylesheets/common.css b/django_app/core/static/core/stylesheets/common.css index 7feefa20..d0c4531b 100644 --- a/django_app/core/static/core/stylesheets/common.css +++ b/django_app/core/static/core/stylesheets/common.css @@ -39,6 +39,18 @@ margin-bottom: 1rem; } +.ml-1 { + margin-left: 1rem; +} + +.ml-2 { + margin-left: 2rem; +} + +.ml-3 { + margin-left: 3rem; +} + .button-that-looks-like-link, .remove-button-that-looks-like-link { background: none !important; border: none; diff --git a/django_app/core/templates/core/base_form_step.html b/django_app/core/templates/core/base_form_step.html index 79f24576..1deb511e 100644 --- a/django_app/core/templates/core/base_form_step.html +++ b/django_app/core/templates/core/base_form_step.html @@ -26,7 +26,6 @@

{{ form.form_h1_header }}

{% csrf_token %} {% block form_content %} {% crispy form %} - Skip for now and return to task list {% endblock form_content %} {% endblock column_content %} diff --git a/django_app/core/views/base_views.py b/django_app/core/views/base_views.py index 624fe59b..1e1c0363 100644 --- a/django_app/core/views/base_views.py +++ b/django_app/core/views/base_views.py @@ -69,6 +69,12 @@ def dispatch(self, request, *args, **kwargs): request.session[settings.SESSION_LAST_ACTIVITY_KEY] = timezone.now().isoformat() return super().dispatch(request, *args, **kwargs) + def post(self, request, *args, **kwargs): + if self.request.POST.get("skip_link"): + return HttpResponseRedirect(reverse("tasklist")) + else: + return super().post(request, *args, **kwargs) + def get_form(self, form_class: BaseForm | None = None) -> BaseForm: form = super().get_form(form_class) self.form = form From eb602503b43f3fd842027e46efa00f18eac32969 Mon Sep 17 00:00:00 2001 From: Christopher Pettinga Date: Thu, 27 Feb 2025 17:51:10 +0000 Subject: [PATCH 3/5] Fixing task list status stuff --- .../apply_for_a_licence/forms/forms_start.py | 2 + .../apply_for_a_licence/tasklist/__init__.py | 13 ++- .../tasklist/base_classes.py | 62 ++++++++---- .../apply_for_a_licence/tasklist/sub_tasks.py | 95 ++++++------------- .../apply_for_a_licence/tasklist/tasks.py | 64 +++++++------ .../apply_for_a_licence/tasklist.html | 87 +++++++++-------- .../views/views_business.py | 9 +- .../views/views_recipients.py | 7 ++ .../views/views_tasklist.py | 14 --- .../views/views_yourself.py | 7 ++ django_app/core/forms/base_forms.py | 8 +- 11 files changed, 191 insertions(+), 177 deletions(-) diff --git a/django_app/apply_for_a_licence/forms/forms_start.py b/django_app/apply_for_a_licence/forms/forms_start.py index 3c2d1a9a..861cabf1 100644 --- a/django_app/apply_for_a_licence/forms/forms_start.py +++ b/django_app/apply_for_a_licence/forms/forms_start.py @@ -17,6 +17,7 @@ class Meta: form_h1_header = "Give your application a name" bold_labels = False save_and_return = True + show_skip_button = False def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) @@ -28,6 +29,7 @@ def __init__(self, *args, **kwargs): class StartForm(BaseModelForm): save_and_return = True + show_skip_button = False class Meta: model = Licence diff --git a/django_app/apply_for_a_licence/tasklist/__init__.py b/django_app/apply_for_a_licence/tasklist/__init__.py index f313fadb..54083c1c 100644 --- a/django_app/apply_for_a_licence/tasklist/__init__.py +++ b/django_app/apply_for_a_licence/tasklist/__init__.py @@ -1,3 +1,4 @@ +from .sub_tasks import UploadDocumentsSubTask from .tasks import ( AboutTheServicesTask, AboutYouTask, @@ -22,5 +23,15 @@ def get_tasks(self): tasks.append(RecipientsTask(licence=self.licence)) tasks.append(UploadDocumentsTask(licence=self.licence)) - tasks.append(ReviewAndSubmitTask(licence=self.licence)) + # now we need to get the status of each of the sub-tasks so we can figure out if the user is allowed to start + # the CYA. Basically they should all be complete apart from UploadDocuments because that is optional. + + # note - this code is messy, hard to understand, and resource-wasteful. + # Please consider optimising I'm sure it can be done better + all_sub_tasks = [sub_task for task in tasks for sub_task in task.get_sub_tasks()] + if all([sub_task.is_completed for sub_task in all_sub_tasks if not isinstance(sub_task, UploadDocumentsSubTask)]): + can_go_to_cya = True + else: + can_go_to_cya = False + tasks.append(ReviewAndSubmitTask(licence=self.licence, can_go_to_cya=can_go_to_cya)) return tasks diff --git a/django_app/apply_for_a_licence/tasklist/base_classes.py b/django_app/apply_for_a_licence/tasklist/base_classes.py index 1320a0b7..7169e96a 100644 --- a/django_app/apply_for_a_licence/tasklist/base_classes.py +++ b/django_app/apply_for_a_licence/tasklist/base_classes.py @@ -1,22 +1,6 @@ -from typing import Literal +from typing import Literal, Type - -class BaseTask: - name: str = "" - - def __init__(self, licence, *args, **kwargs): - self.licence = licence - super().__init__(*args, **kwargs) - - @property - def id(self) -> str: - return self.name.lower().replace(" ", "-") - - def get_sub_tasks(self): - raise NotImplementedError() - - def can_start_sub_task(self) -> bool: - return True +from apply_for_a_licence.models import Licence class BaseSubTask: @@ -26,9 +10,13 @@ class BaseSubTask: url: str = "" def __init__(self, licence, *args, **kwargs): - self.licence = licence + self.licence: Licence = licence super().__init__(*args, **kwargs) + @property + def is_completed(self) -> bool: + return False + @property def tag_colour(self) -> str: if self.status == "in_progress": @@ -57,3 +45,39 @@ def get_human_readable_status(self) -> str: "complete": "Complete", } return status_mapping[self.status] + + +class BaseTask: + name: str = "" + sub_tasks: list[Type[BaseSubTask]] = [] + + def __init__(self, licence, *args, **kwargs): + self.licence: Licence = licence + super().__init__(*args, **kwargs) + + @property + def id(self) -> str: + return self.name.lower().replace(" ", "-") + + def get_sub_tasks(self) -> list[BaseSubTask]: + """Gets an instantiated list of subtasks whilst also setting their status correctly. + + If the previous sub-task has been completed, we can assume the next one is ready to start. + """ + sub_tasks = [each(self.licence) for each in self.sub_tasks] + for index, each in enumerate(sub_tasks): + if each.is_completed: + each.status = "complete" + continue + + if index == 0: + previous_task_completed = True + else: + previous_task_completed = sub_tasks[index - 1].is_completed + + if previous_task_completed: + each.status = "not_started" + else: + each.status = "cannot_start" + + return sub_tasks diff --git a/django_app/apply_for_a_licence/tasklist/sub_tasks.py b/django_app/apply_for_a_licence/tasklist/sub_tasks.py index f2da7139..df58afcf 100644 --- a/django_app/apply_for_a_licence/tasklist/sub_tasks.py +++ b/django_app/apply_for_a_licence/tasklist/sub_tasks.py @@ -28,12 +28,8 @@ def url(self): return reverse("are_you_third_party") @property - def status(self): - status = "not_started" - if self.licence.applicant_full_name: - status = "complete" - - return status + def is_completed(self): + return bool(self.licence.applicant_full_name) class DetailsOfTheEntityYouWantToCoverSubTask(BaseSubTask): @@ -71,26 +67,17 @@ def url(self): return reverse("add_an_individual", kwargs={"individual_uuid": str(uuid.uuid4())}) @property - def status(self): - status = "not_started" - if self.is_business: - entity_qs = self.licence.organisations.filter(type_of_relationship=choices.TypeOfRelationshipChoices.business) - + def is_completed(self) -> bool: + if self.licence.who_do_you_want_the_licence_to_cover == choices.WhoDoYouWantTheLicenceToCoverChoices.business: + return self.licence.organisations.filter( + type_of_relationship=choices.TypeOfRelationshipChoices.business, status="complete" + ).exists() + elif self.licence.who_do_you_want_the_licence_to_cover == choices.WhoDoYouWantTheLicenceToCoverChoices.individual: + return self.licence.individuals.filter(is_applicant=False, status="complete").exists() + elif self.licence.who_do_you_want_the_licence_to_cover == choices.WhoDoYouWantTheLicenceToCoverChoices.myself: + return self.licence.individuals.filter(is_applicant=True, status="complete").exists() else: - entity_qs = self.licence.individuals.filter(is_applicant=False) - - # checking if any draft entities have been created but not completed yet - if entity_qs.filter(status="draft").exists(): - status = "in_progress" - elif entity_qs.filter(status="complete").exists(): - # checking if the business the individual(s) work for exists, only then are we complete - if self.licence.organisations.filter( - type_of_relationship=choices.TypeOfRelationshipChoices.named_individuals, - status=choices.EntityStatusChoices.complete, - ).exists(): - status = "complete" - - return status + return False class PreviousLicensesHeldSubTask(BaseSubTask): @@ -99,15 +86,8 @@ class PreviousLicensesHeldSubTask(BaseSubTask): url = reverse_lazy("previous_licence") @property - def status(self): - status = "cannot_start" - if self.licence.held_existing_licence: - status = "complete" - entity_details_subtask = DetailsOfTheEntityYouWantToCoverSubTask(self.licence) - if entity_details_subtask.status == "complete": - status = "not_started" - - return status + def is_completed(self): + return bool(self.licence.held_existing_licence) class ServicesYouWantToProvideSubTask(BaseSubTask): @@ -116,12 +96,8 @@ class ServicesYouWantToProvideSubTask(BaseSubTask): url = reverse_lazy("type_of_service") @property - def status(self): - status = "not_started" - if self.licence.type_of_service: - status = "complete" - - return status + def is_completed(self) -> bool: + return bool(self.licence.type_of_service) class PurposeForProvidingServicesSubTask(BaseSubTask): @@ -129,14 +105,8 @@ class PurposeForProvidingServicesSubTask(BaseSubTask): help_text = "Licensing grounds or alignment with sanctions regulations" @property - def status(self): - status = "cannot_start" - if self.licence.type_of_service: - status = "not_started" - if self.licence.purpose_of_provision: - status = "complete" - - return status + def is_completed(self): + return bool(self.licence.purpose_of_provision) @property def url(self): @@ -152,24 +122,16 @@ class UploadDocumentsSubTask(BaseSubTask): url = reverse_lazy("upload_documents") @property - def status(self): - status = "not_started" - if self.licence.documents.exists(): - status = "complete" - - return status + def is_completed(self) -> bool: + return self.licence.documents.exists() class RecipientContactDetailsSubTask(BaseSubTask): name = "Recipient contact details" @property - def status(self): - status = "not_started" - if self.licence.recipients.exists(): - status = "complete" - - return status + def is_completed(self) -> bool: + return self.licence.recipients.filter(status=choices.EntityStatusChoices.complete).exists() @property def url(self) -> str: @@ -184,11 +146,10 @@ class CheckYourAnswersSubTask(BaseSubTask): url = reverse_lazy("check_your_answers") @property - def status(self): - status = "cannot_start" - if self.licence.recipients.exists(): - status = "not_started" - if self.licence.status == "submitted": - status = "complete" + def ready_to_start(self) -> bool: + # we can start the CYA the moment they've added recipients + return self.licence.recipients.filter(status=choices.EntityStatusChoices.complete).exists() - return status + @property + def is_completed(self) -> bool: + return self.licence.status == choices.StatusChoices.submitted diff --git a/django_app/apply_for_a_licence/tasklist/tasks.py b/django_app/apply_for_a_licence/tasklist/tasks.py index 5f64c3fd..acf9a60d 100644 --- a/django_app/apply_for_a_licence/tasklist/tasks.py +++ b/django_app/apply_for_a_licence/tasklist/tasks.py @@ -1,4 +1,4 @@ -from apply_for_a_licence.tasklist.base_classes import BaseTask +from apply_for_a_licence.tasklist.base_classes import BaseSubTask, BaseTask from apply_for_a_licence.tasklist.sub_tasks import ( CheckYourAnswersSubTask, DetailsOfTheEntityYouWantToCoverSubTask, @@ -14,56 +14,60 @@ class AboutYouTask(BaseTask): name = "About you" - def get_sub_tasks(self): - sub_tasks = [YourDetailsSubTask(licence=self.licence)] + @property + def sub_tasks(self): + sub_tasks = [YourDetailsSubTask] if self.licence.who_do_you_want_the_licence_to_cover == "myself": - sub_tasks.append(PreviousLicensesHeldSubTask(licence=self.licence)) + sub_tasks.append(PreviousLicensesHeldSubTask) return sub_tasks class WhoTheLicenceCoversTask(BaseTask): name = "Who the licence covers" - - def get_sub_tasks(self): - sub_tasks = [ - DetailsOfTheEntityYouWantToCoverSubTask(licence=self.licence), - PreviousLicensesHeldSubTask(licence=self.licence), - ] - return sub_tasks + sub_tasks = [ + DetailsOfTheEntityYouWantToCoverSubTask, + PreviousLicensesHeldSubTask, + ] class AboutTheServicesTask(BaseTask): name = "About the services" - - def get_sub_tasks(self): - sub_tasks = [ - ServicesYouWantToProvideSubTask(licence=self.licence), - PurposeForProvidingServicesSubTask(licence=self.licence), - ] - return sub_tasks + sub_tasks = [ + ServicesYouWantToProvideSubTask, + PurposeForProvidingServicesSubTask, + ] class RecipientsTask(BaseTask): name = "Recipients of the services" - - def get_sub_tasks(self): - sub_tasks = [ - RecipientContactDetailsSubTask(licence=self.licence), - ] - return sub_tasks + sub_tasks = [ + RecipientContactDetailsSubTask, + ] class ReviewAndSubmitTask(BaseTask): name = "Review and submit" + sub_tasks = [ + CheckYourAnswersSubTask, + ] + + def __init__(self, can_go_to_cya: bool, *args, **kwargs): + self.can_go_to_cya = can_go_to_cya + super().__init__(*args, **kwargs) + + def get_sub_tasks(self) -> list[BaseSubTask]: + sub_tasks = super().get_sub_tasks() + for each in sub_tasks: + if self.can_go_to_cya: + each.status = "not_started" + else: + each.status = "cannot_start" - def get_sub_tasks(self): - sub_tasks = [CheckYourAnswersSubTask(licence=self.licence)] return sub_tasks class UploadDocumentsTask(BaseTask): name = "Upload documents" - - def get_sub_tasks(self): - sub_tasks = [UploadDocumentsSubTask(licence=self.licence)] - return sub_tasks + sub_tasks = [ + UploadDocumentsSubTask, + ] diff --git a/django_app/apply_for_a_licence/templates/apply_for_a_licence/tasklist.html b/django_app/apply_for_a_licence/templates/apply_for_a_licence/tasklist.html index 3c650152..16fccf96 100644 --- a/django_app/apply_for_a_licence/templates/apply_for_a_licence/tasklist.html +++ b/django_app/apply_for_a_licence/templates/apply_for_a_licence/tasklist.html @@ -4,46 +4,49 @@ {% block title %}Apply for a licence to provide sanctioned trade services{% endblock title %} -{% block column_content %} - Task list -

Apply for a licence to provide sanctioned trade services

- {% if licence.who_do_you_want_the_licence_to_cover == "business" %} -

You have selected to apply for a licence for a business.

- {% elif licence.who_do_you_want_the_licence_to_cover == "individual" %} -

You have selected to apply for a licence for a named individual.

- {% elif licence.who_do_you_want_the_licence_to_cover == "myself" %} -

You have selected to apply for a licence for yourself.

- {% endif %} - {% for task in tasklist %} -

{{ task.name }}

- + {% endfor %} +
+{% endblock row_content %} diff --git a/django_app/apply_for_a_licence/views/views_business.py b/django_app/apply_for_a_licence/views/views_business.py index 316a940d..0ccd443e 100644 --- a/django_app/apply_for_a_licence/views/views_business.py +++ b/django_app/apply_for_a_licence/views/views_business.py @@ -2,6 +2,7 @@ import uuid from typing import Any, Dict +from apply_for_a_licence import choices from apply_for_a_licence.choices import TypeOfRelationshipChoices from apply_for_a_licence.forms import forms_business as forms from apply_for_a_licence.models import Organisation @@ -64,7 +65,7 @@ def get_success_url(self) -> str: reverse("is_the_business_registered_with_companies_house", kwargs={"business_uuid": uuid.uuid4()}) + "?change=yes" ) else: - return reverse("previous_licence") + return reverse("tasklist") def get_context_data(self, **kwargs) -> Dict[str, Any]: context = super().get_context_data(**kwargs) @@ -157,6 +158,12 @@ class CheckCompanyDetailsView(BaseBusinessModelFormView): success_url = reverse_lazy("business_added") form_class = forms.CheckCompanyDetailsForm + def save_form(self, form): + instance = super().save_form(form) + instance.status = choices.EntityStatusChoices.complete + instance.save() + return instance + class WhereIsTheBusinessLocatedView(BaseBusinessModelFormView): form_class = forms.WhereIsTheBusinessLocatedForm diff --git a/django_app/apply_for_a_licence/views/views_recipients.py b/django_app/apply_for_a_licence/views/views_recipients.py index 30ea1b35..617dc8c9 100644 --- a/django_app/apply_for_a_licence/views/views_recipients.py +++ b/django_app/apply_for_a_licence/views/views_recipients.py @@ -2,6 +2,7 @@ import uuid from typing import Type +from apply_for_a_licence import choices from apply_for_a_licence.choices import TypeOfRelationshipChoices from apply_for_a_licence.forms import forms_recipients as forms from apply_for_a_licence.models import Organisation @@ -108,3 +109,9 @@ class RelationshipProviderRecipientView(BaseRecipientFormView): form_class = forms.RelationshipProviderRecipientForm success_url = reverse_lazy("recipient_added") redirect_with_query_parameters = False # once we're done here, we don't care about the query parameters + + def save_form(self, form): + instance = form.save(commit=False) + instance.status = choices.EntityStatusChoices.complete + instance.save() + return instance diff --git a/django_app/apply_for_a_licence/views/views_tasklist.py b/django_app/apply_for_a_licence/views/views_tasklist.py index 44743428..aabaf180 100644 --- a/django_app/apply_for_a_licence/views/views_tasklist.py +++ b/django_app/apply_for_a_licence/views/views_tasklist.py @@ -1,5 +1,3 @@ -from typing import Literal, TypedDict - from apply_for_a_licence.models import Licence from apply_for_a_licence.tasklist import Tasklist from apply_for_a_licence.utils import can_user_edit_licence @@ -10,18 +8,6 @@ from django.views.generic import TemplateView -class SubTask(TypedDict): - name: str - help_text: str - status: Literal["complete", "incomplete"] - url: str - - -class Task(TypedDict): - title: str - sub_tasks: list[SubTask] - - class TriageView(BaseView): """Triage view to take users to where they need to be. diff --git a/django_app/apply_for_a_licence/views/views_yourself.py b/django_app/apply_for_a_licence/views/views_yourself.py index 9001edb2..078321ea 100644 --- a/django_app/apply_for_a_licence/views/views_yourself.py +++ b/django_app/apply_for_a_licence/views/views_yourself.py @@ -2,6 +2,7 @@ import uuid from typing import Type +from apply_for_a_licence import choices from apply_for_a_licence.choices import NationalityAndLocation from apply_for_a_licence.forms import forms_individual as individual_forms from apply_for_a_licence.forms import forms_yourself as forms @@ -76,6 +77,12 @@ def get_form_class(self) -> Type[forms.AddYourselfUKAddressForm | forms.AddYours form_class = forms.AddYourselfNonUKAddressForm return form_class + def save_form(self, form): + instance = super().save_form(form) + instance.status = choices.EntityStatusChoices.complete + instance.save() + return instance + class YourselfAndIndividualAddedView(BaseSaveAndReturnFormView): form_class = individual_forms.IndividualAddedForm diff --git a/django_app/core/forms/base_forms.py b/django_app/core/forms/base_forms.py index 79be96f7..b9d6953a 100644 --- a/django_app/core/forms/base_forms.py +++ b/django_app/core/forms/base_forms.py @@ -28,6 +28,7 @@ class BaseForm(forms.Form): # the submit button text submit_button_text = "Save and continue" save_and_return = False + show_skip_button = True def __init__(self, *args: object, **kwargs) -> None: self.request: HttpRequest | None = kwargs.pop("request", None) @@ -46,6 +47,10 @@ def __init__(self, *args: object, **kwargs) -> None: self.helper = FormHelper() self.helper.add_input(Submit("continue", self.submit_button_text, css_class="btn-primary")) + if self.show_skip_button: + self.helper.add_input( + Submit("skip_link", "Skip for now and return to task list", css_class="govuk-button govuk-button--secondary ml-2") + ) if self.single_question_form and not self.form_h1_header: self.helper.label_tag = "h1" @@ -55,9 +60,6 @@ def __init__(self, *args: object, **kwargs) -> None: if self.bold_labels: self.helper.label_size = Size.LARGE - self.helper.add_input( - Submit("skip_link", "Skip for now and return to task list", css_class="govuk-button govuk-button--secondary ml-2") - ) self.helper.layout = Layout(*self.fields) # clearing the form data if 'change' is passed as a query parameter, and it's a GET request From eb1f9bd7e51f511fb3dba447c0e7386543df3cba Mon Sep 17 00:00:00 2001 From: Christopher Pettinga Date: Fri, 28 Feb 2025 08:28:00 +0000 Subject: [PATCH 4/5] reordering --- django_app/apply_for_a_licence/tasklist/tasks.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/django_app/apply_for_a_licence/tasklist/tasks.py b/django_app/apply_for_a_licence/tasklist/tasks.py index acf9a60d..e42cac08 100644 --- a/django_app/apply_for_a_licence/tasklist/tasks.py +++ b/django_app/apply_for_a_licence/tasklist/tasks.py @@ -45,6 +45,13 @@ class RecipientsTask(BaseTask): ] +class UploadDocumentsTask(BaseTask): + name = "Upload documents" + sub_tasks = [ + UploadDocumentsSubTask, + ] + + class ReviewAndSubmitTask(BaseTask): name = "Review and submit" sub_tasks = [ @@ -64,10 +71,3 @@ def get_sub_tasks(self) -> list[BaseSubTask]: each.status = "cannot_start" return sub_tasks - - -class UploadDocumentsTask(BaseTask): - name = "Upload documents" - sub_tasks = [ - UploadDocumentsSubTask, - ] From d6717c07c1f0a5b099bd9d020b8a737e3529fe3d Mon Sep 17 00:00:00 2001 From: Christopher Pettinga Date: Fri, 28 Feb 2025 08:45:47 +0000 Subject: [PATCH 5/5] removing cruft --- django_app/apply_for_a_licence/tasklist/sub_tasks.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/django_app/apply_for_a_licence/tasklist/sub_tasks.py b/django_app/apply_for_a_licence/tasklist/sub_tasks.py index df58afcf..99ba3c98 100644 --- a/django_app/apply_for_a_licence/tasklist/sub_tasks.py +++ b/django_app/apply_for_a_licence/tasklist/sub_tasks.py @@ -145,11 +145,6 @@ class CheckYourAnswersSubTask(BaseSubTask): name = "Check your answers before you submit your application" url = reverse_lazy("check_your_answers") - @property - def ready_to_start(self) -> bool: - # we can start the CYA the moment they've added recipients - return self.licence.recipients.filter(status=choices.EntityStatusChoices.complete).exists() - @property def is_completed(self) -> bool: return self.licence.status == choices.StatusChoices.submitted