keystone_ui-pages 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 173519c8861b68b91c52a60547f7a7457f34c04319eb528b795b7266a6dd0bfd
-  data.tar.gz: a1cf640e7b60ff4d6072be38c644fc8396784d35368499414b17bb21616f88a3
+  metadata.gz: 8a26feddb5cd80b4e5a676159463899d2aa3f8956e0a9e3a2a7cfdc2a9645a61
+  data.tar.gz: 118357d59feb0e62eeb1aa9c04a327fc59ee13683e7878023990ec0388542939
 SHA512:
-  metadata.gz: dc73c41700f1444b0cbaf65ee371dac7a68fe3555f6d73bb5e0f88183c2e244bc638d4de7203c0e10eebc444c02f4e49260ff79cd795227c9c4d3472dfbd13e7
-  data.tar.gz: 74b742f036c877533c267f2787c008c9895ed426d138fe1d63e3edc9ce4dfdb4cdfa6a412e4d7abbe6659203e1c4b0ac482e0d1b5c136e46adc1980eb726fdad
+  metadata.gz: 9aee570200cb37d2bf6be9c90dec6202087b85c4cefe4a448607df0b26f274f162f5c73a85a456659404b4508541d6e6fe53da3c227877bcde74acaaa75baafe
+  data.tar.gz: b1413f0fc7236cbfcc7769ba870726b4e79addd6d786705e1eaf5b10e6feb6f602d05a4ad5b68238b0bf67ac2a3aee9a83b24b260fa7a213d41569f3d767bc17

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

@@ -17,6 +17,7 @@ module KeystoneUi
 
       def drawn_version(version, values: {})
         key = [ "keystone_ui_pages", version.id, Operations.digest(values.to_h.stringify_keys) ]
+        @drawn_page_id = version.page_id
         Rails.cache.fetch(key) { drawn_document(version.document, values: values).to_str }.html_safe
       end
 
@@ -79,10 +80,25 @@ module KeystoneUi
       end
 
       def edited_element(element)
+        return missing_element(element) unless KeystoneUi::Pages.catalog.find(element["key"])
+
         wrapped_element(element, data: { element_id: element["id"], hidden: hidden?(element) || nil }.compact)
       end
 
+      def reported_missing(element)
+        Rails.error.report(InvalidDocument.new("No element is registered as #{element["key"]}"), handled: true,
+          context: { page_id: @drawn_page_id, element_key: element["key"] })
+        nil
+      end
+
+      def missing_element(element)
+        tag.div("No longer offered: #{element["key"]}", class: "ks-pages-element ks-hint rounded-md border-2 border-dashed border-(--ks-color-border-strong) p-3",
+          data: { element_id: element["id"], missing_element: true })
+      end
+
       def drawn_element(element)
+        return reported_missing(element) unless KeystoneUi::Pages.catalog.find(element["key"])
+
         wrapped_element(element) unless hidden?(element)
       end
 

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

@@ -6,8 +6,8 @@ module KeystoneUi
       include KeystoneUiHelper
       include DrawingHelper
 
-      def keystone_ui_page(page, values: {})
-        version = page.live_version
+      def keystone_ui_page(page, values: {}, version: nil)
+        version = version ? page.versions.find_by(number: version) : page.live_version
         return if version.nil?
 
         tag.div(drawn_version(version, values: values), class: "@container")

data/lib/keystone_ui/pages/version.rb

@@ -2,6 +2,6 @@
 
 module KeystoneUi
   module Pages
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

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

@@ -111,10 +111,15 @@ inherit from the base controller, so define it there.
 
 ### Drawing and printing
 
-- `keystone_ui_page(page, values: {})` — a view helper, available in every host
-  view, that draws the page's live version with the values given, inside a
-  `<div class="@container">`. It returns nil when the page has never been
-  published. `values:` takes value names to values, with string or symbol keys.
+- `keystone_ui_page(page, values: {}, version: nil)` — a view helper, available
+  in every host view, that draws the page's live version with the values given,
+  inside a `<div class="@container">`. It returns nil when no version is live.
+  `values:` takes value names to values, with string or symbol keys.
+  `version:` takes a published version's number and draws that version
+  instead, whether it is live or superseded and whether the page is
+  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` record for the page's live version drawn with the
   values given. Its `file` is an Active Storage attachment, ready to download,
@@ -257,8 +262,11 @@ The catalog offers these Keystone UI components by default: `button`,
 
    The method must be reachable in the engine's views and in any host view that
    calls `keystone_ui_page`. A `helper_method` on the base controller covers
-   both. Leaving out an element that pages already use makes those pages fail
-   to draw, so search the pages' documents for its key before leaving it out.
+   both. A page that holds an element the catalog no longer offers still
+   draws its other elements for visitors, marks the missing one in the editor
+   as no longer offered, and reports the page's id and the element's key
+   through `Rails.error`, so search the pages' documents for its key before
+   leaving it out.
 
 ## Conventions
 
@@ -268,7 +276,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.
+  unpublished change shows nowhere else. `keystone_ui_page` with `version:`
+  shows 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.

metadata

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