- Install wagtail and wagtail-factories

Pipfile

@@ -24,6 +24,8 @@ gunicorn = "*"
 dj-database-url = "*"
 slack-sdk = "*"
 sentry-sdk = "*"
+wagtail = "*"
+wagtail-factories = "*"
 
 [dev-packages]
 pytest = "*"

conftest.py

@@ -4,24 +4,31 @@
 from django.test import Client
 import pytest
 from pytest_factoryboy import register
+from wagtail.models import Locale, Site
 
 from authentication.tests.factories.student_user_factory import StudentUserFactory
 from authentication.tests.factories.user_factory import UserFactory
 from payment.tests.factories.referral_coupon_factory import ReferralCouponFactory
 from payment.tests.factories.coupon_effect_factory import CouponEffectFactory
 from staff.tests.factories.batch_factory import BatchFactory
+from staff.tests.factories.batch_page_factory import BatchPageFactory
 from staff.tests.factories.batch_schedule_factory import BatchScheduleFactory
 from staff.tests.factories.course_factory import CourseFactory
+from staff.tests.factories.course_page_factory import CoursePageFactory
+from staff.tests.factories.day_page_factory import DayPageFactory
 from staff.tests.factories.section_factory import SectionFactory
 from student.tests.factories.certificate_factory import CertificateFactory
 from student.tests.factories.enrolment_factory import EnrolmentFactory
 from student.tests.factories.registration_factory import RegistrationFactory
 
 register(BatchFactory)
+register(BatchPageFactory)
 register(BatchScheduleFactory)
 register(CertificateFactory)
 register(CouponEffectFactory)
 register(CourseFactory)
+register(CoursePageFactory)
+register(DayPageFactory)
 register(EnrolmentFactory)
 register(ReferralCouponFactory)
 register(RegistrationFactory)
@@ -147,3 +154,14 @@ def swe_fundamentals_registration_early_bird(swe_fundamentals_batch, registratio
     )
 
     yield swe_fundamentals_registration_early_bird
+
+###########
+# WAGTAIL #
+###########
+
+@pytest.fixture()
+def wagtail_site():
+    Locale.objects.create(language_code='en')
+    wagtail_site = Site(is_default_site=True)
+
+    yield wagtail_site

learn/settings.py

@@ -83,6 +83,19 @@
     'student',
     'payment',
     'emails',
+    'wagtail.contrib.forms',
+    'wagtail.contrib.redirects',
+    'wagtail.embeds',
+    'wagtail.sites',
+    'wagtail.users',
+    'wagtail.snippets',
+    'wagtail.documents',
+    'wagtail.images',
+    'wagtail.search',
+    'wagtail.admin',
+    'wagtail',
+    'modelcluster',
+    'taggit'
 ]
 
 # AUTHENTICATION
@@ -120,6 +133,7 @@
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'whitenoise.middleware.WhiteNoiseMiddleware',
+    'wagtail.contrib.redirects.middleware.RedirectMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
@@ -282,3 +296,8 @@
 COUPON_CODE_NOTIFICATION_TEMPLATE_ID = env('COUPON_CODE_NOTIFICATION_TEMPLATE_ID')
 SWE_FUNDAMENTALS_GRADUATION_NOTIFICATION_TEMPLATE_ID = env('SWE_FUNDAMENTALS_GRADUATION_NOTIFICATION_TEMPLATE_ID')
 SWE_FUNDAMENTALS_REGISTRATION_CONFIRMATION_TEMPLATE_ID = env('SWE_FUNDAMENTALS_REGISTRATION_CONFIRMATION_TEMPLATE_ID')
+
+# WAGTAIL #
+WAGTAIL_SITE_NAME = ROCKET_ACADEMY
+WAGTAILADMIN_RECENT_EDITS_LIMIT = 5
+WAGTAILEMBEDS_RESPONSIVE_HTML = True

staff/migrations/0016_coursepage_batchpage.py

