Refactor components, add tests for edge cases, and boost coverage % (#173)

Author: joshuadavidthomas

src/django_bird/components.py

@@ -74,12 +74,8 @@ def path(self):
     def source(self):
         return self.template.template.source
 
-    @property
-    def used_in(self):
-        return components.get_template_usage(self.name)
-
     @classmethod
-    def from_abs_path(cls, path: Path, root: Path) -> Component | None:
+    def from_abs_path(cls, path: Path, root: Path) -> Component:
         name = str(path.relative_to(root).with_suffix("")).replace("/", ".")
         return cls.from_name(name)
 
@@ -174,11 +170,6 @@ def fill_slots(self, context: Context):
             **slot_nodes,
         }
 
-        if context.get("slots"):
-            for name, content in context["slots"].items():
-                if name not in slots or not slots.get(name):
-                    slots[name] = TextNode(str(content))
-
         if not slots[DEFAULT_SLOT] and "slot" in context:
             slots[DEFAULT_SLOT] = TextNode(context["slot"])
 
@@ -203,8 +194,6 @@ def discover_components(self) -> None:
                 continue
 
             component = Component.from_abs_path(component_abs_path, root_abs_path)
-            if component is None:
-                continue
 
             if component.name not in self._components:
                 self._components[component.name] = component
