Add template for patchouli:relations pages (#92)

Author: object-Object

noxfile.py

@@ -383,6 +383,21 @@ def dummy_setup(session: nox.Session):
                                         "trigger": "story/smelt_iron",
                                         "text": "Wow, what a wonderful quest this is here",
                                     },
+                                    {
+                                        "type": "patchouli:relations",
+                                        "entries": [
+                                            "dummy:otherrecipes",
+                                            "dummy:bar",
+                                        ],
+                                        "text": "have a look at these related entries!!",
+                                    },
+                                    {
+                                        "type": "patchouli:link",
+                                        "url": "https://github.com/hexdoc-dev/hexdoc",
+                                        "link_text": "hexdoc GitHub",
+                                        "text": "Link page",
+                                    },
+                                    {"type": "patchouli:empty"},
                                 ],
                             },
                             "entries/otherrecipes.json": {

src/hexdoc/_templates/pages/patchouli/relations.html.jinja

@@ -0,0 +1,12 @@
+{% extends "pages/patchouli/text.html.jinja" %}
+
+{% import "macros/formatting.html.jinja" as fmt with context %}
+
+{% block inner_body %}
+<ul>
+  {% for ref in page.get_entries() %}
+    <li>{{ fmt.maybe_spoilered_link(book.all_entries[ref]) }}</li>
+  {% endfor %}
+</ul>
+{{ super() }}
+{% endblock %}

src/hexdoc/patchouli/book.py

@@ -34,6 +34,7 @@ class Book(HexdocModel):
 
     # not in book.json
     _categories: dict[ResourceLocation, Category] = PrivateAttr(default_factory=dict)
+    _all_entries: dict[ResourceLocation, Entry] = PrivateAttr(default_factory=dict)
 
     # required
     name: LocalizedStr
@@ -77,6 +78,13 @@ class Book(HexdocModel):
     def categories(self):
         return self._categories
 
+    @property
+    def all_entries(self):
+        """
+        Note: includes external entries as well (not just internal ones)
+        """
+        return self._all_entries
+
     def _load_categories(self, context: ContextSource, book_ctx: BookContext):
         categories = Category.load_all(
             cast_context(context),
@@ -120,6 +128,7 @@ def _load_entries(
             # i used the entry to insert the entry (pretty sure thanos said that)
             if resource_dir.internal:
                 internal_entries[entry.category_id][entry.id] = entry
+            self._all_entries[entry.id] = entry
 
             link_base = book_ctx.get_link_base(resource_dir)
             book_ctx.book_links[entry.book_link_key] = link_base.with_fragment(

src/hexdoc/patchouli/page/pages.py

@@ -1,6 +1,8 @@
 from collections import defaultdict
 from typing import Self
 
+from jinja2 import pass_context
+from jinja2.runtime import Context
 from pydantic import Field, ValidationInfo, field_validator, model_validator
 
 from hexdoc.core import Entity, ItemStack, ResourceLocation
@@ -148,6 +150,13 @@ class RelationsPage(PageWithText, type="patchouli:relations"):
     entries: list[ResourceLocation]
     title: LocalizedStr = LocalizedStr.with_value("Related Chapters")
 
+    @pass_context
+    def get_entries(self, context: Context) -> list[ResourceLocation]:
+        for entry in self.entries:
+            if entry not in context["book"].all_entries:
+                raise ValueError(f"Broken entry reference in relations: {entry}")
+        return self.entries
+
 
 class SmeltingPage(PageWithDoubleRecipe[SmeltingRecipe], type="patchouli:smelting"):
     pass