refactor other tests to use TestComponent test utils (#92)

Author: joshuadavidthomas

tests/conftest.py

@@ -146,44 +146,6 @@ class TestComponentCase:
     template_context: dict[str, Any] = field(default_factory=dict)
 
 
-@pytest.fixture
-def create_bird_dir(templates_dir):
-    def func(name):
-        bird_template_dir = templates_dir / name
-        bird_template_dir.mkdir(exist_ok=True)
-        return bird_template_dir
-
-    return func
-
-
-@pytest.fixture
-def create_bird_template(create_bird_dir):
-    def func(name, content, sub_dir=None, bird_dir_name="bird"):
-        bird_dir = create_bird_dir(bird_dir_name)
-        if sub_dir is not None:
-            dir = bird_dir / sub_dir
-            dir.mkdir()
-        else:
-            dir = bird_dir
-        template = dir / f"{name}.html"
-        template.write_text(content)
-        return template
-
-    return func
-
-
-@pytest.fixture
-def create_bird_asset():
-    def func(component_template: Path, content: str, asset_type: str):
-        component_dir = component_template.parent
-        component_name = component_template.stem
-        asset_file = component_dir / f"{component_name}.{asset_type}"
-        asset_file.write_text(content)
-        return asset_file
-
-    return func
-
-
 @pytest.fixture
 def create_template():
     def _create_template(template_file: Path) -> DjangoTemplate:
@@ -192,8 +154,6 @@ def _create_template(template_file: Path) -> DjangoTemplate:
             dirs=[str(template_file.parent)],
             loaders=["django_bird.loader.BirdLoader"],
         )
