keystone_ui-pages 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a26feddb5cd80b4e5a676159463899d2aa3f8956e0a9e3a2a7cfdc2a9645a61
-  data.tar.gz: 118357d59feb0e62eeb1aa9c04a327fc59ee13683e7878023990ec0388542939
+  metadata.gz: 52e6e9b60483ae6bcec206e22e688d5b246fb3c30bac941df3658c26c8c386db
+  data.tar.gz: ae992048e518aae337f6df23ec7a9c4ffd04f7d76e98f0a8c1a389636d99f78d
 SHA512:
-  metadata.gz: 9aee570200cb37d2bf6be9c90dec6202087b85c4cefe4a448607df0b26f274f162f5c73a85a456659404b4508541d6e6fe53da3c227877bcde74acaaa75baafe
-  data.tar.gz: b1413f0fc7236cbfcc7769ba870726b4e79addd6d786705e1eaf5b10e6feb6f602d05a4ad5b68238b0bf67ac2a3aee9a83b24b260fa7a213d41569f3d767bc17
+  metadata.gz: 7f7dcf0832adca48663675600fa5a2d05aa5f6a6b1e4e4d8c133cf4f9c9cf7bd951fb9244e4fc1824819711733bbd1dfdc03962f239cc60479407ae9ca2754c1
+  data.tar.gz: bb06bbe0e3e0c2cc7a9876343ab7458ccec329019218c9669f266d06eb2438bff3d8b8ecc95199ff1961775718c8b4178ad5aa47c64966d19bb9843f067eaafc

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

@@ -8,15 +8,20 @@ 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
         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 +38,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 +54,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/jobs/keystone_ui/pages/pdf_job.rb

@@ -3,8 +3,8 @@
 module KeystoneUi
   module Pages
     class PdfJob < ActiveJob::Base
-      def perform(page, values)
-        KeystoneUi::Pages.pdf(page, values: values)
+      def perform(page, values, version = nil)
+        KeystoneUi::Pages.pdf(page, values: values, version: version)
       end
     end
   end

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.default_names.fetch(place, "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/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,15 +2,19 @@
   <%= 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") %>
 
-    <label class="ks-label mb-1">Address</label>
-    <%= ui_input(name: "page[slug]", placeholder: "e.g. pricing") %>
+    <% unless @place %>
+      <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) %>
+      <% 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 %>
     <% end %>
 
     <%= ui_button(label: "Create", type: :submit) %>

data/lib/keystone_ui/pages/pdfs.rb

@@ -9,8 +9,8 @@ module KeystoneUi
     module Pdfs
       module_function
 
-      def for(page, values: {})
-        version = page.versions.live.first
+      def for(page, values: {}, version: nil)
+        version = version ? page.versions.find_by(number: version) : page.versions.live.first
         digest = Operations.digest(values.to_h.stringify_keys)
         Pdf.find_by(version: version, values_digest: digest) || Pdf.create!(version: version, values_digest: digest,
           file: { io: StringIO.new(Printer.pdf(PdfDocument.html(version, values: values))), filename: "#{page.slug}.pdf", content_type: "application/pdf" })

data/lib/keystone_ui/pages/version.rb

@@ -2,6 +2,6 @@
 
 module KeystoneUi
   module Pages
-    VERSION = "0.5.0"
+    VERSION = "0.7.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, :places, :access_exceptions, :default_names
       attr_accessor :edit_check_method, :view_check_method, :values_method, :owner_method, :refusal_method, :chrome_path
 
       def base_controller
@@ -35,15 +35,19 @@ module KeystoneUi
       def access_exceptions
         @access_exceptions || {}
       end
+
+      def default_names
+        @default_names || {}
+      end
     end
 
-    def self.pdf(page, values: {})
+    def self.pdf(page, values: {}, version: nil)
       require "keystone_ui/pages/pdfs"
-      Pdfs.for(page, values: values)
+      Pdfs.for(page, values: values, version: version)
     end
 
-    def self.prepare_pdf(page, values: {})
-      PdfJob.perform_later(page, values.to_h.stringify_keys)
+    def self.prepare_pdf(page, values: {}, version: nil)
+      PdfJob.perform_later(page, values.to_h.stringify_keys, version)
     end
 
     def self.catalog

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

@@ -51,6 +51,11 @@ 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.default_names = { "client_report" => "Report template" }`
+  — the word a page created with no name starts with, per place. The page is
+  named with the word and the next number among that owner's pages in that
+  place, so "Report template 1", then "Report template 2". A place with no word,
+  and a page with no place, use "Page".
 - `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
@@ -120,15 +125,17 @@ inherit from the base controller, so define it there.
   unpublished or archived. It returns nil when the page has no version with
   that number. A record made from a page keeps the number it was made with
   and passes it here, so it keeps drawing the same way after later publishes.
-- `KeystoneUi::Pages.pdf(page, values: {})` — returns a
+- `KeystoneUi::Pages.pdf(page, values: {}, version: nil)` — returns a
   `KeystoneUi::Pages::Pdf` record for the page's live version drawn with the
   values given. Its `file` is an Active Storage attachment, ready to download,
-  link or email. The same live version and values return the record already
+  link or email. The same version and values return the record already
   kept, and a newly published version or different values print a new one.
-  When nothing is kept it prints in the current request.
-- `KeystoneUi::Pages.prepare_pdf(page, values: {})` — queues
+  When nothing is kept it prints in the current request. `version:` takes a
+  published version's number and prints that version instead, live or
+  superseded, the same way `keystone_ui_page` draws it.
+- `KeystoneUi::Pages.prepare_pdf(page, values: {}, version: nil)` — queues
   `KeystoneUi::Pages::PdfJob`, which calls `KeystoneUi::Pages.pdf` with the same
-  page and values, so the file is kept before anyone asks for it.
+  page, values and version, so the file is kept before anyone asks for it.
 
 ### The builder and the editor's screens
 
@@ -276,8 +283,8 @@ The catalog offers these Keystone UI components by default: `button`,
   layout and print rules together.
 - **Only the live version leaves the builder.** The draft is what editors
   change. Visitors, `keystone_ui_page` and PDFs show the live version, so an
-  unpublished change shows nowhere else. `keystone_ui_page` with `version:`
-  shows an earlier published version, never the draft.
+  unpublished change shows nowhere else. `keystone_ui_page` and PDFs with
+  `version:` show an earlier published version, never the draft.
 - **Value names are strings.** `Values.names`, the provider's hash and the
   `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.
@@ -310,6 +317,18 @@ 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
+  `default_names` and a blank slug as eight random hex characters. A host
+  linking to it with `new_manage_page_path(place: "client_report")` creates the
+  page in that place, and the form then asks for a name only. 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.default_names
   - 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.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Tyler Schneider