rails_onboarding 0.8.14 → 0.8.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92019b01af432fe5d1e17c6f116c224d6123f15aeda35798193a3d2a6eb46b3d
-  data.tar.gz: ddb5d7f350286ab8512626eae34967b524dfa5284547794b801ca4d1b11fdcbc
+  metadata.gz: f79e357fe7c8d557e953c0c0b531e255b81b79ab2a23fe468c9c3c5d71769dd1
+  data.tar.gz: 98f0008fca60f449ae12e3d7cef03717ceb5069f91cb0038f98ccd502a87cc85
 SHA512:
-  metadata.gz: da8ba6db11ce280647bee31ad9a718f63cb251d420d2c65d86412363db586d8d16d9c09c95e0ddd128b72bb3cbdd3903f7559391dc271339e6db32451f40405c
-  data.tar.gz: ef5428f53020a250d118eb58316ec24dffaa06cc0e364d91fe40bf23c78f97ca56ec7ae15b928e93be7e2e3dfb4d093d2ccd3e8e6957d118df775e7285f27b6f
+  metadata.gz: 1ab29b9cb21add6000d90cc9656c7ae70f31c67417c3921f1e895b1d478006c581954e4ce6b8b201b7521b64f1f22acae8a310902821392569c9926e28ad9883
+  data.tar.gz: 73564d4673ff3a1ba775153b563e45f2e78345162d0cdaa6ade4cdee2f57fc00bec13b189ab7ec92c4a1b1382a16c847aff8163b34ada2fd38017f9e0d66b597

data/app/assets/stylesheets/rails_onboarding/flash_messages.css

@@ -8,6 +8,9 @@
   max-width: 500px;
   width: 100%;
   pointer-events: none;
+  /* Outside .onboarding-container, which is where the engine sets its font, so it would otherwise
+     take the browser's serif default. */
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
 }
 
 .onboarding-flash {
@@ -29,25 +32,46 @@
   box-shadow: 0 6px 16px rgba(0, 0, 0, 0.2);
 }
 
