abraham 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 025f51bb1380ebbd7c172d43d66b79ca4b68fdb4eb4af6940364fff44b282176
-  data.tar.gz: a791c10896b5f002e1aa5daa8edccd2ec810a4479aeccac4a5d8b28a52795c5d
+  metadata.gz: 3928683d3a3d69dc8a8d252bf34a4093527d958f66e992120895d9287f329aa2
+  data.tar.gz: ec22961e9019b4329fce70ae9db31b43cc5ae284c6255d3db3beacecba74fa6e
 SHA512:
-  metadata.gz: 4e6f5e3fae2acca16748c5ace7c7fde3436e3aab72604c3e35030d5488ec389fd4903ff53a63dbdc4fe473a554853860a6d6f05e8a126bd49d7ae15f71c573b4
-  data.tar.gz: 816fb772c290eb0504885b2e93f21d952e7322bf87c05ca3332d57c6ff81fb1e5062a93824d5d087b142c05e4efab6af2f01fdbbc12623b9b3740acb82cc4a7d
+  metadata.gz: 0b9236210c526f1ae9874b13892bf68da1099058c503a065af63b65f2ac61b1af03b69c391725ef227dc3c105c434d68d430e8e9c4e9ffd19654c2e774a786e9
+  data.tar.gz: 12a8fd782dd8d2b0c8414fd7fbff006106ceb48b44e8450458c2a808ccf4f5987b498fdc8420e4ca699e9cf6c0d1dc4e3ea90451866bd342e0099c972c74b62d

data/README.md

@@ -207,6 +207,29 @@ my_tour:
 * `action` is one of the Shepherd tour method names, i.e. `cancel`, `next`, or `complete`
 * `classes` are the CSS class names you want applied to the button
 
+### Flipper integration
+
+If you have [Flipper](https://github.com/jnunemaker/flipper) installed as a dependency in your project you will be able to enable or disable tours based on a flipper using the `flipper_key` option. This will automatically enable a tour when this flipper is active and disable it when it's inactive.
+
+```yml
+walkthrough:
+  flipper_key: "name_of_flipper"
+  steps:
+    1:
+      text: "This walkthrough will show you how to..."
+```
+
+If you would like to disable a tour when a flipper is active you may couple the `flipper_key` option with the `flipper_activation` option. `flipper_activation` supports "enabled" or "disabled" as options. If you enter something other than "enabled" or "disabled" it will use the default, which is "enabled".
+
+```yml
+walkthrough:
+  flipper_key: "name_of_flipper"
+  flipper_activation: "disabled"
+  steps:
+    1:
+      text: "This walkthrough will show you how to..."
+```
+
 ### Testing your tours
 
 Abraham loads tour definitions once when you start your server. Restart your server to see tour changes.

data/app/assets/javascripts/abraham/index.js

@@ -1,5 +1,5 @@
-//= require js-cookie/src/js.cookie
-//= require shepherd.js/dist/js/shepherd
+//= require js.cookie
+//= require shepherd.min
 
 var Abraham = new Object();
 

data/app/helpers/abraham_helper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module AbrahamHelper
+  include FlipperHelper
+
   def abraham_tour
     # Do we have tours for this controller/action in the user's locale?
     tours = Rails.configuration.abraham.tours["#{controller_path}.#{action_name}.#{I18n.locale}"]
@@ -21,11 +23,16 @@ module AbrahamHelper
       tour_html = ''
 
       tour_keys.each do |key|
-        tour_html += render(partial: "application/abraham",
-               locals: { tour_name: key,
-                         tour_completed: tour_keys_completed.include?(key),
-                         trigger: tours[key]["trigger"],
-                         steps: tours[key]["steps"] })
+        flipper_key = tours[key]["flipper_key"]
+        flipper_activation = tours[key]["flipper_activation"]
+
+        if should_add_tour(flipper_key, flipper_activation)
+          tour_html += render(partial: "application/abraham",
+                              locals: { tour_name: key,
+                                        tour_completed: tour_keys_completed.include?(key),
+                                        trigger: tours[key]["trigger"],
+                                        steps: tours[key]["steps"] })
+        end
       end
 
       tour_html.html_safe

data/app/helpers/flipper_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module FlipperHelper
+  def should_add_tour(flipper_key, flipper_activation)
+    return true if !flipper_defined?
+
+    case process_activation_option(flipper_activation)
+    when "enabled"
+      return (flipper_key && Flipper.enabled?(flipper_key.to_sym)) || flipper_key.nil?
+    when "disabled"
+      return (flipper_key && !Flipper.enabled?(flipper_key.to_sym)) || flipper_key.nil?
+    else
+      return false
+    end
+  end
+
+  private
+    def flipper_defined?
+      Object.const_defined?("Flipper")
+    end
+
+    def process_activation_option(flipper_activation)
+      return "disabled" if flipper_activation == "disabled"
+      "enabled"
+    end
+end

data/lib/abraham/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Abraham
-  VERSION = "2.5.0"
+  VERSION = "2.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abraham
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Jonathan Abbett
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2023-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sassc-rails
@@ -96,6 +96,7 @@ files:
 - app/assets/stylesheets/abraham/theme-default.scss
 - app/controllers/abraham_histories_controller.rb
 - app/helpers/abraham_helper.rb
+- app/helpers/flipper_helper.rb
 - app/models/abraham_history.rb
 - app/models/application_record.rb
 - app/views/application/_abraham.html.erb
@@ -130,7 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubyforge_project:
+rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
 summary: Trackable application tours for Rails with i18n support, based on Shepherd.js.