Nicer FBV support

boxed · boxed · commit 7db1f3b0df4e · 2025-11-11T19:26:41.000+01:00
diff --git a/docs/templates/view_artist4.html b/docs/templates/view_artist4.html
@@ -0,0 +1,13 @@
+{% extends "iommi/base.html" %}
+
+{% block content %}
+    <h1>{{ artist }}</h1>
+
+    <ul>
+        {% for album in artist.albums.all %}
+            <li>
+                {{ album }}
+            </li>
+        {% endfor %}
+    </ul>
+{% endblock %}
diff --git a/docs/test_doc_legacy_fbv.py b/docs/test_doc_legacy_fbv.py
@@ -9,10 +9,12 @@
     Track,
 )
 from iommi import (
+    middleware,
     Page,
     Table,
 )
 from iommi.docs import show_output
+from iommi.main_menu import main_menu_middleware
 from tests.helpers import (
     call_view_through_middleware,
     req,
@@ -198,3 +200,45 @@ class MyPage(Page):
     assert black_sabbath.name not in response.content.decode()
     assert album.name in response.content.decode()
     # @end
+
+
+def test_legacy_fbv_with_main_menu_and_basic_html(settings, black_sabbath, medium_discography):
+    # language=rst
+    """
+    Using iommi's base template with a FBV
+    ======================================
+
+    For existing FBVs, you can get the iommi `MainMenu` and the base style
+    assets by simply extending `iommi/base.html`:
+
+    """
+    # @test
+    settings.DEBUG = True
+    settings.IOMMI_MAIN_MENU = 'iommi.main_menu__tests.menu_declaration'
+    settings.ROOT_URLCONF = 'iommi.main_menu__tests'
+    assert 'iommi.main_menu.main_menu_middleware' in settings.MIDDLEWARE
+    # @end
+
+    def view_artist(request, artist_name):
+        artist = get_object_or_404(Artist, name=artist_name)
+        return render(
+            request,
+            'view_artist4.html',
+            context={
+                'artist': artist,
+            }
+        )
+
+    # language=rst
+    """
+    .. literalinclude:: templates/view_artist4.html
+        :language: jinja
+    """
+
+    # @test
+    foo = main_menu_middleware(get_response=lambda request: view_artist(request, artist_name=black_sabbath.name))
+    bar = middleware(get_response=foo)
+    response = bar(req('get', url='/artists/'))
+    show_output(response)
+    assert black_sabbath.name in response.content.decode()
+    # @end
diff --git a/iommi/__init__.py b/iommi/__init__.py
@@ -55,6 +55,7 @@
     register_cell_formatter,
     register_column_factory,
 )
+from iommi.thread_locals import get_current_request
 
 setup_db_compat()
 
@@ -97,6 +98,8 @@ def process_view(self, request, view_func, view_args, view_kwargs):
         request.iommi_not_atomic_for = getattr(view_func, '_non_atomic_requests', set())
 
     def __call__(self, request):
+        # For plain FBVs that want to extend iommi/base.html, we need to insert some assets
+        request.iommi_fallback_assets = lambda: Page().bind(request=get_current_request()).iommi_collected_assets()
         response = self.get_response(request)
 
         if isinstance(response, Part):
diff --git a/iommi/templates/iommi/base.html b/iommi/templates/iommi/base.html
@@ -3,11 +3,19 @@
 <head>
     <title>{% block title %}{% if title %}{{ title }}{% endif %}{% endblock %}</title>
     {% block iommi_head_contents %}{% endblock %}
-    {% for asset in assets.values %}
-        {% if not asset.in_body %}
-            {{ asset }}
-        {% endif %}
-    {% endfor %}
+    {% if assets %}
+        {% for asset in assets.values %}
+            {% if not asset.in_body %}
+                {{ asset }}
+            {% endif %}
+        {% endfor %}
+    {% elif request.iommi_fallback_assets %}
+        {% for asset in request.iommi_fallback_assets.values %}
+            {% if not asset.in_body %}
+                {{ asset }}
+            {% endif %}
+        {% endfor %}
+    {% endif %}
     {% block iommi_head_contents_last %}{% endblock %}
 </head>
 <body{% block iommi_body_tag_attrs %}{% if request.iommi_main_menu %} class="sidebar_menu_active"{% endif %}{% endblock %}>
@@ -25,10 +33,18 @@
 
     {% block iommi_bottom %}{% endblock %}
 
-    {% for asset in assets.values %}
-        {% if asset.in_body %}
-            {{ asset }}
-        {% endif %}
-    {% endfor %}
+    {% if assets %}
+        {% for asset in assets.values %}
+            {% if asset.in_body %}
+                {{ asset }}
+            {% endif %}
+        {% endfor %}
+    {% elif request.iommi_fallback_assets %}
+        {% for asset in request.iommi_fallback_assets.values %}
+            {% if asset.in_body %}
+                {{ asset }}
+            {% endif %}
+        {% endfor %}
+    {% endif %}
 </body>
 </html>
