Consolidate asset and component registries (#87)

Author: joshuadavidthomas

CHANGELOG.md

@@ -20,7 +20,7 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ### Changed
 
-- **Internal**: Renamed Component and Asset registries.
+- **Internal**: Consolidated Component and Asset registries into a single `ComponentRegistry`.
 
 ## [0.7.2]
 

src/django_bird/components.py

@@ -2,6 +2,7 @@
 
 from dataclasses import dataclass
 from dataclasses import field
+from pathlib import Path
 from typing import Any
 
 from cachetools import LRUCache
@@ -11,7 +12,7 @@
 
 from django_bird.staticfiles import Asset
 
-from .staticfiles import get_template_assets
+from .staticfiles import AssetType
 from .templates import get_template_names
 
 
@@ -32,26 +33,40 @@ def nodelist(self):
     def from_name(cls, name: str):
         template_names = get_template_names(name)
         template = select_template(template_names)
-        assets = get_template_assets(template)
-        return cls(name=name, template=template, assets=assets)
+
+        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 cls(name=name, template=template, assets=frozenset(assets))
 
 
 class ComponentRegistry:
     def __init__(self, maxsize: int = 100):
-        self._cache: LRUCache[str, Component] = LRUCache(maxsize=maxsize)
+        self._components: LRUCache[str, Component] = LRUCache(maxsize=maxsize)
+
+    def clear(self) -> None:
+        """Clear the registry. Mainly useful for testing."""
+        self._components.clear()
 
     def get_component(self, name: str) -> Component:
         try:
-            return self._cache[name]
+            return self._components[name]
         except KeyError:
             component = Component.from_name(name)
             if not settings.DEBUG:
-                self._cache[name] = component
+                self._components[name] = component
             return component
 
-    def clear(self) -> None:
-        """Clear the component cache. Mainly useful for testing."""
-        self._cache.clear()
+    def get_assets(self, asset_type: AssetType) -> list[Asset]:
+        assets: list[Asset] = []
+        for component in self._components.values():
+            assets.extend(a for a in component.assets if a.type == asset_type)
+        return assets
 
 
 components = ComponentRegistry()

src/django_bird/loader.py

@@ -17,7 +17,6 @@
 from ._typing import override
 from .compiler import Compiler
 from .components import components
-from .staticfiles import assets
 from .templatetags.tags.bird import TAG
 from .templatetags.tags.bird import BirdNode
 
@@ -50,16 +49,14 @@ def get_contents(self, origin: Origin) -> str:
 
     def _scan_for_components(self, node: Template | Node, context: Context) -> None:
         if isinstance(node, BirdNode):
-            component = components.get_component(node.name)
-            assets.register(component)
+            components.get_component(node.name)
 
         if not _has_nodelist(node) or node.nodelist is None:
             return
 
         for child in node.nodelist:
             if isinstance(child, BirdNode):
-                component = components.get_component(child.name)
-                assets.register(component)
+                components.get_component(child.name)
 
             if isinstance(child, ExtendsNode):
                 parent_template = child.get_parent(context)

src/django_bird/staticfiles.py

@@ -1,18 +1,11 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from dataclasses import field
 from enum import Enum
 from pathlib import Path
-from typing import TYPE_CHECKING
-
-from django.template.backends.django import Template as DjangoTemplate
 
 from ._typing import override
 
-if TYPE_CHECKING:
-    from django_bird.components import Component
-
 
 class AssetType(Enum):
     CSS = "css"
@@ -45,35 +38,3 @@ def from_path(cls, path: Path) -> Asset:
             case _:
                 raise ValueError(f"Unknown asset type for path: {path}")
         return cls(path=path, type=asset_type)
-
-
-def get_template_assets(template: DjangoTemplate):
-    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 frozenset(assets)
-
-
-@dataclass
-class AssetRegistry:
-    components: set[Component] = field(default_factory=set)
-
-    def clear(self) -> None:
-        """Clear the component cache. Mainly useful for testing."""
-        self.components.clear()
-
-    def register(self, component: Component) -> None:
-        self.components.add(component)
-
-    def get_assets(self, asset_type: AssetType) -> list[Asset]:
-        assets: list[Asset] = []
-        for component in self.components:
-            assets.extend(a for a in component.assets if a.type == asset_type)
-        return assets
-
-
-assets = AssetRegistry()

src/django_bird/templatetags/tags/asset.py

@@ -8,9 +8,9 @@
 
 from django_bird._typing import TagBits
 from django_bird._typing import override
+from django_bird.components import components
 from django_bird.staticfiles import Asset
 from django_bird.staticfiles import AssetType
-from django_bird.staticfiles import assets
 
 CSS_TAG = "bird:css"
 JS_TAG = "bird:js"
@@ -48,7 +48,7 @@ def __init__(self, asset_type: AssetType):
 
     @override
     def render(self, context: Context) -> str:
-        component_assets = assets.get_assets(self.asset_type)
+        component_assets = components.get_assets(self.asset_type)
         return self._render_assets(component_assets)
 
     def _render_assets(self, assets: list[Asset]) -> str:

tests/conftest.py

@@ -170,12 +170,3 @@ def clear_components_registry():
     components.clear()
     yield
     components.clear()
-
-
-@pytest.fixture(autouse=True)
-def clear_assets_registry():
-    from django_bird.staticfiles import assets
-
-    assets.clear()
-    yield
-    assets.clear()

tests/test_components.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from pathlib import Path
+
 import pytest
 from django.template.backends.django import Template
 from django.template.exceptions import TemplateDoesNotExist
@@ -18,7 +20,7 @@ def test_from_name_basic(self, create_bird_template):
         comp = Component.from_name("button")
 
         assert comp.name == "button"
-        assert comp.assets == set()
+        assert comp.assets == frozenset()
         assert isinstance(comp.template, Template)
         assert comp.render({}) == "<button>Click me</button>"
 
@@ -38,30 +40,50 @@ def test_from_name_with_assets(self, create_template, create_bird_template):
         assert Asset(js_file, AssetType.JS) in comp.assets
 
     @pytest.mark.parametrize(
-        "asset_suffix,asset_content,expected_asset_type",
+        "suffix,content,expected_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,
+        self, suffix, content, expected_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)
+        file = template_file.with_suffix(suffix)
+        file.write_text(content)
 
         comp = Component.from_name("button")
 
         assert len(comp.assets) == 1
-        assert Asset(file, expected_asset_type) in comp.assets
+        assert Asset(file, expected_type) in comp.assets
+
+    def test_from_name_no_assets(self, create_template, create_bird_template):
+        template_file = create_bird_template("button", "<button>Click me</button>")
+        create_template(template_file)
+
+        comp = Component.from_name("button")
+
+        assert len(comp.assets) == 0
+
+    def test_from_name_custom_component_dir(
+        self, create_template, create_bird_template
+    ):
+        template_file = create_bird_template(
+            name="button", content="<button>", sub_dir="components"
+        )
+
+        css_file = template_file.with_suffix(".css")
+        css_file.write_text("button { color: red; }")
+
+        create_template(template_file)
+
+        comp = Component.from_name("components/button")
+
+        assert len(comp.assets) == 1
+        assert Asset(css_file, AssetType.CSS) in comp.assets
 
 
 class TestComponentRegistry:
@@ -104,13 +126,97 @@ def test_component_not_found(self, registry):
     def test_cache_with_debug(self, registry, create_bird_template):
         create_bird_template(name="button", content="<button>Click me</button>")
 
-        assert len(registry._cache) == 0
+        assert len(registry._components) == 0
 
         with override_settings(DEBUG=True):
             registry.get_component("button")
 
-        assert len(registry._cache) == 0
+        assert len(registry._components) == 0
 
         registry.get_component("button")
 
-        assert len(registry._cache) == 1
+        assert len(registry._components) == 1
+
+    def test_get_assets_by_type(
+        self, registry, create_bird_template, create_bird_asset
+    ):
+        template_file = create_bird_template("test", "<div>Test</div>")
+        css_asset = create_bird_asset(template_file, ".test { color: red; }", "css")
+        js_asset = create_bird_asset(template_file, "console.log('test');", "js")
+
+        registry.get_component(
+            "test"
+        )  # This now registers the component and its assets
+
+        css_assets = registry.get_assets(AssetType.CSS)
+        js_assets = registry.get_assets(AssetType.JS)
+
+        assert len(css_assets) == 1
+        assert len(js_assets) == 1
+        assert Asset(Path(css_asset), AssetType.CSS) in css_assets
+        assert Asset(Path(js_asset), AssetType.JS) in js_assets
+
+    def test_multiple_components_same_asset_names(
+        self, registry, create_bird_template, create_bird_asset
+    ):
+        template1 = create_bird_template("comp1", "<div>One</div>", sub_dir="first")
+        template2 = create_bird_template("comp2", "<div>Two</div>", sub_dir="second")
+
+        css1 = create_bird_asset(template1, ".one { color: red; }", "css")
+        css2 = create_bird_asset(template2, ".two { color: blue; }", "css")
+
+        registry.get_component("first/comp1")
+        registry.get_component("second/comp2")
+
+        css_assets = registry.get_assets(AssetType.CSS)
+        assert len(css_assets) == 2
+
+        asset_paths = {str(asset.path) for asset in css_assets}
+        assert str(css1) in asset_paths
+        assert str(css2) in asset_paths
+
+    def test_template_inheritance_assets(
+        self,
+        registry,
+        create_bird_template,
+        create_bird_asset,
+        create_template,
+        templates_dir,
+    ):
+        parent = create_bird_template("parent", "<div>Parent</div>")
+        child = create_bird_template("child", "<div>Child</div>")
+
+        parent_css = create_bird_asset(parent, ".parent { color: red; }", "css")
+        child_css = create_bird_asset(child, ".child { color: blue; }", "css")
+
+        base_path = templates_dir / "base.html"
+        base_path.write_text("""
+            {% bird parent %}Parent Content{% endbird %}
+            {% block content %}{% endblock %}
+        """)
+
+        child_path = templates_dir / "child.html"
+        child_path.write_text("""
+            {% extends 'base.html' %}
+            {% block content %}
+                {% bird child %}Child Content{% endbird %}
+            {% endblock %}
+        """)
+
+        # Pre-load the components so they're in the registry
+        registry.get_component("parent")
+        registry.get_component("child")
+
+        template = create_template(child_path)
+        template.render({})
+
+        css_assets = registry.get_assets(AssetType.CSS)
+        asset_paths = {str(asset.path) for asset in css_assets}
+
+        assert str(parent_css) in asset_paths, "Parent CSS not found in assets"
+        assert str(child_css) in asset_paths, "Child CSS not found in assets"
+
+    def test_empty_registry(self, registry):
+        assert len(registry._components) == 0
+        assert len(registry.get_assets(AssetType.CSS)) == 0
+        assert len(registry.get_assets(AssetType.JS)) == 0

tests/test_loader.py

@@ -8,9 +8,9 @@
 from django.template.engine import Engine
 from django.template.loader import get_template
 
+from django_bird.components import components
 from django_bird.loader import BIRD_TAG_PATTERN
 from django_bird.loader import BirdLoader
-from django_bird.staticfiles import assets
 from django_bird.templatetags.tags.bird import BirdNode
 
 
@@ -86,4 +86,4 @@ def test_scan_for_components(
 
     loader._scan_for_components(node, context)
 
-    assert len(assets.components) == expected_count
+    assert len(components._components) == expected_count