rails_onboarding 0.8.15 → 0.8.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df859b74947576d40a44a8a6ce1e37ceb1c9b92297875ac06faa3926f19489cc
-  data.tar.gz: 360a0d59bece71c30df19f549bea51cba322b7d0abf0e657d2e77d8b4b9e9d3b
+  metadata.gz: f79e357fe7c8d557e953c0c0b531e255b81b79ab2a23fe468c9c3c5d71769dd1
+  data.tar.gz: 98f0008fca60f449ae12e3d7cef03717ceb5069f91cb0038f98ccd502a87cc85
 SHA512:
-  metadata.gz: 0fce05257f5c3f4af31cd191dc961ea151e2b753988758e53315e9914f6db67d4d22f1759ae81562b60b8bbe177a2cd3b59ddeb0f840f42ff46b0834f32b63fe
-  data.tar.gz: 83404bc6ac100510474a792a1ff245dbb09f53166df47325117b4f3551cacdeca9bf60dc54550d6c07794c8f371a93f9c2779dc1c48d6d1ffae01d0c4a9ef16e
+  metadata.gz: 1ab29b9cb21add6000d90cc9656c7ae70f31c67417c3921f1e895b1d478006c581954e4ce6b8b201b7521b64f1f22acae8a310902821392569c9926e28ad9883
+  data.tar.gz: 73564d4673ff3a1ba775153b563e45f2e78345162d0cdaa6ade4cdee2f57fc00bec13b189ab7ec92c4a1b1382a16c847aff8163b34ada2fd38017f9e0d66b597

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

@@ -48,6 +48,15 @@
   <% 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>
 

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.15"
+  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.15
+  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.15
+  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: