Merge changes from main

app/categories/constants.py

@@ -13,9 +13,14 @@ class Category:
     # Internal code
     code: Optional[str] = None
     children: dict[str, "Category"] | None = field(default_factory=dict)
+    parent_code: Optional[str] = None
     _referrer_text: Optional[LazyString] = None
     exit_page: Optional[bool] = False
 
+    @property
+    def url_friendly_name(self):
+        return self.code.replace("_", "-").lower()
+
     @property
     def display_text(self):
         return self.title
@@ -26,15 +31,23 @@ def sub(self):
         class Subcategory:
             def __init__(self, category):
                 self.children: dict[str, Category] = category.children
+                self.category: Category = category
 
             def __getattr__(self, item):
+                if item not in self.children:
+                    raise AttributeError(
+                        f"Could not find {item} in category {self.category.title}"
+                    )
                 return self.children.get(item)
 
         return Subcategory(self)
 
     @classmethod
     def from_dict(cls, data: dict) -> "Category":
-        children: dict = data.pop("children", {})
+        data = data.copy()
+        children = {}
+        if "children" in data:
+            children: dict = data.pop("children")
         category = cls(**data)
         if children:
             for name, child in children.items():
@@ -474,21 +487,27 @@ def __str__(self):
 def init_children(category: Category) -> None:
     for child in category.children.values():
         child.chs_code = child.chs_code or category.chs_code
+        child.parent_code = category.code
         child.article_category_name = (
             child.article_category_name or category.article_category_name
         )
 
 
-ALL_CATEGORIES = [
-    DOMESTIC_ABUSE,
-    FAMILY,
-    HOUSING,
-    DISCRIMINATION,
-    EDUCATION,
-    COMMUNITY_CARE,
-    BENEFITS,
-    PUBLIC_LAW,
-    ASYLUM_AND_IMMIGRATION,
-    MENTAL_CAPACITY,
-]
-list(map(init_children, ALL_CATEGORIES))
+ALL_CATEGORIES = {
+    DOMESTIC_ABUSE.code: DOMESTIC_ABUSE,
+    FAMILY.code: FAMILY,
+    HOUSING.code: HOUSING,
+    DISCRIMINATION.code: DISCRIMINATION,
+    EDUCATION.code: EDUCATION,
+    COMMUNITY_CARE.code: COMMUNITY_CARE,
+    BENEFITS.code: BENEFITS,
+    PUBLIC_LAW.code: PUBLIC_LAW,
+    ASYLUM_AND_IMMIGRATION.code: ASYLUM_AND_IMMIGRATION,
+    MENTAL_CAPACITY.code: MENTAL_CAPACITY,
+}
+
+list(map(init_children, ALL_CATEGORIES.values()))
+
+
+def get_category_from_code(code: str) -> Category:
+    return ALL_CATEGORIES[code]

app/categories/models.py

@@ -0,0 +1,38 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import Optional
+
+from flask import url_for
+from app.categories.constants import Category
+
+
+class QuestionType(str, Enum):
+    SUB_CATEGORY = "sub_category"
+    ONWARD = "onward_question"
+
+
+@dataclass
+class CategoryAnswer:
+    question: str
+    answer_value: str
+    answer_label: str
+    category: Category
+    question_page: str
+    next_page: str
+    question_type: Optional[QuestionType] = field(default=QuestionType.SUB_CATEGORY)
+
+    @property
+    def edit_url(self):
+        return url_for(self.question_page)
+
+    @property
+    def next_url(self):
+        return url_for(self.next_page)
+
+    @property
+    def question_type_is_sub_category(self):
+        return self.question_type == QuestionType.SUB_CATEGORY
+
+    @property
+    def question_type_is_onward(self):
+        return self.question_type == QuestionType.ONWARD

app/categories/views.py

@@ -3,6 +3,7 @@
 from flask import render_template, redirect, url_for, session, request
 from app.categories.forms import QuestionForm
 from app.categories.constants import Category
+from app.categories.models import CategoryAnswer, QuestionType
 
 
 class CategoryPage(View):
@@ -13,21 +14,17 @@ class CategoryPage(View):
     def __init__(self, template, *args, **kwargs):
         self.template = template
 
