move some utility functions to a utils module (#149)

Author: joshuadavidthomas

src/django_bird/components.py

@@ -26,12 +26,12 @@
 from .staticfiles import AssetType
 from .templates import gather_bird_tag_template_usage
 from .templates import get_component_directories
-from .templates import get_files_from_dirs
 from .templates import get_template_names
 from .templates import scan_template_for_bird_tag
 from .templatetags.tags.bird import BirdNode
 from .templatetags.tags.slot import DEFAULT_SLOT
 from .templatetags.tags.slot import SlotNode
+from .utils import get_files_from_dirs
 
 
 @dataclass(frozen=True, slots=True)

src/django_bird/conf.py

@@ -11,6 +11,7 @@
 from django.conf import settings
 
 from ._typing import override
+from .utils import unique_ordered
 
 DJANGO_BIRD_SETTINGS_NAME = "DJANGO_BIRD"
 
@@ -40,6 +41,9 @@ def autoconfigure(self) -> None:
 
         self._configurator.autoconfigure()
 
+    def get_component_directory_names(self):
+        return unique_ordered([*self.COMPONENT_DIRS, "bird"])
+
 
 @final
 class AutoConfigurator:

src/django_bird/staticfiles.py

@@ -19,7 +19,7 @@
 
 from ._typing import override
 from .apps import DjangoBirdAppConfig
-from .templates import get_component_directory_names
+from .conf import app_settings
 
 if TYPE_CHECKING:
     pass
@@ -92,7 +92,7 @@ def storage(self):
     @property
     def template_dir(self):
         template_dir = self.path.parent
-        component_dirs = get_component_directory_names()
+        component_dirs = app_settings.get_component_directory_names()
         while (
             len(template_dir.parts) > 1 and template_dir.parts[-1] not in component_dirs
         ):

src/django_bird/templates.py

@@ -3,7 +3,6 @@
 import re
 from collections.abc import Callable
 from collections.abc import Generator
-from collections.abc import Iterable
 from collections.abc import Iterator
 from pathlib import Path
 from typing import Any
@@ -19,14 +18,13 @@
 from django.template.loader_tags import IncludeNode
 from django.template.utils import get_app_template_dirs
 
+from django_bird.utils import unique_ordered
+
 from ._typing import _has_nodelist
 from .conf import app_settings
 from .templatetags.tags.bird import TAG
 from .templatetags.tags.bird import BirdNode
-
-
-def get_component_directory_names():
-    return list(dict.fromkeys([*app_settings.COMPONENT_DIRS, "bird"]))
+from .utils import get_files_from_dirs
 
 
 def get_template_names(name: str) -> list[str]:
@@ -64,8 +62,8 @@ def get_template_names(name: str) -> list[str]:
     Returns:
         list[str]: A list of potential template names in resolution order.
     """
-    template_names = []
-    component_dirs = get_component_directory_names()
+    template_names: list[str] = []
+    component_dirs = app_settings.get_component_directory_names()
 
     name_parts = name.split(".")
     path_name = "/".join(name_parts)
@@ -79,7 +77,7 @@ def get_template_names(name: str) -> list[str]:
         ]
         template_names.extend(potential_names)
 
-    return list(dict.fromkeys(template_names))
+    return unique_ordered(template_names)
 
 
 def get_template_directories() -> Generator[Path, Any, None]:
@@ -99,19 +97,10 @@ def get_component_directories(
     return [
         Path(template_dir) / component_dir
         for template_dir in template_dirs
-        for component_dir in get_component_directory_names()
+        for component_dir in app_settings.get_component_directory_names()
     ]
 
 
-def get_files_from_dirs(
-    dirs: Iterable[Path],
-) -> Generator[tuple[Path, Path], Any, None]:
-    for dir in dirs:
-        for path in dir.rglob("*"):
-            if path.is_file():
-                yield path, dir
-
-
 BIRD_TAG_PATTERN = re.compile(
     rf"{{%\s*{TAG}\s+(?:\"|')?([a-zA-Z0-9_.-]+)(?:\"|')?.*?%}}"
 )

src/django_bird/utils.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from collections.abc import Generator
+from collections.abc import Iterable
+from pathlib import Path
+from typing import Any
+from typing import TypeVar
+
+
+def get_files_from_dirs(
+    dirs: Iterable[Path],
+    pattern: str = "*",
+) -> Generator[tuple[Path, Path], Any, None]:
+    for dir in dirs:
+        for path in dir.rglob(pattern):
+            if path.is_file():
+                yield path, dir
+
+
+Item = TypeVar("Item")
+
+
+def unique_ordered(items: Iterable[Item]) -> list[Item]:
+    return list(dict.fromkeys(items))

tests/test_utils.py

@@ -0,0 +1,51 @@
+from __future__ import annotations
+
+import pytest
+
+from django_bird.utils import get_files_from_dirs
+from django_bird.utils import unique_ordered
+
+
+def test_get_files_from_dirs(tmp_path):
+    first = tmp_path / "first"
+    first.mkdir()
+
+    for i in range(10):
+        file = first / f"to_find{i}.txt"
+        file.write_text("file should be found")
+
+    for i in range(10):
+        file = first / f"do_not_find{i}.txt"
+        file.write_text("file should not be found")
+
+    second = tmp_path / "second"
+    second.mkdir()
+
+    for i in range(10):
+        file = second / f"to_find{i}.txt"
+        file.write_text("file should be found")
+
+    for i in range(10):
+        file = second / f"do_not_find{i}.txt"
+        file.write_text("file should not be found")
+
+    dirs = [first, second]
+
+    found_paths = list(get_files_from_dirs(dirs, "to_find*.txt"))
+
+    assert len(found_paths) == 20
+    assert all("to_find" in path.name for path, _ in found_paths)
+    assert not any("do_not_find" in path.name for path, _ in found_paths)
+
+
+@pytest.mark.parametrize(
+    "items,expected",
+    [
+        (["a", "b", "c", "a"], ["a", "b", "c"]),
+        (["first", "second", "first", "third"], ["first", "second", "third"]),
+        ([1, 2, 1, 3], [1, 2, 3]),
+        ([1, "b", 1, "a"], [1, "b", "a"]),
+    ],
+)
+def test_unique_ordered(items, expected):
+    assert unique_ordered(items) == expected