TWE-21 - BE - Secondary Navigation (#357)

* Create BasePage, also move ContactMixin to prevent circular dependency

* Create NavigationSet snippet

* Add NavigationSetMixin to DivisionPage

* Add DivisionMixin & NavigationSetMixin to BasePage

* Update DivisionMixin to also use self if it's a division page

* Display temporary logo & secondary nav

* Add secondary nav template

* Make schema migrations

* Add revisions to NavigationSet

* Update schema migration

* Update division mixin tests to check division page's self is returned

* Tweak navigation set to actually get from the ancestor, or an ancestor with a division with a navigation set

* Add unit tests

* Add generic relation for Revision

* Update schema migration

tbx/blog/migrations/0028_divisionmixin_and_navigationsetmixin.py

@@ -0,0 +1,57 @@
+# Generated by Django 5.1.4 on 2025-01-28 09:34
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("blog", "0027_update_theme_colour_choices"),
+        ("divisions", "0002_divisionmixin_and_navigationsetmixin"),
+        ("navigation", "0007_divisionmixin_and_navigationsetmixin"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="blogindexpage",
+            name="division",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to="divisions.divisionpage",
+            ),
+        ),
+        migrations.AddField(
+            model_name="blogindexpage",
+            name="override_navigation_set",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="+",
+                to="navigation.navigationset",
+            ),
+        ),
+        migrations.AddField(
+            model_name="blogpage",
+            name="division",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to="divisions.divisionpage",
+            ),
+        ),
+        migrations.AddField(
+            model_name="blogpage",
+            name="override_navigation_set",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="+",
+                to="navigation.navigationset",
+            ),
+        ),
+    ]

tbx/blog/models.py

@@ -19,20 +19,18 @@
 from bs4 import BeautifulSoup
 
 from tbx.core.blocks import StoryBlock
+from tbx.core.models import BasePage
 from tbx.core.utils.fields import StreamField
 from tbx.core.utils.models import (
     ColourThemeMixin,
-    NavigationFields,
+    ContactMixin,
     SocialFields,
 )
 from tbx.images.models import CustomImage
-from tbx.people.models import ContactMixin
 from tbx.taxonomy.models import Sector, Service
 
 
-class BlogIndexPage(
-    ColourThemeMixin, ContactMixin, SocialFields, NavigationFields, Page
-):
+class BlogIndexPage(BasePage):
     template = "patterns/pages/blog/blog_listing.html"
 
     subpage_types = ["BlogPage"]
@@ -119,20 +117,8 @@ def get_context(self, request, *args, **kwargs):
         )
         return context
 
-    promote_panels = (
-        [
-            MultiFieldPanel(Page.promote_panels, "Common page configuration"),
-        ]
-        + NavigationFields.promote_panels
-        + ColourThemeMixin.promote_panels
-        + ContactMixin.promote_panels
-        + [
-            MultiFieldPanel(SocialFields.promote_panels, "Social fields"),
-        ]
-    )
-
 
-class BlogPage(ColourThemeMixin, ContactMixin, SocialFields, NavigationFields, Page):
+class BlogPage(BasePage):
     template = "patterns/pages/blog/blog_detail.html"
 
     parent_page_types = ["BlogIndexPage"]
@@ -158,7 +144,7 @@ class BlogPage(ColourThemeMixin, ContactMixin, SocialFields, NavigationFields, P
     related_services = ParentalManyToManyField(
         "taxonomy.Service", related_name="blog_posts"
     )
-    search_fields = Page.search_fields + [
+    search_fields = BasePage.search_fields + [
         index.SearchField("body"),
     ]
 
@@ -243,7 +229,7 @@ def read_time(self):
     def type(self):
         return "BLOG POST"
 
-    content_panels = Page.content_panels + [
+    content_panels = BasePage.content_panels + [
         InlinePanel("authors", label="Author", min_num=1),
         FieldPanel("date"),
         FieldPanel("body"),

tbx/core/migrations/0040_divisionmixin_and_navigationsetmixin.py

@@ -0,0 +1,50 @@
+# Generated by Django 5.1.4 on 2025-01-28 09:34
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("divisions", "0002_divisionmixin_and_navigationsetmixin"),
+        ("navigation", "0007_divisionmixin_and_navigationsetmixin"),
+        (
+            "torchbox",
+            "0039_remove_homepage_introduction_homepage_hero_heading_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="homepage",
+            name="override_navigation_set",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="+",
+                to="navigation.navigationset",
+            ),
+        ),
+        migrations.AddField(
+            model_name="standardpage",
+            name="division",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to="divisions.divisionpage",
+            ),
+        ),
+        migrations.AddField(
+            model_name="standardpage",
+            name="override_navigation_set",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="+",
+                to="navigation.navigationset",
+            ),
+        ),
+    ]