@@ -0,0 +1,40 @@
+# Generated by Django 4.1.3 on 2022-12-06 13:42
+
+from django.db import migrations, models
+import django.db.models.deletion
+import wagtail.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('wagtailcore', '0078_referenceindex'),
+        ('staff', '0015_alter_course_name'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CoursePage',
+            fields=[
+                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.page')),
+                ('intro', wagtail.fields.RichTextField(blank=True)),
+                ('course', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='staff.course')),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=('wagtailcore.page',),
+        ),
+        migrations.CreateModel(
+            name='BatchPage',
+            fields=[
+                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.page')),
+                ('intro', wagtail.fields.RichTextField(blank=True)),
+                ('batch', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='staff.batch')),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=('wagtailcore.page',),
+        ),
+    ]

staff/migrations/0017_daypage.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.1.4 on 2023-01-03 08:17
+
+from django.db import migrations, models
+import django.db.models.deletion
+import wagtail.fields
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('wagtailcore', '0078_referenceindex'),
+        ('staff', '0016_coursepage_batchpage'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DayPage',
+            fields=[
+                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.page')),
+                ('body', wagtail.fields.RichTextField(blank=True)),
+                ('batch_page', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='staff.batchpage')),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=('wagtailcore.page',),
+        ),
+    ]

staff/models/__init__.py

@@ -1,5 +1,8 @@
 from .batch import Batch
+from .batch_page import BatchPage
 from .batch_schedule import BatchSchedule
 from .certificate import Certificate
 from .course import Course
+from .course_page import CoursePage
+from .day_page import DayPage
 from .section import Section

staff/models/batch.py

@@ -62,7 +62,7 @@ def save(self, *args, **kwargs):
         return super().save(*args, **kwargs)
 
     def __str__(self):
-        return f"Batch {self.number}"
+        return f"{self.course.get_name_display()} Batch {self.number}"
 
     @classmethod
     def next_number(self, course_id, type):

staff/models/batch_page.py

@@ -0,0 +1,30 @@
+from django import forms
+from django.db import models
+from wagtail.admin.panels import FieldPanel
+from wagtail.fields import RichTextField
+from wagtail.models import Page
+from wagtail.search import index
+
+from staff.models import Batch
+
+
+class BatchPage(Page):
+    intro = RichTextField(blank=True)
+    batch = models.ForeignKey(Batch, on_delete=models.PROTECT)
+
+    search_fields = Page.search_fields + [
+        index.FilterField('intro'),
+        index.SearchField('intro'),
+    ]
+
+    content_panels = Page.content_panels + [
+        FieldPanel('batch', widget=forms.Select),
+        FieldPanel('intro')
+    ]
+
+    def save(self, *args, **kwargs):
+        # slug does not appear above as an attribute
+        # because it is an attribute on Wagtail's Page model
+        self.slug = self.batch.number
+
+        return super().save(*args, **kwargs)

staff/models/course.py

@@ -18,3 +18,6 @@ class Course(SafeDeleteModel):
     name = models.CharField(max_length=255, choices=NAME_CHOICES)
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return self.get_name_display()

staff/models/course_page.py

@@ -0,0 +1,23 @@
+from django import forms
+from django.db import models
+from wagtail.admin.panels import FieldPanel
+from wagtail.fields import RichTextField
+from wagtail.models import Page
+from wagtail.search import index
+
+from staff.models import Course
+
+
+class CoursePage(Page):
+    intro = RichTextField(blank=True)
+    course = models.ForeignKey(Course, on_delete=models.PROTECT)
+
+    search_fields = Page.search_fields + [
+        index.FilterField('intro'),
+        index.SearchField('intro'),
+    ]
+
+    content_panels = Page.content_panels + [
+        FieldPanel('course', widget=forms.Select),
+        FieldPanel('intro')
+    ]

staff/models/day_page.py

@@ -0,0 +1,23 @@
+from django import forms
+from django.db import models
+from wagtail.admin.panels import FieldPanel
+from wagtail.fields import RichTextField
+from wagtail.models import Page
+from wagtail.search import index
+
+from staff.models import BatchPage
+
+
+class DayPage(Page):
+    batch_page = models.ForeignKey(BatchPage, on_delete=models.PROTECT)
+    body = RichTextField(blank=True)
+
+    search_fields = Page.search_fields + [
+        index.FilterField('body'),
+        index.SearchField('body'),
+    ]
+
+    content_panels = Page.content_panels + [
+        FieldPanel('batch_page', widget=forms.Select),
+        FieldPanel('body')
+    ]

