Set the sort order for the listing.

Author: pauleveritt

src/psc/resources.py

@@ -4,6 +4,7 @@
 """
 from dataclasses import dataclass
 from dataclasses import field
+from operator import attrgetter
 from pathlib import Path
 from pathlib import PurePath
 from typing import cast
@@ -16,13 +17,12 @@
 from psc.here import HERE
 from psc.here import PYODIDE
 
-
 EXCLUSIONS = ("pyscript.css", "pyscript.js", "favicon.png")
 
 
 def tag_filter(
-    tag: Tag,
-    exclusions: tuple[str, ...] = EXCLUSIONS,
+        tag: Tag,
+        exclusions: tuple[str, ...] = EXCLUSIONS,
 ) -> bool:
     """Filter nodes from example that should not get included."""
     attr = "href" if tag.name == "link" else "src"
@@ -155,14 +155,19 @@ class Resources:
     pages: dict[PurePath, Page] = field(default_factory=dict)
 
 
+def get_sorted_examples() -> list[PurePath]:
+    """Return an alphabetized listing of the examples."""
+    examples_dir = HERE / "gallery/examples"
+    examples = [e for e in examples_dir.iterdir() if e.is_dir()]
+    return sorted(examples, key=attrgetter("name"))
+
+
 def get_resources() -> Resources:
     """Factory to construct all the resources in the site."""
     resources = Resources()
 
     # Load the examples
-    examples_dir = HERE / "gallery/examples"
-    examples = [e for e in examples_dir.iterdir() if e.is_dir()]
-    for example in examples:
+    for example in get_sorted_examples():
         this_path = PurePath(example.name)
         this_example = Example(path=this_path)
         resources.examples[this_path] = this_example

tests/test_app.py

@@ -58,12 +58,12 @@ def test_examples_listing(client_page: PageT) -> None:
     first_example = examples_soup.select_one("p.title a")
     assert first_example
     first_href = first_example.get("href")
-    assert first_href == "../gallery/examples/hello_world/"
+    assert first_href == "../gallery/examples/altair/"
     hello_soup = client_page(first_href)
     assert hello_soup
     title = hello_soup.select_one("title")
     assert title
-    assert title.text == "Hello World | PyScript Collective"
+    assert title.text == "Altair Visualization | PyScript Collective"
 
 
 def test_static(test_client: TestClient) -> None:

tests/test_resources.py

@@ -5,15 +5,14 @@
 import pytest
 from bs4 import BeautifulSoup
 
-from psc.resources import Example
+from psc.resources import Example, get_sorted_examples
 from psc.resources import Page
 from psc.resources import get_body_content
 from psc.resources import get_head_nodes
 from psc.resources import get_resources
 from psc.resources import is_local
 from psc.resources import tag_filter
 
-
 IS_LOCAL = is_local()
 
 
@@ -117,8 +116,8 @@ def test_example() -> None:
     this_example = Example(path=PurePath("hello_world"))
     assert this_example.title == "Hello World"
     assert (
-        this_example.subtitle
-        == "The classic hello world, but in Python -- in a browser!"
+            this_example.subtitle
+            == "The classic hello world, but in Python -- in a browser!"
     )
     assert "hello_world.css" in this_example.extra_head
     assert "<h1>Hello ...</h1>" in this_example.body
@@ -153,6 +152,12 @@ def test_missing_page() -> None:
     assert str(exc.value) == "No page at xxx"
 
 
+def test_sorted_examples() -> None:
+    examples = get_sorted_examples()
+    first_example = examples[0]
+    assert "altair" == first_example.name
+
+
 def test_get_resources() -> None:
     """Ensure the dict-of-dicts is generated with PurePath keys."""
     resources = get_resources()
@@ -162,8 +167,8 @@ def test_get_resources() -> None:
     hello_world = resources.examples[hello_world_path]
     assert hello_world.title == "Hello World"
     assert (
-        hello_world.subtitle
-        == "The classic hello world, but in Python -- in a browser!"
+            hello_world.subtitle
+            == "The classic hello world, but in Python -- in a browser!"
     )
 
     # Page