Refactor asset collection to new internal plugin (#186)

* Refactor asset collection using plugin system

* update changelog

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: joshuadavidthomas

CHANGELOG.md

@@ -21,6 +21,12 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 ### Added
 
 - Added plugin system infrastructure using `pluggy`.
+- Added plugin hook for component asset collection.
+
+### Changed
+
+- **Internal**: Refactored asset collection to use plugin system instead of directly in main library.
+- **Internal**: Moved `Asset.from_path` functionality to the new file assets plugin.
 
 ## [0.14.2]
 

pyproject.toml

@@ -55,11 +55,7 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython"
 ]
-dependencies = [
-  "cachetools>=5.5.0",
-  "django>=4.2",
-  "pluggy>=1.5.0"
-]
+dependencies = ["cachetools>=5.5.0", "django>=4.2", "pluggy>=1.5.0"]
 description = "High-flying components for perfectionists with deadlines"
 dynamic = ["version"]
 keywords = []
@@ -78,6 +74,12 @@ exclude = ["**/__pycache__"]
 include = ["src"]
 reportAny = false
 reportExplicitAny = false
+reportUnusedCallResult = false
+
+[[tool.basedpyright.executionEnvironments]]
+reportReturnType = false
+reportUnusedParameter = false
+root = "src/django_bird/plugins/hookspecs.py"
 
 [[tool.basedpyright.executionEnvironments]]
 root = "src"
