wagtail 6.4rc1__py3-none-any.whl → 7.0__py3-none-any.whl

wagtail/snippets/tests/test_viewset.py

@@ -425,10 +425,10 @@ class TestFilterSetClass(BaseSnippetViewSetTests):
 
     def create_test_snippets(self):
         FullFeaturedSnippet.objects.create(
-            text="Nasi goreng from Indonesia", country_code="ID"
+            text="Nasi goreng from Indonesia", country_code="ID", some_number=123
         )
         FullFeaturedSnippet.objects.create(
-            text="Fish and chips from the UK", country_code="UK"
+            text="Fish and chips from the UK", country_code="UK", some_number=456
         )
 
     def test_get_include_filters_form_media(self):
@@ -511,6 +511,29 @@ class TestFilterSetClass(BaseSnippetViewSetTests):
         self.assertEqual(url, self.get_url("list_results"))
         self.assertNotIn("country_code=ID", params)
 
+    def test_range_filter(self):
+        self.create_test_snippets()
+        response = self.get({"some_number_min": 100, "some_number_max": 200})
+        self.assertContains(response, "Nasi goreng from Indonesia")
+        self.assertNotContains(response, "Fish and chips from the UK")
+        self.assertContains(response, "There is 1 match")
+        # Should render the active filters
+        soup = self.get_soup(response.content)
+        active_filters = soup.select_one(".w-active-filters")
+        self.assertIsNotNone(active_filters)
+        pill = active_filters.select_one(".w-pill")
+        self.assertIsNotNone(pill)
+        self.assertEqual(
+            pill.get_text(separator=" ", strip=True),
+            "Number range: 100 - 200",
+        )
+        clear = pill.select_one(".w-pill__remove")
+        self.assertIsNotNone(clear)
+        url, params = clear.attrs.get("data-w-swap-src-value").split("?", 1)
+        self.assertEqual(url, self.get_url("list_results"))
+        self.assertNotIn("some_number_min=100", params)
+        self.assertNotIn("some_number_max=200", params)
+
 
 class TestFilterSetClassSearch(WagtailTestUtils, TransactionTestCase):
     fixtures = ["test_empty.json"]
@@ -1204,7 +1227,7 @@ class TestMenuItemRegistration(BaseSnippetViewSetTests):
         self.assertEqual(item.url, reverse("wagtailsnippets:index"))
 
         # Clear cached property
