Remove deprecated view-based asset serving and related code (#171)

* Remove deprecated view-based asset serving and related code

* update changelog

* remove newline

* remove prints

* make mypy happy

* add views to coverage ignore

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: joshuadavidthomas

CHANGELOG.md

@@ -22,6 +22,10 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 - Added the `{% bird:var %}` templatetag for managing local context variables within components, including support for appending, overwriting, and resetting values. Variables are scoped to components and automatically are cleaned up when the component finishes rendering, with optional explicit cleanup via `{% endbird:var %}`.
 
+### Removed
+
+- Removed the deprecated asset serving view (`asset_view`) and its URL configuration. Use `BirdAssetFinder` with Django's staticfiles app instead.
+
 ## [0.13.2]
 
 ### Fixed

docs/assets.md

@@ -133,27 +133,3 @@ python manage.py collectstatic
 ```
 
 This will collect all component assets into your static files directory, allowing you to serve them via your web server, [WhiteNoise](https://whitenoise.readthedocs.io), or a CDN.
-
-### Deprecated View-Based Serving
-
-```{warning}
-**Warning:** The built-in asset serving view is deprecated and will be removed in a future release. Please switch to using the custom staticfiles finder and serve assets through Django's static files system.
-```
-
-If you still need to use the view-based asset serving during the transition, you can enable it by adding django-bird's URLs to your project's URL configuration:
-
-```{code-block} python
-:caption: urls.py
-
-from django.conf import settings
-from django.urls import include
-from django.urls import path
-
-
-if settings.DEBUG:
-    urlpatterns = [
-        path("__bird__/", include("django_bird.urls")),
-    ]
-```
-
-This will make component assets available at `/__bird__/assets/<component_name>/<asset_filename>` when `DEBUG` is `True`.

pyproject.toml

@@ -117,7 +117,12 @@ exclude_lines = [
 fail_under = 98
 
 [tool.coverage.run]
-omit = ["src/django_bird/migrations/*", "src/django_bird/_typing.py", "tests/*"]
+omit = [
+  "src/django_bird/migrations/*",
+  "src/django_bird/_typing.py",
+  "src/django_bird/views.py",  # TODO: remove when not empty
+  "tests/*"
+]
 source = ["src/django_bird"]
 
 [tool.django-stubs]

src/django_bird/staticfiles.py

@@ -16,7 +16,6 @@
 from django.contrib.staticfiles.storage import StaticFilesStorage
 from django.core.checks import CheckMessage
 from django.core.files.storage import FileSystemStorage
-from django.urls import reverse
 
 from ._typing import override
 from .apps import DjangoBirdAppConfig
@@ -70,6 +69,9 @@ def exists(self) -> bool:
         return self.path.exists()
 
     def render(self):
+        if self.url is None:
+            return ""
+
         match self.type:
             case AssetType.CSS:
                 return f'<link rel="stylesheet" href="{self.url}">'
@@ -101,18 +103,12 @@ def template_dir(self):
         return template_dir.parent
 
     @property
-    def url(self) -> str:
+    def url(self) -> str | None:
         static_path = finders.find(str(self.relative_path))
-        if static_path is not None:
-            static_relative_path = Path(static_path).relative_to(self.template_dir)
-            return self.storage.url(str(static_relative_path))
-        return reverse(
-            "django_bird:asset",
-            kwargs={
-                "component_name": self.path.stem,
-                "asset_filename": self.path.name,
-            },
-        )
+        if static_path is None:
+            return None
+        static_relative_path = Path(static_path).relative_to(self.template_dir)
+        return self.storage.url(str(static_relative_path))
 
     @classmethod
     def from_path(cls, path: Path, asset_type: AssetType):

src/django_bird/urls.py

@@ -1,12 +1,7 @@
 from __future__ import annotations
 
-from django.urls import path
-
 from .apps import DjangoBirdAppConfig
-from .views import asset_view
 
 app_name = DjangoBirdAppConfig.label
 
-urlpatterns = [
-    path("assets/<str:component_name>/<str:asset_filename>", asset_view, name="asset"),
-]
+urlpatterns = []  # type: ignore[var-annotated]

src/django_bird/views.py

@@ -1,41 +1 @@
 from __future__ import annotations
-
-import warnings
-from io import BytesIO
-
-from django.conf import settings
-from django.http import FileResponse
-from django.http import Http404
-from django.http.request import HttpRequest
-from django.template.exceptions import TemplateDoesNotExist
-
-from .components import components
-
-
-def asset_view(request: HttpRequest, component_name: str, asset_filename: str):
-    warnings.warn(
-        "The 'asset_view' is deprecated and will be removed in a future release. "
-        "Use the 'BirdAssetFinder' with Django's static files system instead.",
-        DeprecationWarning,
-        stacklevel=2,
-    )
-
-    if not settings.DEBUG:
-        warnings.warn(
-            "Serving assets through this view in production is not recommended.",
-            RuntimeWarning,
-            stacklevel=2,
-        )
-
-    try:
-        component = components.get_component(component_name)
-    except (KeyError, TemplateDoesNotExist) as err:
-        raise Http404("Component not found") from err
-
-    asset = component.get_asset(asset_filename)
-    if not asset or not asset.path.exists():
-        raise Http404("Asset not found")
-
-    content = asset.path.read_bytes()
-
-    return FileResponse(BytesIO(content), content_type=asset.type.content_type)

tests/conftest.py

@@ -37,6 +37,11 @@ def pytest_configure(config):
         "django.contrib.staticfiles",
     ],
     "STATIC_URL": "/static/",
+    "STATICFILES_FINDERS": [
+        "django.contrib.staticfiles.finders.FileSystemFinder",
+        "django.contrib.staticfiles.finders.AppDirectoriesFinder",
+        "django_bird.staticfiles.BirdAssetFinder",
+    ],
     "TEMPLATES": [
         {
             "BACKEND": "django.template.backends.django.DjangoTemplates",

tests/templatetags/test_asset.py

@@ -1,16 +1,13 @@
 from __future__ import annotations
 
 import pytest
-from django.conf import settings
 from django.template.base import Parser
 from django.template.base import Token
 from django.template.base import TokenType
 from django.template.context import Context
 from django.template.exceptions import TemplateSyntaxError
 from django.template.loader import get_template
-from django.test import override_settings
 
-from django_bird.conf import DJANGO_BIRD_FINDER
 from django_bird.staticfiles import AssetType
 from django_bird.templatetags.tags.asset import CSS_TAG
 from django_bird.templatetags.tags.asset import JS_TAG
@@ -20,18 +17,6 @@
 from tests.utils import TestComponent
 
 
-@pytest.fixture(autouse=True)
-def reset_staticfiles_finders():
-    with override_settings(
-        STATICFILES_FINDERS=[
-            finder
-            for finder in settings.STATICFILES_FINDERS
-            if finder != DJANGO_BIRD_FINDER
-        ]
-    ):
-        yield
-
-
 class TestTemplateTag:
     @pytest.mark.parametrize(
         "tag,expected",
@@ -115,21 +100,15 @@ def test_template_inheritence(self, create_template, templates_dir, registry):
         rendered = template.render({})
 
         assert (
-            f'<link rel="stylesheet" href="/__bird__/assets/{alert.name}/{alert_css.file.name}">'
-            in rendered
-        )
-        assert (
-            f'<link rel="stylesheet" href="/__bird__/assets/{button.name}/{button_css.file.name}">'
-            in rendered
-        )
-        assert (
-            f'<script src="/__bird__/assets/{alert.name}/{alert_js.file.name}"></script>'
+            f'<link rel="stylesheet" href="/static/bird/{alert_css.file.name}">'
             in rendered
         )
         assert (
-            f'<script src="/__bird__/assets/{button.name}/{button_js.file.name}"></script>'
+            f'<link rel="stylesheet" href="/static/bird/{button_css.file.name}">'
             in rendered
         )
+        assert f'<script src="/static/bird/{alert_js.file.name}"></script>' in rendered
+        assert f'<script src="/static/bird/{button_js.file.name}"></script>' in rendered
 
     def test_with_no_assets(self, create_template, templates_dir):
         TestComponent(
@@ -206,21 +185,21 @@ def test_component_render_order(self, create_template, templates_dir, registry):
 
         head_end = rendered.find("</head>")
         assert (
-            f'<link rel="stylesheet" href="/__bird__/assets/{first.name}/{first_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/bird/{first_css.file.name}">'
             in rendered[:head_end]
         )
         assert (
-            f'<link rel="stylesheet" href="/__bird__/assets/{second.name}/{second_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/bird/{second_css.file.name}">'
             in rendered[:head_end]
         )
 
         body_start = rendered.find("<body")
         assert (
-            f'<script src="/__bird__/assets/{first.name}/{first_js.file.name}"></script>'
+            f'<script src="/static/bird/{first_js.file.name}"></script>'
             in rendered[body_start:]
         )
         assert (
-            f'<script src="/__bird__/assets/{second.name}/{second_js.file.name}"></script>'
+            f'<script src="/static/bird/{second_js.file.name}"></script>'
             in rendered[body_start:]
         )
 
@@ -267,18 +246,15 @@ def test_asset_duplication(self, create_template, templates_dir, registry):
         template = get_template(child_path.name)
 
         rendered = template.render({})
-        print(f"{rendered=}")
 
         assert (
             rendered.count(
-                f'<link rel="stylesheet" href="/__bird__/assets/{alert.name}/{alert_css.file.name}">'
+                f'<link rel="stylesheet" href="/static/bird/{alert_css.file.name}">'
             )
             == 1
         )
         assert (
-            rendered.count(
-                f'<script src="/__bird__/assets/{alert.name}/{alert_js.file.name}"></script>'
-            )
+            rendered.count(f'<script src="/static/bird/{alert_js.file.name}"></script>')
             == 1
         )
 
@@ -337,19 +313,16 @@ def test_unused_component_asset_not_rendered(
         rendered = template.render({})
 
         assert (
-            f'<link rel="stylesheet" href="/__bird__/assets/{alert.name}/{alert_css.file.name}">'
-            in rendered
-        )
-        assert (
-            f'<script src="/__bird__/assets/{alert.name}/{alert_js.file.name}"></script>'
+            f'<link rel="stylesheet" href="/static/bird/{alert_css.file.name}">'
             in rendered
         )
+        assert f'<script src="/static/bird/{alert_js.file.name}"></script>' in rendered
         assert (
-            f'<link rel="stylesheet" href="/__bird__/assets/{button.name}/{button_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/bird/{button_css.file.name}">'
             not in rendered
         )
         assert (
-            f'<script src="/__bird__/assets/{button.name}/{button_js.file.name}"></script>'
+            f'<script src="/static/bird/{button_js.file.name}"></script>'
             not in rendered
         )
 

tests/test_staticfiles.py

@@ -4,15 +4,13 @@
 from pathlib import Path
 
 import pytest
-from django.conf import settings
 from django.contrib.staticfiles import finders
 from django.core.management import call_command
 from django.template.base import Template
 from django.template.context import Context
 from django.test import override_settings
 
 from django_bird.components import Component
-from django_bird.conf import DJANGO_BIRD_FINDER
 from django_bird.staticfiles import Asset
 from django_bird.staticfiles import AssetType
 from django_bird.staticfiles import BirdAssetFinder
@@ -49,15 +47,38 @@ def test_exists_nonexistent(self):
     @pytest.mark.parametrize(
         "asset,expected_html_tag_bits",
         [
-            (Asset(Path("static.css"), AssetType.CSS), 'link rel="stylesheet" href='),
-            (Asset(Path("static.js"), AssetType.JS), "script src="),
+            (
+                TestAsset(
+                    component=None,
+                    content=".button { color: blue; }",
+                    asset_type=AssetType.CSS,
+                ),
+                'link rel="stylesheet" href=',
+            ),
+            (
+                TestAsset(
+                    component=None,
+                    content="console.log('button');",
+                    asset_type=AssetType.JS,
+                ),
+                "script src=",
+            ),
         ],
     )
-    def test_render(self, asset, expected_html_tag_bits):
-        rendered = asset.render()
+    def test_render(self, asset, expected_html_tag_bits, templates_dir):
+        button = TestComponent(
+            name="button", content="<button>Click me</button>"
+        ).create(templates_dir)
+        asset.component = button
+        asset.create()
+
+        component = Component.from_name(button.name)
+        component_asset = component.get_asset(asset.file.name)
+
+        rendered = component_asset.render()
 
         assert expected_html_tag_bits in rendered
-        assert asset.url in rendered
+        assert component_asset.url in rendered
 
     def test_storage(self, templates_dir, settings):
         button = TestComponent(
@@ -141,7 +162,7 @@ def test_relative_path_nested(self, templates_dir):
 
         assert asset.relative_path == Path("bird/nested/button.css")
 
-    def test_url_with_staticfiles_finder(self, templates_dir):
+    def test_url(self, templates_dir):
         button = TestComponent(
             name="button",
             content="<button>Click me</button>",
@@ -159,7 +180,7 @@ def test_url_with_staticfiles_finder(self, templates_dir):
             asset.url == f"/static/{button_css.file.parent.name}/{button_css.file.name}"
         )
 
-    def test_url_with_reverse_fallback(self, templates_dir):
+    def test_url_nonexistent(self, templates_dir):
         button = TestComponent(
             name="button",
             content="<button>Click me</button>",
@@ -173,14 +194,9 @@ def test_url_with_reverse_fallback(self, templates_dir):
         component = Component.from_name(button.name)
         asset = component.get_asset(button_css.file.name)
 
-        with override_settings(
-            STATICFILES_FINDERS=[
-                finder
-                for finder in settings.STATICFILES_FINDERS
-                if finder != DJANGO_BIRD_FINDER
-            ]
-        ):
-            assert asset.url == f"/__bird__/assets/{component.name}/{asset.path.name}"
+        button_css.file.unlink()
+
+        assert asset.url is None
 
     def test_from_path(self, templates_dir):
         button = TestComponent(