wagtail-developer-reference 0.1.4__tar.gz → 0.1.5__tar.gz

{wagtail_developer_reference-0.1.4/wagtail_developer_reference.egg-info → wagtail_developer_reference-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wagtail-developer-reference
-Version: 0.1.4
+Version: 0.1.5
 Summary: A visual auditing tool for Wagtail developers to track Page models and StreamField blocks.
 Author-email: Four Digits <info@fourdigits.nl>
 Project-URL: Homepage, https://github.com/fourdigits/wagtail-developer-reference
@@ -72,5 +72,24 @@ By default, no account can see the menu item or access the URLs. Superusers are
 granted access automatically by this package; assign the permission directly or
 through a group.
 
+## Settings
+
+### `WAGTAIL_DEVELOPER_REFERENCE_ALLOW_ALL_ADMIN_USERS`
+
+Default: `False`.
+
+Set this to `True` in your Django settings to allow all active, authenticated
+users with access to the Wagtail admin (`wagtailadmin.access_admin`) to see the
+**System Registry** menu item and access the Developer Reference URLs, without
+assigning the additional Developer Reference permission:
+
+```python
+WAGTAIL_DEVELOPER_REFERENCE_ALLOW_ALL_ADMIN_USERS = True
+```
+
+This includes active superusers. When omitted or set to `False`, the explicit
+user or group permission described above is still required, including for
+superusers.
+
 ## License
 **Internal Use Only** - Copyright © 2026 Fourdigits. All rights reserved.

{wagtail_developer_reference-0.1.4 → wagtail_developer_reference-0.1.5}/README.md

@@ -46,5 +46,24 @@ By default, no account can see the menu item or access the URLs. Superusers are
 granted access automatically by this package; assign the permission directly or
 through a group.
 
+## Settings
+
+### `WAGTAIL_DEVELOPER_REFERENCE_ALLOW_ALL_ADMIN_USERS`
+
+Default: `False`.
+
+Set this to `True` in your Django settings to allow all active, authenticated
+users with access to the Wagtail admin (`wagtailadmin.access_admin`) to see the
+**System Registry** menu item and access the Developer Reference URLs, without
+assigning the additional Developer Reference permission:
+
+```python
+WAGTAIL_DEVELOPER_REFERENCE_ALLOW_ALL_ADMIN_USERS = True
+```
+
+This includes active superusers. When omitted or set to `False`, the explicit
+user or group permission described above is still required, including for
+superusers.
+
 ## License
 **Internal Use Only** - Copyright © 2026 Fourdigits. All rights reserved.

{wagtail_developer_reference-0.1.4 → wagtail_developer_reference-0.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wagtail-developer-reference"
-version = "0.1.4"
+version = "0.1.5"
 description = "A visual auditing tool for Wagtail developers to track Page models and StreamField blocks."
 readme = "README.md"
 authors = [{name = "Four Digits", email = "info@fourdigits.nl" }]

{wagtail_developer_reference-0.1.4 → wagtail_developer_reference-0.1.5}/setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="wagtail-developer-reference",
-    version="0.1.4",
+    version="0.1.5",
     packages=find_packages(),
     include_package_data=True,
     install_requires=[

{wagtail_developer_reference-0.1.4 → wagtail_developer_reference-0.1.5}/wagtail_developer_reference/templates/index.html

@@ -39,6 +39,24 @@
     }
     .quick-search-item .type-tag { margin-right: 0.35rem; }
     .registry-controls label { display: block; font-weight: bold; color: white; margin-bottom: 0.5rem; }
+    .registry-controls .usage-label { display: flex; align-items: center; gap: 0.35rem; margin-bottom: 0.5rem; }
+    .registry-controls .usage-label label { margin-bottom: 0; }
+    .usage-help { position: relative; display: inline-flex; }
+    .usage-help-icon {
+        background: transparent; border: 1px solid currentColor; border-radius: 50%;
+        color: white; cursor: help; font: bold 0.8rem serif;
+        width: 1.25rem; height: 1.25rem; padding: 0;
+    }
+    .usage-help-icon:focus-visible { outline: 2px solid #dcbd3d; outline-offset: 2px; }
+    .usage-help-tooltip {
+        display: none; position: absolute; top: 100%; right: 0; z-index: 20;
+        width: 16rem; max-width: calc(100vw - 3rem); padding: 0.75rem;
+        background: #222; border: 1px solid #dcbd3d; color: white;
+        font-size: 0.875rem; font-weight: normal; line-height: 1.5;
+    }
+    .usage-help:hover .usage-help-tooltip,
+    .usage-help:focus-within .usage-help-tooltip { display: block; }
+    .usage-help-tooltip[hidden] { display: none; }
     .registry-controls input, .registry-controls select {
         box-sizing: border-box; height: 2.5rem; width: 100%;
         border: 1px solid #dcbd3d; background: #333; color: white; border-radius: 0;
@@ -133,7 +151,16 @@
             <div class="registry-search"><label for="reg-search">Search Registry</label><input type="search" id="reg-search" name="q" value="{{ filters.q }}" placeholder="Name, field or site..."></div>
             <div><label for="reg-filter">Component Type</label><select id="reg-filter" name="type"><option value="ALL" {% if filters.type == "ALL" %}selected{% endif %}>All</option><option value="PAGE" {% if filters.type == "PAGE" %}selected{% endif %}>Pages</option><option value="BLOCK" {% if filters.type == "BLOCK" %}selected{% endif %}>Blocks</option></select></div>
             <div><label for="reg-site-filter">Site</label><select id="reg-site-filter" name="site"><option value="">All sites</option>{% for site in sites %}<option value="{{ site.id }}" {% if filters.site == site.id|stringformat:"s" %}selected{% endif %}>{{ site.site_name }}</option>{% endfor %}</select></div>
-            <div class="usage-range"><label for="min-usage">Min usage</label><input id="min-usage" type="number" min="0" name="min_usage" value="{{ filters.min_usage }}"></div>
+            <div class="usage-range">
+                <span class="usage-label">
+                    <label for="min-usage">Min usage</label>
+                    <span class="usage-help">
+                        <button id="min-usage-help" class="usage-help-icon" type="button" aria-label="About Min usage" aria-describedby="min-usage-tooltip"><span aria-hidden="true">i</span></button>
+                        <span id="min-usage-tooltip" class="usage-help-tooltip" role="tooltip">Usage counts for pages, blocks, images and documents are only shown when Min usage is filled in. Enter 0 to include items with no usage, then apply the filters.</span>
+                    </span>
+                </span>
+                <input id="min-usage" type="number" min="0" name="min_usage" value="{{ filters.min_usage }}" aria-describedby="min-usage-tooltip">
+            </div>
             <div class="usage-range"><label for="max-usage">Max usage</label><input id="max-usage" type="number" min="0" name="max_usage" value="{{ filters.max_usage }}"></div>
             <div class="filter-actions"><button type="submit" class="button">Apply Filters</button><a class="button button-secondary" href="{% url 'dev_reference' %}">Clear</a></div>
         </form>
@@ -214,6 +241,23 @@
     </div>
 
     <script>
+        const usageHelp = document.getElementById("min-usage-help");
+        const usageTooltip = document.getElementById("min-usage-tooltip");
+        ["mouseenter", "focus", "click"].forEach(eventName => {
+            usageHelp.addEventListener(eventName, () => {
+                usageTooltip.hidden = false;
+                usageTooltip.style.transform = "";
+                const tooltipLeft = usageTooltip.getBoundingClientRect().left;
+                if (tooltipLeft < 16) {
+                    usageTooltip.style.transform = `translateX(${16 - tooltipLeft}px)`;
+                }
+            });
+        });
+        window.addEventListener("resize", () => { usageTooltip.hidden = true; });
+        document.addEventListener("keydown", event => {
+            if (event.key === "Escape") usageTooltip.hidden = true;
+        });
+
         let currentSortColumn = -1;
         let isSortAscending = true;
 

wagtail_developer_reference-0.1.5/wagtail_developer_reference/tests/test_registry.py

@@ -0,0 +1,37 @@
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import Permission
+from django.test import TestCase
+from django.urls import reverse
+
+
+class RegistryHelpTests(TestCase):
+    def test_min_usage_help_is_available_without_applying_filters(self):
+        user = get_user_model().objects.create_superuser(
+            username="registry-admin", email="admin@example.com", password="password"
+        )
+        user.user_permissions.add(
+            Permission.objects.get(
+                content_type__app_label="wagtail_developer_reference",
+                codename="access_developer_reference",
+            )
+        )
+        self.client.force_login(user)
+
+        response = self.client.get(reverse("dev_reference"))
+
+        self.assertContains(response, '<label for="min-usage">Min usage</label>')
+        self.assertContains(
+            response,
+            '<button id="min-usage-help" class="usage-help-icon" type="button" '
+            'aria-label="About Min usage" aria-describedby="min-usage-tooltip">'
+            '<span aria-hidden="true">i</span></button>',
+            html=True,
+        )
+        self.assertContains(
+            response,
+            '<span id="min-usage-tooltip" class="usage-help-tooltip" role="tooltip">'
+            "Usage counts for pages, blocks, images and documents are only shown "
+            "when Min usage is filled in. Enter 0 to include items with no usage, "
+            "then apply the filters.</span>",
+            html=True,
+        )

{wagtail_developer_reference-0.1.4 → wagtail_developer_reference-0.1.5}/wagtail_developer_reference/wagtail_hooks.py

@@ -9,6 +9,7 @@ from pathlib import Path
 from typing import Any, Literal, Optional, TypedDict
 from urllib.parse import urlencode
 
+from django.conf import settings
 from django.contrib.auth.decorators import user_passes_test
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import PermissionDenied
@@ -85,6 +86,10 @@ def user_can_access_developer_reference(user: Any) -> bool:
         return False
     if not getattr(user, "is_active", False):
         return False
+
+    if getattr(settings, "WAGTAIL_DEVELOPER_REFERENCE_ALLOW_ALL_ADMIN_USERS", False):
+        return user.has_perm("wagtailadmin.access_admin")
+
     return user.user_permissions.filter(
         codename=ACCESS_PERMISSION_CODENAME,
         content_type__app_label=ACCESS_PERMISSION_APP_LABEL,

{wagtail_developer_reference-0.1.4 → wagtail_developer_reference-0.1.5/wagtail_developer_reference.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wagtail-developer-reference
-Version: 0.1.4
+Version: 0.1.5
 Summary: A visual auditing tool for Wagtail developers to track Page models and StreamField blocks.
 Author-email: Four Digits <info@fourdigits.nl>
 Project-URL: Homepage, https://github.com/fourdigits/wagtail-developer-reference
@@ -72,5 +72,24 @@ By default, no account can see the menu item or access the URLs. Superusers are
 granted access automatically by this package; assign the permission directly or
 through a group.
 
+## Settings
+
+### `WAGTAIL_DEVELOPER_REFERENCE_ALLOW_ALL_ADMIN_USERS`
+
+Default: `False`.
+
+Set this to `True` in your Django settings to allow all active, authenticated
+users with access to the Wagtail admin (`wagtailadmin.access_admin`) to see the
+**System Registry** menu item and access the Developer Reference URLs, without
+assigning the additional Developer Reference permission:
+
+```python
+WAGTAIL_DEVELOPER_REFERENCE_ALLOW_ALL_ADMIN_USERS = True
+```
+
+This includes active superusers. When omitted or set to `False`, the explicit
+user or group permission described above is still required, including for
+superusers.
+
 ## License
 **Internal Use Only** - Copyright © 2026 Fourdigits. All rights reserved.

{wagtail_developer_reference-0.1.4 → wagtail_developer_reference-0.1.5}/wagtail_developer_reference.egg-info/SOURCES.txt

@@ -16,4 +16,5 @@ wagtail_developer_reference/migrations/__init__.py
 wagtail_developer_reference/templates/detail.html
 wagtail_developer_reference/templates/index.html
 wagtail_developer_reference/tests/__init__.py
-wagtail_developer_reference/tests/test_auditor.py
+wagtail_developer_reference/tests/test_auditor.py
+wagtail_developer_reference/tests/test_registry.py