rails_onboarding 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5f1d40794e4959c807fd7fd7077c81c60821cbf8e1bd79fd69089543e718790
-  data.tar.gz: 3ce1ebd746fc540b491460bf1c0c7e2dee36709182bee72beab9a6c5e4b56ec0
+  metadata.gz: 54c87e18cdea35b440ea3d1f9dcd93984da008e6690bbf0dba255e8b1b803266
+  data.tar.gz: 6675e0f3bf44029a6ee5d2b6c6d051edf877dd388e087b44925a716f51070a1b
 SHA512:
-  metadata.gz: ac1a9a964c82891f05512236f1930c753082efa29e16f34621da582f962cabdd7761611c4538f4857a6ffc08f5388c123f8837b3923aba3d2392b6d72c178ce2
-  data.tar.gz: ed7976e143fc227f068324ac48c6d93e01acad26a3fcd6a445599fd628411b0b22f8353a9f5c87085929cc07025b18e956391c6d7973cb9742aab6dd4e522cf3
+  metadata.gz: fd7a88c2058c5ea08bc5636990af96fd58775bfa98bf8f5a93849793564afe09bb51dcdf4983641dab499cd850213e6b24c2c867c44137b4ae30b7cc469697b0
+  data.tar.gz: 75827eaa49ba15a510ae5212be0ba4f6ea67739b32e1da632c9e9fd36eaa452a721d635f839e01f77922755ed15742e9d31f91618dcca0485f4c012b4e6088d3

data/app/controllers/rails_onboarding/onboarding_controller.rb

@@ -231,7 +231,7 @@ module RailsOnboarding
     def advance_completed_steps
       awarded_milestones = []
       RailsOnboarding.configuration.total_steps.times do
-        break unless @current_step && step_criteria_met?(@current_step)
+        break unless @current_step && onboarding_step_criteria_met?(@current_step)
 
         if defined?(RailsOnboarding::MilestoneService)
           milestones = RailsOnboarding::MilestoneService.check_onboarding_step_milestones(
@@ -258,19 +258,6 @@ module RailsOnboarding
       set_step
     end
 
-    # A buggy :complete_if must not brick onboarding - if it raises, treat the
-    # step as not yet complete instead of letting the shared StandardError
-    # handler redirect back to /onboarding (which would re-raise on arrival,
-    # redirecting again in an endless browser loop).
-    def step_criteria_met?(step)
-      return false unless step[:complete_if].is_a?(Proc)
-
-      step[:complete_if].call(current_user)
-    rescue StandardError => e
-      Rails.logger.error("RailsOnboarding: complete_if for step '#{step[:name]}' raised #{e.class} - #{e.message}")
-      false
-    end
-
     # Redirect to the host-app page that owns the current step. Returns false
     # (without redirecting) when the configured path can't be resolved, so
     # show can fall back to rendering a gem template instead of stranding the

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

@@ -34,11 +34,15 @@
       </span>
     </div>
     <div class="onboarding-banner-actions">
-      <%# For :path steps, /onboarding re-checks complete_if and either
-          advances or routes back to the step's page - so "Continue" is
-          always the right link. %>
-      <%= link_to "Continue setup →", onboarding_root,
-                  class: "onboarding-banner-continue" %>
+      <%# /onboarding re-checks complete_if and either advances or routes back
+          to the step's page. That makes "Continue" the right link from
+          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? %>
+        <%= link_to "Continue setup →", onboarding_root,
+                    class: "onboarding-banner-continue" %>
+      <% end %>
       <% if step[:skippable] %>
         <%= button_to "Skip this step", rails_onboarding.skip_onboarding_path,
                       method: :post, class: "onboarding-banner-skip" %>

data/lib/rails_onboarding/controller_helpers.rb

@@ -4,7 +4,7 @@ module RailsOnboarding
     extend ActiveSupport::Concern
 
     included do
-      helper_method :needs_onboarding?, :onboarding_path
+      helper_method :needs_onboarding?, :onboarding_path, :onboarding_continue_available?
     end
 
     # Configuration at the controller level
@@ -105,6 +105,59 @@ module RailsOnboarding
       path.is_a?(Proc) ? instance_exec(&path) : main_app.public_send(path)
     end
 
+    # Has this step's :complete_if been satisfied?
+    #
+    # A buggy :complete_if must not brick onboarding - if it raises, treat the
+    # step as not yet complete instead of letting the engine's shared
+    # StandardError handler redirect back to /onboarding (which would re-raise
+    # on arrival, redirecting again in an endless browser loop).
+    def onboarding_step_criteria_met?(step)
+      return false unless step.is_a?(Hash) && step[:complete_if].is_a?(Proc)
+
+      step[:complete_if].call(current_user)
+    rescue StandardError => e
+      Rails.logger.error("RailsOnboarding: complete_if for step '#{step[:name]}' raised #{e.class} - #{e.message}")
+      false
+    end
+
+    # Would following the banner's "Continue" link actually move the user?
+    #
+    # Anywhere else in the app, yes: /onboarding routes them to the current
+    # step. Standing on the step's own page it depends - /onboarding re-checks
+    # :complete_if and only advances once it passes. Until then it resolves the
+    # step's path and redirects straight back to the page the user is already
+    # on, so the link renders but the click does nothing visible. The banner
+    # asks this before offering it.
+    #
+    # The comparison is deliberately an exact path match rather than
+    # on_current_step_page?, which also treats any other action on the same
+    # controller as "on the step page". That breadth is right for the loop
+    # guard - it keeps the guard off the PATCH that completes the step - but
+    # wrong here: /profiles/123 is a different page from a step pointing at
+    # /profiles/123/edit, and Continue really does move the user between them.
+    def onboarding_continue_available?
+      return false unless user_signed_in?
+      return false unless current_user.respond_to?(:current_onboarding_step)
+
+      step = current_user.current_onboarding_step
+      # No :path means the step renders a gem template at /onboarding, which is
+      # always somewhere other than the host page showing this banner.
+      return true unless step.is_a?(Hash) && step[:path]
+
+      # The resolved route may carry a query string or be a full URL;
+      # request.path never does.
+      resolved_path = URI.parse(resolve_onboarding_step_path(step[:path]).to_s).path
+      return true unless request.path == resolved_path
+
+      onboarding_step_criteria_met?(step)
+    rescue StandardError => e
+      # An unresolvable :path means the engine can't redirect to it either - it
+      # falls back to rendering a gem template, so Continue still goes
+      # somewhere. Offer it.
+      Rails.logger.warn("RailsOnboarding: could not resolve step path for the banner link: #{e.class} - #{e.message}")
+      true
+    end
+
     private
 
     # True when the current request is for the page a :path-based step points

data/lib/rails_onboarding/version.rb

@@ -1,3 +1,3 @@
 module RailsOnboarding
-  VERSION = "0.6.1"
+  VERSION = "0.6.3"
 end

metadata

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