staff/templates/staff/batch_page.html

@@ -0,0 +1,20 @@
+{% extends "staff_base.html" %}
+
+{% load wagtailcore_tags %}
+
+{% block body_class %}template-blogindexpage{% endblock %}
+
+{% block content %}
+    <div class="row">
+        <div class="col-6">
+            <h1>{{ page.title }}</h1>
+
+            <div class="intro my-5">{{ page.intro|richtext }}</div>
+
+            {% for post in page.get_children %}
+                <h2><a href="{% pageurl post %}">{{ post.title }}</a></h2>
+            {% endfor %}
+        </div>
+    </div>
+
+{% endblock %}

staff/templates/staff/course_page.html

@@ -0,0 +1,20 @@
+{% extends "staff_base.html" %}
+
+{% load wagtailcore_tags %}
+
+{% block body_class %}template-blogindexpage{% endblock %}
+
+{% block content %}
+    <div class="row">
+        <div class="col-6">
+            <h1>{{ page.title }}</h1>
+
+            <div class="intro my-5">{{ page.intro|richtext }}</div>
+
+            {% for post in page.get_children %}
+                <h4><a href="{% pageurl post %}">{{ post.title }}</a></h4>
+            {% endfor %}
+        </div>
+    </div>
+
+{% endblock %}

staff/templates/staff/day_page.html

@@ -0,0 +1,20 @@
+{% extends "staff_base.html" %}
+
+{% load wagtailcore_tags %}
+
+{% block body_class %}template-blogindexpage{% endblock %}
+
+{% block content %}
+    <div class="row">
+        <div class="col-6">
+            <h1>{{ page.title }}</h1>
+
+            <div class="intro my-5">{{ page.body|richtext }}</div>
+
+            {% for post in page.get_children %}
+                <h2><a href="{% pageurl post %}">{{ post.title }}</a></h2>
+            {% endfor %}
+        </div>
+    </div>
+
+{% endblock %}

staff/tests/factories/batch_page_factory.py

@@ -0,0 +1,25 @@
+from django.utils.text import slugify
+from factory import LazyAttribute, SubFactory, Trait
+from factory.fuzzy import FuzzyText
+from wagtail_factories import PageFactory
+
+from staff.models import BatchPage
+from staff.tests.factories.batch_factory import BatchFactory
+
+class BatchPageFactory(PageFactory):
+    class Meta:
+        model = BatchPage
+
+    title = FuzzyText(length=15)
+    slug = LazyAttribute(lambda object: slugify(object.batch.number))
+    intro = FuzzyText(length=20)
+    batch = SubFactory(BatchFactory, swe_fundamentals=True)
+
+    class Params:
+        swe_fundamentals = Trait(
+            batch=SubFactory(BatchFactory, swe_fundamentals=True)
+        )
+
+        coding_bootcamp = Trait(
+            batch=SubFactory(BatchFactory, coding_bootcamp=True)
+        )

staff/tests/factories/course_page_factory.py

@@ -0,0 +1,25 @@
+from django.utils.text import slugify
+from factory import LazyAttribute, SubFactory, Trait
+from factory.fuzzy import FuzzyText
+from wagtail_factories import PageFactory
+
+from staff.models import CoursePage
+from staff.tests.factories.course_factory import CourseFactory
+
+class CoursePageFactory(PageFactory):
+    class Meta:
+        model = CoursePage
+
+    title = FuzzyText(length=15)
+    slug = LazyAttribute(lambda object: slugify(object.course.name.replace('_', '-')))
+    intro = FuzzyText(length=20)
+    course = SubFactory(CourseFactory, swe_fundamentals=True)
+
+    class Params:
+        swe_fundamentals = Trait(
+            course=SubFactory(CourseFactory, swe_fundamentals=True)
+        )
+
+        coding_bootcamp = Trait(
+            course=SubFactory(CourseFactory, coding_bootcamp=True)
+        )