Feature/reorder ingredients countries 565

bakerydemo/breads/migrations/0010_alter_breadingredient_options_alter_country_options_and_more.py

@@ -0,0 +1,39 @@
+# Generated by Django 5.2.7 on 2025-10-27 08:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("breads", "0009_alter_breadpage_body"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="breadingredient",
+            options={
+                "ordering": ["sort_order", "name"],
+                "verbose_name": "bread ingredient",
+                "verbose_name_plural": "bread ingredients",
+            },
+        ),
+        migrations.AlterModelOptions(
+            name="country",
+            options={
+                "ordering": ["sort_order", "title"],
+                "verbose_name": "country of origin",
+                "verbose_name_plural": "countries of origin",
+            },
+        ),
+        migrations.AddField(
+            model_name="breadingredient",
+            name="sort_order",
+            field=models.IntegerField(blank=True, editable=False, null=True),
+        ),
+        migrations.AddField(
+            model_name="country",
+            name="sort_order",
+            field=models.IntegerField(blank=True, db_index=True, null=True),
+        ),
+    ]

bakerydemo/breads/migrations/0011_backfill_sort_order.py

@@ -0,0 +1,50 @@
+# Generated by Django 5.2.7 on 2025-10-27 08:12
+
+from django.db import migrations
+
+
+def backfill_country_sort_order(apps, schema_editor):
+    """
+    Backfill sort_order for existing Country instances.
+    Assigns sort_order based on alphabetical order of title.
+    """
+    Country = apps.get_model("breads", "Country")
+    for index, country in enumerate(Country.objects.order_by("title"), start=1):
+        country.sort_order = index * 10  # Use increments of 10 for flexibility
+        country.save(update_fields=["sort_order"])
+
+
+def backfill_ingredient_sort_order(apps, schema_editor):
+    """
+    Backfill sort_order for existing BreadIngredient instances.
+    Assigns sort_order based on alphabetical order of name.
+    """
+    BreadIngredient = apps.get_model("breads", "BreadIngredient")
+    for index, ingredient in enumerate(
+        BreadIngredient.objects.order_by("name"), start=1
+    ):
+        ingredient.sort_order = index * 10  # Use increments of 10 for flexibility
+        ingredient.save(update_fields=["sort_order"])
+
+
+def reverse_backfill(apps, schema_editor):
+    """
+    Reverse migration: set all sort_order values back to None.
+    """
+    Country = apps.get_model("breads", "Country")
+    Country.objects.update(sort_order=None)
+
+    BreadIngredient = apps.get_model("breads", "BreadIngredient")
+    BreadIngredient.objects.update(sort_order=None)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("breads", "0010_alter_breadingredient_options_alter_country_options_and_more"),
+    ]
+
+    operations = [
+        migrations.RunPython(backfill_country_sort_order, reverse_backfill),
+        migrations.RunPython(backfill_ingredient_sort_order, migrations.RunPython.noop),
+    ]

bakerydemo/breads/models.py

@@ -6,7 +6,7 @@
 from wagtail.admin.panels import FieldPanel, MultiFieldPanel
 from wagtail.api import APIField
 from wagtail.fields import StreamField
-from wagtail.models import DraftStateMixin, Page, RevisionMixin
+from wagtail.models import DraftStateMixin, Orderable, Page, RevisionMixin
 from wagtail.search import index
 
 from bakerydemo.base.blocks import BaseStreamBlock
@@ -24,6 +24,7 @@ class in wagtail_hooks.py. This allows us to customize the admin interface for t
     """
 
     title = models.CharField(max_length=100)
+    sort_order = models.IntegerField(null=True, blank=True, db_index=True)
 
     api_fields = [
         APIField("title"),
@@ -35,9 +36,10 @@ def __str__(self):
     class Meta:
         verbose_name = "country of origin"
         verbose_name_plural = "countries of origin"
+        ordering = ["sort_order", "title"]
 
 
-class BreadIngredient(DraftStateMixin, RevisionMixin, models.Model):
+class BreadIngredient(Orderable, DraftStateMixin, RevisionMixin, models.Model):
     """
     A Django model to store a single ingredient.
     It is made accessible in the Wagtail admin interface through the BreadIngredientSnippetViewSet
@@ -71,6 +73,7 @@ def __str__(self):
     class Meta:
         verbose_name = "bread ingredient"
         verbose_name_plural = "bread ingredients"
+        ordering = ["sort_order", "name"]
 
 
 class BreadType(RevisionMixin, models.Model):
@@ -181,6 +184,11 @@ class BreadPage(Page):
         APIField("ingredients"),
     ]
 