-/* Flash types */
+/* Each message is an open <dialog> (see shared/_flash), so it closes without JavaScript. Undo
+   what the browser gives a dialog - centred, absolutely placed, bordered all round - leaving the
+   coloured left border from the type rules below. */
+dialog.onboarding-flash {
+  inset: auto;
+  margin: 0 0 12px;
+  width: auto;
+  max-width: none;
+  max-height: none;
+  border-top: 0;
+  border-right: 0;
+  border-bottom: 0;
+}
+
+/* The close form is only there for method="dialog"; its button is the flex item. */
+.onboarding-flash form {
+  display: contents;
+}
+
+/* Flash types. Each pair is at least 4.5:1 (WCAG AA): white on the 500-weight greens, ambers and
+   reds these used was 2-4:1, unreadable on amber in particular. Amber keeps its colour and takes
+   dark text instead. */
 .flash-notice,
 .flash-success {
-  background-color: #10b981;
+  background-color: #047857;
   color: white;
-  border-left: 4px solid #059669;
+  border-left: 4px solid #065f46;
 }
 
 .flash-alert,
 .flash-warning {
   background-color: #f59e0b;
-  color: white;
-  border-left: 4px solid #d97706;
+  color: #451a03;
+  border-left: 4px solid #b45309;
 }
 
 .flash-error {
-  background-color: #ef4444;
+  background-color: #b91c1c;
   color: white;
-  border-left: 4px solid #dc2626;
+  border-left: 4px solid #7f1d1d;
 }
 
 .flash-info {
@@ -152,6 +176,9 @@
     right: 10px;
     left: 10px;
     max-width: none;
+    /* Not 100%: with both left and right set, a width overrides right, and the message ran 10px
+       off the screen. */
+    width: auto;
   }
 
   .onboarding-flash {

data/app/models/concerns/rails_onboarding/onboardable.rb

@@ -730,8 +730,18 @@ module RailsOnboarding
       { onboarding_replay_started_at: nil, onboarding_replay_steps: [] }
     end
 
+    # column_names queries the database like the rest, so it takes the same
+    # guard -- but purely for symmetry: this one cannot actually be reached
+    # with the table missing. It is an instance method, and ActiveRecord cannot
+    # instantiate a model whose table is absent (`new` raises while building
+    # attribute types), so the guard can never fire. Kept so every column query
+    # in this file reads the same way, and it costs nothing: table_exists?
+    # reads the schema cache.
     def onboarding_column?(name)
-      self.class.respond_to?(:column_names) && self.class.column_names.include?(name)
+      return false unless self.class.respond_to?(:column_names)
+      return false unless RailsOnboarding::SchemaGuard.columns_queryable?(self.class)
+
+      self.class.column_names.include?(name)
     end
 
     def persist_and_track!(attributes = nil)

data/app/views/layouts/rails_onboarding/application.html.erb

@@ -48,9 +48,23 @@
   <% end %>
 
   <%= javascript_include_tag "rails_onboarding/application", "data-turbo-track": "reload", defer: true %>
+
+  <%# Host-supplied script, loaded after the engine's. Nothing else on these pages
+      loads the host's JavaScript, so without it a host whose pages need Turbo or
+      Stimulus loses both here - and a Hotwire Native app, which requires Turbo on
+      every page it shows, refuses the page outright with "Turbo is not present".
+      Deferred like the engine's, so the two run in this order. %>
+  <% if RailsOnboarding.configuration.custom_js_path.present? %>
+    <%= javascript_include_tag RailsOnboarding.configuration.custom_js_path, "data-turbo-track": "reload", defer: true %>
+  <% end %>
 </head>
 <body>
 
+<%# Without this, a message on the way to onboarding was lost: a host's redirect_to with an alert,
+    the engine's own redirect_to onboarding_path, alert:, and the Turbo Stream errors, which replace
+    #flash-messages and found nothing to replace. Fixed-position, so it sits over the page. %>
+<%= render "rails_onboarding/shared/flash" %>
+
 <%# .onboarding-container/.onboarding-content provide the page-level
     min-height/centering/responsive padding that the stylesheets (see
     application.css and mobile.css) already define for every onboarding

data/app/views/rails_onboarding/shared/_flash.html.erb

@@ -1,25 +1,26 @@
-<div id="flash-messages" class="flash-container">
-  <% if defined?(notice) && notice %>
-    <div class="onboarding-flash flash-notice" role="alert">
-      <span class="flash-icon">✓</span>
-      <span class="flash-message"><%= notice %></span>
-      <button class="flash-close" onclick="this.parentElement.remove()" aria-label="Dismiss">×</button>
-    </div>
-  <% end %>
+<%# The flash, on every page of the engine layout, and the target the onboarding controller's
+    Turbo Stream errors replace (#flash-messages). Each message comes from a local when one is
+    given - those streams pass the message they want shown - and from the flash otherwise.
 
-  <% if defined?(alert) && alert %>
-    <div class="onboarding-flash flash-alert" role="alert">
-      <span class="flash-icon">⚠</span>
-      <span class="flash-message"><%= alert %></span>
-      <button class="flash-close" onclick="this.parentElement.remove()" aria-label="Dismiss">×</button>
-    </div>
-  <% end %>
-
-  <% if defined?(error) && error %>
-    <div class="onboarding-flash flash-error" role="alert">
-      <span class="flash-icon">✕</span>
-      <span class="flash-message"><%= error %></span>
-      <button class="flash-close" onclick="this.parentElement.remove()" aria-label="Dismiss">×</button>
-    </div>
+    Each message is an open <dialog> closed by a form with method="dialog", which the browser
+    handles itself: no JavaScript, so nothing for a strict Content Security Policy to refuse. The
+    close buttons were onclick= attributes, which such a policy blocks without a word. Turbo
+    leaves method="dialog" forms alone. %>
+<% messages = {
+     notice: local_assigns.fetch(:notice) { flash[:notice] },
+     alert: local_assigns.fetch(:alert) { flash[:alert] },
+     error: local_assigns.fetch(:error) { flash[:error] }
+   } %>
+<% icons = { notice: "✓", alert: "⚠", error: "✕" } %>
+<div id="flash-messages" class="flash-container">
+  <% messages.each do |type, message| %>
+    <% next if message.blank? %>
+    <dialog open class="onboarding-flash flash-<%= type %>">
+      <span class="flash-icon" aria-hidden="true"><%= icons[type] %></span>
+      <span class="flash-message" role="alert"><%= message %></span>
+      <form method="dialog">
+        <button class="flash-close" aria-label="Dismiss">×</button>
+      </form>
+    </dialog>
   <% end %>
 </div>

data/lib/generators/rails_onboarding/templates/rails_onboarding.rb

@@ -21,6 +21,12 @@ RailsOnboarding.configure do |config|
   # --onboarding-* tokens in that file rather than overriding rules.
   # config.custom_css_path = "rails_onboarding_custom"
 
+  # Asset name of a script loaded after the engine's own on onboarding pages.
+  # Nothing else loads your JavaScript there, so name your application bundle
+  # if those pages need Turbo or Stimulus - a Hotwire Native app always does,
+  # and shows "Turbo is not present" instead of the page without it.
+  # config.custom_js_path = "application"
+
   # Feature toggles
   config.enable_tooltips = true
   config.enable_milestones = true

data/lib/rails_onboarding/configuration.rb

@@ -59,6 +59,12 @@ module RailsOnboarding
       # app/assets/stylesheets/rails_onboarding_custom.css; set this to
       # "rails_onboarding_custom" to actually load it. nil = load nothing.
       @custom_css_path = nil
+
+      # Asset name of a host script to load after the engine's own on onboarding
+      # pages - typically the host's "application" bundle, which is what brings
+      # Turbo and Stimulus. Required for a Hotwire Native app, which refuses any
+      # page without Turbo. nil = load nothing.
+      @custom_js_path = nil
       @redirect_after_completion = :root_path
       @redirect_after_skip = :root_path
       @welcome_heading = "We're excited to have you here!"

data/lib/rails_onboarding/configuration_validator.rb

@@ -55,6 +55,7 @@ module RailsOnboarding
       validate_type(:user_class_name, [ String ], "user_class_name must be a String")
       validate_type(:include_host_styles, [ TrueClass, FalseClass ], "include_host_styles must be a Boolean")
       validate_type(:custom_css_path, [ String ], "custom_css_path must be a String")
+      validate_type(:custom_js_path, [ String ], "custom_js_path must be a String")
       validate_type(:enable_tooltips, [ TrueClass, FalseClass ], "enable_tooltips must be a Boolean")
       validate_type(:enable_milestones, [ TrueClass, FalseClass ], "enable_milestones must be a Boolean")
       validate_type(:enable_analytics, [ TrueClass, FalseClass ], "enable_analytics must be a Boolean")

data/lib/rails_onboarding/version.rb

@@ -1,3 +1,3 @@
 module RailsOnboarding
-  VERSION = "0.8.14"
+  VERSION = "0.8.16"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_onboarding
 version: !ruby/object:Gem::Version
-  version: 0.8.14
+  version: 0.8.16
 platform: ruby
 authors:
 - David Lewis
@@ -283,7 +283,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/bunnahabhain/rails_onboarding
-  source_code_uri: https://github.com/bunnahabhain/rails_onboarding/tree/v0.8.14
+  source_code_uri: https://github.com/bunnahabhain/rails_onboarding/tree/v0.8.16
   changelog_uri: https://github.com/bunnahabhain/rails_onboarding/blob/master/docs/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -299,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.19
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Flexible onboarding engine for Rails applications
 test_files: []