tbx/core/models.py

@@ -18,10 +18,12 @@
 )
 from tbx.core.utils.models import (
     ColourThemeMixin,
+    ContactMixin,
+    DivisionMixin,
     NavigationFields,
+    NavigationSetMixin,
     SocialFields,
 )
-from tbx.people.models import ContactMixin
 
 from .blocks import HomePageStoryBlock, StandardPageStoryBlock
 
@@ -118,6 +120,33 @@ class Meta:
         abstract = True
 
 
+class BasePage(
+    ColourThemeMixin,
+    ContactMixin,
+    DivisionMixin,
+    NavigationFields,
+    NavigationSetMixin,
+    SocialFields,
+    Page,
+):
+    class Meta:
+        abstract = True
+
+    promote_panels = (
+        [
+            MultiFieldPanel(Page.promote_panels, "Common page configuration"),
+        ]
+        + NavigationFields.promote_panels
+        + NavigationSetMixin.promote_panels
+        + ColourThemeMixin.promote_panels
+        + DivisionMixin.promote_panels
+        + ContactMixin.promote_panels
+        + [
+            MultiFieldPanel(SocialFields.promote_panels, "Social fields"),
+        ]
+    )
+
+
 class HomePagePartnerLogo(Orderable):
     page = ParentalKey("torchbox.HomePage", related_name="logos")
     image = models.ForeignKey(
@@ -134,7 +163,14 @@ class HomePagePartnerLogo(Orderable):
 
 
 # Home Page
-class HomePage(ColourThemeMixin, ContactMixin, SocialFields, NavigationFields, Page):
+class HomePage(
+    ColourThemeMixin,
+    ContactMixin,
+    NavigationFields,
+    NavigationSetMixin,
+    SocialFields,
+    Page,
+):
     template = "patterns/pages/home/home_page.html"
 
     parent_page_types = ["wagtailcore.Page"]
@@ -153,7 +189,7 @@ def partner_logos(self):
             return [logo.image for logo in logos]
         return []
 
-    content_panels = Page.content_panels + [
+    content_panels = BasePage.content_panels + [
         MultiFieldPanel(
             [
                 FieldPanel(
@@ -193,6 +229,7 @@ def partner_logos(self):
             MultiFieldPanel(Page.promote_panels, "Common page configuration"),
         ]
         + NavigationFields.promote_panels
+        + NavigationSetMixin.promote_panels
         + ColourThemeMixin.promote_panels
         + ContactMixin.promote_panels
         + [
@@ -210,30 +247,16 @@ def get_context(self, request):
 
 
 # Standard page
-class StandardPage(
-    ColourThemeMixin, ContactMixin, SocialFields, NavigationFields, Page
-):
+class StandardPage(BasePage):
     template = "patterns/pages/standard/standard_page.html"
 
     body = StreamField(StandardPageStoryBlock())
 
-    content_panels = Page.content_panels + [
+    content_panels = BasePage.content_panels + [
         FieldPanel("body"),
     ]
 
-    promote_panels = (
-        [
-            MultiFieldPanel(Page.promote_panels, "Common page configuration"),
-        ]
-        + NavigationFields.promote_panels
-        + ColourThemeMixin.promote_panels
-        + ContactMixin.promote_panels
-        + [
-            MultiFieldPanel(SocialFields.promote_panels, "Social fields"),
-        ]
-    )
-
-    search_fields = Page.search_fields + [
+    search_fields = BasePage.search_fields + [
         index.SearchField("body"),
     ]
 

tbx/core/tests/test_division_mixin.py

@@ -45,6 +45,14 @@ def test_division_selected(self):
         self.assertEqual(self.service_1.final_division, self.division_1)
         self.assertEqual(service_3.final_division, self.division_2)
 
+    def test_division_self(self):
+        """
+        For a division page,
+        final_division should return the page itself.
+        """
+        self.assertEqual(self.division_1.final_division, self.division_1)
+        self.assertEqual(self.division_2.final_division, self.division_2)
+
     def test_division_selected_on_ancestor(self):
         """
         For a page that does not have a division selected