rails_onboarding 0.8.4 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 007cab6c758c3d50c9c2b9dca6c8f798956b6c09d61a0078de8c347f2b857395
-  data.tar.gz: d431ee736da8d5de6af011483929f64cefd5da668844d88934ad48d30e3af5a1
+  metadata.gz: 1eb640c48091d5cc3028c5563bbdd22d3b5a2b2a32e3ce6079f20afb99b14cec
+  data.tar.gz: b85af1963ce35f84da739613dc6168179ea0e548bc90d11a91e7a01be2c5c484
 SHA512:
-  metadata.gz: b6f99c18d8a9e4143aa445392866e46e88561ec28e51f8d29a72c37458eecfbab311bed79ed9c400104849ba2669acecc8307464a5bbb8edbe3001543df763ec
-  data.tar.gz: c4db1b37aeec6472fb839ac1647f8d4ddc9fd1f643e4118e889e0a14db9a5ec1b9793bd3d3af0cfbb1f1550cced75c5439216f8a3c1b7f26402bf26d276a0dfb
+  metadata.gz: 1f76a6f1b8d8ec877f5efe98026c2f75039d6a6102bc3eda76cbdbabb36d9926b9b2fe3f88044e0a515fcb76053eb087d7929b7fa62799acdd5ab2abafacb476
+  data.tar.gz: b58edc5a568ad4691982422fe8a21c557d074fed14c91990fbda23ef2e8cdd9584eee8b54241ac5996f97578eeffdbdcd6250c5812d8880e2753ed644893fab8

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

@@ -203,6 +203,17 @@
   border-color: var(--onboarding-primary-fill-hover);
 }
 
+/* Shown in place of a control on a step that is neither skippable nor yet
+   satisfied, so the banner's action area is never empty on one step and full on
+   the next. Sized and spaced like .onboarding-banner-skip so the three states
+   occupy the same visual slot. */
+.onboarding-banner-hint {
+  color: var(--onboarding-text-muted);
+  padding: var(--onboarding-space-sm) var(--onboarding-space-sm);
+  font-size: var(--onboarding-text-sm);
+  white-space: nowrap;
+}
+
 .onboarding-banner-skip {
   background: transparent;
   color: var(--onboarding-text-muted);

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

@@ -101,9 +101,18 @@ module RailsOnboarding
     #   user.onboarding_progress #=> 75
     def onboarding_progress
       return 100 if onboarding_completed?
-      return 0 unless onboarding_current_step
 
-      current_index = RailsOnboarding.configuration.step_index(onboarding_current_step)
+      # onboarding_current_step is only written once a step is *completed*, so a
+      # member who has not finished one yet has nil here while
+      # #current_onboarding_step already reports the first step. Without the same
+      # fallback the two disagree: the progress markers show "1 of 5" and the bar
+      # reads 0%, then jumps to 40% at step two. Fall back the same way, so the
+      # first step measures as the first step.
+      step_name = onboarding_current_step ||
+                  RailsOnboarding.configuration.steps.first&.dig(:name)
+      return 0 unless step_name
+
+      current_index = RailsOnboarding.configuration.step_index(step_name)
       return 0 if current_index.nil?
 
       total_steps = RailsOnboarding.configuration.total_steps

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

@@ -6,7 +6,7 @@
       viewport and zooms out to fit the physical screen - everything (text,
       buttons, spacing) looks shrunk even though the CSS itself is correct. %>
   <meta name="viewport" content="width=device-width, initial-scale=1">
-  <title><%= Rails.application.class.module_parent.name %> Onboarding</title>
+  <title><%= RailsOnboarding.configuration.app_name.presence || Rails.application.class.module_parent.name %> Onboarding</title>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 

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

@@ -39,7 +39,8 @@
           anywhere else in the app - but on the step's own page, with the
           criteria not yet met, it redirects straight back here and the click
           does nothing visible. Offer it only when it leads somewhere. %>
-      <% if !defined?(onboarding_continue_available?) || onboarding_continue_available? %>
+      <% continue_offered = !defined?(onboarding_continue_available?) || onboarding_continue_available? %>
+      <% if continue_offered %>
         <%= link_to "Continue setup →", onboarding_root,
                     class: "onboarding-banner-continue" %>
       <% end %>
@@ -47,6 +48,14 @@
         <%= button_to "Skip this step", rails_onboarding.skip_onboarding_path,
                       method: :post, class: "onboarding-banner-skip" %>
       <% end %>
+      <%# A step that is neither skippable nor yet satisfied offers neither
+          control, which leaves this area empty on one step and populated on the
+          next - the flow looks inconsistent step to step even though each state
+          is individually correct. Say what will move the member on instead, so
+          the banner always answers "how do I proceed?". %>
+      <% if !step[:skippable] && !continue_offered && step[:hint].present? %>
+        <span class="onboarding-banner-hint"><%= step[:hint] %></span>
+      <% end %>
     </div>
   </div>
 <% end %>

data/lib/rails_onboarding/configuration.rb

@@ -33,7 +33,8 @@ module RailsOnboarding
     include RateLimiting
     include Templates
 
-    attr_accessor :user_class_name,
+    attr_accessor :app_name,
+                  :user_class_name,
                   :include_host_styles,
                   :redirect_after_completion,
                   :redirect_after_skip,
@@ -45,6 +46,11 @@ module RailsOnboarding
                   :admin_user_search
 
     def initialize
+      # What to call the host product on onboarding pages. Defaults to the Rails
+      # application's module name, which is a code identifier and often not what
+      # the product is actually called - "Gift" for an app called Gift Posse.
+      # nil keeps the derived name.
+      @app_name = nil
       @user_class_name = "User"
       @include_host_styles = true  # Default to including host app css
 

data/lib/rails_onboarding/configuration_validator.rb

@@ -112,6 +112,7 @@ module RailsOnboarding
           { name: :title, type: String },
           { name: :icon, type: String },
           { name: :skippable, type: [ TrueClass, FalseClass ] },
+          { name: :hint, type: String },
           { name: :path, type: [ Symbol, String, Proc ] },
           { name: :complete_if, type: Proc }
         ]

data/lib/rails_onboarding/version.rb

@@ -1,3 +1,3 @@
 module RailsOnboarding
-  VERSION = "0.8.4"
+  VERSION = "0.8.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_onboarding
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.6
 platform: ruby
 authors:
 - David Lewis
@@ -282,7 +282,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.4
+  source_code_uri: https://github.com/bunnahabhain/rails_onboarding/tree/v0.8.6
   changelog_uri: https://github.com/bunnahabhain/rails_onboarding/blob/master/docs/CHANGELOG.md
 rdoc_options: []
 require_paths: