studio-engine 0.58.1 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 349b589e663f401c61c9d310aaf72e9f86dc63c5dc77cb8ef90ff36904d3ea94
-  data.tar.gz: 614fb35d60924ca44cb8c8f89b0acf48b821f3a325728048c3cc141983976155
+  metadata.gz: 47709f3ad708764cdbf14ab7bb8f82d3698180f201a123e7ec097363ec5f260b
+  data.tar.gz: 1fc08166c64c745d19c2bf9c640aac8ecac5726902fa4157a136fd8ddb0ed821
 SHA512:
-  metadata.gz: e95e3ead35e2e1e91b22660e8fb4b1beb4509681129c56358c74e20bf8d460bb39f1edbca7ce787789ef7f38d8cf8ecfebc9372e4e417f749a38ea806bf1b279
-  data.tar.gz: d8eb124ab7bdba7b5fbeb6f2b90c56f6528c6e65be7db24768a3f709daf300d8574124837936ac65269722252bf97e40ab5e34f57a9cb06eace380d3ace1b0d2
+  metadata.gz: 300e04e693d5cba7a50d38abd445f71163e3e24b35f693f498e5a167442b389a624fcd3a618231701cd4d116b9a248dd8e1b3279b5ea5fce6d688a3fb8b083ec
+  data.tar.gz: c93897b51c64938d0446f73038c0273a815fb761a357c53b54d615e7e11ae3eb0ca4138a8ea918b3fd05fe4053ac58c64445e4cc2fdc0aa5dc154b7828768a2d

data/CHANGELOG.md

@@ -188,6 +188,49 @@ The format is [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). This pro
 
 ### Fixed
 
