keystone_ui-pages 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77da11cab12ab896f890ea203bdf2f4b346603a1a0de8163359adf0fb1f8a608
-  data.tar.gz: abed3bcb29768934b84651c448105a9a75d6480c5000149b3473d3ce7250eb6e
+  metadata.gz: ebfd45f732eefa22bd08b4a5abd3c13ff88a2fa65c55a5309c89c8b21468c69c
+  data.tar.gz: bb309abcbff6e6d5a12aa1096db65c1a3d298ca1db781ed4c3110a5b4e6334a3
 SHA512:
-  metadata.gz: 9bc3c8e60570178ccc5c4ef7029a6fe9cad8039187cb5649039cd85b3162d2a349814987825326834f0d4a8d1791dfbb0f5a2abab60b2e578e470d804f6003b0
-  data.tar.gz: 68dea7bf498637cf98b1233afb11f509ff45be2e030a6d3ab4ce150dd2f7b289cca9e80a3ef9b23900aa4d3f85e7f8a82b1cd1b1f7fb1d2658a3ecaf0fb6752f
+  metadata.gz: 845983515d8a34e9d1c4ef3faff043e2ec832461b4fbf9be78b246d9fc9aba12c9823b69f3b573879df2755dd30e7041a7b1865939cab16d53ee1dad64f6a94e
+  data.tar.gz: dc35e48a37f83ed5b6e61d0d41b22e92139017c8b0fa9cb1cabb458e33bb61a69b38d625800a6f7f7113fe5f3ae80689691f5c2b4a2eafbef3f2db8753b3c4cf

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

@@ -8,15 +8,21 @@ module KeystoneUi
       class PagesController < BaseController
         def index
           @archived = params[:archived].present?
+          @place = chosen_place
           @pages = owned_pages.public_send(@archived ? :archived : :current).order(:name)
+          @pages = @pages.where(place: @place) if @place
           @printable = Printer.chrome.present?
         end
 
         def new
+          @place = chosen_place
+          @default_name = Page.new(place: @place, owner: page_owner).default_name
         end
 
         def create
-          page = Page.create!(params.require(:page).permit(:name, :slug, :place).merge(owner: page_owner))
+          page = Page.new(params.require(:page).permit(:name, :slug, :place).merge(owner: page_owner))
+          return render(:new, status: :unprocessable_entity) unless page.save
+
           redirect_to manage_page_path(page)
         end
 
@@ -33,7 +39,7 @@ module KeystoneUi
           @page = owned_pages.find(params[:id])
           return render(:edit, status: :unprocessable_entity) unless @page.update(params.require(:page).permit(:name, :slug, :place))
 
-          redirect_to manage_pages_path
+          redirect_to manage_pages_path(place: @page.place)
         end
 
         def publish
@@ -49,17 +55,23 @@ module KeystoneUi
         end
 
         def archive
-          owned_pages.find(params[:id]).archive
-          redirect_to manage_pages_path
+          page = owned_pages.find(params[:id])
+          page.archive
+          redirect_to manage_pages_path(place: page.place)
         end
 
         def restore
-          owned_pages.find(params[:id]).restore
-          redirect_to manage_pages_path
+          page = owned_pages.find(params[:id])
+          page.restore
+          redirect_to manage_pages_path(place: page.place)
         end
 
         private
 
+        def chosen_place
+          params[:place] if KeystoneUi::Pages.places.key?(params[:place])
+        end
+
         def local_address?(address)
           address.to_s.match?(%r{\A/(?![/\\])})
         end

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

@@ -32,7 +32,7 @@ module KeystoneUi
           redo_url: manage_page_redo_path(page),
           undoable: page.undo_history.any?,
           redoable: page.undone_changes.any?,
-          back_url: session.dig(:keystone_ui_pages_return_to, page.id.to_s) || manage_pages_path,
+          back_url: session.dig(:keystone_ui_pages_return_to, page.id.to_s) || manage_pages_path(place: page.place),
           live_url: (manage_page_live_path(page) if page.live_version),
           token: form_authenticity_token
         }

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "securerandom"
 require "keystone_ui/pages/document"
 
 module KeystoneUi
@@ -17,6 +18,11 @@ module KeystoneUi
       scope :archived, -> { where.not(archived_at: nil) }
       scope :current, -> { where(archived_at: nil) }
 
+      before_validation(on: :create) do
+        self.name = default_name if name.blank?
+        self.slug = SecureRandom.hex(4) if slug.blank?
+      end
+
       validates :name, :slug, presence: true
       validates :slug, uniqueness: { scope: %i[owner_type owner_id] }
       validates :place, inclusion: { in: -> { KeystoneUi::Pages.places.keys } }, allow_nil: true, if: -> { KeystoneUi::Pages.places.any? }
@@ -81,6 +87,12 @@ module KeystoneUi
       def next_number
         (versions.maximum(:number) || 0) + 1
       end
