Merge pull request #42 from sphinx-notes/feat/path-indexer

 feat: Impl PathIndexer

Author: SilverRainZ

.github/workflows/test.yml

@@ -5,11 +5,14 @@ on:
   schedule:
     - cron: '0 7 * * 6'
 jobs:
-  test-ubuntu:
+  test:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: 'pyproject.toml'
     - name: Install the dependencies
-      run: python3 -m pip install sphinx -r ./requirements.txt
+      run: python3 -m pip install .[dev]
     - name: Build
       run: make test

pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
     "Topic :: Documentation :: Sphinx",
 ]
 
-requires-python = ">=3.8"
+requires-python = ">=3.12"
 dependencies = [
     "Sphinx >= 4",
     "Jinja2",

src/sphinxnotes/any/schema.py

@@ -160,9 +160,8 @@ def classify(self, objref: Value) -> list[Category]:
 
     _T = TypeVar('_T')
 
-    @abstractmethod
     def sort(self, data: Iterable[_T], key: Callable[[_T], Category]) -> list[_T]:
-        raise NotImplementedError
+        return sorted(data, key=lambda x: key(x)._sort_key)
 
     @abstractmethod
     def anchor(self, refval: str) -> str:
@@ -178,11 +177,6 @@ def classify(self, objref: Value) -> list[Category]:
             entries.append(Category(main=v))
         return entries
 
-    def sort(
-        self, data: Iterable[Indexer._T], key: Callable[[Indexer._T], Category]
-    ) -> list[Indexer._T]:
-        return sorted(data, key=lambda x: key(x)._sort_key)
-
     def anchor(self, refval: str) -> str:
         return refval
 
@@ -303,6 +297,27 @@ def anchor(self, refval: str) -> str:
         return ''
 
 
+class PathIndexer(Indexer):
+    name = 'path'
+
+    def __init__(self, sep: str, maxsplit: Literal[1, 2]):
+        self.sep = sep
+        self.maxsplit = maxsplit
+
+    def classify(self, objref: Value) -> list[Category]:
+        entries = []
+        for v in objref.as_list():
+            comps = v.split(self.sep, maxsplit=self.maxsplit)
+            category = Category(main=comps[0], extra=v)
+            if self.maxsplit == 2:
+                category.sub = v[1] if len(comps) > 1 else None
+            entries.append(category)
+        return entries
+
+    def anchor(self, refval: str) -> str:
+        return refval.split(self.sep, maxsplit=self.maxsplit)[0]
+
+
 @dataclasses.dataclass(frozen=True)
 class Object(object):
     objtype: str

tests/test_schema.py

@@ -15,9 +15,9 @@ def test_equal(self):
     def new_schema(self) -> Schema:
         return Schema(
             'cat',
-            name=Field(referenceable=True, form=Field.Form.LINES),
+            name=Field(ref=True, form=Field.Forms.LINES),
             attrs={
-                'id': Field(unique=True, referenceable=True, required=True),
+                'id': Field(uniq=True, ref=True, required=True),
                 'owner': Field(),
                 'height': Field(),
                 'width': Field(),