-        print(f"Engine dirs: {engine.dirs}")  # Debug print
-        print(f"Looking for template: {template_file.name}")  # Debug print
         template = engine.get_template(template_file.name)
         backend = DjangoTemplates(
             {

tests/templatetags/test_asset.py

@@ -12,6 +12,8 @@
 from django_bird.templatetags.tags.asset import JS_TAG
 from django_bird.templatetags.tags.asset import AssetNode
 from django_bird.templatetags.tags.asset import do_asset
+from tests.conftest import TestAsset
+from tests.conftest import TestComponent
 
 
 class TestTemplateTag:
@@ -44,16 +46,28 @@ def test_invalid_tag_name(self, tag):
         with pytest.raises(ValueError):
             do_asset(parser, token)
 
-    def test_template_inheritence(
-        self, create_bird_template, create_bird_asset, create_template, templates_dir
-    ):
-        alert = create_bird_template("alert", '<div class="alert">{{ slot }}</div>')
-        alert_css = create_bird_asset(alert, ".alert { color: red; }", "css")
-        alert_js = create_bird_asset(alert, "console.log('alert');", "js")
-
-        button = create_bird_template("button", "<button>{{ slot }}</button>")
-        button_css = create_bird_asset(button, ".button { color: blue; }", "css")
-        button_js = create_bird_asset(button, "console.log('button');", "js")
+    def test_template_inheritence(self, create_template, templates_dir):
+        alert = TestComponent(
+            name="alert", content='<div class="alert">{{ slot }}</div>'
+        ).create(templates_dir)
+        alert_css = TestAsset(
+            component=alert, content=".alert { color: red; }", asset_type=AssetType.CSS
+        ).create()
+        alert_js = TestAsset(
+            component=alert, content="console.log('alert');", asset_type=AssetType.JS
+        ).create()
+
+        button = TestComponent(
+            name="button", content="<button>{{ slot }}</button>"
+        ).create(templates_dir)
+        button_css = TestAsset(
+            component=button,
+            content=".button { color: blue; }",
+            asset_type=AssetType.CSS,
+        ).create()
+        button_js = TestAsset(
+            component=button, content="console.log('button');", asset_type=AssetType.JS
+        ).create()
 
         base_path = templates_dir / "base.html"
         base_path.write_text("""
@@ -82,15 +96,15 @@ def test_template_inheritence(
 
         rendered = template.render({})
 
-        assert f'<link rel="stylesheet" href="{alert_css}">' in rendered
-        assert f'<link rel="stylesheet" href="{button_css}">' in rendered
-        assert f'<script src="{alert_js}"></script>' in rendered
-        assert f'<script src="{button_js}"></script>' in rendered
+        assert f'<link rel="stylesheet" href="{alert_css.file}">' in rendered
+        assert f'<link rel="stylesheet" href="{button_css.file}">' in rendered
+        assert f'<script src="{alert_js.file}"></script>' in rendered
+        assert f'<script src="{button_js.file}"></script>' in rendered
 
-    def test_with_no_assets(
-        self, create_bird_template, create_bird_asset, create_template, templates_dir
-    ):
-        create_bird_template("alert", '<div class="alert">{{ slot }}</div>')
+    def test_with_no_assets(self, create_template, templates_dir):
+        TestComponent(
+            name="alert", content='<div class="alert">{{ slot }}</div>'
+        ).create(templates_dir)
 
         base_path = templates_dir / "base.html"
         base_path.write_text("""
@@ -114,16 +128,28 @@ def test_with_no_assets(
         assert '<link rel="stylesheet" href="' not in rendered
         assert '<script src="' not in rendered
 
-    def test_component_render_order(
-        self, create_bird_template, create_bird_asset, create_template, templates_dir
-    ):
-        first = create_bird_template("first", "<div>First: {{ slot }}</div>")
-        first_css = create_bird_asset(first, ".first { color: red; }", "css")
-        first_js = create_bird_asset(first, "console.log('first');", "js")
-
-        second = create_bird_template("second", "<div>Second: {{ slot }}</div>")
-        second_css = create_bird_asset(second, ".second { color: red; }", "css")
-        second_js = create_bird_asset(second, "console.log('second');", "js")
+    def test_component_render_order(self, create_template, templates_dir):
+        first = TestComponent(
+            name="first", content="<div>First: {{ slot }}</div>"
+        ).create(templates_dir)
+        first_css = TestAsset(
+            component=first, content=".first { color: red; }", asset_type=AssetType.CSS
+        ).create()
+        first_js = TestAsset(
+            component=first, content="console.log('first');", asset_type=AssetType.JS
+        ).create()
+
+        second = TestComponent(
+            name="second", content="<div>Second: {{ slot }}</div>"
+        ).create(templates_dir)
+        second_css = TestAsset(
+            component=second,
+            content=".second { color: red; }",
+            asset_type=AssetType.CSS,
+        ).create()
+        second_js = TestAsset(
+            component=second, content="console.log('second');", asset_type=AssetType.JS
+        ).create()
 
         template_path = templates_dir / "test.html"
         template_path.write_text("""
@@ -147,12 +173,14 @@ def test_component_render_order(
         rendered = template.render({})
 
         head_end = rendered.find("</head>")
-        assert f'<link rel="stylesheet" href="{first_css}">' in rendered[:head_end]
-        assert f'<link rel="stylesheet" href="{second_css}">' in rendered[:head_end]
+        assert f'<link rel="stylesheet" href="{first_css.file}">' in rendered[:head_end]
+        assert (
+            f'<link rel="stylesheet" href="{second_css.file}">' in rendered[:head_end]
+        )
 
         body_start = rendered.find("<body")
-        assert f'<script src="{first_js}"></script>' in rendered[body_start:]
-        assert f'<script src="{second_js}"></script>' in rendered[body_start:]
+        assert f'<script src="{first_js.file}"></script>' in rendered[body_start:]
+        assert f'<script src="{second_js.file}"></script>' in rendered[body_start:]
 
 
 class TestNode:

tests/test_apps.py

@@ -3,11 +3,14 @@
 from django.apps import apps
 
 from django_bird.components import components
+from tests.conftest import TestComponent
 
 
-def test_ready_scans_components(create_bird_template):
-    create_bird_template("button", "<button>Click me</button>")
-    create_bird_template("alert", "<div>Alert</div>")
+def test_ready_scans_components(templates_dir):
+    TestComponent(name="button", content="<button>Click me</button>").create(
+        templates_dir
+    )
+    TestComponent(name="alert", content="<div>Alert</div>").create(templates_dir)
 
     components.clear()
 

tests/test_fixtures.py

@@ -3,12 +3,14 @@
 import pytest
 from django.template.loader import get_template
 
+from tests.conftest import TestComponent
 
-def test_create_bird_template(create_bird_template):
+
+def test_test_component(templates_dir):
     name = "foo"
     content = "<div>bar</div>"
 
-    create_bird_template(name, content)
+    TestComponent(name=name, content=content).create(templates_dir)
 
     template = get_template(f"bird/{name}.html")