move get_component_directory_names to templates module (#227)

Author: joshuadavidthomas

src/django_bird/conf.py

@@ -7,7 +7,6 @@
 from django.conf import settings
 
 from ._typing import override
-from .utils import unique_ordered
 
 DJANGO_BIRD_SETTINGS_NAME = "DJANGO_BIRD"
 
@@ -26,8 +25,5 @@ def __getattribute__(self, __name: str) -> object:
         user_settings = getattr(settings, DJANGO_BIRD_SETTINGS_NAME, {})
         return user_settings.get(__name, super().__getattribute__(__name))
 
-    def get_component_directory_names(self):
-        return unique_ordered([*self.COMPONENT_DIRS, "bird"])
-
 
 app_settings = AppSettings()

src/django_bird/staticfiles.py

@@ -25,6 +25,7 @@
 from .apps import DjangoBirdAppConfig
 from .conf import app_settings
 from .templates import get_component_directories
+from .templates import get_component_directory_names
 from .templatetags.tags.asset import AssetTag
 from .utils import get_files_from_dirs
 
@@ -125,7 +126,7 @@ def storage(self):
     @property
     def template_dir(self):
         template_dir = self.path.parent
-        component_dirs = app_settings.get_component_directory_names()
+        component_dirs = get_component_directory_names()
         while (
             len(template_dir.parts) > 1 and template_dir.parts[-1] not in component_dirs
         ):

src/django_bird/templates.py

@@ -68,7 +68,7 @@ def get_template_names(name: str) -> list[str]:
         list[str]: A list of potential template names in resolution order.
     """
     template_names: list[str] = []
-    component_dirs = app_settings.get_component_directory_names()
+    component_dirs = get_component_directory_names()
 
     name_parts = name.split(".")
     path_name = "/".join(name_parts)
@@ -103,6 +103,10 @@ def get_template_directories() -> Generator[Path, Any, None]:
         yield from hook_result
 
 
+def get_component_directory_names() -> list[Path | str]:
+    return unique_ordered([*app_settings.COMPONENT_DIRS, "bird"])
+
+
 def get_component_directories(
     template_dirs: Iterator[Path] | None = None,
 ) -> list[Path]:
@@ -112,7 +116,7 @@ def get_component_directories(
     return [
         Path(template_dir) / component_dir
         for template_dir in template_dirs
-        for component_dir in app_settings.get_component_directory_names()
+        for component_dir in get_component_directory_names()
     ]
 
 

tests/test_conf.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import pytest
-from django.test import override_settings
 
 from django_bird.conf import app_settings
 
@@ -10,10 +9,3 @@
 def test_app_settings():
     assert app_settings.COMPONENT_DIRS == []
     assert app_settings.ENABLE_BIRD_ATTRS is True
-
-
-def test_component_directory_names():
-    assert app_settings.get_component_directory_names() == ["bird"]
-
-    with override_settings(DJANGO_BIRD={"COMPONENT_DIRS": ["components"]}):
-        assert app_settings.get_component_directory_names() == ["components", "bird"]

tests/test_templates.py

@@ -5,6 +5,7 @@
 
 from django_bird.templates import find_components_in_template
 from django_bird.templates import gather_bird_tag_template_usage
+from django_bird.templates import get_component_directory_names
 from django_bird.templates import get_template_names
 
 
@@ -60,8 +61,8 @@ def test_get_template_names_invalid():
     assert "bird/input/label/invalid.html" not in template_names
 
 
-def test_get_template_names_duplicates():
-    with override_settings(DJANGO_BIRD={"COMPONENT_DIRS": ["bird"]}):
+def test_get_template_names_duplicates(override_app_settings):
+    with override_app_settings(COMPONENT_DIRS=["bird"]):
         template_names = get_template_names("button")
 
         template_counts = {}
@@ -72,6 +73,13 @@ def test_get_template_names_duplicates():
             assert count == 1
 
 
+def test_component_directory_names(override_app_settings):
+    assert get_component_directory_names() == ["bird"]
+
+    with override_app_settings(COMPONENT_DIRS=["components"]):
+        assert get_component_directory_names() == ["components", "bird"]
+
+
 def test_find_components_handles_errors():
     result = find_components_in_template("non_existent_template.html")
     assert result == set()