You are a constitutional council ranking individual git commits for ownership allocation. Compare these two commits. Decide which contributed more lasting value to the project. Judge substance, not spectacle: - Prefer correct, lasting design and real bugfixes over churn, formatting, renames, or generated noise. - Prefer clarity and necessity over sheer line count. A small precise change can beat a large diffuse one. - Do not favor a side merely because its patch is longer or noisier. - Weight what the change does for the project, not the contributor's name. Return ONLY a JSON object: {"winner": "A" or "B", "ratio": "N:M", "explanation": "..."} The explanation must cite concrete differences in the patches (1-3 sentences). Side A β€” contributor: tommy-mor Side A β€” commit message: [02cd761c] Make ranked child group pin icons clickable to unpin. Lets users clear the garden pin from the ranked child groups list via the same POST /ui set_garden_pin flow as the HUD and item header. Co-authored-by: Cursor Side A β€” unified diff (full patch): diff --git a/server/src/html/garden/pin.rs b/server/src/html/garden/pin.rs index 1820d7fe7ee167ecbf5ad5124f23b2ab92ffb01f..b7ea92bbe67d6d499915edb607a3a0b36178d7f6 100644 --- a/server/src/html/garden/pin.rs +++ b/server/src/html/garden/pin.rs @@ -101,6 +101,7 @@ pub(super) fn child_row_pin_or_vote( row_item: &ItemId, pinned_room_and_item: Option<&(String, ItemId)>, scope_content: &ContentState, + next_path: &str, ) -> maud::Markup { let pin_matches_scope = pinned_room_and_item .map(|(r, _)| r == nav.room_wire.as_str()) @@ -108,12 +109,25 @@ pub(super) fn child_row_pin_or_vote( let pinned_item = pinned_room_and_item .filter(|_| pin_matches_scope) .map(|(_, i)| i); + let unpin_rpc = template_json_compact(&json!({ + "action": "set_garden_pin", + "clear": true, + "room_wire": "", + "next": next_path, + "form_action": "/ui", + })) + .expect("unpin rpc json"); html! { @if let Some(pi) = pinned_item { span class="ont-garden-child-actions" data-garden-room=(nav.room_wire.as_str()) { @if pi == row_item { - span class="ont-garden-pinned-here" title="Pinned" aria-label="Pinned" { "πŸ“Œ" } + form method="POST" action="/ui" data-navigate="full" class="ont-garden-pin-form" { + input type="hidden" name=(UI_RPC_FIELD) value=(unpin_rpc); + button type="submit" class="ont-garden-pin-ico ont-garden-pin-ico-active" title="Unpin" aria-label="Unpin from HUD" { + span class="ont-garden-pin-glyph" aria-hidden="true" { "πŸ“Œ" } + } + } } @else { @let nv = edge_vote_count_for_pair(scope_content, pi, row_item); @let tip = format!( diff --git a/server/src/html/garden/render.rs b/server/src/html/garden/render.rs index bd8cbce059ee789de6e8dc9b6f69f54beee2f994..7bfaadc0786b734db8973c53b82296a188d26e22 100644 --- a/server/src/html/garden/render.rs +++ b/server/src/html/garden/render.rs @@ -216,7 +216,7 @@ pub(super) async fn render_scope_view( @let item_url = item_href(r.item.as_str(), &nav); @let score_str = format!("{:.3}", r.score); li data-garden-item=(r.item.as_str()) { - (child_row_pin_or_vote(&nav, &r.item, pin_ref.as_ref(), scope_content)) + (child_row_pin_or_vote(&nav, &r.item, pin_ref.as_ref(), scope_content, &next_for_pin)) a class="item-link" href=(item_url) { code { (item_display_path(r.item.as_str())) } } span class="ont-rank-score" { (score_str) } } @@ -232,7 +232,7 @@ pub(super) async fn render_scope_view( ul class="ont-group-list" { @for name in &model.child_rankings.unranked_items { li data-garden-item=(name.as_str()) { - (child_row_pin_or_vote(&nav, name, pin_ref.as_ref(), scope_content)) + (child_row_pin_or_vote(&nav, name, pin_ref.as_ref(), scope_content, &next_for_pin)) @let href = item_href(name.as_str(), &nav); a class="item-link" href=(href) { code { (item_display_path(name.as_str())) } } } diff --git a/server/static/theme_default.css b/server/static/theme_default.css index 2dabf3a7094cecd89d0c9674d27efe30cd01c010..b846ab86cb6eb5fb56be87efb054fb8b18082583 100644 --- a/server/static/theme_default.css +++ b/server/static/theme_default.css @@ -891,8 +891,7 @@ button.ont-pin-btn-active { vertical-align: middle; } button.ont-garden-pin-ico, -a.ont-garden-vote-ico, -span.ont-garden-pinned-here { +a.ont-garden-vote-ico { font-size: 13px; line-height: 1; padding: 2px 6px; @@ -910,6 +909,11 @@ span.ont-garden-pinned-here { align-items: center; justify-content: center; } +form.ont-garden-pin-form { + display: inline; + margin: 0; + padding: 0; +} a.ont-garden-vote-ico { gap: 4px; } @@ -925,10 +929,14 @@ a.ont-garden-vote-ico:hover { span.ont-garden-vote-glyph { line-height: 1; } -span.ont-garden-pinned-here { +button.ont-garden-pin-ico-active { border-color: var(--link); color: var(--signal); - cursor: default; + background: color-mix(in srgb, var(--link) 12%, var(--g3)); +} +button.ont-garden-pin-ico-active:hover { + color: var(--signal); + background: color-mix(in srgb, var(--link) 18%, var(--g4)); } button.ont-garden-pin-ico:focus-visible { outline: 2px solid var(--link); diff --git a/server/static/theme_retro_craft.css b/server/static/theme_retro_craft.css index bdd9031b82154a5019782e6dcb8bf7589fafce09..5d4954812ad43f2ee7e63c71c7f0ae0b3e3fc95b 100644 --- a/server/static/theme_retro_craft.css +++ b/server/static/theme_retro_craft.css @@ -711,8 +711,7 @@ body.view-ontology span.ont-garden-vote-glyph { line-height: 1; } body.view-ontology button.ont-garden-pin-ico, -body.view-ontology a.ont-garden-vote-ico, -body.view-ontology span.ont-garden-pinned-here { +body.view-ontology a.ont-garden-vote-ico { font-size: 0.95rem; line-height: 1; padding: 0.1rem 0.35rem; @@ -732,10 +731,14 @@ body.view-ontology a.ont-garden-vote-ico:hover { border-color: #a68e6b; background: #ebe6dc; } -body.view-ontology span.ont-garden-pinned-here { +body.view-ontology button.ont-garden-pin-ico-active { border-color: #1a4a8c; background: color-mix(in srgb, #1a4a8c 10%, #f7f3eb); - cursor: default; + color: #0d2d5c; +} +body.view-ontology button.ont-garden-pin-ico-active:hover { + border-color: #a68e6b; + background: color-mix(in srgb, #1a4a8c 14%, #ebe6dc); } body.view-ontology form.ont-garden-pin-form { display: inline; diff --git a/test/browser_garden_pin.clj b/test/browser_garden_pin.clj index d4fa9ed60b45e872ec60e29307cfa61bcd9dd6b2..579976f4c2493a149f9eba081862ca07919f4fe9 100644 --- a/test/browser_garden_pin.clj +++ b/test/browser_garden_pin.clj @@ -58,10 +58,11 @@ (let [alice-token (oauth/fetch-bearer-token! base-url :username "alice") thread-tag "browser-garden-pin" raw (str "# " thread-tag "\n\n" - "~/gp-pin-a {alpha}\n" - "~/gp-pin-b {beta}\n" + "~/gp-parent {parent}\n" + "~/gp-parent/pin-a {alpha}\n" + "~/gp-parent/pin-b {beta}\n" "{pin test vote}\n" - "~/gp-pin-a 2:1 ~/gp-pin-b\n") + "~/gp-parent/pin-a 2:1 ~/gp-parent/pin-b\n") post-resp (oauth/http-post-json (str base-url "/api/v0/rpc") [{"Post" {"room" "public" @@ -77,23 +78,43 @@ (core/with-page [pg (core/new-page-from-context ctx)] (page/navigate pg (str base-url "/login")) (is (wait-for-text pg "body" "@alice" 15000) "alice session after login") - (page/navigate pg (str base-url "/~/gp-pin-a")) - (is (wait-for-text pg ".ont-item-shell" "~/gp-pin-a" 15000) "on item a page") + (page/navigate pg (str base-url "/~/gp-parent/pin-a")) + (is (wait-for-text pg ".ont-item-shell" "~/gp-parent/pin-a" 15000) "on item a page") ;; Native form POST /ui (data-navigate=full) β€” not fetch/eval (locator/click (page/locator pg ".ont-item-pin-zone form.ont-pin-form button[type=submit]")) - (is (wait-for-text pg "#slug-pin-hud" "gp-pin-a" 15000) + (is (wait-for-text pg "#slug-pin-hud" "gp-parent/pin-a" 15000) "HUD shows pinned item label after redirect") - (page/navigate pg (str base-url "/~/gp-pin-b")) - (is (wait-for-text pg ".ont-item-shell" "~/gp-pin-b" 15000) "on item b page") + (page/navigate pg (str base-url "/~/gp-parent/pin-b")) + (is (wait-for-text pg ".ont-item-shell" "~/gp-parent/pin-b" 15000) "on item b page") (is (wait-for-text pg "a.ont-vote-compare-btn" "vote" 10000) "vote link visible vs pinned item") - ;; HUD clears pin (POST set_garden_pin clear), not navigate to item + ;; Unpin from ranked child groups on parent page + (page/navigate pg (str base-url "/~/gp-parent")) + (is (wait-for-text pg ".ont-tab-panel-children" "ranked child groups" 15000) + "parent page shows ranked child groups") + (is (wait-for-text pg ".ont-ranking-list button.ont-garden-pin-ico-active" "πŸ“Œ" 10000) + "pinned row shows active pin in ranked list") + (locator/click (page/locator pg ".ont-ranking-list button.ont-garden-pin-ico-active")) + (is (wait-for-absence-substr pg "#slug-pin-hud" "gp-parent/pin-a" 15000) + "HUD clears after unpin from ranked child list") + (is (wait-for-absence-substr pg ".ont-ranking-list" "ont-garden-vote-ico" 10000) + "vote icons removed from ranked list after unpin") + (page/navigate pg (str base-url "/~/gp-parent/pin-b")) + (is (wait-for-text pg ".ont-item-shell" "~/gp-parent/pin-b" 15000) "on item b page again") + (is (wait-for-absence-substr pg "body" "ont-vote-compare-btn" 15000) + "compare vote CTA removed after ranked-list unpin") + ;; HUD unpin still works from item page context + (page/navigate pg (str base-url "/~/gp-parent/pin-a")) + (locator/click (page/locator pg ".ont-item-pin-zone form.ont-pin-form button[type=submit]")) + (is (wait-for-text pg "#slug-pin-hud" "gp-parent/pin-a" 15000) + "re-pin from item page for HUD unpin test") + (page/navigate pg (str base-url "/~/gp-parent/pin-b")) (locator/click (page/locator pg "#slug-pin-hud button.slug-pin-hud-unpin-btn")) - (is (wait-for-absence-substr pg "#slug-pin-hud" "gp-pin-a" 15000) + (is (wait-for-absence-substr pg "#slug-pin-hud" "gp-parent/pin-a" 15000) "HUD clears after unpin from HUD button") (is (wait-for-absence-substr pg "body" "ont-vote-compare-btn" 15000) "compare vote CTA removed after HUD unpin on same reload") - (is (str/includes? (or (page/url pg) "") "/~/gp-pin-b") + (is (str/includes? (or (page/url pg) "") "/~/gp-parent/pin-b") "still on item b after HUD unpin")))))) (finally Side B β€” contributor: tommy-mor Side B β€” commit message: [1c914c6e] stage set Side B β€” unified diff (full patch): diff --git a/plan.md b/plan.md new file mode 100644 index 0000000000000000000000000000000000000000..00d6867a1e0ed144a16a020ea037f685ce646c73 --- /dev/null +++ b/plan.md @@ -0,0 +1,155 @@ +# Plan: `ItemId` + `RouteContext` (identity vs hrefs) + +This document is for **the next agent** to continue the refactor without re-deriving context from chat. It supersedes ad-hoc notes: treat it as the checklist of record until the work lands and this file is deleted or trimmed. + +## Goal + +- **Identity** (what lives in the reducer graph, votes, indexes) becomes a **structural `ItemId` enum** in `slug-types`, not a canonical `String` / `CanonicalItemUrl` newtype. +- **Presentation** (tilde / dash display, breadcrumbs) derives from `ItemId` via explicit methods, not string stripping. +- **Routing** (browser `href`s for public vs room) goes through **`RouteContext`** (started in `server/src/html/routing.rs`) so Maud/handlers do not stitch `/r/…` vs `/~` ad hoc. + +**Non-goals for v1 of the migration:** backward-compatible JSONL or dual-read of old canonical strings in the event log (project has accepted breaking changes). If you reintroduce compat, document it here. + +## Current state (as of this plan) + +- **`CanonicalItemUrl`** (`types/src/paths.rs`): newtype around `String`; `parse` / `parent` / `display_path` / `tilde_tail` / etc. Reducer `ContentState`, `VoteData`, ranking, RPC, search, garden, breadcrumbs all use it or `String` keys derived from it. +- **`ThreadNav`** (`server/src/html/forum/nav.rs`): encodes scope prefixes for threads and garden URLs; **`RouteContext`** now wraps `ThreadNav` (`server/src/html/routing.rs`, re-exported from `server/src/html/mod.rs`) but **most HTML still takes `&ThreadNav` directly** β€” migration incomplete. +- **URL normalization** lives in `types/src/url_normalize.rs` + `canonicalize_item` / `finalize_external_identity_url` in `paths.rs` (YouTube, sorted query params, room path `room_route_segment` in `paths.rs`). +- **Room HTTP paths** are `/r/{short}{slug}` (fused segment); wire **`room_id`** remains `short/slug` for RPC/events. + +## Target architecture + +### `ItemId` (types) + +Suggested shape (adjust after profiling `Ord` / `Hash` / serde size): + +```text +ItemId::Root β€” tilde ontology root (today `SLUG_TILDE_ONTOLOGY_ROOT`) +ItemId::Local { segments } β€” slug.social ~/… path as Vec (lowercase segments, non-empty for non-root) +ItemId::External { url: Url } β€” normalized `url::Url` (crate `url` already in `slug-types`) +``` + +**API surface (minimum):** + +- `ItemId::parse(&str) -> Option` β€” single entry from DSL / user input / legacy wire (internally may call `canonicalize_item` + structured split). +- `ItemId::to_wire_url(&self) -> String` β€” only for **external** boundaries if needed (HTTP fetch, rare assertions); avoid using as the primary key once maps use `ItemId`. +- `parent`, `display_path`, `tilde_tail` / `tilde_http_tail`, `tilde_segments`, `last_segment`, `normalized_storage` β€” port from `CanonicalItemUrl`. +- **`Ord` + `Hash` + `Eq`** stable for `BTreeSet` / `HashMap` (see `write_actor` scope-rank snapshots). +- **`Serialize` / `Deserialize`** β€” decide **tagged JSON** for any persisted or API-carried structs (e.g. `VoteData` in tests). If RPC must stay stringy for clients, use a **DTO layer** that converts `ItemId` ↔ wire at the boundary only. + +**Remove:** `CanonicalItemUrl` type and all `path_types::CanonicalItemUrl` / `slug_types::paths::CanonicalItemUrl` exports once call sites are migrated. **`Borrow`** on the old newtype goes away; update `nav!` / any code that assumed map keys borrowed as `str`. + +### `RouteContext` (server HTML) + +- **File:** `server/src/html/routing.rs` β€” **`RouteContext(ThreadNav)`** with `item_href`, `item_href_raw`, `thread_url`, `garden_root_url`, `room_url`, `From`/`Into` `ThreadNav`. +- **Direction:** new code and refactored Maud should take **`&RouteContext`** (or owned where appropriate) instead of `&ThreadNav` when building links. Long term, **`item_href(&ItemId)`** should not parse strings β€” it should pattern-match `ItemId` and append tilde tail or `/-/…` external tail using the same rules as today’s `ThreadNav::garden_item_url`. + +### Axum / garden routes + +- **No** single catch-all route (explicit decision): keep the existing router layout in `server/src/lib.rs`. +- Room routes stay **`/r/:room_key/...`** with `room_key` fused; parsing via `slug_types::room_id_from_route_segment` / `room_route_segment` in `paths.rs`. + +## Phased execution (recommended order) + +### Phase 0 β€” Preconditions (quick) + +1. Read **`AGENTS.md`** (UI contract, durability matrix, `RpcCommand` vs `HtmlUiAction`). +2. Run **`cargo test --workspace`** and **`./scripts/clj-test.sh`** on clean `main` before large diffs; repeat after each phase. + +### Phase 1 β€” `ItemId` in `slug-types` (no server yet) + +1. Add **`ItemId`** (new file e.g. `types/src/item_id.rs` **or** inline at bottom of `paths.rs` β€” see **Module cycle** below). +2. Implement **`ItemId::parse`** using existing **`canonicalize_item`** + normalization; port **`CanonicalItemUrl`** methods to **`ItemId`** with tests ported from `paths.rs` `#[cfg(test)] mod tests`. +3. **`GardenItemUrl::from_stored(&ItemId, room_wire)`** (and thread helpers) β€” build absolute hrefs from structure, not from re-parsing a canonical string. +4. **`TildeHttpPathTail::to_item_id`** (rename from `to_canonical`) / **`tilde_http_path_to_item_id`**. +5. **`TildeOntologyPath::from_stored(&ItemId)`**. +6. Export **`ItemId`** from **`types/src/lib.rs`**; update **`server/src/path_types.rs`** re-exports. +7. **Delete `CanonicalItemUrl`** and fix all **in-crate** references in `types` only until `cargo test` passes for `slug-types`. + +**Module cycle trap:** `item_id.rs` must not `use crate::paths::{...}` if `paths.rs` also imports `ItemId` for `GardenItemUrl` in the same module. **Fix one of:** + +- **A)** Put `ItemId` **inside `paths.rs`** below `canonicalize_item` / helpers (simplest, large file), or +- **B)** Split **`canonicalize_item`** (+ dash host helpers + `finalize_external_identity_url`) into **`types/src/item_wire.rs`**, then `paths.rs` + `item_id.rs` both depend on `item_wire` only (cleaner, more files). + +### Phase 2 β€” Reducer + ranking (server core) + +1. **`server/src/reducer.rs`**: `ContentState` / `GroupState` / **`VoteData`** β€” replace **`CanonicalItemUrl`** with **`ItemId`** on all maps, sets, deques, vectors. +2. **`apply_vote`**: normalize `a`/`b` via **`ItemId::parse`** or **`ItemId`**-aware logic (remove string round-trip). +3. **`apply_ingest_to_content`**: **`dsl`** still yields strings for item titles in statements; normalize to **`ItemId`** at ingest boundary via **`ItemId::parse`** once per item. +4. **`server/src/ranking.rs`**, **`server/src/scope_rank.rs`**, **`server/src/api/write_actor.rs`** (including **`BTreeSet`** ordering), **`server/src/api/validate.rs`**, **`server/src/api/helpers.rs`** β€” propagate **`ItemId`**. +5. **`server/tests/basic.rs`** and any reducer tests constructing **`VoteData`** β€” use **`ItemId::parse(...).unwrap()`** or helpers. + +### Phase 3 β€” RPC + search + external resolver + +1. **`server/src/api/rpc.rs`**: rank/pair/matchup/search payloads; today many paths use **`GardenItemUrl::from_storage_str(item.as_str(), …)`** β€” switch to **`ItemId`** + **`GardenItemUrl::from_stored(&item_id, …)`** (or equivalent). +2. **`server/src/html/search.rs`**: scoring uses item path strings β€” derive from **`ItemId::display_path`** / **`to_wire_url`** only at the scoring boundary if needed. +3. **`server/src/external_resolver.rs`**: take **`&ItemId`** or **`ItemId::external_url()`** instead of **`&CanonicalItemUrl`**. + +### Phase 4 β€” HTML / Maud + +1. **`ThreadNav::garden_item_url`**: overload or replace with **`garden_item_href(&self, item: &ItemId)`** (no `CanonicalItemUrl::parse` inside). +2. **`RouteContext`**: extend **`item_href(&ItemId)`**; migrate call sites from **`ThreadNav`** to **`RouteContext`** where only link-building is needed (keep **`ThreadNav`** where scope / auth helpers need the full struct). +3. **`server/src/html/garden.rs`**, **`breadcrumb_path.rs`**, **`forum/*`**, **`editor.rs`**: replace **`CanonicalItemUrl`** with **`ItemId`**; breadcrumbs should walk **`ItemId::parent`** without string `rsplit`. +4. **`types` JSON types** (`RankRow`, etc.): decide whether **`GardenItemUrl`** stays string for JSON or becomes a structured field; keep **one** wire format for the public API. + +### Phase 5 β€” Cleanup + docs + +1. Remove dead **`canonical_path`** / **`breadcrumb_path`** string logic if fully superseded. +2. Update **`AGENTS.md`** if durability, `POST /ui`, or command surfaces change. +3. Delete or shrink **`plan.md`** when done. + +## File / symbol checklist (non-exhaustive β€” grep-driven) + +Run periodically: + +```bash +rg "CanonicalItemUrl" -g'*.rs' +rg "path_types::CanonicalItemUrl" -g'*.rs' +rg "tilde_http_path_to_canonical" -g'*.rs' +``` + +**High-touch files (from prior exploration):** + +| Area | Files | +|------|--------| +| Types | `types/src/paths.rs`, `types/src/lib.rs`, `types/src/url_normalize.rs`, (optional) `types/src/item_id.rs`, `types/src/item_wire.rs` | +| Server re-exports | `server/src/path_types.rs`, `server/src/canonical_path.rs` | +| Reducer / ingest | `server/src/reducer.rs`, `server/src/dsl.rs` (parse output types if changed) | +| Ranking | `server/src/ranking.rs`, `server/src/scope_rank.rs` | +| Writer / RPC | `server/src/api/write_actor.rs`, `server/src/api/rpc.rs`, `server/src/api/helpers.rs`, `server/src/api/validate.rs` | +| HTML | `server/src/html/garden.rs`, `server/src/html/breadcrumb_path.rs`, `server/src/html/forum/nav.rs`, `server/src/html/routing.rs`, `server/src/html/search.rs`, `server/src/html/editor.rs`, `server/src/html/forum/ingest.rs`, … | +| Tests | `server/tests/basic.rs`, `server/tests/integration.rs`, `types/src/paths.rs` tests, Clojure under `test/` if URLs/assertions mention canonical shapes | + +## Events / JSONL + +- **`Ingest`** events store **`raw` DSL** only β€” no change required for item identity inside the event. +- If any future event type stores item ids as strings, migrate to **structured `ItemId` serde** or accept string only at the event boundary with immediate parse into **`ItemId`** on `apply_event`. + +## `nav!` macro (`server/src/paths.rs`) + +- Macros use **`keypath($key)`** with **`.clone()`** β€” **`ItemId`** must be **`Clone`** (already for enums). Remove any reliance on **`Borrow`** for map keys. + +## Testing gate + +After each phase: + +```bash +cargo test --workspace +./scripts/clj-test.sh +``` + +## Risks / gotchas + +1. **`Ord` on `ItemId`**: must match prior **`CanonicalItemUrl`** / `String` ordering wherever **`BTreeSet`** is used (e.g. deterministic scope-rank snapshots in **`write_actor`**). +2. **External `ItemId`**: **`Url`** equality / hashing β€” normalization is already centralized in **`url_normalize`**; ensure **`ItemId::parse`** always inserts normalized **`Url`** into **`External`**. +3. **Fake parent URLs** in garden (e.g. **`https://.`** for external root ranking): find all **`parse("https://.")`** style hacks and express as **`ItemId`** or a dedicated sentinel. +4. **Serde**: tests and any RPC clients that snapshot JSON may need expectation updates if **`VoteData`** shape changes. + +## Optional follow-ups (not blocking `ItemId`) + +- More **domain normalizers** in **`url_normalize.rs`** (e.g. `music.youtube.com`, Spotify, etc.). +- **Room wire** vs **HTTP segment** helpers already in **`paths.rs`** (`ROOM_SHORT_ID_LEN`, `room_route_segment`, `room_id_from_route_segment`). + +--- + +**End state criteria:** `rg CanonicalItemUrl` returns nothing; reducer maps use **`ItemId`**; HTML link generation for items goes through **`RouteContext` + `ItemId`**; tests and Kaocha green. diff --git a/server/src/html/mod.rs b/server/src/html/mod.rs index c3dccd03dc6da2a2f6f6fa828657e33a951884b1..668403a35c415e6f091362b28c63ac294057fb6d 100644 --- a/server/src/html/mod.rs +++ b/server/src/html/mod.rs @@ -15,6 +15,7 @@ mod breadcrumb_path; mod editor; mod forum; mod garden; +pub mod routing; mod search; pub mod ui_action; use breadcrumb_path::{ExternalOntologyPath, OntologyPath}; @@ -35,6 +36,7 @@ pub use garden::{ external_garden_index, external_ontology_path, garden_index, ontology_path, room_external_garden_index, room_external_ontology_path, room_garden_index, room_ontology_path, }; +pub use routing::RouteContext; pub use search::{search_page, search_results_fragment}; pub use forum::user_profile_page; pub use ui_action::{parse_html_ui_from_form, HtmlUiAction, HtmlUiParseError, UI_RPC_FIELD}; diff --git a/server/src/html/routing.rs b/server/src/html/routing.rs new file mode 100644 index 0000000000000000000000000000000000000000..13e9ae0cbe32d454e34a7737edf8234d2a558502 --- /dev/null +++ b/server/src/html/routing.rs @@ -0,0 +1,71 @@ +//! Scoped browser paths for HTML. **RouteContext** is the intended single place to build `href`s +//! given public vs room scope (the original blueprint name); today it wraps [`ThreadNav`]. +//! +//! Prefer `RouteContext::item_href` / [`RouteContext::thread_url`] in new Maud over stitching +//! `/r/…` vs `/~` manually. Call sites can migrate incrementally from passing `&ThreadNav`. + +use crate::path_types::CanonicalItemUrl; + +use super::forum::ThreadNav; + +#[derive(Clone)] +pub struct RouteContext(ThreadNav); + +impl RouteContext { + #[inline] + pub fn public() -> Self { + Self(ThreadNav::public()) + } + + #[inline] + pub fn from_room_id(room_id: &str) -> Option { + ThreadNav::from_room_id(room_id).map(Self) + } + + #[inline] + pub fn thread_nav(&self) -> &ThreadNav { + &self.0 + } + + #[inline] + pub fn into_thread_nav(self) -> ThreadNav { + self.0 + } + + /// Relative path for a stored canonical item in this scope’s garden. + pub fn item_href(&self, item: &CanonicalItemUrl) -> String { + self.0.garden_item_url(item.as_str()) + } + + /// Same as [`Self::item_href`] but parses `item` first (raw DSL / user paste). + pub fn item_href_raw(&self, item: &str) -> String { + self.0.garden_item_url(item) + } + + #[inline] + pub fn thread_url(&self, tag: &str) -> String { + self.0.thread_url(tag) + } + + #[inline] + pub fn garden_root_url(&self) -> &str { + self.0.garden_root_url() + } + + #[inline] + pub fn room_url(&self) -> &str { + self.0.room_url() + } +} + +impl From for RouteContext { + fn from(nav: ThreadNav) -> Self { + Self(nav) + } +} + +impl From for ThreadNav { + fn from(ctx: RouteContext) -> Self { + ctx.0 + } +}