-        del item._all_have_menu_items
+        del item._snippets_in_index_view
 
         with mock.patch(
             "wagtail.snippets.views.snippets.SnippetViewSet.get_menu_item_is_registered"
@@ -1214,6 +1237,19 @@ class TestMenuItemRegistration(BaseSnippetViewSetTests):
             snippets = [item for item in menu_items if item.name == "snippets"]
             self.assertEqual(len(snippets), 0)
 
+    def test_snippets_menu_item_hidden_when_user_lacks_permissions_for_snippets(self):
+        self.user.is_superuser = False
+        self.user.user_permissions.add(
+            Permission.objects.get(
+                content_type__app_label="wagtailadmin", codename="access_admin"
+            )
+        )
+        self.user.save()
+
+        menu_items = admin_menu.render_component(self.request)
+        snippets = [item for item in menu_items if item.name == "snippets"]
+        self.assertEqual(len(snippets), 0)
+
 
 class TestCustomFormClass(BaseSnippetViewSetTests):
     model = DraftStateModel
@@ -1471,9 +1507,6 @@ class TestInspectViewConfiguration(BaseSnippetViewSetTests):
 
 class TestBreadcrumbs(AdminTemplateTestUtils, BaseSnippetViewSetTests):
     model = FullFeaturedSnippet
-    base_breadcrumb_items = AdminTemplateTestUtils.base_breadcrumb_items + [
-        {"label": "Snippets", "url": "/admin/snippets/"},
-    ]
 
     @classmethod
     def setUpTestData(cls):
@@ -1645,3 +1678,33 @@ class TestCustomPermissionPolicy(BaseSnippetViewSetTests):
         self.assertEqual(self.user.get_full_name(), "[FORBIDDEN] Joe")
         response = self.client.get(self.get_url("edit", args=(quote(self.object.pk),)))
         self.assertRedirects(response, reverse("wagtailadmin_home"))
+
+
+class TestSnippetIndexViewBreadcrumbs(SimpleTestCase):
+    def test_snippet_without_menu_item_breadcrumbs(self):
+        self.assertEqual(
+            Advert.snippet_viewset.breadcrumbs_items,
+            [
+                {"url": reverse("wagtailadmin_home"), "label": "Home"},
+                {"url": reverse("wagtailsnippets:index"), "label": "Snippets"},
+            ],
+        )
+
+    def check_snippet_with_menu_item_breadcrumbs(self, expected):
+        self.assertEqual(DraftStateModel.snippet_viewset.breadcrumbs_items, expected)
+
+    def test_snippet_with_menu_item_breadcrumbs(self):
+        self.check_snippet_with_menu_item_breadcrumbs(
+            [
+                {"url": reverse("wagtailadmin_home"), "label": "Home"},
+            ],
+        )
+
+    @override_settings(WAGTAILSNIPPETS_MENU_SHOW_ALL=True)
+    def test_snippet_with_menu_item_breadcrumbs_show_all(self):
+        self.check_snippet_with_menu_item_breadcrumbs(
+            [
+                {"url": reverse("wagtailadmin_home"), "label": "Home"},
+                {"url": reverse("wagtailsnippets:index"), "label": "Snippets"},
+            ]
+        )

wagtail/snippets/tests/test_workflows.py

@@ -162,10 +162,6 @@ class TestEditViewNotLockable(TestEditView):
 
 
 class TestWorkflowHistory(AdminTemplateTestUtils, BaseWorkflowsTestCase):
-    base_breadcrumb_items = AdminTemplateTestUtils.base_breadcrumb_items + [
-        {"label": "Snippets", "url": "/admin/snippets/"},
-    ]
-
     def setUp(self):
         super().setUp()
         self.timestamps = [

wagtail/snippets/views/snippets.py

@@ -1,11 +1,9 @@
-from warnings import warn
-
 from django.apps import apps
+from django.conf import settings
 from django.contrib.admin.utils import quote
 from django.core import checks
 from django.core.exceptions import ImproperlyConfigured, PermissionDenied
 from django.http import Http404
-from django.shortcuts import redirect
 from django.urls import path, re_path, reverse, reverse_lazy
 from django.utils.functional import cached_property
 from django.utils.text import capfirst
@@ -20,7 +18,6 @@ from wagtail.admin.ui.side_panels import ChecksSidePanel, PreviewSidePanel
 from wagtail.admin.ui.tables import (
     BulkActionsCheckboxColumn,
     Column,
-    LiveStatusTagColumn,
     TitleColumn,
 )
 from wagtail.admin.views import generic
@@ -49,7 +46,6 @@ from wagtail.snippets.action_menu import SnippetActionMenu
 from wagtail.snippets.models import SnippetAdminURLFinder, get_snippet_models
 from wagtail.snippets.side_panels import SnippetStatusSidePanel
 from wagtail.snippets.views.chooser import SnippetChooserViewSet
-from wagtail.utils.deprecation import RemovedInWagtail70Warning
 
 
 # == Helper functions ==
@@ -72,6 +68,19 @@ def get_snippet_model_from_url_params(app_name, model_name):
 # == Views ==
 
 
+def get_snippet_models_for_index_view():
+    models = get_snippet_models()
+
+    if getattr(settings, "WAGTAILSNIPPETS_MENU_SHOW_ALL", False):
+        return models
+
+    return [
+        model
+        for model in models
+        if not model.snippet_viewset.get_menu_item_is_registered()
+    ]
+
+
 class ModelIndexView(generic.BaseListingView):
     page_title = gettext_lazy("Snippets")
     header_icon = "snippet"
@@ -90,7 +99,7 @@ class ModelIndexView(generic.BaseListingView):
                 "model": model,
                 "url": url,
             }
-            for model in get_snippet_models()
+            for model in get_snippet_models_for_index_view()
             if (url := self.get_list_url(model))
         ]
 
@@ -196,15 +205,7 @@ class IndexView(generic.IndexViewOptionalFeaturesMixin, generic.IndexView):
         # Pass the more_buttons to the construct hooks, as that's what contains
         # the default buttons and most buttons added via register_snippet_listing_buttons
         for hook in hooks.get_hooks("construct_snippet_listing_buttons"):
-            try:
-                hook(more_buttons, instance, self.request.user)
-            except TypeError:
-                warn(
-                    "construct_snippet_listing_buttons hook no longer accepts a context argument",
-                    RemovedInWagtail70Warning,
-                    stacklevel=2,
-                )
-                hook(more_buttons, instance, self.request.user, {})
+            hook(more_buttons, instance, self.request.user)
 
         if more_buttons:
             list_buttons.append(
@@ -765,21 +766,6 @@ class SnippetViewSet(ModelViewSet):
             workflow_history_url_name=self.get_url_name("workflow_history"),
         )
 