-    def update_session(self, question: str, answer: str, category: Category) -> None:
+    def update_session(self, category_answer: CategoryAnswer) -> None:
         """
         Update the session with the current page and answer.
 
         """
-        session.set_category_question_answer(
-            question_title=question,
-            answer=answer,
-            category=category,
-        )
+        session.set_category_question_answer(category_answer)
 
     def dispatch_request(self):
         category = getattr(self, "category", None)
         if category is not None:
-            session["category"] = category
+            session.category = category
 
         response = self.process_request()
         if not response:
@@ -41,76 +38,103 @@ def process_request(self):
 class CategoryLandingPage(CategoryPage):
     template: str = "categories/landing.html"
 
-    routing_map: dict[str, str] = {}
+    routing_map: dict[str, list] = {}
+    """
+    A dictionary that organizes category listings into different sections: "main", "more", and "other".
+
+    - "main" and "more" contain lists of tuples, where each tuple consists of:
+      - `category`: Category object.  
+      - `route`:  String - an intermediary route than stores the selected category before redirecting to the target
+
+    - "other" is a string representing an intermediary route than stores the selected answer before redirecting to the target
+    """
+    listing: dict[str, list] = {}
+
+    def __init__(self, route_endpoint: str = None, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.routing_map and route_endpoint:
+            self.listing["main"] = []
+            for category, next_page in self.routing_map["main"]:
+                self.listing["main"].append(
+                    (category, f"categories.{route_endpoint}.{category.code}")
+                )
+
+            self.listing["more"] = []
+            for category, next_page in self.routing_map["more"]:
+                self.listing["more"].append(
+                    (category, f"categories.{route_endpoint}.{category.code}")
+                )
+
+            self.listing["other"] = f"categories.{route_endpoint}.other"
 
     def process_request(self):
         return render_template(
-            self.template, category=self.category, routing_map=self.routing_map
+            self.template, category=self.category, listing=self.listing
         )
 
     @classmethod
     def register_routes(cls, blueprint: Blueprint, path: str = None):
         if not path:
-            path = cls.category.code.lower().replace("_", "-")
+            path = cls.category.url_friendly_name
 
         blueprint.add_url_rule(
             f"/{path}/",
-            view_func=cls.as_view("landing", template=cls.template),
+            view_func=cls.as_view(
+                "landing", route_endpoint=blueprint.name, template=cls.template
+            ),
         )
         cls.register_sub_routes(blueprint, path, cls.routing_map["main"])
         cls.register_sub_routes(blueprint, path, cls.routing_map["more"])
 
         if "other" in cls.routing_map and cls.routing_map["other"] is not None:
+            category_answer = CategoryAnswer(
+                question=cls.question_title,
+                question_page=f"categories.{blueprint.name}.landing",
+                answer_value="other",
+                answer_label="Other",
+                next_page=cls.routing_map["other"],
+                category=cls.category,
+            )
             blueprint.add_url_rule(
                 f"/{path}/answer/other",
-                view_func=CategoryAnswerPage.as_view(
-                    "other",
-                    question=cls.question_title,
-                    answer="other",
-                    next_page=cls.routing_map["other"],
-                    category=cls.category,
-                ),
+                view_func=CategoryAnswerPage.as_view("other", category_answer),
             )
 
     @classmethod
     def register_sub_routes(cls, blueprint: Blueprint, path, routes):
         for sub_category, next_page in routes:
+            category_answer = CategoryAnswer(
+                question=cls.question_title,
+                question_page=f"categories.{blueprint.name}.landing",
+                answer_value=sub_category.code,
+                answer_label=sub_category.title,
+                next_page=next_page,
+                category=sub_category,
+            )
             blueprint.add_url_rule(
-                f"/{path}/answer/{sub_category.code.replace('_', '-')}",
+                f"/{path}/answer/{sub_category.url_friendly_name}",
                 view_func=CategoryAnswerPage.as_view(
-                    sub_category.code,
-                    question=cls.question_title,
-                    answer=sub_category.code,
-                    next_page=next_page,
-                    category=sub_category,
+                    sub_category.code, category_answer
                 ),
             )
 
 
 class CategoryAnswerPage(View):
-    def __init__(self, question, answer, next_page, category):
-        self.question = question
-        self.answer = answer
-        self.next_page = next_page
-        self.category = category
+    def __init__(self, category_answer: CategoryAnswer):
+        self.category_answer = category_answer
 
     def update_session(self) -> None:
         """
         Update the session with the current page and answer.
 
         """
-        session["previous_page"] = request.endpoint
-        session.set_category_question_answer(
-            question_title=self.question,
-            answer=self.answer,
-            category=self.category,
-        )
+        session.set_category_question_answer(self.category_answer)
 
     def dispatch_request(self):
         self.update_session()
-        if isinstance(self.next_page, dict):
-            return redirect(url_for(**self.next_page))
-        return redirect(url_for(self.next_page))
+        if isinstance(self.category_answer.next_page, dict):
+            return redirect(url_for(**self.category_answer.next_page))
+        return redirect(url_for(self.category_answer.next_page))
 
 
 class QuestionPage(CategoryPage):
@@ -138,14 +162,14 @@ def __init__(self, form_class: type[QuestionForm], template=None):
         self.category = form_class.category
         super().__init__(self.template)
 
-    def get_next_page(self, answer: str) -> redirect:
+    def get_next_page(self, answer: str) -> str:
         """Determine and redirect to the next page based on the user's answer.
 
         Args:
             answer: The user's selected answer
 
         Returns:
-            A Flask redirect response to the next appropriate page
+            A string representing the next page to take the user to
 
         Raises:
             ValueError if the answer does not have a mapping to a next page
@@ -156,21 +180,39 @@ def get_next_page(self, answer: str) -> redirect:
         ]  # We should only route to these pages if they are the only answer
 
         if len(answer) == 1 and answer[0] in optional_answers:
-            return redirect(url_for(self.form_class.next_step_mapping[answer[0]]))
+            return url_for(self.form_class.next_step_mapping[answer[0]])
 
         if isinstance(answer, list):
             for a in answer:
                 if a in self.form_class.next_step_mapping and a not in optional_answers:
-                    return redirect(url_for(self.form_class.next_step_mapping[a]))
+                    return url_for(self.form_class.next_step_mapping[a])
             answer = "*"
 
         if answer not in self.form_class.next_step_mapping:
             raise ValueError(f"No mapping found for answer: {answer}")
 
         next_page = self.form_class.next_step_mapping[answer]
+
         if isinstance(next_page, dict):
-            return redirect(url_for(**next_page))
-        return redirect(url_for(next_page))
+            return url_for(**next_page)
+        return url_for(next_page)
+
+    def update_session(self, form: QuestionForm) -> None:
+        answer = form.question.data
+        answer = answer if isinstance(answer, list) else [answer]
+        answer_labels = [
+            label for value, label in form.question.choices if value in answer
+        ]
+        category_answer = CategoryAnswer(
+            question=form.title,
+            answer_value=form.question.data,
+            answer_label=answer_labels if len(answer) > 1 else answer_labels[0],
+            category=form.category,
+            next_page=self.get_next_page(form.question.data),
+            question_page=request.url_rule.endpoint,
+            question_type=QuestionType.ONWARD,
+        )
+        super().update_session(category_answer)
 
     def process_request(self):
         """Handle requests for the question page, including form submissions.
@@ -183,13 +225,11 @@ def process_request(self):
             Either a redirect to the next page or the rendered template
         """
         form = self.form_class(request.args)
-        session["category"] = form.category
+        session.category = form.category
 
         if form.submit.data and form.validate():
-            self.update_session(
-                question=form.title, answer=form.question.data, category=form.category
-            )
-            return self.get_next_page(form.question.data)
+            self.update_session(form)
+            return redirect(self.get_next_page(form.question.data))
 
         # Pre-populate form with previous answer if it exists
         previous_answer = session.get_category_question_answer(form.title)

app/main/__init__.py

@@ -1,4 +1,4 @@
-from flask import Blueprint, request, url_for
+from flask import Blueprint, request, url_for, session
 from flask import current_app
 
 bp = Blueprint("main", __name__, template_folder="../templates/main")
@@ -30,3 +30,13 @@ def inject_language_switcher():
             },
         }
     }
+
+
+@bp.app_context_processor
+def inject_exit_this_page():
+    category = session.category
+
+    if not category:
+        return {"show_exit_this_page": False}
+
+    return {"show_exit_this_page": getattr(category, "exit_page", False)}