Fix static URLs to include django_bird prefix (#219)

* Fix static URLs to include django_bird prefix

The BirdAssetStorage class wasn't applying the 'django_bird' prefix
to generated static URLs, causing a mismatch between collection paths
and URL paths. Added an override to the URL method that ensures the
prefix is applied.

* Update changelog for upcoming release with staticfiles URL fix

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,10 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Fixed
+
+- Fixed static asset URLs to properly include the 'django_bird' prefix, ensuring URLs match the actual file paths during collection
+
 ## [0.17.0]
 
 🚨 This release contains some breaking changes. See the Removed section for more information. 🚨

src/django_bird/staticfiles.py

@@ -174,6 +174,14 @@ def __init__(self, *args: Any, prefix: str, **kwargs: Any):
         super().__init__(*args, **kwargs)
         self.prefix = prefix
 
+    @override
+    def url(self, name: str | None) -> str:
+        if name is None:
+            return super().url(name)
+        if not name.startswith(f"{self.prefix}/"):
+            name = f"{self.prefix}/{name}"
+        return super().url(name)
+
 
 @final
 class BirdAssetFinder(BaseFinder):

tests/templatetags/test_asset.py

@@ -103,15 +103,21 @@ def test_template_inheritence(self, create_template, templates_dir, registry):
         rendered = template.render({})
 
         assert (
-            f'<link rel="stylesheet" href="/static/bird/{alert_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/django_bird/bird/{alert_css.file.name}">'
             in rendered
         )
         assert (
-            f'<link rel="stylesheet" href="/static/bird/{button_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/django_bird/bird/{button_css.file.name}">'
+            in rendered
+        )
+        assert (
+            f'<script src="/static/django_bird/bird/{alert_js.file.name}"></script>'
+            in rendered
+        )
+        assert (
+            f'<script src="/static/django_bird/bird/{button_js.file.name}"></script>'
             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_template_inheritence_no_bird_usage(
         self, create_template, templates_dir, registry
@@ -154,10 +160,13 @@ def test_template_inheritence_no_bird_usage(
         rendered = template.render({})
 
         assert (
-            f'<link rel="stylesheet" href="/static/bird/{alert_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/django_bird/bird/{alert_css.file.name}">'
+            in rendered
+        )
+        assert (
+            f'<script src="/static/django_bird/bird/{alert_js.file.name}"></script>'
             in rendered
         )
-        assert f'<script src="/static/bird/{alert_js.file.name}"></script>' in rendered
 
     def test_with_no_assets(self, create_template, templates_dir):
         TestComponent(
@@ -232,21 +241,21 @@ def test_component_render_order(self, create_template, templates_dir, registry):
 
         head_end = rendered.find("</head>")
         assert (
-            f'<link rel="stylesheet" href="/static/bird/{first_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/django_bird/bird/{first_css.file.name}">'
             in rendered[:head_end]
         )
         assert (
-            f'<link rel="stylesheet" href="/static/bird/{second_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/django_bird/bird/{second_css.file.name}">'
             in rendered[:head_end]
         )
 
         body_start = rendered.find("<body")
         assert (
-            f'<script src="/static/bird/{first_js.file.name}"></script>'
+            f'<script src="/static/django_bird/bird/{first_js.file.name}"></script>'
             in rendered[body_start:]
         )
         assert (
-            f'<script src="/static/bird/{second_js.file.name}"></script>'
+            f'<script src="/static/django_bird/bird/{second_js.file.name}"></script>'
             in rendered[body_start:]
         )
 
@@ -294,12 +303,14 @@ def test_asset_duplication(self, create_template, templates_dir, registry):
 
         assert (
             rendered.count(
-                f'<link rel="stylesheet" href="/static/bird/{alert_css.file.name}">'
+                f'<link rel="stylesheet" href="/static/django_bird/bird/{alert_css.file.name}">'
             )
             == 1
         )
         assert (
-            rendered.count(f'<script src="/static/bird/{alert_js.file.name}"></script>')
+            rendered.count(
+                f'<script src="/static/django_bird/bird/{alert_js.file.name}"></script>'
+            )
             == 1
         )
 
@@ -356,16 +367,19 @@ def test_unused_component_asset_not_rendered(
         rendered = template.render({})
 
         assert (
-            f'<link rel="stylesheet" href="/static/bird/{alert_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/django_bird/bird/{alert_css.file.name}">'
+            in rendered
+        )
+        assert (
+            f'<script src="/static/django_bird/bird/{alert_js.file.name}"></script>'
             in rendered
         )
-        assert f'<script src="/static/bird/{alert_js.file.name}"></script>' in rendered
         assert (
-            f'<link rel="stylesheet" href="/static/bird/{button_css.file.name}">'
+            f'<link rel="stylesheet" href="/static/django_bird/bird/{button_css.file.name}">'
             not in rendered
         )
         assert (
-            f'<script src="/static/bird/{button_js.file.name}"></script>'
+            f'<script src="/static/django_bird/bird/{button_js.file.name}"></script>'
             not in rendered
         )
 
@@ -425,7 +439,7 @@ def test_asset_tag_with_manifest_in_production(
             rendered = template.render({})
 
             assert (
-                f'<link rel="stylesheet" href="/static/bird/{button_css.file.name}">'
+                f'<link rel="stylesheet" href="/static/django_bird/bird/{button_css.file.name}">'
                 in rendered
             )
 
@@ -466,7 +480,7 @@ def test_asset_tag_in_debug_mode(
             rendered = template.render({})
 
             assert (
-                f'<link rel="stylesheet" href="/static/bird/{button_css.file.name}">'
+                f'<link rel="stylesheet" href="/static/django_bird/bird/{button_css.file.name}">'
                 in rendered
             )
 
@@ -513,7 +527,7 @@ def test_asset_tag_fallback_when_template_not_in_manifest(
             rendered = template.render({})
 
             assert (
-                f'<link rel="stylesheet" href="/static/bird/{button_css.file.name}">'
+                f'<link rel="stylesheet" href="/static/django_bird/bird/{button_css.file.name}">'
                 in rendered
             )
 

tests/test_staticfiles.py

@@ -213,7 +213,8 @@ def test_url(self, templates_dir):
         asset = component.get_asset(button_css.file.name)
 
         assert (
-            asset.url == f"/static/{button_css.file.parent.name}/{button_css.file.name}"
+            asset.url
+            == f"/static/django_bird/{button_css.file.parent.name}/{button_css.file.name}"
         )
 
     def test_url_nonexistent(self, templates_dir):