-    @property
-    def redirect_to_usage_view(self):
-        def redirect_to_usage(request, pk):
-            warn(
-                (
-                    "%s's `/<pk>/usage/` usage view URL pattern has been "
-                    "deprecated in favour of /usage/<pk>/."
-                )
-                % (self.__class__.__name__),
-                category=RemovedInWagtail70Warning,
-            )
-            return redirect(self.get_url_name("usage"), pk, permanent=True)
-
-        return redirect_to_usage
-
     @property
     def chooser_viewset(self):
         return self.chooser_viewset_class(
@@ -790,13 +776,6 @@ class SnippetViewSet(ModelViewSet):
             per_page=self.chooser_per_page,
         )
 
-    @cached_property
-    def list_display(self):
-        list_display = super().list_display.copy()
-        if self.draftstate_enabled:
-            list_display.append(LiveStatusTagColumn())
-        return list_display
-
     @cached_property
     def icon(self):
         return self.get_icon()
@@ -861,15 +840,24 @@ class SnippetViewSet(ModelViewSet):
     def get_menu_item_is_registered(self):
         return self.menu_item_is_registered
 
-    @cached_property
+    @property
     def breadcrumbs_items(self):
         # Use reverse_lazy instead of reverse
         # because this will be passed to the view classes at startup
