keystone_ui-pages 0.1.0 → 0.2.0

data/app/controllers/keystone_ui/pages/manage/access_exceptions_controller.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module KeystoneUi
+  module Pages
+    module Manage
+      class AccessExceptionsController < BaseController
+        include EditsPages
+
+        def update
+          if page.update(access_exception: params[:access_exception].presence)
+            shown
+          else
+            render json: { error: page.errors.full_messages.to_sentence }, status: :unprocessable_entity
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/keystone_ui/pages/manage/pages_controller.rb

@@ -7,7 +7,8 @@ module KeystoneUi
     module Manage
       class PagesController < BaseController
         def index
-          @pages = owned_pages.order(:name)
+          @archived = params[:archived].present?
+          @pages = owned_pages.public_send(@archived ? :archived : :current).order(:name)
           @printable = Printer.chrome.present?
         end
 
@@ -15,7 +16,7 @@ module KeystoneUi
         end
 
         def create
-          page = Page.create!(params.require(:page).permit(:name, :slug).merge(owner: page_owner))
+          page = Page.create!(params.require(:page).permit(:name, :slug, :place).merge(owner: page_owner))
           redirect_to manage_page_path(page)
         end
 
@@ -30,6 +31,22 @@ module KeystoneUi
           redirect_to manage_page_path(page)
         end
 
+        def unpublish
+          page = owned_pages.find(params[:id])
+          page.unpublish
+          redirect_to manage_page_path(page)
+        end
+
+        def archive
+          owned_pages.find(params[:id]).archive
+          redirect_to manage_pages_path
+        end
+
+        def restore
+          owned_pages.find(params[:id]).restore
+          redirect_to manage_pages_path
+        end
+
         private
 
         def local_address?(address)

data/app/controllers/keystone_ui/pages/pages_controller.rb

@@ -11,11 +11,17 @@ module KeystoneUi
       def show
         page = owned_pages.find_by(slug: params[:slug])
         @version = page&.live_version
-        refuse if @version.nil? || !viewable?(page)
+        return refuse if @version.nil? || !viewable?(page)
+
+        @values = visitor_values(page)
       end
 
       private
 
+      def visitor_values(page)
+        send(KeystoneUi::Pages.values_method, page) if KeystoneUi::Pages.values_method
+      end
+
       def viewable?(page)
         return true unless KeystoneUi::Pages.view_check_method
 

data/app/helpers/keystone_ui/pages/editor_helper.rb

@@ -23,6 +23,9 @@ module KeystoneUi
           samples: Values.samples_for(page),
           sample: chosen_sample(page),
           samples_url: manage_page_sample_path(page),
+          access_exceptions: KeystoneUi::Pages.access_exceptions.invert.to_a,
+          access_exception: page.access_exception,
+          access_exception_url: manage_page_access_exception_path(page),
           history_url: manage_page_versions_path(page),
           undo_url: manage_page_undo_path(page),
           redo_url: manage_page_redo_path(page),

data/app/javascript/keystone_ui_pages/AccessExceptionChoice.jsx

@@ -0,0 +1,16 @@
+import React from "react"
+import Select from "keystone_ui-react/src/Select.jsx"
+
+export default function AccessExceptionChoice({ exceptions, chosen, onChoose }) {
+  if (exceptions.length === 0) return null
+
+  return (
+    <label className="flex items-center gap-2 text-sm">
+      <span className="whitespace-nowrap">Access exception</span>
+      <Select defaultValue={chosen ?? ""} onChange={(event) => onChoose(event.target.value)} className="py-1">
+        <option value="">None</option>
+        {exceptions.map(([label, value]) => <option key={value} value={value}>{label}</option>)}
+      </Select>
+    </label>
+  )
+}

data/app/javascript/keystone_ui_pages/PageEditor.jsx

@@ -2,13 +2,14 @@ import React, { useEffect, useLayoutEffect, useRef, useState } from "react"
 import { DragDropManager, Draggable, Droppable, KeyboardSensor, PointerSensor } from "@dnd-kit/dom"
 import { Sortable } from "@dnd-kit/dom/sortable"
 import Button from "keystone_ui-react/src/Button.jsx"