+    @property
+    def ordered_ingredients(self):
+        """Return ingredients ordered by sort_order, then name."""
+        return self.ingredients.order_by("sort_order", "name")
+
 
 class BreadsIndexPage(Page):
     """

bakerydemo/breads/tests.py

@@ -0,0 +1,71 @@
+from django.test import TestCase
+
+from bakerydemo.breads.models import BreadIngredient, Country
+
+
+class CountryModelTest(TestCase):
+    """Test Country model ordering and sort_order field."""
+
+    def test_country_has_sort_order_field(self):
+        """Test that Country model has sort_order field."""
+        country = Country(title="Test Country", sort_order=10)
+        country.save()
+        self.assertEqual(country.sort_order, 10)
+
+    def test_country_ordering_respects_sort_order(self):
+        """Test that Country model ordering includes sort_order."""
+        Country.objects.create(title="Country A", sort_order=20)
+        Country.objects.create(title="Country B", sort_order=10)
+        Country.objects.create(title="Country C", sort_order=30)
+
+        countries = list(Country.objects.all())
+        self.assertEqual(countries[0].title, "Country B")
+        self.assertEqual(countries[1].title, "Country A")
+        self.assertEqual(countries[2].title, "Country C")
+
+    def test_country_ordering_with_null_sort_order(self):
+        """Test that Country with null sort_order is ordered by title."""
+        Country.objects.create(title="AAA", sort_order=None)
+        Country.objects.create(title="BBB", sort_order=10)
+        Country.objects.create(title="CCC", sort_order=None)
+
+        countries = list(Country.objects.all())
+        # NULL sort_order values come first in SQL, then ordered by title
+        # Then items with sort_order
+        self.assertEqual(countries[0].title, "AAA")
+        self.assertEqual(countries[1].title, "CCC")
+        self.assertEqual(countries[2].title, "BBB")
+
+
+class BreadIngredientModelTest(TestCase):
+    """Test BreadIngredient model ordering and sort_order field."""
+
+    def test_ingredient_has_sort_order_field(self):
+        """Test that BreadIngredient model has sort_order field."""
+        ingredient = BreadIngredient(name="Test Ingredient", sort_order=10)
+        ingredient.save()
+        self.assertEqual(ingredient.sort_order, 10)
+
+    def test_ingredient_ordering_respects_sort_order(self):
+        """Test that BreadIngredient model ordering includes sort_order."""
+        BreadIngredient.objects.create(name="Ingredient A", sort_order=20)
+        BreadIngredient.objects.create(name="Ingredient B", sort_order=10)
+        BreadIngredient.objects.create(name="Ingredient C", sort_order=30)
+
+        ingredients = list(BreadIngredient.objects.all())
+        self.assertEqual(ingredients[0].name, "Ingredient B")
+        self.assertEqual(ingredients[1].name, "Ingredient A")
+        self.assertEqual(ingredients[2].name, "Ingredient C")
+
+    def test_ingredient_ordering_with_null_sort_order(self):
+        """Test that BreadIngredient with null sort_order is ordered by name."""
+        BreadIngredient.objects.create(name="AAA", sort_order=None)
+        BreadIngredient.objects.create(name="BBB", sort_order=10)
+        BreadIngredient.objects.create(name="CCC", sort_order=None)
+
+        ingredients = list(BreadIngredient.objects.all())
+        # NULL sort_order values come first in SQL, then ordered by name
+        # Then items with sort_order
+        self.assertEqual(ingredients[0].name, "AAA")
+        self.assertEqual(ingredients[1].name, "CCC")
+        self.assertEqual(ingredients[2].name, "BBB")

bakerydemo/breads/wagtail_hooks.py

@@ -18,10 +18,11 @@ class Meta:
 
 class BreadIngredientSnippetViewSet(SnippetViewSet):
     model = BreadIngredient
-    ordering = ("name",)
+    ordering = ("sort_order", "name")
     search_fields = ("name",)
     filterset_class = BreadIngredientFilterSet
     inspect_view_enabled = True
+    sort_order_field = "sort_order"
 
 
 class BreadTypeFilterSet(RevisionFilterSetMixin, WagtailFilterSet):
@@ -39,10 +40,11 @@ class BreadTypeSnippetViewSet(SnippetViewSet):
 
 class CountryModelViewSet(ModelViewSet):
     model = Country
-    ordering = ("title",)
+    ordering = ("sort_order", "title")
     search_fields = ("title",)
     icon = "globe"
     inspect_view_enabled = True
+    sort_order_field = "sort_order"
 
     panels = [
         FieldPanel("title"),

bakerydemo/templates/breads/bread_page.html

@@ -32,7 +32,7 @@
                                 <p class="bread-detail__meta-title">Type</p>
                                 <p class="bread-detail__meta-content">{{ page.bread_type }}</p>
                             {% endif %}
-                            {% with ingredients=page.ingredients.all %}
+                            {% with ingredients=page.ordered_ingredients %}
                                 {% if ingredients %}
                                     <h4>Ingredients</h4>
                                     <ul>