tool: set up tests for tooling code

Author: colmjude

Makefile

@@ -4,9 +4,9 @@ BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
 init::
 	python -m pip install --upgrade pip
 	python -m pip install pip-tools
-	python -m piptools compile explorer/requirements/dev-requirements.in
-	python -m piptools compile explorer/requirements/requirements.in
-	python -m piptools sync explorer/requirements/dev-requirements.txt explorer/requirements/requirements.txt
+	python -m piptools compile requirements/dev-requirements.in
+	python -m piptools compile requirements/requirements.in
+	python -m piptools sync requirements/dev-requirements.txt requirements/requirements.txt
 
 
 checks:
@@ -49,4 +49,4 @@ commit-issue-tracking::
 
 commit-outputs:
 	git add generated/
-	git diff --quiet && git diff --staged --quiet || (git commit -m "Latest generated outputs $(shell date +%F)"; git push origin $(BRANCH))
+	git diff --quiet && git diff --staged --quiet || (git commit -m "Latest generated outputs $(shell date +%F)"; git push origin $(BRANCH))

bin/utils.py

@@ -16,3 +16,18 @@ def save_string_to_file(content: str, file_path: str):
         os.makedirs(folder, exist_ok=True)
     with open(file_path, "w", encoding="utf-8") as f:
         f.write(content)
+
+
+# New helpers for name/anchor formatting
+def to_anchor(s: str) -> str:
+    """
+    Convert a string into a URL-safe kebab-case anchor.
+    e.g. "Site constraint" -> "site-constraint"
+    """
+    if not s:
+        return ""
+    s = s.lower()
+    # replace any sequence of non-alphanumeric characters with a single hyphen
+    s = re.sub(r"[^a-z0-9]+", "-", s)
+    s = s.strip("-")
+    return s

explorer/requirements/dev-requirements.txt

@@ -1,4 +1,5 @@
 -c requirements.in
 flake8
 black
-isort
+isort
+pytest

explorer/requirements/dev-requirements.in requirements/dev-requirements.inexplorer/requirements/dev-requirements.in renamed to requirements/dev-requirements.in

@@ -0,0 +1,50 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    pip-compile requirements/dev-requirements.in
+#
+black==25.1.0
+    # via -r requirements/dev-requirements.in
+click==8.1.8
+    # via
+    #   -c /Users/colm/code/mhclg/digital-land/planning-application-data-specification/requirements/requirements.in
+    #   black
+exceptiongroup==1.3.0
+    # via pytest
+flake8==7.2.0
+    # via -r requirements/dev-requirements.in
+iniconfig==2.1.0
+    # via pytest
+isort==6.0.1
+    # via -r requirements/dev-requirements.in
+mccabe==0.7.0
+    # via flake8
+mypy-extensions==1.1.0
+    # via black
+packaging==25.0
+    # via
+    #   black
+    #   pytest
+pathspec==0.12.1
+    # via black
+platformdirs==4.3.8
+    # via black
+pluggy==1.6.0
+    # via pytest
+pycodestyle==2.13.0
+    # via flake8
+pyflakes==3.3.2
+    # via flake8
+pygments==2.19.2
+    # via pytest
+pytest==8.4.1
+    # via -r requirements/dev-requirements.in
+tomli==2.2.1
+    # via
+    #   black
+    #   pytest
+typing-extensions==4.13.2
+    # via
+    #   black
+    #   exceptiongroup

requirements/dev-requirements.txt

@@ -2,23 +2,23 @@
 # This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
-#    pip-compile explorer/requirements/requirements.in
+#    pip-compile requirements/requirements.in
 #
 certifi==2025.6.15
     # via requests
 charset-normalizer==3.4.2
     # via requests
 click==8.1.8
-    # via -r explorer/requirements/requirements.in
+    # via -r requirements/requirements.in
 idna==3.10
     # via requests
 python-dotenv==1.1.1
-    # via -r explorer/requirements/requirements.in
+    # via -r requirements/requirements.in
 python-frontmatter==1.1.0
-    # via -r explorer/requirements/requirements.in
+    # via -r requirements/requirements.in
 pyyaml==6.0.2
     # via python-frontmatter
 requests==2.32.4
-    # via -r explorer/requirements/requirements.in
+    # via -r requirements/requirements.in
 urllib3==2.5.0
     # via requests

explorer/requirements/requirements.in requirements/requirements.inexplorer/requirements/requirements.in renamed to requirements/requirements.in

@@ -0,0 +1,5 @@
+# tests/conftest.py
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))

explorer/requirements/requirements.txt requirements/requirements.txtexplorer/requirements/requirements.txt renamed to requirements/requirements.txt

@@ -0,0 +1,18 @@
+from bin.utils import to_anchor
+
+
+def test_to_anchor_simple():
+    assert to_anchor("Site constraint") == "site-constraint"
+
+
+def test_to_anchor_non_alnum():
+    assert to_anchor("Site: Constraint / Area") == "site-constraint-area"
+
+
+def test_to_anchor_trims_hyphens():
+    assert to_anchor("  --Example!! ") == "example"
+
+
+def test_to_anchor_empty():
+    assert to_anchor("") == ""
+    assert to_anchor(None) == ""