Some followup main menu changes: harder check to not avoid access control, rename middleware

Author: boxed

docs/test_doc_main_menu.py

@@ -3,7 +3,7 @@
 from iommi.experimental.main_menu import (
     M,
     MainMenu,
-    menu_access_control_middleware,
+    main_menu_middleware,
 )
 from tests.helpers import (
     req,
@@ -21,7 +21,7 @@
 
 The main menu component in iommi is used to create the main navigation for your app. This is primarily useful for SaaS or internal apps. It creates a sidebar menu with support for nested menu items, and centralized access control that automatically shows only menu items the user has access to.
 
-To set up your main menu you declare it, register the `iommi.experimental.main_menu.menu_access_control_middleware` middleware, and define the `IOMMI_MAIN_MENU` setting to point to where you have defined it (like `IOMMI_MAIN_MENU = 'your_app.main_menu.main_menu'`). 
+To set up your main menu you declare it, register the `iommi.experimental.main_menu.main_menu_middleware` middleware, and define the `IOMMI_MAIN_MENU` setting to point to where you have defined it (like `IOMMI_MAIN_MENU = 'your_app.main_menu.main_menu'`). 
 
 Access control is recursive, meaning that if a user does not have access to a menu item, it is automatically denied access to all subitems.
 """
@@ -51,8 +51,8 @@ def test_base(settings, medium_discography):
     # @test
     settings.IOMMI_MAIN_MENU = 'docs.test_doc_main_menu.menu_declaration'
     settings.ROOT_URLCONF = 'docs.test_doc_main_menu'
-    assert 'iommi.experimental.main_menu.menu_access_control_middleware' in settings.MIDDLEWARE
+    assert 'iommi.experimental.main_menu.main_menu_middleware' in settings.MIDDLEWARE
 
-    response = menu_access_control_middleware(get_response=lambda request: Table(auto__model=Artist).bind(request=request).render_to_response())(req('get', url='/artists/'))
+    response = main_menu_middleware(get_response=lambda request: Table(auto__model=Artist).bind(request=request).render_to_response())(req('get', url='/artists/'))
     show_output(response)
     # @end

examples/examples/settings.py

@@ -87,7 +87,7 @@
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
     'iommi.middleware',
-    'iommi.experimental.main_menu.menu_access_control_middleware',
+    'iommi.experimental.main_menu.main_menu_middleware',
 ]
 
 

iommi/experimental/main_menu.py

@@ -71,6 +71,10 @@ def __init__(self, *, items=None, attrs, template=MISSING, paths=None):
             c._set_name(name)
 
     def urlpatterns(self):
+        if 'iommi.experimental.main_menu.main_menu_middleware' not in settings.MIDDLEWARE:
+            # This is an explicit raise instead of an `assert` because I'm paranoid of people running Python in optimized mode with skipped asserts.
+            raise AssertionError('To use the iommi main menu, you must add `iommi.experimental.main_menu.main_menu_middleware` to the MIDDLEWARE list.')
+
         return [
             path(x.path, x.urlpatterns())
             for x in self.items.values()
@@ -380,8 +384,8 @@ def check_access(self):
             item.check_access()
 
 
-def menu_access_control_middleware(get_response):
-    def menu_access_control_middleware_inner(request):
+def main_menu_middleware(get_response):
+    def main_menu_middleware_inner(request):
         if request.resolver_match is None:
             request.resolver_match = get_resolver().resolve(request.path_info)
 
@@ -395,7 +399,7 @@ def menu_access_control_middleware_inner(request):
                     return handler403(request, exception=exception)
 
         menu_fully_qualified_name = getattr(settings, 'IOMMI_MAIN_MENU', None)
-        assert menu_fully_qualified_name is not None, "To use the menu_access_control_middleware, you must define settings.IOMMI_MAIN_MENU as a string to the full path to the main menu declaration"
+        assert menu_fully_qualified_name is not None, "To use the main_menu_middleware, you must define settings.IOMMI_MAIN_MENU as a string to the full path to the main menu declaration"
         assert '.' in menu_fully_qualified_name, "IOMMI_MAIN_MENU must be in `your_module.symbol` format"
         menu_module_name, _, menu_symbol_name = menu_fully_qualified_name.rpartition('.')
 
@@ -410,4 +414,4 @@ def menu_access_control_middleware_inner(request):
 
         return get_response(request)
 
-    return menu_access_control_middleware_inner
+    return main_menu_middleware_inner

iommi/experimental/main_menu__tests.py

@@ -14,7 +14,7 @@
     EXTERNAL,
     M,
     MainMenu,
-    menu_access_control_middleware,
+    main_menu_middleware,
     path,
 )
 from iommi.path import (
@@ -186,7 +186,7 @@ def test_access(settings):
     settings.ROOT_URLCONF = 'iommi.experimental.main_menu__tests'
 
     ok = object()
-    inner = menu_access_control_middleware(lambda request: ok)
+    inner = main_menu_middleware(lambda request: ok)
 
     assert inner(staff_req('get', url='/foo/')) == ok
     assert inner(staff_req('get', url='/foo/bar/')) == ok
@@ -241,7 +241,7 @@ def decode_artist(string, **_):
 
     with register_path_decoding(artist_pk=PathDecoder(decode=decode_artist, name='artist')):
         ok = object()
-        inner = menu_access_control_middleware(lambda request: ok)
+        inner = main_menu_middleware(lambda request: ok)
 
         assert inner(staff_req('get', url=f'/{black_sabbath.pk}/')) == ok
 
@@ -251,7 +251,7 @@ def decode_artist_permission_denied(**_):
 
     with register_path_decoding(artist_pk=PathDecoder(decode=decode_artist_permission_denied, name='artist')):
         ok = object()
-        inner = menu_access_control_middleware(lambda request: ok)
+        inner = main_menu_middleware(lambda request: ok)
 
         result = inner(staff_req('get', url=f'/{black_sabbath.pk}/'))
         assert isinstance(result, HttpResponseForbidden)

tests/settings.py

@@ -44,7 +44,7 @@
 IOMMI_MAIN_MENU = 'tests.main_menu.main_menu'
 
 MIDDLEWARE = [
-    'iommi.experimental.main_menu.menu_access_control_middleware',
+    'iommi.experimental.main_menu.main_menu_middleware',
     'iommi.live_edit.Middleware',
     'iommi.sql_trace.Middleware',
     'django.middleware.security.SecurityMiddleware',