ED-16: Feature/education skeleton pages (#1959)

Co-authored-by: James Biggs <62654785+jamesbiggs@users.noreply.github.com>
Co-authored-by: jamesbiggs <james.biggs@nationalarchives.gov.uk>

Author: rzarrouk

app/core/blocks/__init__.py

@@ -6,11 +6,17 @@
 from .featured_content import (
     FeaturedCollectionBlock,
 )
-from .image import ContentImageBlock, ImageGalleryBlock, PartnerLogoListBlock
+from .image import (
+    APIImageChooserBlock,
+    ContentImageBlock,
+    ImageGalleryBlock,
+    PartnerLogoChooserBlock,
+    PartnerLogoListBlock,
+)
 from .lists import DescriptionListBlock, DoDontListBlock, PeopleListingBlock
 from .page_chooser import APIPageChooserBlock
 from .page_list import PageListBlock
-from .paragraph import ParagraphBlock
+from .paragraph import APIRichTextBlock, ParagraphBlock
 from .promoted_links import (
     FeaturedExternalLinkBlock,
     FeaturedPageBlock,
@@ -24,6 +30,8 @@
 from .video import MixedMediaBlock, YouTubeBlock
 
 __all__ = [
+    "APIImageChooserBlock",
+    "APIRichTextBlock",
     "APIPageChooserBlock",
     "AccordionsBlock",
     "ButtonBlock",
@@ -46,6 +54,7 @@
     "MixedMediaBlock",
     "PageListBlock",
     "ParagraphBlock",
+    "PartnerLogoChooserBlock",
     "PartnerLogoListBlock",
     "PeopleListingBlock",
     "QuoteBlock",

app/core/blocks/image.py

@@ -49,6 +49,9 @@ def get_api_representation(self, value, context=None):
         )
         return serializer.to_representation(value)
 
+    class Meta:
+        group = "Video, audio and downloads"
+
 
 class ContentImageBlock(blocks.StructBlock):
     image = APIImageChooserBlock(rendition_size="max-900x900", required=True)

app/core/blocks/paragraph.py

@@ -8,6 +8,9 @@ def get_api_representation(self, value, context=None):
         representation = super().get_api_representation(value, context)
         return expand_db_html(representation)
 
+    class Meta:
+        group = "Basic text"
+
 
 class ParagraphBlock(blocks.StructBlock):
     text = APIRichTextBlock(features=settings.RESTRICTED_RICH_TEXT_FEATURES)

app/education/__init__.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class EducationConfig(AppConfig):
+    default_auto_field = "django.db.models.AutoField"
+    name = "app.education"
+    verbose_name = "Education"

app/education/apps.py

@@ -0,0 +1,96 @@
+from django.conf import settings
+from wagtail import blocks
+
+from app.core.blocks import (
+    APIImageChooserBlock,
+    APIRichTextBlock,
+    FeaturedExternalLinkBlock,
+    FeaturedPageBlock,
+    InsetTextBlock,
+    ParagraphBlock,
+    PartnerLogoChooserBlock,
+    QuoteBlock,
+    YouTubeBlock,
+)
+from app.media.blocks import MediaBlock
+
+# Resources - Source
+
+
+class SourceImageWithCaptionBlock(blocks.StructBlock):
+    image = APIImageChooserBlock(
+        rendition_size="max-900x900",
+        help_text="An image for the source.",
+    )
+    caption = APIRichTextBlock(features=["bold", "italic"], required=False)
+
+    class Meta:
+        group = "Video, audio and downloads"
+
+
+class SourceMediaWithCaptionBlock(MediaBlock):
+    title = None
+    caption = APIRichTextBlock(features=["bold", "italic"], required=False)
+
+
+class SourceYouTubeWithCaptionBlock(MediaBlock):
+    youtube = YouTubeBlock()
+    caption = APIRichTextBlock(features=["bold", "italic"], required=False)
+
+    class Meta:
+        label = "YouTube"
+
+
+class SourceMediaBlock(blocks.StreamBlock):
+    image = SourceImageWithCaptionBlock()
+    video = SourceMediaWithCaptionBlock()
+    youtube = SourceYouTubeWithCaptionBlock()
+
+    class Meta:
+        label = "Source media"
+
+
+class SourceFeaturedLinkBlock(blocks.StreamBlock):
+    external_link = FeaturedExternalLinkBlock()
+    internal_link = FeaturedPageBlock()
+
+    class Meta:
+        label = "Source featured link"
+
+
+class SourceQuestionItemBlock(blocks.StructBlock):
+    question_heading = blocks.CharBlock(
+        required=False,
+        max_length=255,
+    )
+    question_description = APIRichTextBlock(
+        features=settings.RESTRICTED_RICH_TEXT_FEATURES,
+        required=False,
+    )
+
+    class Meta:
+        icon = "help"
+        label = "Question"
+
+
+class SourceQuestionBlock(blocks.StreamBlock):
+    question = SourceQuestionItemBlock()
+
+    class Meta:
+        label = "Source question"
+
+
+class SectionContentBlock(blocks.StreamBlock):
+    description = ParagraphBlock()
+    partner_logo = PartnerLogoChooserBlock()
+    quote = QuoteBlock()
+    inset_text = InsetTextBlock()
+
+
+class SessionDescriptionBlock(blocks.StructBlock):
+    heading = blocks.CharBlock(max_length=100, label="Heading")
+    content = SectionContentBlock(required=False)
+
+    class Meta:
+        label = "Section"
+        group = "Basic text"

app/education/blocks.py

@@ -0,0 +1,108 @@
+# etna:allowAlterField
+
+
+from django.db import migrations
+
+KEY_STAGES = [
+    ("key-stage-1", "Key stage 1", 1, "5-7"),
+    ("key-stage-2", "Key stage 2", 2, "7-11"),
+    ("key-stage-3", "Key stage 3", 3, "11-14"),
+    ("key-stage-4", "Key stage 4", 4, "14-16"),
+    ("key-stage-5", "Key stage 5", 5, "16-18"),
+]
+
+THEMES = [
+    ("power-politics-and-reform", "Power, politics and reform"),
+    ("war-and-revolution", "War and revolution"),
+    ("migration-and-identity", "Migration and identity"),
+    ("empire-and-decolonisation", "Empire and decolonisation"),
+    ("crime-and-punishment", "Crime and punishment"),
+    ("medicine-welfare-and-society", "Medicine, welfare and society"),
+    ("family-community-and-everyday-life", "Family, community and everyday life"),
+    ("economy-trade-and-industry", "Economy, trade and industry"),
+    ("archive-skills", "Archive skills"),
+    ("local-history", "Local history"),
+    ("womens-history", "Women's history"),
+    ("black-asian-and-global-majority-history", "Black, Asian and global majority history"),
+    ("lgbtq-history", "LGBTQ+ history"),
+    ("disability-history", "Disability history"),
+    ("significant-people-places-and-events", "Significant people, places and events"),
+]
+
+# Tuple: (slug, name, year_from, year_to, available_for_resources)
+TIME_PERIODS = [
+    ("early-civilisations", "Early civilisations", None, 900, False),
+    ("medieval", "Medieval", 900, 1485, True),
+    ("early-modern", "Early modern", 1485, 1750, True),
+    ("industrial-revolution", "Industrial revolution", 1750, 1901, True),
+    ("early-twentieth-century", "Early Twentieth Century", 1901, 1945, True),
+    ("post-war-and-modern", "Post-War and modern", 1945, None, True),
+    ("cross-period", "Cross period", None, None, True),
+]
+
+
+def seed_key_stages(apps, schema_editor):
+    KeyStage = apps.get_model("education", "KeyStage")
+    key_stage_field_names = {field.name for field in KeyStage._meta.fields}
+
+    for slug, name, stage, age_range in KEY_STAGES:
+        defaults = {"name": name}
+        defaults["stage"] = stage
+        defaults["age_range"] = age_range
+
+        KeyStage.objects.update_or_create(
+            slug=slug,
+            defaults=defaults,
+        )
+
+
+def seed_themes(apps, schema_editor):
+    Theme = apps.get_model("education", "Theme")
+
+    for slug, name in THEMES:
+        Theme.objects.update_or_create(
+            slug=slug,
+            defaults={"name": name},
+        )
+
+
+def seed_time_periods(apps, schema_editor):
+    TimePeriod = apps.get_model("education", "TimePeriod")
+    time_period_field_names = {field.name for field in TimePeriod._meta.fields}
+
+    for slug, name, year_from, year_to, available_for_resources in TIME_PERIODS:
+        defaults = {"name": name}
+
+        if "year_from" in time_period_field_names:
+            defaults["year_from"] = year_from
+
+        if "year_to" in time_period_field_names:
+            defaults["year_to"] = year_to
+
+        if "available_for_resources" in time_period_field_names:
+            defaults["available_for_resources"] = available_for_resources
+
+        TimePeriod.objects.update_or_create(
+            slug=slug,
+            defaults=defaults,
+        )
+
+
+def seed_education_taxonomies(apps, schema_editor):
+    seed_key_stages(apps, schema_editor)
+    seed_themes(apps, schema_editor)
+    seed_time_periods(apps, schema_editor)
+
+
+def noop_reverse(apps, schema_editor):
+    pass
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("education", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.RunPython(seed_education_taxonomies, noop_reverse),
+    ]

app/education/migrations/0001_initial.py

@@ -0,0 +1,15 @@
+from .landing import EducationPage
+from .listings import (
+    EducationSessionsListingPage,
+    TeachingResourcesListingPage,
+)
+from .resources import TeachingResourcePage
+from .sessions import EducationSessionPage
+
+__all__ = [
+    "EducationPage",
+    "TeachingResourcePage",
+    "EducationSessionPage",
+    "EducationSessionsListingPage",
+    "TeachingResourcesListingPage",
+]