-        return [
+        breadcrumbs = [
             {"url": reverse_lazy("wagtailadmin_home"), "label": _("Home")},
-            {"url": reverse_lazy("wagtailsnippets:index"), "label": _("Snippets")},
         ]
 
+        if (
+            getattr(settings, "WAGTAILSNIPPETS_MENU_SHOW_ALL", False)
+            or not self.get_menu_item_is_registered()
+        ):
+            breadcrumbs.append(
+                {"url": reverse_lazy("wagtailsnippets:index"), "label": _("Snippets")},
+            )
+
+        return breadcrumbs
+
     def get_queryset(self, request):
         """
         Returns a QuerySet of all model instances to be shown on the index view.
@@ -1147,19 +1135,7 @@ class SnippetViewSet(ModelViewSet):
                     ),
                 ]
 
-        # RemovedInWagtail70Warning: Remove legacy URL patterns
-        return urlpatterns + self._legacy_urlpatterns
-
-    @cached_property
-    def _legacy_urlpatterns(self):
-        return [
-            # RemovedInWagtail70Warning: Remove legacy URL patterns
-            # legacy URLs that could potentially collide if the pk matches one of the reserved names above
-            # ('add', 'edit' etc) - redirect to the unambiguous version
-            path("<str:pk>/", self.redirect_to_edit_view),
-            path("<str:pk>/delete/", self.redirect_to_delete_view),
-            path("<str:pk>/usage/", self.redirect_to_usage_view),
-        ]
+        return urlpatterns
 
     def get_edit_handler(self):
         """

wagtail/snippets/wagtail_hooks.py

@@ -5,7 +5,6 @@ from django.utils.translation import gettext_lazy as _
 from wagtail import hooks
 from wagtail.admin.menu import MenuItem
 from wagtail.snippets.bulk_actions.delete import DeleteBulkAction
-from wagtail.snippets.models import get_snippet_models
 from wagtail.snippets.permissions import user_can_access_snippets
 from wagtail.snippets.views import snippets as snippet_views
 
@@ -26,14 +25,11 @@ def register_admin_urls():
 
 class SnippetsMenuItem(MenuItem):
     @cached_property
-    def _all_have_menu_items(self):
-        return all(
-            model.snippet_viewset.get_menu_item_is_registered()
-            for model in get_snippet_models()
-        )
+    def _snippets_in_index_view(self):
+        return snippet_views.get_snippet_models_for_index_view()
 
     def is_shown(self, request):
-        return not self._all_have_menu_items and user_can_access_snippets(request.user)
+        return user_can_access_snippets(request.user, self._snippets_in_index_view)
 
 
 @hooks.register("register_admin_menu_item")

wagtail/templates/wagtailcore/shared/block_preview.html

@@ -18,7 +18,15 @@
         {% block body %}
             <main>
                 {% block content %}
-                    {% include_block bound_block %}
+                    {% comment %}
+                        StreamBlock renders each child block in a `div` wrapper
+                        like the following. Since we are rendering the block
+                        directly (without a StreamBlock), add the div wrapper
+                        here in case the styles rely on the `block-` CSS class.
+                    {% endcomment %}
+                    <div class="block-{{ block_def.name }}">
+                        {% include_block bound_block %}
+                    </div>
                 {% endblock %}
             </main>
 

wagtail/test/apps.py

@@ -0,0 +1,5 @@
+from wagtail.users.apps import WagtailUsersAppConfig
+
+
+class CustomUsersAppConfig(WagtailUsersAppConfig):
+    user_viewset = "wagtail.test.customuser.viewsets.CustomUserViewSet"

wagtail/test/context_processors.py

@@ -7,3 +7,22 @@ def do_not_use_static_url(request):
     return {
         "STATIC_URL": lambda: exception(),
     }
+
+
+CALL_COUNT = 0
+
+
+def count_calls(request):
+    global CALL_COUNT
+    CALL_COUNT += 1
+    return {}
+
+
+def get_call_count():
+    global CALL_COUNT
+    return CALL_COUNT
+
+
+def reset_call_count():
+    global CALL_COUNT
+    CALL_COUNT = 0

wagtail/test/customuser/forms.py

@@ -0,0 +1,19 @@
+from django import forms
+
+from wagtail.users.forms import UserCreationForm, UserEditForm
+
+
+class CustomUserCreationForm(UserCreationForm):
+    country = forms.CharField(required=True, label="Country")
+    attachment = forms.FileField(required=True, label="Attachment")
+
+    class Meta(UserCreationForm.Meta):
+        fields = UserCreationForm.Meta.fields | {"country", "attachment"}
+
+
+class CustomUserEditForm(UserEditForm):
+    country = forms.CharField(required=True, label="Country")
+    attachment = forms.FileField(required=True, label="Attachment")
+
+    class Meta(UserEditForm.Meta):
+        fields = UserEditForm.Meta.fields | {"country", "attachment"}

wagtail/test/customuser/viewsets.py

@@ -0,0 +1,12 @@
+from wagtail.users.views.users import UserViewSet as WagtailUserViewSet
+
+from .forms import CustomUserCreationForm, CustomUserEditForm
+
+
+class CustomUserViewSet(WagtailUserViewSet):
+    icon = "custom-icon"
+
+    def get_form_class(self, for_update=False):
+        if for_update:
+            return CustomUserEditForm
+        return CustomUserCreationForm

wagtail/test/settings.py

@@ -76,9 +76,9 @@ STORAGES = {
 }
 
 if os.environ.get("STATICFILES_STORAGE", "") == "manifest":
-    STORAGES["staticfiles"][
-        "BACKEND"
-    ] = "django.contrib.staticfiles.storage.ManifestStaticFilesStorage"
+    STORAGES["staticfiles"]["BACKEND"] = (
+        "django.contrib.staticfiles.storage.ManifestStaticFilesStorage"
+    )
 
 
 USE_TZ = not os.environ.get("DISABLE_TIMEZONE")
@@ -101,6 +101,7 @@ TEMPLATES = [
                 "django.template.context_processors.request",
                 "wagtail.test.context_processors.do_not_use_static_url",
                 "wagtail.contrib.settings.context_processors.settings",
+                "wagtail.test.context_processors.count_calls",
             ],
             "debug": True,  # required in order to catch template errors
         },