@@ -123,7 +125,6 @@ fail_under = 98
 [tool.coverage.run]
 omit = [
   "src/django_bird/migrations/*",
-  "src/django_bird/plugins/*",  # TODO: remove when plugin hooks implemented
   "src/django_bird/_typing.py",
   "src/django_bird/views.py",  # TODO: remove when not empty
   "tests/*"
@@ -166,6 +167,10 @@ ignore_errors = true
 ignore_missing_imports = true
 module = ["*.migrations.*", "docs.*", "tests.*"]
 
+[[tool.mypy.overrides]]
+disable_error_code = "empty-body"
+module = ["django_bird.plugins.hookspecs"]
+
 [tool.mypy_django_plugin]
 ignore_missing_model_attributes = true
 

src/django_bird/components.py

@@ -1,7 +1,9 @@
 from __future__ import annotations
 
+import itertools
 from collections import defaultdict
 from collections.abc import Generator
+from collections.abc import Iterable
 from dataclasses import dataclass
 from dataclasses import field
 from hashlib import md5
@@ -22,6 +24,7 @@
 from .params import Param
 from .params import Params
 from .params import Value
+from .plugins import pm
 from .staticfiles import Asset
 from .staticfiles import AssetType
 from .templates import gather_bird_tag_template_usage
@@ -82,17 +85,12 @@ def from_abs_path(cls, path: Path, root: Path) -> Component:
     def from_name(cls, name: str):
         template_names = get_template_names(name)
         template = select_template(template_names)
-        assets: list[Asset] = [
-            asset
-            for asset_type in AssetType
-            if (
-                asset := Asset.from_path(
-                    Path(template.template.origin.name), asset_type
-                )
-            )
-            is not None
-        ]
-        return cls(name=name, template=template, assets=frozenset(assets))
+        assets: list[Iterable[Asset]] = pm.hook.collect_component_assets(
+            template_path=Path(template.template.origin.name)
+        )
+        return cls(
+            name=name, template=template, assets=frozenset(itertools.chain(*assets))
+        )
 
 
 class SequenceGenerator:

src/django_bird/plugins/file_assets.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from collections.abc import Iterable
+from pathlib import Path
+
+from django_bird import hookimpl
+from django_bird.staticfiles import Asset
+from django_bird.staticfiles import AssetType
+
+
+def find_component_asset(path: Path, asset_type: AssetType) -> Asset | None:
+    asset_path = path.with_suffix(asset_type.ext)
+    if asset_path.exists():
+        return Asset(path=asset_path, type=asset_type)
+    return None
+
+
+@hookimpl
+def collect_component_assets(template_path: Path) -> Iterable[Asset]:
+    assets: list[Asset] = []
+    for asset_type in AssetType:
+        if asset := find_component_asset(template_path, asset_type):
+            assets.append(asset)
+    return assets

src/django_bird/plugins/hookspecs.py

@@ -1,5 +1,15 @@
 from __future__ import annotations
 
+from collections.abc import Iterable
+from pathlib import Path
+
 from pluggy import HookspecMarker
 
+from django_bird.staticfiles import Asset
+
 hookspec = HookspecMarker("django_bird")
+
+
+@hookspec
+def collect_component_assets(template_path: Path) -> Iterable[Asset]:
+    """Collect all assets associated with a component."""

src/django_bird/plugins/manager.py

@@ -9,7 +9,10 @@
 pm = pluggy.PluginManager("django_bird")
 pm.add_hookspecs(hookspecs)
 
-DEFAULT_PLUGINS: list[str] = []
+DEFAULT_PLUGINS: list[str] = [
+    "django_bird.plugins.file_assets",
+]
+
 
 for plugin in DEFAULT_PLUGINS:
     mod = importlib.import_module(plugin)

src/django_bird/staticfiles.py

@@ -110,13 +110,6 @@ def url(self) -> str | None:
         static_relative_path = Path(static_path).relative_to(self.template_dir)
         return self.storage.url(str(static_relative_path))
 
-    @classmethod
-    def from_path(cls, path: Path, asset_type: AssetType):
-        asset_path = path.with_suffix(asset_type.ext)
-        if asset_path.exists():
-            return cls(path=asset_path, type=asset_type)
-        return None
-
 
 @final
 class BirdAssetStorage(StaticFilesStorage):

tests/plugins/__init__.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from django_bird.plugins.file_assets import find_component_asset
+from django_bird.staticfiles import Asset
+from django_bird.staticfiles import AssetType
+from tests.utils import TestAsset
+from tests.utils import TestComponent
+
+
+def test_find_component_asset(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()
+    button_js = TestAsset(
+        component=button, content="console.log('button');", asset_type=AssetType.JS
+    ).create()
+
+    assert find_component_asset(button.file, button_css.asset_type) == Asset(
+        button_css.file, button_css.asset_type
+    )
+    assert find_component_asset(button.file, button_js.asset_type) == Asset(
+        button_js.file, button_js.asset_type
+    )
+
+
+def test_from_template_nested(templates_dir):
+    button = TestComponent(
+        name="button", content="<button>Click me</button>", sub_dir="nested"
+    ).create(templates_dir)
+    button_css = TestAsset(
+        component=button,
+        content=".button { color: blue; }",
+        asset_type=AssetType.CSS,
+    ).create()
+
+    assert find_component_asset(button.file, button_css.asset_type) == Asset(
+        button_css.file, button_css.asset_type
+    )

tests/plugins/test_file_asset.py

@@ -198,40 +198,6 @@ def test_url_nonexistent(self, templates_dir):
 
         assert asset.url is None
 
-    def test_from_path(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()
-        button_js = TestAsset(
-            component=button, content="console.log('button');", asset_type=AssetType.JS
-        ).create()
-
-        assert Asset.from_path(button.file, button_css.asset_type) == Asset(
-            button_css.file, button_css.asset_type
-        )
-        assert Asset.from_path(button.file, button_js.asset_type) == Asset(
-            button_js.file, button_js.asset_type
-        )
-
-    def test_from_template_nested(self, templates_dir):
-        button = TestComponent(
-            name="button", content="<button>Click me</button>", sub_dir="nested"
-        ).create(templates_dir)
-        button_css = TestAsset(
-            component=button,
-            content=".button { color: blue; }",
-            asset_type=AssetType.CSS,
-        ).create()
-
-        assert Asset.from_path(button.file, button_css.asset_type) == Asset(
-            button_css.file, button_css.asset_type
-        )
-
 
 class TestBirdAssetFinder:
     def test_check(self):