🔀 Merge pull request #30 from davep/sortable

Make various items in the API sortable

Author: davep

.github/workflows/style-and-lint.yaml …ithub/workflows/style-lint-and-test.yaml.github/workflows/style-and-lint.yaml renamed to .github/workflows/style-lint-and-test.yaml .github/workflows/style-and-lint.yaml renamed to .github/workflows/style-lint-and-test.yaml

@@ -8,9 +8,9 @@ on:
 
 jobs:
 
-  style-and-lint:
+  style-lint-and-test:
 
-    name: Style and lint
+    name: Style, lint, test
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -50,4 +50,7 @@ jobs:
       - name: Type check the code
         run: make stricttypecheck
 
-### style-and-lint.yaml ends here
+      - name: Run unit tests
+        run: make test
+
+### style-lint-and-test.yaml ends here

ChangeLog.md

@@ -1,5 +1,14 @@
 # OldAS ChangeLog
 
+## Unrelased
+
+**Released: WiP**
+
+- Make `Folders` sortable by `Folder.name` by default.
+  ([#30](https://github.com/davep/oldas/pull/30))
+- Make `Subscriptons` sortable by `Subscription.title` by default.
+  ([#30](https://github.com/davep/oldas/pull/30))
+
 ## v0.6.0
 
 **Released: 2026-01-25**

Makefile

@@ -1,10 +1,12 @@
 lib      := oldas
 src      := src/
+tests    := tests/
 docs     := docs/
 run      := uv run --env-file .env
 sync     := uv sync
 build    := uv build
 publish  := uv publish --username=__token__ --keyring-provider=subprocess
+test     := $(run) pytest
 python   := $(run) python
 ruff     := $(run) ruff
 lint     := $(ruff) check --select I
@@ -38,26 +40,30 @@ resetup: realclean		# Recreate the virtual environment from scratch
 # Checking/testing/linting/etc.
 .PHONY: lint
 lint:				# Check the code for linting issues
-	$(lint) $(src)
+	$(lint) $(src) $(tests)
 
 .PHONY: codestyle
 codestyle:			# Is the code formatted correctly?
-	$(fmt) --check $(src)
+	$(fmt) --check $(src) $(tests)
 
 .PHONY: typecheck
 typecheck:			# Perform static type checks with mypy
-	$(mypy) --scripts-are-modules $(src)
+	$(mypy) --scripts-are-modules $(src) $(tests)
 
 .PHONY: stricttypecheck
 stricttypecheck:	        # Perform a strict static type checks with mypy
-	$(mypy) --scripts-are-modules --strict $(src)
+	$(mypy) --scripts-are-modules --strict $(src) $(tests)
+
+.PHONY: test
+test:				# Run the unit tests
+	$(test) -v
 
 .PHONY: spellcheck
 spellcheck:			# Spell check the code
-	$(spell) *.md $(src) $(docs)
+	$(spell) *.md $(src) $(docs) $(tests)
 
 .PHONY: checkall
-checkall: spellcheck codestyle lint stricttypecheck # Check all the things
+checkall: spellcheck codestyle lint stricttypecheck test # Check all the things
 
 ##############################################################################
 # Documentation.
@@ -103,7 +109,7 @@ delint:			# Fix linting issues.
 
 .PHONY: pep8ify
 pep8ify:			# Reformat the code to be as PEP8 as possible.
-	$(fmt) $(src)
+	$(fmt) $(src) $(tests)
 
 .PHONY: tidy
 tidy: delint pep8ify		# Tidy up the code, fixing lint and format issues.

pyproject.toml

@@ -60,6 +60,7 @@ dev = [
     "mkdocstrings[python]>=1.0.0",
     "mypy>=1.18.2",
     "pre-commit>=4.3.0",
+    "pytest>=9.0.2",
     "ruff>=0.14.0",
 ]
 

src/oldas/folders.py

@@ -6,6 +6,7 @@
 
 ##############################################################################
 # Python imports.
+from functools import total_ordering
 from typing import NamedTuple
 
 ##############################################################################
@@ -16,6 +17,7 @@
 
 
 ##############################################################################
+@total_ordering
 class Folder(NamedTuple):
     """Folder information class."""
 
@@ -47,6 +49,16 @@ def from_json(cls, data: RawData) -> Folder:
             sort_id=data["sortid"],
         )
 
+    def __gt__(self, value: object, /) -> bool:
+        if isinstance(value, Folder):
+            return self.name > value.name
+        raise NotImplementedError
+
+    def __eq__(self, value: object, /) -> bool:
+        if isinstance(value, Folder):
+            return self.name == value.name
+        raise NotImplementedError
+
 
 ##############################################################################
 class Folders(OldList[Folder]):

src/oldas/subscriptions.py

@@ -7,6 +7,7 @@
 ##############################################################################
 # Python imports.
 from datetime import datetime, timezone
+from functools import total_ordering
 from typing import NamedTuple
 
 ##############################################################################
@@ -51,6 +52,7 @@ class Categories(OldList[Category]):
 
 
 ##############################################################################
+@total_ordering
 class Subscription(NamedTuple):
     """Holds a subscription."""
 
@@ -116,6 +118,16 @@ def folder_id(self) -> str | None:
             None,
         )
 
+    def __gt__(self, value: object, /) -> bool:
+        if isinstance(value, Subscription):
+            return self.title > value.title
+        raise NotImplementedError
+
+    def __eq__(self, value: object, /) -> bool:
+        if isinstance(value, Subscription):
+            return self.title == value.title
+        raise NotImplementedError
+
 
 ##############################################################################
 class SubscribeResult(NamedTuple):

tests/unit/test_folders.py

@@ -0,0 +1,24 @@
+"""Tests for the code relating to folders."""
+
+##############################################################################
+# Local imports.
+from oldas import Folder, Folders
+from oldas.prefixes import Prefix
+
+##############################################################################
+TEST_FOLDERS = Folders(
+    [
+        Folder.from_json({"id": f"{Prefix.FOLDER}z", "sortid": ""}),
+        Folder.from_json({"id": f"{Prefix.FOLDER}a", "sortid": ""}),
+    ]
+)
+
+
+##############################################################################
+def test_sort_folders() -> None:
+    """Folders should sort by name."""
+    assert [folder.name for folder in TEST_FOLDERS] == ["z", "a"]
+    assert [folder.name for folder in sorted(TEST_FOLDERS)] == ["a", "z"]
+
+
+### test_folders.py ends here

tests/unit/test_subscriptions.py

@@ -0,0 +1,46 @@
+"""Tests for code relating to the subscriptions."""
+
+##############################################################################
+# Local imports.
+from oldas import Subscription, Subscriptions
+
+##############################################################################
+TEST_SUBSCRIPTIONS = Subscriptions(
+    [
+        Subscription.from_json(
+            {
+                "id": "1",
+                "title": "z",
+                "sortid": "",
+                "firstitemmsec": 0,
+                "url": "https://example.com/",
+                "htmlUrl": "https://example.com/",
+                "categories": [],
+            }
+        ),
+        Subscription.from_json(
+            {
+                "id": "1",
+                "title": "a",
+                "sortid": "",
+                "firstitemmsec": 0,
+                "url": "https://example.com/",
+                "htmlUrl": "https://example.com/",
+                "categories": [],
+            }
+        ),
+    ]
+)
+
+
+##############################################################################
+def test_sort_subscriptions() -> None:
+    """Subscriptions should sort by title."""
+    assert [subscription.title for subscription in TEST_SUBSCRIPTIONS] == ["z", "a"]
+    assert [subscription.title for subscription in sorted(TEST_SUBSCRIPTIONS)] == [
+        "a",
+        "z",
+    ]
+
+
+### test_subscriptions.py ends here