create components dir and move attrs and templates (#50)

Author: joshuadavidthomas

src/django_bird/components/__init__.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from django import template
+from django.template.context import Context
+from django.utils.safestring import SafeString
+from django.utils.safestring import mark_safe
+
+
+@dataclass
+class Attr:
+    name: str
+    value: str | bool
+
+    def render(self) -> str:
+        if isinstance(self.value, bool) and self.value:
+            return self.name
+        return f'{self.name}="{self.value}"'
+
+
+@dataclass
+class Attrs:
+    attrs: list[Attr]
+
+    @classmethod
+    def parse(cls, raw_attrs: list[str], context: Context) -> Attrs:
+        parsed = []
+        for attr in raw_attrs:
+            if "=" in attr:
+                name, value = attr.split("=", 1)
+                resolved_value = template.Variable(value).resolve(context)
+                parsed.append(Attr(name=name, value=resolved_value))
+            else:
+                parsed.append(Attr(name=attr, value=True))
+        return cls(parsed)
+
+    def flatten(self) -> SafeString:
+        rendered = " ".join(attr.render() for attr in self.attrs)
+        return mark_safe(rendered)

src/django_bird/components/attrs.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from django_bird.conf import app_settings
+
+
+def get_template_names(name: str) -> list[str]:
+    """
+    Generate a list of potential template names for a component.
+
+    The function searches for templates in the following order (from most specific to most general):
+
+    1. In a subdirectory named after the component, using the component name
+    2. In the same subdirectory, using a fallback 'index.html'
+    3. In parent directory for nested components
+    4. In the base component directory, using the full component name
+
+    The order of names is important as it determines the template resolution priority.
+    This order allows for both direct matches and hierarchical component structures,
+    with more specific paths taking precedence over more general ones.
+
+    This order allows for:
+    - Single file components
+    - Multi-part components
+    - Specific named files within component directories
+    - Fallback default files for components
+
+    For example:
+    - For an "input" component, the ordering would be:
+        1. `{component_dir}/input/input.html`
+        2. `{component_dir}/input/index.html`
+        3. `{component_dir}/input.html`
+    - For an "input.label" component:
+        1. `{component_dir}/input/label/label.html`
+        2. `{component_dir}/input/label/index.html`
+        3. `{component_dir}/input/label.html`
+        4. `{component_dir}/input.label.html`
+
+    Returns:
+        list[str]: A list of potential template names in resolution order.
+    """
+    template_names = []
+    component_dirs = list(dict.fromkeys([*app_settings.COMPONENT_DIRS, "bird"]))
+
+    name_parts = name.split(".")
+    path_name = "/".join(name_parts)
+
+    for component_dir in component_dirs:
+        potential_names = [
+            f"{component_dir}/{path_name}/{name_parts[-1]}.html",
+            f"{component_dir}/{path_name}/index.html",
+            f"{component_dir}/{path_name}.html",
+            f"{component_dir}/{name}.html",
+        ]
+        template_names.extend(potential_names)
+
+    return list(dict.fromkeys(template_names))

src/django_bird/components/templates.py

@@ -14,7 +14,8 @@
 
 from django_bird._typing import TagBits
 from django_bird._typing import override
-from django_bird.conf import app_settings
+from django_bird.components.attrs import Attrs
+from django_bird.components.templates import get_template_names
 
 from .slot import SlotNode
 
@@ -67,7 +68,7 @@ def __init__(self, name: str, attrs: list[str], nodelist: NodeList | None) -> No
     def render(self, context: Context) -> SafeString:
         component_name = self.get_component_name(context)
         component_context = self.get_component_context_data(context)
-        template_names = self.get_template_names(component_name)
+        template_names = get_template_names(component_name)
         template = select_template(template_names)
         return template.render(component_context)
 
@@ -79,11 +80,11 @@ def get_component_name(self, context: Context) -> str:
         return name
 
     def get_component_context_data(self, context: Context) -> dict[str, Any]:
+        attrs = Attrs.parse(self.attrs, context)
         rendered_slots = self.render_slots(context)
-        flat_attrs = self.flatten_attrs(context)
         default_slot = rendered_slots.get(self.default_slot) or context.get("slot")
         return {
-            "attrs": mark_safe(flat_attrs),
+            "attrs": attrs.flatten(),
             "slot": mark_safe(default_slot),
             "slots": {
                 name: mark_safe(content) for name, content in rendered_slots.items()
@@ -117,70 +118,3 @@ def render_slots(self, context: Context) -> dict[str, str]:
             slot: template.Template("".join(content)).render(context)
             for slot, content in contents.items()
         }
-
-    def flatten_attrs(self, context: Context) -> str:
-        attrs: dict[str, str | None | bool] = {}
-
-        for attr in self.attrs:
-            if "=" in attr:
-                key, value = attr.split("=", 1)
-                attrs[key] = template.Variable(value).resolve(context)
-            else:
-                attrs[attr] = True
-
-        return " ".join(
-            key if isinstance(value, bool) and value else f'{key}="{value}"'
-            for key, value in attrs.items()
-        )
-
-    def get_template_names(self, name: str) -> list[str]:
-        """
-        Generate a list of potential template names for a component.
-
-        The function searches for templates in the following order (from most specific to most general):
-
-        1. In a subdirectory named after the component, using the component name
-        2. In the same subdirectory, using a fallback 'index.html'
-        3. In parent directory for nested components
-        4. In the base component directory, using the full component name
-
-        The order of names is important as it determines the template resolution priority.
-        This order allows for both direct matches and hierarchical component structures,
-        with more specific paths taking precedence over more general ones.
-
-        This order allows for:
-        - Single file components
-        - Multi-part components
-        - Specific named files within component directories
-        - Fallback default files for components
-
-        For example:
-        - For an "input" component, the ordering would be:
-            1. `{component_dir}/input/input.html`
-            2. `{component_dir}/input/index.html`
-            3. `{component_dir}/input.html`
-        - For an "input.label" component:
-            1. `{component_dir}/input/label/label.html`
-            2. `{component_dir}/input/label/index.html`
-            3. `{component_dir}/input/label.html`
-            4. `{component_dir}/input.label.html`
-
-        Returns:
-            list[str]: A list of potential template names in resolution order.
-        """
-        template_names = []
-        component_dirs = list(dict.fromkeys([*app_settings.COMPONENT_DIRS, "bird"]))
-
-        name_parts = name.split(".")
-        path_name = "/".join(name_parts)
-
-        for component_dir in component_dirs:
-            potential_names = [
-                f"{component_dir}/{path_name}/{name_parts[-1]}.html",
-                f"{component_dir}/{path_name}/index.html",
-                f"{component_dir}/{path_name}.html",
-                f"{component_dir}/{self.name}.html",
-            ]
-            template_names.extend(potential_names)
-
-        return list(dict.fromkeys(template_names))

src/django_bird/templatetags/tags/bird.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+import pytest
+from django.test import override_settings
+
+from django_bird.components.templates import get_template_names
+
+
+@pytest.mark.parametrize(
+    "name,component_dirs,expected",
+    [
+        (
+            "button",
+            [],
+            [
+                "bird/button/button.html",
+                "bird/button/index.html",
+                "bird/button.html",
+            ],
+        ),
+        (
+            "input.label",
+            [],
+            [
+                "bird/input/label/label.html",
+                "bird/input/label/index.html",
+                "bird/input/label.html",
+                "bird/input.label.html",
+            ],
+        ),
+        (
+            "button",
+            ["custom", "theme"],
+            [
+                "custom/button/button.html",
+                "custom/button/index.html",
+                "custom/button.html",
+                "theme/button/button.html",
+                "theme/button/index.html",
+                "theme/button.html",
+                "bird/button/button.html",
+                "bird/button/index.html",
+                "bird/button.html",
+            ],
+        ),
+    ],
+)
+def test_get_template_names(name, component_dirs, expected):
+    with override_settings(DJANGO_BIRD={"COMPONENT_DIRS": component_dirs}):
+        template_names = get_template_names(name)
+
+    assert template_names == expected
+
+
+def test_get_template_names_invalid():
+    template_names = get_template_names("input.label")
+
+    assert "bird/input/label/invalid.html" not in template_names
+
+
+def test_get_template_names_duplicates():
+    with override_settings(DJANGO_BIRD={"COMPONENT_DIRS": ["bird"]}):
+        template_names = get_template_names("button")
+
+        template_counts = {}
+        for template in template_names:
+            template_counts[template] = template_counts.get(template, 0) + 1
+
+        for _, count in template_counts.items():
+            assert count == 1

tests/components/__init__.py

@@ -10,7 +10,6 @@
 from django.template.base import Token
 from django.template.base import TokenType
 from django.template.exceptions import TemplateSyntaxError
-from django.test import override_settings
 
 from django_bird.templatetags.tags.bird import END_TAG
 from django_bird.templatetags.tags.bird import TAG
@@ -280,70 +279,3 @@ def test_get_component_name(self, name, context, expected, create_bird_template)
         component_name = node.get_component_name(context=Context(context))
 
         assert component_name == expected
-
-    @pytest.mark.parametrize(
-        "name,component_dirs,expected",
-        [
-            (
-                "button",
-                [],
-                [
-                    "bird/button/button.html",
-                    "bird/button/index.html",
-                    "bird/button.html",
-                ],
-            ),
-            (
-                "input.label",
-                [],
-                [
-                    "bird/input/label/label.html",
-                    "bird/input/label/index.html",
-                    "bird/input/label.html",
-                    "bird/input.label.html",
-                ],
-            ),
-            (
-                "button",
-                ["custom", "theme"],
-                [
-                    "custom/button/button.html",
-                    "custom/button/index.html",
-                    "custom/button.html",
-                    "theme/button/button.html",
-                    "theme/button/index.html",
-                    "theme/button.html",
-                    "bird/button/button.html",
-                    "bird/button/index.html",
-                    "bird/button.html",
-                ],
-            ),
-        ],
-    )
-    def test_get_template_names(self, name, component_dirs, expected):
-        node = BirdNode(name=name, attrs=[], nodelist=None)
-
-        with override_settings(DJANGO_BIRD={"COMPONENT_DIRS": component_dirs}):
-            template_names = node.get_template_names(node.name)
-
-        assert template_names == expected
-
-    def test_get_template_names_invalid(self):
-        node = BirdNode(name="input.label", attrs=[], nodelist=None)
-
-        template_names = node.get_template_names(node.name)
-
-        assert "bird/input/label/invalid.html" not in template_names
-
-    def test_get_template_names_duplicates(self):
-        with override_settings(DJANGO_BIRD={"COMPONENT_DIRS": ["bird"]}):
-            node = BirdNode(name="button", attrs=[], nodelist=None)
-
-            template_names = node.get_template_names(node.name)
-
-            template_counts = {}
-            for template in template_names:
-                template_counts[template] = template_counts.get(template, 0) + 1
-
-            for _, count in template_counts.items():
-                assert count == 1