+- **The Geo signpost now reaches every app whose admin chrome the engine owns.**
+  The row added last release went into `components/_admin_dropdown` alone, on the
+  premise that the shared dropdown reaches every app from one change. It does
+  not, and counted against the apps that actually consume this engine it reached
+  **none of them**. Wherever a host declares an admin-flagged sidebar section,
+  `studio_sidebar_replaces_admin_menu?` SUPPRESSES the dropdown and the link
+  sidebar is the admin menu — that is both `mcritchie-studio` and
+  `mcritchie-industries`. An app that forks its navbar outright renders neither,
+  which is `turf-monster`. Nobody was left on the plain engine navbar to see it,
+  so the app carrying the largest admin surface in the ecosystem was among those
+  guaranteed never to.
+
+  The row moved into its own partial, **`components/_geo_signpost`**, and BOTH
+  engine chromes render it — the dropdown as before, and
+  `components/_link_sidebar` under its own admin-chipped `Geo` heading. Nothing
+  to configure: a host on either chrome gets the signage from the version bump.
+
+  **Exactly one of them, never both.** The sidebar carries the row only where it
+  IS the admin menu (the host declared an admin-flagged section, so the dropdown
+  is suppressed). A host declaring only public sections renders BOTH chromes by
+  design, and there the dropdown keeps the row — fixing a reach gap by showing
+  an admin the same row twice is not a fix.
+
+  **A forked chrome still needs one line**, because the engine cannot reach a
+  fork by rendering. Inside your own admin block:
+
+  ```erb
+  <%= render "components/geo_signpost",
+        variant: :sidebar, close_action: "$store.sidebars.gearOpen = false" %>
+  ```
+
+  `variant:` picks the chrome's row shape (`:dropdown`, the default, or
+  `:sidebar`); `close_action:` is the Alpine expression that closes YOUR panel
+  behind the row — the store flag belongs to the caller, so the partial never
+  hardcodes one. See [`docs/GEO.md`](docs/GEO.md#finding-the-page--the-signpost-in-whichever-chrome-the-app-has).
+
+  Behavior is otherwise unchanged: same three states, same words, same
+  self-gating on `admin?`, and `ENABLE_GEO_BLOCKING` still governs the LINK and
+  never the gate. One test hook was renamed — `data-test="geo-signpost-disabled"`,
+  was `admin-dropdown-geo-disabled` — since the row renders in two chromes now
+  and a name claiming one of them was a lie. Grepped ecosystem-wide first: it
+  appeared in no consumer.
+
 - **`.conic-surface` keeps its wash inside its own box.** The wash was an
   OVERSIZED pseudo (`inset: -50%`) spun by a `transform` keyframe, cut back to
   the element by the host's `overflow: hidden`. That clip is not dependable: the

data/app/views/components/_admin_dropdown.html.erb

@@ -13,29 +13,10 @@
   <div x-show="open" x-cloak @click.outside="open = false" x-transition:enter="transition ease-out duration-100" x-transition:enter-start="opacity-0 scale-95" x-transition:enter-end="opacity-100 scale-100" x-transition:leave="transition ease-in duration-75" x-transition:leave-start="opacity-100 scale-100" x-transition:leave-end="opacity-0 scale-95" class="absolute right-0 mt-2 w-44 bg-surface border border-subtle rounded-lg shadow-lg z-50 py-1">
     <a href="/admin/theme" class="block px-4 py-2 text-sm text-body hover:text-heading hover:bg-surface-alt transition">Theme</a>
     <a href="/admin/navbar" class="block px-4 py-2 text-sm text-body hover:text-heading hover:bg-surface-alt transition">Navbar</a>
-    <%# GEO — shown in every app, LIVE only where it can actually be used.
-        A disabled row rather than a hidden one is the whole point: an app that has
-        not turned geo on still learns the feature exists and what to set, instead
-        of it being invisible until someone reads the gem's docs.
-
-        Two prerequisites, and the row says WHICH is missing, because they are
-        fixed in different places — an env var on the dyno, a line in the app's
-        initializer. The route check is not decoration: where draw_geo_routes is
-        false, `admin_geo_path` does not exist and calling it RAISES, so the
-        disabled branch must never reach for the helper. %>
-    <% geo_routes = respond_to?(:admin_geo_path) %>
-    <% if Studio.geo_blocking_enabled? && geo_routes %>
-      <a href="<%= admin_geo_path %>" class="block px-4 py-2 text-sm text-body hover:text-heading hover:bg-surface-alt transition">Geo</a>
-    <% else %>
-      <span class="block px-4 py-2 text-sm text-muted cursor-not-allowed select-none"
-            data-test="admin-dropdown-geo-disabled"
-            title="<%= geo_routes ? "Set ENABLE_GEO_BLOCKING=true to manage geo blocking" : "Set config.draw_geo_routes = true in config/initializers/studio.rb, then ENABLE_GEO_BLOCKING=true" %>">
-        Geo
-        <span class="block text-xs text-muted">
-          <%= geo_routes ? "Set ENABLE_GEO_BLOCKING=true" : "Draw the geo routes first" %>
-        </span>
-      </span>
-    <% end %>
+    <%# GEO — the signpost lives in components/_geo_signpost, because this
+        dropdown is only ONE of the engine's two admin chromes and an app on the
+        other one never renders this file. Same row, same policy, both chromes. %>
+    <%= render "components/geo_signpost" %>
     <a href="/error_logs" class="block px-4 py-2 text-sm text-body hover:text-heading hover:bg-surface-alt transition">Error Logs</a>
   </div>
 </div>

data/app/views/components/_geo_signpost.html.erb

@@ -0,0 +1,92 @@
+<%# THE GEO SIGNPOST — one row, rendered into whichever admin chrome the app has.
+
+    WHY IT IS ITS OWN PARTIAL, and not a block inside the dropdown. 0.58.0 put
+    this row in components/_admin_dropdown on the premise that the shared
+    dropdown reaches every app "from one change". It does not. Counted against
+    the apps that actually consume this engine, the row reached NONE of them:
+
+      * an app whose admin menu is the LINK SIDEBAR never renders the dropdown —
+        studio_sidebar_replaces_admin_menu? suppresses it so the two cog glyphs
+        do not read as a double gear. Both mcritchie-studio and
+        mcritchie-industries declare an admin-flagged section, so both are that;
+      * an app that forks the navbar outright renders neither — turf-monster
+        forks _user_nav and _navbar and owns components/_gear_sidebar;
+      * nobody was left on the plain engine navbar to see it.
+
+    So the policy below now has ONE home, and BOTH engine-owned chromes render
+    it: components/_admin_dropdown and components/_link_sidebar. A host that
+    forks its chrome adopts it in one line, inside its own admin block — an ERB
+    render tag around:
+
+      render "components/geo_signpost",
+             variant: :sidebar, close_action: "$store.sidebars.gearOpen = false"
+
+    Locals:
+      variant      — :dropdown (default), the gear dropdown's narrow rows;
+                     :sidebar, the link sidebar's wide emoji rows.
+      close_action — optional Alpine expression run on click, so the panel the
+                     row lives in closes behind it. The flag is the CALLER's
+                     (linkTreeOpen here, gearOpen in a forked chrome), which is
+                     exactly why this partial must not hardcode one.
+
+    ADMIN CHROME, self-gated. The gate lives HERE rather than in each caller so
+    no caller can forget it: the dropdown shipped without one once and offered
+    /admin/theme and /error_logs to signed-out strangers on a public page.
+%>
+<% if respond_to?(:admin?) && admin? %>
+  <%# The two prerequisites, resolved ONCE and shared by both variants — the
+      point of a single partial is that the two chromes cannot drift into
+      disagreeing about whether geo is reachable.
+
+      The route check is not decoration: where draw_geo_routes is false,
+      `admin_geo_path` is not defined at all, so the disabled branch must never
+      reach for it. A NoMethodError here takes down admin chrome on EVERY page.
+
+      They are named separately because they are FIXED in different places — an
+      env var on the dyno, a line in the app's initializer — so the row says
+      which one is missing rather than a vague "unavailable". %>
+  <% geo_routes = respond_to?(:admin_geo_path) %>
+  <% geo_live   = Studio.geo_blocking_enabled? && geo_routes %>
+  <% geo_hint   = geo_routes ? "Set ENABLE_GEO_BLOCKING=true" : "Draw the geo routes first" %>
+  <% geo_title  = geo_routes ? "Set ENABLE_GEO_BLOCKING=true to manage geo blocking" : "Set config.draw_geo_routes = true in config/initializers/studio.rb, then ENABLE_GEO_BLOCKING=true" %>
+  <% geo_close  = local_assigns[:close_action].presence %>
+
+  <% if local_assigns.fetch(:variant, :dropdown).to_sym == :sidebar %>
+    <%# Sidebar variant: the wide emoji row the link sidebar's own sections use,
+        so an engine-owned row is indistinguishable from a host-declared one. %>
+    <% if geo_live %>
+      <%= link_to admin_geo_path,
+            class: "group flex items-start gap-3 px-4 py-3 text-sm text-body hover:text-heading hover:bg-surface-alt focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-primary/40 focus-visible:ring-inset transition",
+            "@click": geo_close do %>
+        <span class="text-lg leading-none flex-shrink-0">🌍</span>
+        <span class="min-w-0">
+          <span class="block font-medium truncate">Geo</span>
+          <span class="block text-xs text-muted leading-snug mt-0.5">Country and subdivision blocking</span>
+        </span>
+      <% end %>
+    <% else %>
+      <span class="flex items-start gap-3 px-4 py-3 text-sm text-muted cursor-not-allowed select-none"
+            data-test="geo-signpost-disabled"
+            title="<%= geo_title %>">
+        <span class="text-lg leading-none flex-shrink-0">🌍</span>
+        <span class="min-w-0">
+          <span class="block font-medium truncate">Geo</span>
+          <span class="block text-xs text-muted leading-snug mt-0.5"><%= geo_hint %></span>
+        </span>
+      </span>
+    <% end %>
+  <% else %>
+    <%# Dropdown variant: the narrow row that shipped in 0.58.0, unchanged apart
+        from the test hook, which no longer names one chrome. %>
+    <% if geo_live %>
+      <a href="<%= admin_geo_path %>" class="block px-4 py-2 text-sm text-body hover:text-heading hover:bg-surface-alt transition">Geo</a>
+    <% else %>
+      <span class="block px-4 py-2 text-sm text-muted cursor-not-allowed select-none"
+            data-test="geo-signpost-disabled"
+            title="<%= geo_title %>">
+        Geo
+        <span class="block text-xs text-muted"><%= geo_hint %></span>
+      </span>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/components/_link_sidebar.html.erb

@@ -136,6 +136,47 @@
         <% end %>
       <% end %>
     <% end %>
+
+    <%# THE GEO SIGNPOST — how a sidebar-chrome app gets geo signage at all.
+
+        This panel IS the admin menu wherever the host declares an admin-flagged
+        section (studio_sidebar_replaces_admin_menu?), and in exactly that case
+        the engine suppresses components/_admin_dropdown — so before this block
+        every app on this chrome was guaranteed NEVER to see the row the 0.58.0
+        signpost added, including the one carrying the largest admin surface in
+        the ecosystem. mcritchie-studio is that one:
+        app/views/layouts/application.html.erb renders this partial, and
+        app/helpers/link_tree_helper.rb stamps `admin: true` on every admin
+        section it declares. mcritchie-industries is the other.
+
+        Engine-owned rather than host-declared on purpose. Appending it to
+        Studio.sidebar_sections instead would make studio_sidebar? and
+        studio_sidebar_replaces_admin_menu? true for apps that declare NO
+        sections — raising a sidebar where none existed and taking Theme,
+        Navbar and Error Logs away from apps that rely on the dropdown.
+
+        EXACTLY ONE HOME PER APP, which is what the second half of the gate
+        buys. A host that declares only PUBLIC sections keeps the dropdown —
+        the engine navbar renders BOTH chromes for that shape, deliberately, so
+        its admins never lose Theme, Navbar and Error Logs. Signposting geo here
+        as well would show such an admin the same row twice, in two menus open
+        at the same time. So the row goes wherever the admin menu IS: the
+        dropdown for that shape, this panel for the shape that suppresses the
+        dropdown.
+
+        The predicate is `studio_sidebar_replaces_admin_menu?` (see
+        StudioSidebarHelper), computed here from the sections already in hand
+        rather than called: this partial renders in hosts and test rigs that
+        provide studio_sidebar_sections without the rest of the helper, and a
+        bare call would raise for them. The two must stay the same question —
+        if the helper's rule changes, this changes with it. %>
+    <% if sidebar_admin && sections.any? { |section| section[:admin] } %>
+      <div class="px-4 pt-4 pb-1 label-upper font-bold text-muted flex items-center gap-2">
+        <span>Geo</span>
+        <span class="rounded border border-primary/20 bg-primary/10 px-1.5 py-0.5 text-[10px] font-mono text-primary">ADMIN</span>
+      </div>
+      <%= render "components/geo_signpost", variant: :sidebar, close_action: close_action %>
+    <% end %>
   </nav>
 <% end %>
 

data/lib/studio/version.rb

@@ -1,3 +1,3 @@
 module Studio
-  VERSION = "0.58.1"
+  VERSION = "0.59.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: studio-engine
 version: !ruby/object:Gem::Version
-  version: 0.58.1
+  version: 0.59.0
 platform: ruby
 authors:
 - Alex McRitchie
@@ -378,6 +378,7 @@ files:
 - app/views/components/_emoji_swap.html.erb
 - app/views/components/_empty_state.html.erb
 - app/views/components/_geo_badge.html.erb
+- app/views/components/_geo_signpost.html.erb
 - app/views/components/_google_logo.html.erb
 - app/views/components/_input.html.erb
 - app/views/components/_json_debug.html.erb