@@ -249,9 +238,5 @@ def get_component_usage(
         for component_name in self._template_usage.get(path, set()):
             yield Component.from_name(component_name)
 
-    def get_template_usage(self, component: str | Component) -> frozenset[Path]:
-        name = component.name if isinstance(component, Component) else component
-        return frozenset(self._component_usage.get(name, set()))
-
 
 components = ComponentRegistry()

src/django_bird/conf.py

@@ -72,7 +72,7 @@ def configure_templates(self) -> None:
         self.configure_builtins(options)
 
         # Force re-evaluation of settings.TEMPLATES because EngineHandler caches it.
-        with suppress(AttributeError):
+        with suppress(AttributeError):  # pragma: no cover
             del django.template.engines.templates
             django.template.engines._engines = {}  # type: ignore[attr-defined]
 

tests/templatetags/test_prop.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import pytest
+from django import template
 from django.template.base import Parser
 from django.template.base import Token
 from django.template.base import TokenType
@@ -25,3 +26,10 @@ def test_do_prop(contents, expected):
     assert node.name == expected.name
     assert node.default == expected.default
     assert node.attrs == expected.attrs
+
+
+def test_do_prop_no_args():
+    start_token = Token(TokenType.BLOCK, TAG)
+
+    with pytest.raises(template.TemplateSyntaxError):
+        do_prop(Parser([]), start_token)

tests/templatetags/test_var.py

@@ -1,13 +1,35 @@
 from __future__ import annotations
 
 import pytest
+from django import template
 from django.template import Context
 from django.template import Template
+from django.template.base import Parser
+from django.template.base import Token
+from django.template.base import TokenType
 from django.template.exceptions import TemplateSyntaxError
 
+from django_bird.templatetags.tags.var import END_TAG
+from django_bird.templatetags.tags.var import TAG
+from django_bird.templatetags.tags.var import do_end_var
+from django_bird.templatetags.tags.var import do_var
 from tests.utils import TestComponent
 
 
+def test_do_var_no_args():
+    start_token = Token(TokenType.BLOCK, TAG)
+
+    with pytest.raises(template.TemplateSyntaxError):
+        do_var(Parser([]), start_token)
+
+
+def test_do_end_var_no_args():
+    start_token = Token(TokenType.BLOCK, END_TAG)
+
+    with pytest.raises(template.TemplateSyntaxError):
+        do_end_var(Parser([]), start_token)
+
+
 def test_basic_assignment():
     template = Template("""
         {% load django_bird %}

tests/test_components.py

@@ -27,6 +27,30 @@
 
 
 class TestComponentClass:
+    def test_get_asset(self, templates_dir):
+        button = TestComponent(
+            name="button", content="<button>Click me</button>"
+        ).create(templates_dir)
+        button_css = TestAsset(
+            component=button,
+            content=".button { color: blue; }",
+            asset_type=AssetType.CSS,
+        ).create()
+
+        component = Component.from_name(button.name)
+
+        assert component.get_asset(button_css.file.name)
+
+    def test_get_asset_no_asset(self, templates_dir):
+        button = TestComponent(
+            name="button", content="<button>Click me</button>"
+        ).create(templates_dir)
+
+        component = Component.from_name(button.name)
+
+        assert component.get_asset("button.css") is None
+        assert component.get_asset("button.js") is None
+
     def test_from_abs_path_basic(self, templates_dir):
         test_component = TestComponent(
             name="button", content="<button>Click me</button>"

tests/test_conf.py

@@ -9,76 +9,91 @@
 
 from django_bird.conf import DJANGO_BIRD_BUILTINS
 from django_bird.conf import DJANGO_BIRD_FINDER
-from django_bird.conf import AppSettings
 from django_bird.conf import AutoConfigurator
 from django_bird.conf import app_settings
 
 
+@pytest.fixture(autouse=True)
+def reset_settings():
+    template_options = settings.TEMPLATES[0]["OPTIONS"]
+
+    assert DJANGO_BIRD_BUILTINS in template_options["builtins"]
+    assert DJANGO_BIRD_FINDER in settings.STATICFILES_FINDERS
+
+    with override_settings(
+        STATICFILES_FINDERS=[
+            finder
+            for finder in settings.STATICFILES_FINDERS
+            if finder != DJANGO_BIRD_FINDER
+        ],
+        TEMPLATES=[
+            settings.TEMPLATES[0]
+            | {
+                **settings.TEMPLATES[0],
+                "OPTIONS": {
+                    "builtins": [
+                        builtin
+                        for builtin in template_options["builtins"]
+                        if builtin != DJANGO_BIRD_BUILTINS
+                    ],
+                },
+            }
+        ],
+    ):
+        options = settings.TEMPLATES[0]["OPTIONS"]
+
+        assert DJANGO_BIRD_BUILTINS not in options["builtins"]
+        assert DJANGO_BIRD_FINDER not in settings.STATICFILES_FINDERS
+
+        yield
+
+
 @pytest.mark.default_app_settings
 def test_app_settings():
     assert app_settings.COMPONENT_DIRS == []
     assert app_settings.ENABLE_AUTO_CONFIG is True
 
 
+def test_autoconfigure_disabled():
+    template_options = settings.TEMPLATES[0]["OPTIONS"]
+
+    with override_settings(
+        DJANGO_BIRD={
+            "ENABLE_AUTO_CONFIG": False,
+        }
+    ):
+        app_settings.autoconfigure()
+
+    assert DJANGO_BIRD_BUILTINS not in template_options["builtins"]
+    assert DJANGO_BIRD_FINDER not in settings.STATICFILES_FINDERS
+
+
 class TestAutoConfigurator:
     @pytest.fixture
     def configurator(self):
         return AutoConfigurator(app_settings)
 
-    @pytest.fixture(autouse=True)
-    def reset_settings(self):
+    def test_autoconfigure(self, configurator):
         template_options = settings.TEMPLATES[0]["OPTIONS"]
 
+        configurator.autoconfigure()
+
         assert DJANGO_BIRD_BUILTINS in template_options["builtins"]
         assert DJANGO_BIRD_FINDER in settings.STATICFILES_FINDERS
 
+    def test_non_django_template_engine(self, configurator):
+        template_options = settings.TEMPLATES[0]["OPTIONS"]
+
         with override_settings(
-            STATICFILES_FINDERS=[
-                finder
-                for finder in settings.STATICFILES_FINDERS
-                if finder != DJANGO_BIRD_FINDER
-            ],
             TEMPLATES=[
-                settings.TEMPLATES[0]
-                | {
-                    **settings.TEMPLATES[0],
-                    "OPTIONS": {
-                        "builtins": [
-                            builtin
-                            for builtin in template_options["builtins"]
-                            if builtin != DJANGO_BIRD_BUILTINS
-                        ],
-                    },
+                {
+                    "BACKEND": "django.template.backends.jinja2.Jinja2",
                 }
             ],
         ):
-            options = settings.TEMPLATES[0]["OPTIONS"]
-
-            assert DJANGO_BIRD_BUILTINS not in options["builtins"]
-            assert DJANGO_BIRD_FINDER not in settings.STATICFILES_FINDERS
-
-            yield
-
-    def test_autoconfigure(self, configurator):
-        template_options = settings.TEMPLATES[0]["OPTIONS"]
-
-        configurator.autoconfigure()
-
-        assert DJANGO_BIRD_BUILTINS in template_options["builtins"]
-        assert DJANGO_BIRD_FINDER in settings.STATICFILES_FINDERS
-
-    @override_settings(
-        DJANGO_BIRD={
-            "ENABLE_AUTO_CONFIG": False,
-        }
-    )
-    def test_autoconfigure_disabled(self):
-        app_settings = AppSettings()
-        template_options = settings.TEMPLATES[0]["OPTIONS"]
+            configurator.configure_templates()
 
-        assert app_settings.ENABLE_AUTO_CONFIG is False
         assert DJANGO_BIRD_BUILTINS not in template_options["builtins"]
-        assert DJANGO_BIRD_FINDER not in settings.STATICFILES_FINDERS
 
     def test_configure_builtins(self, configurator):
         template_options = settings.TEMPLATES[0]["OPTIONS"]