+
+      def default_name
+        word = KeystoneUi::Pages.place_settings.dig(place, :default_name) || "Page"
+        used = Page.where(owner: owner, place: place).pluck(:name).filter_map { |taken| taken[/\A#{Regexp.escape(word)} (\d+)\z/, 1]&.to_i }
+        "#{word} #{(used.max || 0) + 1}"
+      end
     end
   end
 end

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

@@ -9,7 +9,7 @@
     <label class="ks-label mb-1">Name</label>
     <%= ui_input(name: "page[name]", value: @page.name) %>
 
-    <label class="ks-label mb-1">Address</label>
+    <label class="ks-label mb-1">URL slug</label>
     <%= ui_input(name: "page[slug]", value: @page.slug) %>
 
     <% if KeystoneUi::Pages.places.any? %>

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

@@ -1,10 +1,10 @@
 <%= ui_page(max_width: :xl) do %>
-  <%= 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 %>
+  <%= ui_page_header(title: @archived ? "Archived pages" : "Pages", action_url: (new_manage_page_path(place: @place) unless @archived), action_label: "Create") do |header| %>
+    <% header.action { ui_button(label: "Create", href: new_manage_page_path(place: @place)) } 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)) %>
+    <%= @archived ? link_to("Show current pages", manage_pages_path(place: @place)) : link_to("Show archived", manage_pages_path(archived: 1, place: @place)) %>
   </p>
 
   <div class="ks-table overflow-x-auto">

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

@@ -2,13 +2,17 @@
   <%= ui_page_header(title: "New page") %>
 
   <%= ui_form(action: manage_pages_path, method: :post) do %>
+    <%= hidden_field_tag "page[place]", @place if @place %>
+
     <label class="ks-label mb-1">Name</label>
-    <%= ui_input(name: "page[name]", placeholder: "e.g. Pricing") %>
+    <%= ui_input(name: "page[name]", placeholder: @default_name) %>
 
-    <label class="ks-label mb-1">Address</label>
-    <%= ui_input(name: "page[slug]", placeholder: "e.g. pricing") %>
+    <% if KeystoneUi::Pages.slugged?(@place) %>
+      <label class="ks-label mb-1">URL slug</label>
+      <%= ui_input(name: "page[slug]", placeholder: "e.g. pricing") %>
+    <% end %>
 
-    <% if KeystoneUi::Pages.places.any? %>
+    <% if !@place && 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 %>

data/lib/keystone_ui/pages/version.rb

@@ -2,6 +2,6 @@
 
 module KeystoneUi
   module Pages
-    VERSION = "0.6.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/keystone_ui/pages.rb

@@ -9,7 +9,7 @@ require "keystone_ui/pages/engine"
 module KeystoneUi
   module Pages
     class << self
-      attr_writer :base_controller, :layout, :editor_layout, :pdf_stylesheet, :places, :access_exceptions
+      attr_writer :base_controller, :layout, :editor_layout, :pdf_stylesheet, :access_exceptions
       attr_accessor :edit_check_method, :view_check_method, :values_method, :owner_method, :refusal_method, :chrome_path
 
       def base_controller
@@ -29,7 +29,24 @@ module KeystoneUi
       end
 
       def places
-        @places || {}
+        (@places || {}).merge(place_settings.transform_values { |settings| settings[:label] })
+      end
+
+      def places=(labels)
+        @places = labels
+        @place_settings = {}
+      end
+
+      def register_place(key, label:, default_name: "Page", slug: true)
+        place_settings[key.to_s] = { label: label, default_name: default_name, slug: slug }
+      end
+
+      def place_settings
+        @place_settings ||= {}
+      end
+
+      def slugged?(place)
+        place_settings.dig(place.to_s, :slug) != false
       end
 
       def access_exceptions

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

@@ -51,6 +51,15 @@ inherit from the base controller, so define it there.
   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.register_place("client_report", label: "Client report", default_name: "Report template", slug: false)`
+  — adds one place with its own settings, so each part of a host app registers
+  the place it uses and two registrations never replace each other. `label:` is
+  what editors see. `default_name:` is the word a page created with no name
+  starts with, followed by the next number among that owner's pages in that
+  place, so "Report template 1", then "Report template 2"; it defaults to
+  "Page". `slug:` says whether the place's pages have a URL slug; it defaults to
+  true. Registered places are offered alongside any set with `places =`, and
+  `places = nil` clears both.
 - `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
@@ -312,6 +321,19 @@ The catalog offers these Keystone UI components by default: `button`,
   from `--ks-spacing`. The page builder has no setting of its own for these:
   a host changes them through its keystone_ui theme values. A section saved
   without either draws as it did before.
+- **A place's page list** at `/pages/manage/pages?place=client_report` shows
+  only that place's pages, and its Create and archived links keep the place.
+  With no place, or one the host does not name, the list shows every page. For
+  a page with a place, the redirects after saving settings, archiving and
+  restoring go to that place's list, and so does the builder's Back link unless
+  the host passed its own `return_to`.
+- **The New page form** at `/pages/manage/pages/new` saves a blank name from
+  the place's `default_name` and a blank slug as eight random hex characters,
+  and shows that name as the Name field's placeholder. A host linking to it
+  with `new_manage_page_path(place: "client_report")` creates the page in that
+  place and offers no place choice. The URL slug field shows unless the place
+  was registered with `slug: false`. A place the host does not name in the link
+  is ignored, and one posted to create is refused with the form shown again.
 - **A page's settings** at `/pages/manage/pages/:id/edit` change its name, slug
   and place after it is created. A slug another page of the same owner uses, or
   a place the host does not name, is refused with a message and changes nothing.

data/the_local/interface.yml

@@ -11,6 +11,7 @@ develop:
   - KeystoneUi::Pages.view_check_method
   - KeystoneUi::Pages.places
   - KeystoneUi::Pages.access_exceptions
+  - KeystoneUi::Pages.register_place
   - KeystoneUi::Pages.values_method
   - KeystoneUi::Pages.edit_check_method
   - KeystoneUi::Pages.refusal_method

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keystone_ui-pages
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Tyler Schneider