add assets field to Component dataclass and collect assets (#65)

* add assets field to `Component` dataclass and collect assets

* update changelog

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,18 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Added
+
+- Component assets (CSS/JS) are now automatically discovered and associated with components
+
+### Changed
+
+- **Internal**: Refactored `AssetType` to use string values and file extensions
+
+### Removed
+
+- **Internal**: Simplified asset handling by removing global registry in favor of per-component assets
+
 ## [0.5.0]
 
 ### Added

src/django_bird/components.py

@@ -1,19 +1,24 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from dataclasses import field
 from typing import Any
 
 from cachetools import LRUCache
 from django.template.backends.django import Template
 from django.template.loader import select_template
 
+from django_bird.staticfiles import Asset
+
+from .staticfiles import get_template_assets
 from .templates import get_template_names
 
 
 @dataclass(frozen=True, slots=True)
 class Component:
     name: str
     template: Template
+    assets: set[Asset] = field(default_factory=set)
 
     def render(self, context: dict[str, Any]):
         return self.template.render(context)
@@ -26,7 +31,8 @@ def nodelist(self):
     def from_name(cls, name: str):
         template_names = get_template_names(name)
         template = select_template(template_names)
-        return cls(name=name, template=template)
+        assets = get_template_assets(template)
+        return cls(name=name, template=template, assets=assets)
 
 
 class Registry:

src/django_bird/staticfiles.py

@@ -1,24 +1,24 @@
 from __future__ import annotations
 
-from collections.abc import Callable
 from dataclasses import dataclass
-from enum import IntEnum
+from enum import Enum
 from pathlib import Path
 
-from django.templatetags.static import static
-from django.utils.html import format_html
-from django.utils.html import format_html_join
-from django.utils.safestring import SafeString
+from django.template.backends.django import Template
 
 from ._typing import override
 
 
-class AssetType(IntEnum):
-    CSS = 1
-    JS = 2
+class AssetType(Enum):
+    CSS = "css"
+    JS = "js"
 
+    @property
+    def ext(self):
+        return f".{self.value}"
 
-@dataclass(frozen=True)
+
+@dataclass(frozen=True, slots=True)
 class Asset:
     path: Path
     type: AssetType
@@ -42,52 +42,12 @@ def from_path(cls, path: Path) -> Asset:
         return cls(path=path, type=asset_type)
 
 
-class Registry:
-    def __init__(self) -> None:
-        self.assets: set[Asset] = set()
-
-    def register(self, asset: Asset | Path) -> None:
-        if isinstance(asset, Path):
-            asset = Asset.from_path(asset)
-
-        if not asset.exists():
-            raise FileNotFoundError(f"Asset file not found: {asset.path}")
-
-        self.assets.add(asset)
-
-    def clear(self) -> None:
-        self.assets.clear()
-
-    def get_assets(self, asset_type: AssetType) -> list[Asset]:
-        assets = [asset for asset in self.assets if asset.type == asset_type]
-        return self.sort_assets(assets)
-
-    def sort_assets(
-        self,
-        assets: list[Asset],
-        *,
-        key: Callable[[Asset], str] = lambda a: str(a.path),
-    ) -> list[Asset]:
-        return sorted(assets, key=key)
-
-    def get_format_string(self, asset_type: AssetType) -> str:
-        match asset_type:
-            case AssetType.CSS:
-                return '<link rel="stylesheet" href="{}" type="text/css">'
-            case AssetType.JS:
-                return '<script src="{}" type="text/javascript">'
-
-    def render(self, asset_type: AssetType) -> SafeString:
-        assets = self.get_assets(asset_type)
-
-        if not assets:
-            return format_html("")
-
-        return format_html_join(
-            "\n",
-            self.get_format_string(asset_type),
-            ((static(str(asset.path)),) for asset in assets),
-        )
-
-
-registry = Registry()
+def get_template_assets(template: Template):
+    assets: set[Asset] = set()
+    template_path = Path(template.template.origin.name)
+    for asset_type in AssetType:
+        asset_path = template_path.with_suffix(asset_type.ext)
+        if asset_path.exists():
+            asset = Asset.from_path(asset_path)
+            assets.add(asset)
+    return assets

tests/conftest.py

@@ -6,6 +6,8 @@
 
 import pytest
 from django.conf import settings
+from django.template.backends.django import Template as DjangoTemplate
+from django.template.engine import Engine
 from django.test import override_settings
 
 from .settings import DEFAULT_SETTINGS
@@ -94,6 +96,16 @@ def func(name, content, sub_dir=None, bird_dir_name="bird"):
     return func
 
 
+@pytest.fixture
+def create_template():
+    def _create_template(template_file: Path) -> DjangoTemplate:
+        engine = Engine.get_default()
+        django_template = engine.get_template(str(template_file))
+        return DjangoTemplate(django_template, engine)
+
+    return _create_template
+
+
 @pytest.fixture
 def normalize_whitespace():
     def func(text):

tests/test_components.py

@@ -6,18 +6,62 @@
 
 from django_bird.components import Component
 from django_bird.components import Registry
+from django_bird.staticfiles import Asset
+from django_bird.staticfiles import AssetType
 
 
 class TestComponent:
-    def test_from_name(self, create_bird_template):
+    def test_from_name_basic(self, create_bird_template):
         create_bird_template("button", "<button>Click me</button>")
 
         comp = Component.from_name("button")
 
         assert comp.name == "button"
+        assert comp.assets == set()
         assert isinstance(comp.template, Template)
         assert comp.render({}) == "<button>Click me</button>"
 
+    def test_from_name_with_assets(self, create_template, create_bird_template):
+        template_file = create_bird_template("button", "<button>Click me</button>")
+        create_template(template_file)
+
+        css_file = template_file.with_suffix(".css")
+        js_file = template_file.with_suffix(".js")
+        css_file.write_text("button { color: red; }")
+        js_file.write_text("console.log('loaded');")
+
+        comp = Component.from_name("button")
+
+        assert len(comp.assets) == 2
+        assert Asset(css_file, AssetType.CSS) in comp.assets
+        assert Asset(js_file, AssetType.JS) in comp.assets
+
+    @pytest.mark.parametrize(
+        "asset_suffix,asset_content,expected_asset_type",
+        [
+            (".css", "button { color: red; }", AssetType.CSS),
+            (".js", "console.log('loaded');", AssetType.JS),
+        ],
+    )
+    def test_from_name_with_partial_assets(
+        self,
+        asset_suffix,
+        asset_content,
+        expected_asset_type,
+        create_template,
+        create_bird_template,
+    ):
+        template_file = create_bird_template("button", "<button>Click me</button>")
+        create_template(template_file)
+
+        file = template_file.with_suffix(asset_suffix)
+        file.write_text(asset_content)
+
+        comp = Component.from_name("button")
+
+        assert len(comp.assets) == 1
+        assert Asset(file, expected_asset_type) in comp.assets
+
 
 class TestRegistry:
     @pytest.fixture