keystone_ui-pages 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20dcd88a9a3339db1695fdf1d3c7597e60c3706f7686a3ca1bf9efeb130e0529
-  data.tar.gz: ac4ebbcec505d877acaaaeef407246ef202f1e09884b9d6e7479d09a49faf977
+  metadata.gz: 77da11cab12ab896f890ea203bdf2f4b346603a1a0de8163359adf0fb1f8a608
+  data.tar.gz: abed3bcb29768934b84651c448105a9a75d6480c5000149b3473d3ce7250eb6e
 SHA512:
-  metadata.gz: 1b7d8e2f3f4be7fbda39dac9e52b9b36824c1b8c5f2906e6502023fe10f6cab2ce5d6da1b355e08ca9abc8b144eb0b6cac580ac5d5c19cc699b3e6f6dd9ff0b0
-  data.tar.gz: d50999cf89f1fb712ebeb7c1891dcf00edce95dfab8422115625198568444e3c7e2060a55a474594ec880e5913e6754ced5ea231b7592e5ab27f1340967d42d6
+  metadata.gz: 9bc3c8e60570178ccc5c4ef7029a6fe9cad8039187cb5649039cd85b3162d2a349814987825326834f0d4a8d1791dfbb0f5a2abab60b2e578e470d804f6003b0
+  data.tar.gz: 68dea7bf498637cf98b1233afb11f509ff45be2e030a6d3ab4ce150dd2f7b289cca9e80a3ef9b23900aa4d3f85e7f8a82b1cd1b1f7fb1d2658a3ecaf0fb6752f

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/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/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.4.1"
+    VERSION = "0.6.0"
   end
 end

data/lib/keystone_ui/pages.rb

@@ -37,13 +37,13 @@ module KeystoneUi
       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

@@ -111,19 +111,26 @@ 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.
-- `KeystoneUi::Pages.pdf(page, values: {})` — returns a
+- `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: {}, 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
 
@@ -271,7 +278,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` 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.

metadata

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