update assets templatetag to use correct url (#117)

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,10 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Changed
+
+- Changed asset URLs to use django-bird's asset view instead of file paths.
+
 ## [0.10.1]
 
 ### Fixed

src/django_bird/staticfiles.py

@@ -4,6 +4,9 @@
 from enum import Enum
 from pathlib import Path
 
+from django.contrib.staticfiles import finders
+from django.urls import reverse
+
 from ._typing import override
 
 
@@ -36,6 +39,21 @@ def __hash__(self) -> int:
     def exists(self) -> bool:
         return self.path.exists()
 
+    @property
+    def url(self) -> str:
+        component_name = self.path.stem
+        asset_filename = self.path.name
+
+        path = finders.find(f"django_bird/assets/{component_name}/{asset_filename}")
+
+        return path or reverse(
+            "django_bird:asset",
+            kwargs={
+                "component_name": component_name,
+                "asset_filename": asset_filename,
+            },
+        )
+
     @classmethod
     def from_path(cls, path: Path) -> Asset:
         match path.suffix.lower():

src/django_bird/templatetags/tags/asset.py

@@ -57,12 +57,12 @@ def _render_assets(self, assets: list[Asset]) -> str:
 
         if self.asset_type == AssetType.CSS:
             tags = (
-                f'<link rel="stylesheet" href="{asset.path}">'
+                f'<link rel="stylesheet" href="{asset.url}">'
                 for asset in sorted(assets, key=lambda a: a.path)
             )
         else:  # JS
             tags = (
-                f'<script src="{asset.path}"></script>'
+                f'<script src="{asset.url}"></script>'
                 for asset in sorted(assets, key=lambda a: a.path)
             )
 

tests/conftest.py

@@ -11,6 +11,9 @@
 from django.template.backends.django import Template as DjangoTemplate
 from django.template.engine import Engine
 from django.test import override_settings
+from django.urls import clear_url_caches
+from django.urls import include
+from django.urls import path
 
 from .settings import DEFAULT_SETTINGS
 
@@ -49,6 +52,26 @@ def pytest_configure(config):
 }
 
 
+@pytest.fixture(autouse=True)
+def setup_urls():
+    urlpatterns = [
+        path("__bird__/", include("django_bird.urls")),
+    ]
+
+    clear_url_caches()
+
+    with override_settings(
+        ROOT_URLCONF=type(
+            "urls",
+            (),
+            {"urlpatterns": urlpatterns},
+        ),
+    ):
+        yield
+
+    clear_url_caches()
+
+
 @pytest.fixture
 def templates_dir(tmp_path):
     templates_dir = tmp_path / "templates"

tests/templatetags/test_asset.py

@@ -96,10 +96,22 @@ def test_template_inheritence(self, create_template, templates_dir):
 
         rendered = template.render({})
 
-        assert f'<link rel="stylesheet" href="{alert_css.file}">' in rendered
-        assert f'<link rel="stylesheet" href="{button_css.file}">' in rendered
-        assert f'<script src="{alert_js.file}"></script>' in rendered
-        assert f'<script src="{button_js.file}"></script>' in rendered
+        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>'
+            in rendered
+        )
+        assert (
+            f'<script src="/__bird__/assets/{button.name}/{button_js.file.name}"></script>'
+            in rendered
+        )
 
     def test_with_no_assets(self, create_template, templates_dir):
         TestComponent(
@@ -173,14 +185,24 @@ def test_component_render_order(self, create_template, templates_dir):
         rendered = template.render({})
 
         head_end = rendered.find("</head>")
-        assert f'<link rel="stylesheet" href="{first_css.file}">' in rendered[:head_end]
         assert (
-            f'<link rel="stylesheet" href="{second_css.file}">' in rendered[:head_end]
+            f'<link rel="stylesheet" href="/__bird__/assets/{first.name}/{first_css.file.name}">'
+            in rendered[:head_end]
+        )
+        assert (
+            f'<link rel="stylesheet" href="/__bird__/assets/{second.name}/{second_css.file.name}">'
+            in rendered[:head_end]
         )
 
         body_start = rendered.find("<body")
-        assert f'<script src="{first_js.file}"></script>' in rendered[body_start:]
-        assert f'<script src="{second_js.file}"></script>' in rendered[body_start:]
+        assert (
+            f'<script src="/__bird__/assets/{first.name}/{first_js.file.name}"></script>'
+            in rendered[body_start:]
+        )
+        assert (
+            f'<script src="/__bird__/assets/{second.name}/{second_js.file.name}"></script>'
+            in rendered[body_start:]
+        )
 
 
 class TestNode:

tests/test_integration.py

@@ -57,5 +57,5 @@ def test_template_inheritance_assets(create_template, templates_dir):
     """)
     rendered = template.render(Context({}))
 
-    assert str(parent_css.file) in rendered
-    assert str(child_css.file) in rendered
+    assert str(parent_css.file.name) in rendered
+    assert str(child_css.file.name) in rendered

tests/test_views.py

@@ -4,9 +4,6 @@
 
 import pytest
 from django.test import override_settings
-from django.urls import clear_url_caches
-from django.urls import include
-from django.urls import path
 from django.urls import reverse
 
 from django_bird.staticfiles import AssetType
@@ -21,26 +18,6 @@ def debug_mode():
         yield
 
 
-@pytest.fixture(autouse=True)
-def setup_urls():
-    urlpatterns = [
-        path("__bird__/", include("django_bird.urls")),
-    ]
-
-    clear_url_caches()
-
-    with override_settings(
-        ROOT_URLCONF=type(
-            "urls",
-            (),
-            {"urlpatterns": urlpatterns},
-        ),
-    ):
-        yield
-
-    clear_url_caches()
-
-
 def test_url_reverse(templates_dir):
     button = TestComponent(name="button", content="<button>Click me</button>").create(
         templates_dir