@@ -163,7 +164,6 @@ INSTALLED_APPS = [
     "wagtail.images",
     "wagtail.sites",
     "wagtail.locales",
-    "wagtail.users",
     "wagtail.snippets",
     "wagtail.documents",
     "wagtail.admin",
@@ -171,6 +171,7 @@ INSTALLED_APPS = [
     "wagtail",
     "taggit",
     "rest_framework",
+    "django_filters",
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",
@@ -212,17 +213,15 @@ WAGTAILSEARCH_BACKENDS = {
 EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
 
 if os.environ.get("USE_EMAIL_USER_MODEL"):
+    INSTALLED_APPS.append("wagtail.users")
     INSTALLED_APPS.append("wagtail.test.emailuser")
     AUTH_USER_MODEL = "emailuser.EmailUser"
     print("EmailUser (no username) user model active")  # noqa: T201
 else:
+    # this appconfig takes the place of wagtail.users
+    INSTALLED_APPS.append("wagtail.test.apps.CustomUsersAppConfig")
     INSTALLED_APPS.append("wagtail.test.customuser")
     AUTH_USER_MODEL = "customuser.CustomUser"
-    # Extra user field for custom user edit and create form tests. This setting
-    # needs to here because it is used at the module level of wagtailusers.forms
-    # when the module gets loaded. The decorator 'override_settings' does not work
-    # in this scenario.
-    WAGTAIL_USER_CUSTOM_FIELDS = ["country", "attachment"]
 
 if os.environ.get("DATABASE_ENGINE") == "django.db.backends.postgresql":
     WAGTAILSEARCH_BACKENDS["postgresql"] = {

wagtail/test/snippets/apps.py

@@ -7,3 +7,13 @@ class WagtailSnippetsTestsAppConfig(AppConfig):
     name = "wagtail.test.snippets"
     label = "snippetstests"
     verbose_name = _("Wagtail snippets tests")
+
+    def ready(self):
+        # Test registration of permission order within the group permissions view,
+        # as per https://docs.wagtail.org/en/stable/extending/customizing_group_views.html#customizing-the-group-editor-permissions-ordering
+        # Invoking `register` from `ready` confirms that it does not perform any database queries -
+        # if it did, it would fail (on a standard test run without --keepdb at least) because the
+        # test database hasn't been migrated yet.
+        from wagtail.users.permission_order import register
+
+        register("snippetstests.fancysnippet", order=999)

wagtail/test/streamfield_migrations/testutils.py

@@ -10,7 +10,7 @@ class MigrationTestMixin:
     default_operation_and_block_path = []
     app_name = None
 
-    def init_migration(self, revisions_from=None, operations_and_block_path=None):
+    def init_migration(self, revisions_from=None, operations_and_block_paths=None):
         migration = Migration(
             "test_migration", "wagtail_streamfield_migration_toolkit_test"
         )
@@ -18,7 +18,7 @@ class MigrationTestMixin:
             app_name=self.app_name,
             model_name=self.model.__name__,
             field_name="content",
-            operations_and_block_paths=operations_and_block_path
+            operations_and_block_paths=operations_and_block_paths
             or self.default_operation_and_block_path,
             revisions_from=revisions_from,
         )
@@ -29,11 +29,11 @@ class MigrationTestMixin:
     def apply_migration(
         self,
         revisions_from=None,
-        operations_and_block_path=None,
+        operations_and_block_paths=None,
     ):
         migration = self.init_migration(
             revisions_from=revisions_from,
-            operations_and_block_path=operations_and_block_path,
+            operations_and_block_paths=operations_and_block_paths,
         )
 
         loader = MigrationLoader(connection=connection)

wagtail/test/testapp/migrations/0046_alter_custom_rendition_to_unique_constraint.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.1.4 on 2025-01-19 21:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tests", "0045_alter_streampage_body"),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name="customrendition",
+            unique_together=set(),
+        ),
+        migrations.AddConstraint(
+            model_name="customrendition",
+            constraint=models.UniqueConstraint(
+                fields=("image", "filter_spec", "focal_point_key"),
+                name="unique_rendition",
+            ),
+        ),
+    ]

wagtail/test/testapp/migrations/0047_advertwithcustomuuidprimarykey_page.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.1.5 on 2025-02-13 01:36
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tests", "0046_alter_custom_rendition_to_unique_constraint"),
+        ("wagtailcore", "0094_alter_page_locale"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="advertwithcustomuuidprimarykey",
+            name="page",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to="wagtailcore.page",
+            ),
+        ),
+    ]

wagtail/test/testapp/migrations/0048_requireddatepage.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.1.5 on 2025-02-28 00:28
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tests", "0047_advertwithcustomuuidprimarykey_page"),
+        ("wagtailcore", "0094_alter_page_locale"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="RequiredDatePage",
+            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",
+                    ),
+                ),
+                ("deadline", models.DateField()),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("wagtailcore.page",),
+        ),
+    ]

wagtail/test/testapp/migrations/0049_promotionalpage.py

@@ -0,0 +1,35 @@
+# Generated by Django 5.0.12 on 2025-03-20 22:31
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tests", "0048_requireddatepage"),
+        ("wagtailcore", "0094_alter_page_locale"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="PromotionalPage",
+            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",
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+            },
+            bases=("wagtailcore.page",),
+        ),
+    ]

wagtail/test/testapp/migrations/0050_headcountrelatedmodelusingpk_related_page.py

@@ -0,0 +1,25 @@
+# Generated by Django 6.0.dev20250303103700 on 2025-03-21 07:17
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tests", "0049_promotionalpage"),
+        ("wagtailcore", "0094_alter_page_locale"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="headcountrelatedmodelusingpk",
+            name="related_page",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="head_count_relations",
+                to="wagtailcore.page",
+            ),
+        ),
+    ]