Turn examples into unit tests. Add TODO and skip test for now.

Author: rudolfbyker

test/example1/.gitignore examples/example1/.gitignoretest/example1/.gitignore renamed to examples/example1/.gitignore

@@ -18,6 +18,12 @@ class VbaCollector(BaseCollector):
     Collect data from a VBA file.
     """
 
+    base_dir: Path
+
+    def __init__(self, base_dir: Path) -> None:
+        super().__init__()
+        self.base_dir = base_dir
+
     def collect(
         self,
         identifier: str,
@@ -35,7 +41,7 @@ def collect(
         Returns:
             The collected object tree.
         """
-        p = Path(identifier)
+        p = Path(self.base_dir, identifier)
         with p.open("r") as f:
             code = f.read()
 

test/example1/docs/index.md examples/example1/docs/index.mdtest/example1/docs/index.md renamed to examples/example1/docs/index.md

@@ -1,6 +1,7 @@
 """This module implements a handler for the VBA language."""
 
 import posixpath
+from pathlib import Path
 from typing import Any, BinaryIO, Iterator, Optional, Tuple
 
 from griffe.logger import patch_loggers
@@ -67,6 +68,8 @@ def get_handler(
         An instance of `VbaHandler`.
     """
     return VbaHandler(
-        collector=VbaCollector(),
+        # TODO How do we get the path of the directory containing mkdocs.yml here?
+        #  Indentifiers for .bas files need to be found relative to that.
+        collector=VbaCollector(base_dir=Path(".")),
         renderer=VbaRenderer("vba", theme, custom_templates),
     )

test/example1/mkdocs.yml examples/example1/mkdocs.ymltest/example1/mkdocs.yml renamed to examples/example1/mkdocs.yml

@@ -0,0 +1,45 @@
+import unittest
+from contextlib import contextmanager
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from locate import this_dir
+from mkdocs.commands.build import build
+from mkdocs.config import load_config
+
+repo_dir = this_dir().parent
+examples_dir = repo_dir.joinpath("examples")
+
+
+@contextmanager
+def tmp_build(config_file_path: Path):
+    with TemporaryDirectory() as tmp_dir:
+        tmp_dir = Path(tmp_dir)
+
+        with config_file_path.open(mode="rb") as f:
+            config = load_config(config_file=f)
+            config["site_dir"] = tmp_dir
+            build(
+                config=config,
+                dirty=False,
+                live_server=False,
+            )
+
+        try:
+            yield tmp_dir
+        finally:
+            pass
+
+
+class TestExamples(unittest.TestCase):
+    def test_example1(self):
+        raise unittest.SkipTest
+
+        with tmp_build(examples_dir.joinpath("example1", "mkdocs.yml")) as tmp_dir:
+            pass
+
+
+if __name__ == "__main__":
+    unittest.main(
+        failfast=True,
+    )