-import { addColumn, addElement, addRow, addSection, arrange, bindField, chooseSample, duplicateNode, moveNode, removeNode, setField, showWhen, stepHistory } from "./operations"
+import { addColumn, addElement, addRow, addSection, arrange, bindField, chooseAccessException, chooseSample, duplicateNode, moveNode, removeNode, setField, showWhen, stepHistory } from "./operations"
 import LayoutPanel from "./LayoutPanel"
 import DeviceWidth, { DEVICES } from "./DeviceWidth"
 import SelectionToolbar from "./SelectionToolbar"
 import ElementPalette from "./ElementPalette"
 import SelectionPath from "./SelectionPath"
 import SampleChoice from "./SampleChoice"
+import AccessExceptionChoice from "./AccessExceptionChoice"
 import ShowWhen from "./ShowWhen"
 import ThemeMode from "./ThemeMode"
 import LookChoice from "./LookChoice"
@@ -28,7 +29,7 @@ const innermost = (target) => NODES.map(([selector, kind]) => [target.closest(se
 
 const PLACED_SENSORS = [PointerSensor.configure({ preventActivation: () => false }), KeyboardSensor]
 
-export default function PageEditor({ name, publish_url, elements, canvas: drawn, document: saved, elements_url, sections_url, columns_url, rows_url, nodes_url, arrangements, defaults, shares, value_names, looks = [], samples = [], sample, samples_url, history_url, live_url, back_url, undo_url, redo_url, undoable: couldUndo, redoable: couldRedo, token }) {
+export default function PageEditor({ name, publish_url, unpublish_url, elements, canvas: drawn, document: saved, elements_url, sections_url, columns_url, rows_url, nodes_url, arrangements, defaults, shares, value_names, looks = [], samples = [], sample, samples_url, access_exceptions = [], access_exception, access_exception_url, history_url, live_url, back_url, undo_url, redo_url, undoable: couldUndo, redoable: couldRedo, token }) {
   const [canvas, setCanvas] = useState(drawn)
   const [undoable, setUndoable] = useState(couldUndo)
   const [redoable, setRedoable] = useState(couldRedo)
@@ -210,12 +211,19 @@ export default function PageEditor({ name, publish_url, elements, canvas: drawn,
           <ThemeMode />
           <LookChoice looks={looks} />
           <SampleChoice samples={samples} chosen={sample} onChoose={(choice) => chooseSample(samples_url, token, choice).then(shown, refused)} />
+          <AccessExceptionChoice exceptions={access_exceptions} chosen={access_exception} onChoose={(choice) => chooseAccessException(access_exception_url, token, choice).then(shown, refused)} />
         </div>
         <div className="flex items-center gap-2">
         <Button type="button" size="sm" variant="secondary" disabled={!undoable} title={undoable ? "Undo the last change" : "Nothing to undo"} onClick={() => stepHistory(undo_url, token).then(shown, refused)}>↶ Undo</Button>
         <Button type="button" size="sm" variant="secondary" disabled={!redoable} title={redoable ? "Redo the change you undid" : "Nothing to redo"} onClick={() => stepHistory(redo_url, token).then(shown, refused)}>↷ Redo</Button>
         {live_url && <a href={live_url} className="text-sm whitespace-nowrap hover:underline">View live</a>}
         <a href={history_url} className="text-sm hover:underline">History</a>
+        {unpublish_url && (
+          <form method="post" action={unpublish_url}>
+            <input type="hidden" name="authenticity_token" value={token} />
+            <Button type="submit" size="sm" variant="secondary">Unpublish</Button>
+          </form>
+        )}
         <form method="post" action={publish_url}>
           <input type="hidden" name="authenticity_token" value={token} />
           <Button type="submit" size="sm">Publish</Button>

data/app/javascript/keystone_ui_pages/operations.js

@@ -27,6 +27,8 @@ export const bindField = (url, token, elementId, field, name, fallback) => sent(
 
 export const chooseSample = (url, token, choice) => sent(url, token, "POST", { choice })
 
+export const chooseAccessException = (url, token, accessException) => sent(url, token, "POST", { access_exception: accessException })
+
 export const showWhen = (url, token, nodeId, name, equals) => sent(`${url}/${nodeId}/condition`, token, "POST", { name, equals })
 
 export const stepHistory = (url, token) => sent(url, token, "POST")

data/app/models/keystone_ui/pages/page.rb

@@ -14,9 +14,16 @@ module KeystoneUi
       attribute :undo_history, :json, default: -> { [] }
       attribute :undone_changes, :json, default: -> { [] }
 
+      scope :archived, -> { where.not(archived_at: nil) }
+      scope :current, -> { where(archived_at: nil) }
+
       validates :name, :slug, presence: true
+      validates :place, inclusion: { in: -> { KeystoneUi::Pages.places.keys } }, allow_nil: true, if: -> { KeystoneUi::Pages.places.any? }
+      validates :access_exception, inclusion: { in: -> { KeystoneUi::Pages.access_exceptions.keys } }, allow_nil: true, if: -> { KeystoneUi::Pages.access_exceptions.any? }
 
       def publish
+        return if archived_at
+
         transaction do
           live_version&.update!(status: :superseded)
           versions.create!(number: next_number, document: document, status: :live)
@@ -43,6 +50,29 @@ module KeystoneUi
         update!(document: undone_changes.last, undone_changes: undone_changes[0...-1], undo_history: undo_history + [ document ])
       end
 
+      def unpublish
+        live_version&.update!(status: :superseded)
+      end
+
+      def archive
+        transaction do
+          unpublish
+          update!(archived_at: Time.current)
+        end
+      end
+
+      def restore
+        update!(archived_at: nil)
+      end
+
+      def state
+        return :archived if archived_at
+        return :published if live_version
+        return :unpublished if versions.exists?
+
+        :draft
+      end
+
       def live_version
         versions.find_by(status: :live)
       end

data/app/views/keystone_ui/pages/manage/pages/index.html.erb

@@ -1,5 +1,11 @@
 <%= ui_page(max_width: :xl) do %>
-  <%= ui_page_header(title: "Pages") %>
+  <%= ui_page_header(title: @archived ? "Archived pages" : "Pages", action_url: (new_manage_page_path unless @archived), action_label: "Create") do |header| %>
+    <% header.action { ui_button(label: "Create", href: new_manage_page_path) } unless @archived %>
+  <% end %>
+
+  <p class="mb-4 text-sm">
+    <%= @archived ? link_to("Show current pages", manage_pages_path) : link_to("Show archived", manage_pages_path(archived: 1)) %>
+  </p>
 
   <div class="ks-table overflow-x-auto">
     <table class="relative min-w-full divide-y divide-gray-300 dark:divide-white/15">
@@ -8,6 +14,12 @@
           <th class="ks-table-header ks-table-header-first text-left text-sm">Name</th>
           <th class="ks-table-header ks-table-header-middle text-left text-sm">Status</th>
           <th class="ks-table-header ks-table-header-middle text-left text-sm">Last published</th>
+          <% if KeystoneUi::Pages.places.any? %>
+            <th class="ks-table-header ks-table-header-middle text-left text-sm">Place</th>
+          <% end %>
+          <% if KeystoneUi::Pages.access_exceptions.any? %>
+            <th class="ks-table-header ks-table-header-middle text-left text-sm">Access exception</th>
+          <% end %>
           <th class="ks-table-header ks-table-header-last text-right text-sm"><span class="sr-only">Open</span></th>
         </tr>
       </thead>
@@ -16,8 +28,14 @@
           <% live = page.live_version %>
           <tr data-page="<%= page.slug %>">
             <td class="ks-table-cell-first text-sm whitespace-nowrap"><%= page.name %></td>
-            <td class="ks-table-cell-middle text-sm whitespace-nowrap"><%= ui_badge(label: live ? "Published" : "Draft", variant: live ? :success : :neutral) %></td>
+            <td class="ks-table-cell-middle text-sm whitespace-nowrap"><%= ui_badge(label: page.state.to_s.capitalize, variant: live ? :success : :neutral) %></td>
             <td class="ks-table-cell-middle text-sm whitespace-nowrap"><%= live&.created_at&.to_date&.to_fs(:long) %></td>
+            <% if KeystoneUi::Pages.places.any? %>
+              <td data-access class="ks-table-cell-middle text-sm whitespace-nowrap"><%= KeystoneUi::Pages.places[page.place] %></td>
+            <% end %>
+            <% if KeystoneUi::Pages.access_exceptions.any? %>
+              <td data-access class="ks-table-cell-middle text-sm whitespace-nowrap"><%= KeystoneUi::Pages.access_exceptions[page.access_exception] %></td>
+            <% end %>
             <td class="ks-table-cell-middle text-sm whitespace-nowrap text-right">
               <%= link_to "Edit", manage_page_path(page) %>
               <% if live %>
@@ -26,6 +44,17 @@
                   <%= link_to "PDF", manage_page_pdf_path(page), class: "ml-4" %>
                 <% end %>
               <% end %>
+              <div class="ml-4 inline-block">
+                <% if page.archived_at %>
+                  <%= ui_form(action: restore_manage_page_path(page), method: :post) do %>
+                    <%= ui_button(label: "Restore", type: :submit, variant: :secondary, size: :sm) %>
+                  <% end %>
+                <% else %>
+                  <%= ui_form(action: archive_manage_page_path(page), method: :post) do %>
+                    <%= ui_button(label: "Archive", type: :submit, variant: :secondary, size: :sm) %>
+                  <% end %>
+                <% end %>
+              </div>
             </td>
           </tr>
         <% end %>

data/app/views/keystone_ui/pages/manage/pages/new.html.erb

@@ -8,6 +8,11 @@
     <label class="ks-label mb-1">Address</label>
     <%= ui_input(name: "page[slug]", placeholder: "e.g. pricing") %>
 
+    <% if KeystoneUi::Pages.places.any? %>
+      <label class="ks-label mb-1">Place</label>
+      <%= ui_select(name: "page[place]", options: KeystoneUi::Pages.places.invert.to_a) %>
+    <% end %>
+
     <%= ui_button(label: "Create", type: :submit) %>
   <% end %>
 <% end %>

data/app/views/keystone_ui/pages/manage/pages/show.html.erb

@@ -4,5 +4,5 @@
 <% end %>
 
 <div data-page-builder>
-  <%= react_ui("keystone_ui_pages/editor", editor_props(@page).merge(name: @page.name, publish_url: publish_manage_page_path(@page))) %>
+  <%= react_ui("keystone_ui_pages/editor", editor_props(@page).merge(name: @page.name, publish_url: publish_manage_page_path(@page), unpublish_url: (unpublish_manage_page_path(@page) if @page.live_version))) %>
 </div>

data/config/routes.rb

@@ -4,6 +4,9 @@ KeystoneUi::Pages::Engine.routes.draw do
   namespace :manage do
     resources :pages, only: %i[index new create show] do
       post :publish, on: :member
+      post :unpublish, on: :member
+      post :archive, on: :member
+      post :restore, on: :member
       resources :elements, only: %i[create update] do
         post :bind, on: :member
       end
@@ -17,6 +20,7 @@ KeystoneUi::Pages::Engine.routes.draw do
       end
       resource :document, only: %i[update]
       post :sample, to: "samples#update"
+      post :access_exception, to: "access_exceptions#update"
       post :undo, to: "edit_history#undo"
       post :redo, to: "edit_history#redo"
       resource :live, only: %i[show]

data/db/migrate/20261019120000_add_access_to_keystone_ui_pages_pages.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddAccessToKeystoneUiPagesPages < ActiveRecord::Migration[7.1]
+  def change
+    add_column :keystone_ui_pages_pages, :place, :string
+    add_column :keystone_ui_pages_pages, :access_exception, :string
+  end
+end

data/db/migrate/20261019130000_add_archived_at_to_keystone_ui_pages_pages.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddArchivedAtToKeystoneUiPagesPages < ActiveRecord::Migration[7.1]
+  def change
+    add_column :keystone_ui_pages_pages, :archived_at, :datetime
+  end
+end

data/lib/keystone_ui/pages/engine.rb

@@ -10,7 +10,7 @@ module KeystoneUi
     class Engine < ::Rails::Engine
       isolate_namespace KeystoneUi::Pages
 
-      initializer "keystone_ui_pages.host_helper" do
+      config.to_prepare do
         ActiveSupport.on_load(:action_view) { include KeystoneUi::Pages::HostHelper }
       end
 

data/lib/keystone_ui/pages/version.rb

@@ -2,6 +2,6 @@
 
 module KeystoneUi
   module Pages
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/keystone_ui/pages.rb

@@ -9,8 +9,8 @@ require "keystone_ui/pages/engine"
 module KeystoneUi
   module Pages
     class << self
-      attr_writer :base_controller, :layout, :editor_layout, :pdf_stylesheet
-      attr_accessor :edit_check_method, :view_check_method, :owner_method, :refusal_method, :chrome_path
+      attr_writer :base_controller, :layout, :editor_layout, :pdf_stylesheet, :places, :access_exceptions
+      attr_accessor :edit_check_method, :view_check_method, :values_method, :owner_method, :refusal_method, :chrome_path
 
       def base_controller
         @base_controller || "ActionController::Base"
@@ -27,6 +27,14 @@ module KeystoneUi
       def pdf_stylesheet
         @pdf_stylesheet || "tailwind.css"
       end
+
+      def places
+        @places || {}
+      end
+
+      def access_exceptions
+        @access_exceptions || {}
+      end
     end
 
     def self.pdf(page, values: {})

data/the_local/agents/keystone_ui-pages-develop.md

@@ -46,14 +46,32 @@ inherit from the base controller, so define it there.
 - `KeystoneUi::Pages.view_check_method = :may_view_page?` — a method taking the
   page and returning true when the current visitor may see the published page
   at `/pages/:slug`. Unset, every published page is shown.
+- `KeystoneUi::Pages.places = { "marketing" => "Marketing site" }` — a hash of
+  the places a page can belong to, each stored value to the label editors see.
+  When it is not empty, the New page form offers them, a page with a place not
+  in it is refused, and the page list shows each page's place. The view check
+  reads it as `page.place`. Unset, pages have no place.
+- `KeystoneUi::Pages.access_exceptions = { "public_preview" => "Public preview" }`
+  — a hash of the exceptions an editor can set on a page, each stored value to
+  its label. When it is not empty, the builder's top bar has an Access exception
+  choice that sets or clears one, an exception not in it is refused, and the page
+  list shows each page's exception. The view check reads it as
+  `page.access_exception`. Unset, the choice is not shown.
+- `KeystoneUi::Pages.values_method = :page_values` — a method taking the page
+  and returning a hash of value names to values for the current visitor. The
+  engine calls it each time it draws a published page at `/pages/:slug`, so
+  bound fields and show-when conditions follow the visitor there. The drawing is
+  cached per version and per set of values, so no visitor gets a copy drawn for
+  other values. Unset, published pages draw with no values.
 - `KeystoneUi::Pages.edit_check_method = :may_edit_pages?` — a method with no
   arguments returning true when the current user may use the editor's screens:
   the page list, the builder, View live, History and the PDF link. It runs
   before every one of those requests. Unset, everyone may.
 - `KeystoneUi::Pages.refusal_method = :refuse_page` — a method with no
   arguments that renders the response when a request is refused: a failed view
-  or edit check, an unknown slug, or a page with no live version. Unset, the
-  response is an empty 404.
+  or edit check, an unknown slug, or a page with no live version, which covers a
+  draft, an unpublished page and an archived page. Unset, the response is an
+  empty 404.
 - `KeystoneUi::Pages.layout = "application"` — the host layout published pages
   and View live are drawn in. Defaults to `"application"`.
 - `KeystoneUi::Pages.editor_layout = "editor"` — the host layout the page
@@ -186,9 +204,10 @@ The catalog offers these Keystone UI components by default: `button`,
 
    The drawing is kept in `Rails.cache` under the version and the values, so
    the same version and values are drawn once. A page that uses host values
-   should be drawn this way, since the published address `/pages/:slug` draws
-   it with no values: bound fields show their fallback text there, and
-   conditions on a value hide what they guard unless they compare against blank.
+   should be drawn this way unless the host sets `values_method`, since without
+   it the published address `/pages/:slug` draws with no values: bound fields
+   show their fallback text there, and conditions on a value hide what they
+   guard unless they compare against blank.
 
 6. To make a PDF:
 
@@ -254,9 +273,18 @@ The catalog offers these Keystone UI components by default: `button`,
   `values:` passed to the helper and to PDFs all use the same names. The gem
   turns symbol keys into strings, so either works, but the names must match.
 - **The editor's page list** at `/pages/manage/pages` shows each page's name,
-  whether it is published or a draft, and when it was last published. Each row
-  links to Edit, and a published page also links to View live and, when Chrome
-  or Chromium is found, to its PDF.
+  its state, and when it was last published, plus its place and access
+  exception when the host names any. Each row links to Edit and has an Archive
+  button, and a published page also links to View live and, when Chrome or
+  Chromium is found, to its PDF. Show archived lists archived pages instead,
+  each with a Restore button.
+- **A page's state** is Draft before its first publish, Published while it has
+  a live version, Unpublished once that version is taken down, and Archived.
+  The builder's Unpublish button, shown next to Publish on a published page,
+  takes the live version down and keeps the page's history. Archiving takes the
+  live version down too and hides the page from the list. An archived page
+  cannot be published, and restoring it returns it to Draft or Unpublished,
+  never straight to Published. Visitors are refused every state but Published.
 - **View live** draws the live version in `KeystoneUi::Pages.layout` with the
   values of the sample chosen in the builder, behind the edit check. It is
   linked from the page list and from the builder's top bar once the page is

data/the_local/interface.yml

@@ -9,6 +9,9 @@ develop:
   - KeystoneUi::Pages.base_controller
   - KeystoneUi::Pages.owner_method
   - KeystoneUi::Pages.view_check_method
+  - KeystoneUi::Pages.places
+  - KeystoneUi::Pages.access_exceptions
+  - KeystoneUi::Pages.values_method
   - KeystoneUi::Pages.edit_check_method
   - KeystoneUi::Pages.refusal_method
   - KeystoneUi::Pages.layout

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keystone_ui-pages
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Schneider
@@ -77,6 +77,7 @@ files:
 - app/assets/builds/keystone_ui_pages/editor.js
 - app/controllers/concerns/keystone_ui/pages/edits_pages.rb
 - app/controllers/concerns/keystone_ui/pages/host_checks.rb
+- app/controllers/keystone_ui/pages/manage/access_exceptions_controller.rb
 - app/controllers/keystone_ui/pages/manage/base_controller.rb
 - app/controllers/keystone_ui/pages/manage/columns_controller.rb
 - app/controllers/keystone_ui/pages/manage/documents_controller.rb
@@ -94,6 +95,7 @@ files:
 - app/helpers/keystone_ui/pages/drawing_helper.rb
 - app/helpers/keystone_ui/pages/editor_helper.rb
 - app/helpers/keystone_ui/pages/host_helper.rb
+- app/javascript/keystone_ui_pages/AccessExceptionChoice.jsx
 - app/javascript/keystone_ui_pages/DeviceWidth.jsx
 - app/javascript/keystone_ui_pages/ElementFields.jsx
 - app/javascript/keystone_ui_pages/ElementPalette.jsx
@@ -125,6 +127,8 @@ files:
 - db/migrate/20261014120001_create_keystone_ui_pages_versions.rb
 - db/migrate/20261015130000_create_keystone_ui_pages_pdfs.rb
 - db/migrate/20261016120000_add_edit_history_to_keystone_ui_pages_pages.rb
+- db/migrate/20261019120000_add_access_to_keystone_ui_pages_pages.rb
+- db/migrate/20261019130000_add_archived_at_to_keystone_ui_pages_pages.rb
 - lib/keystone_ui-pages.rb
 - lib/keystone_ui/pages.rb
 - lib/keystone_ui/pages/catalog.rb