Update Asset to use StaticFilesStorage (#165)

* Update staticfiles handling to use StaticFilesStorage and improve asset URL generation

* Update CHANGELOG.md with asset URL generation fix

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,9 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Fixed
+- Fixed asset URL generation to properly use Django's static file storage system instead of raw file paths.
+
 ## [0.13.0]
 
 🚨 This release contains some breaking changes. See the Deprecated and Removed sections for more information. 🚨

src/django_bird/staticfiles.py

@@ -13,6 +13,7 @@
 
 from django.contrib.staticfiles import finders
 from django.contrib.staticfiles.finders import BaseFinder
+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
@@ -85,7 +86,7 @@ def relative_path(self):
 
     @property
     def storage(self):
-        storage = FileSystemStorage(location=str(self.template_dir))
+        storage = StaticFilesStorage(location=str(self.template_dir))
         storage.prefix = DjangoBirdAppConfig.label  # type: ignore[attr-defined]
         return storage
 
@@ -101,8 +102,10 @@ def template_dir(self):
 
     @property
     def url(self) -> str:
-        path = finders.find(str(self.relative_path))
-        return path or reverse(
+        static_path = finders.find(str(self.relative_path))
+        if static_path is not None:
+            return self.storage.url(static_path)
+        return reverse(
             "django_bird:asset",
             kwargs={
                 "component_name": self.path.stem,

tests/conftest.py

@@ -34,7 +34,9 @@ def pytest_configure(config):
 TEST_SETTINGS = {
     "INSTALLED_APPS": [
         "django_bird",
+        "django.contrib.staticfiles",
     ],
+    "STATIC_URL": "/static/",
     "TEMPLATES": [
         {
             "BACKEND": "django.template.backends.django.DjangoTemplates",

tests/test_staticfiles.py

@@ -72,7 +72,10 @@ def test_storage(self, templates_dir, settings):
         component = Component.from_name(button.name)
         asset = component.get_asset(button_css.file.name)
 
-        assert str(asset.storage.location) in str(button_css.file)
+        with override_settings(
+            STATIC_URL="/static/",
+        ):
+            assert str(asset.storage.location) in str(button_css.file)
 
     def test_template_dir(self, templates_dir):
         button = TestComponent(
@@ -152,7 +155,7 @@ def test_url_with_staticfiles_finder(self, templates_dir):
         component = Component.from_name(button.name)
         asset = component.get_asset(button_css.file.name)
 
-        assert asset.url == str(button_css.file)
+        assert asset.url == f"/static{button_css.file.parent}/{button_css.file.name}"
 
     def test_url_with_reverse_fallback(self, templates_dir):
         button = TestComponent(
@@ -415,14 +418,6 @@ def test_find_all(self, templates_dir):
 
 
 class TestStaticCollection:
-    @pytest.fixture(autouse=True)
-    def staticfiles_app(self):
-        with override_settings(
-            INSTALLED_APPS=settings.INSTALLED_APPS + ["django.contrib.staticfiles"],
-            STATIC_URL="/static/",
-        ):
-            yield
-
     @pytest.fixture
     def static_root(self, tmp_path):
         static_dir = tmp_path / "static"
@@ -554,14 +549,6 @@ def test_clear_collection(self, templates_dir, static_root):
 
 
 class TestStaticTemplateTag:
-    @pytest.fixture(autouse=True)
-    def staticfiles_app(self):
-        with override_settings(
-            INSTALLED_APPS=settings.INSTALLED_APPS + ["django.contrib.staticfiles"],
-            STATIC_URL="/static/",
-        ):
-            yield
-
     def test_static_tag(self, templates_dir):
         button = TestComponent(
             name="button", content="<button>Click me</button>"