abraham 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b75864d476b103f987bcfebba3192a4b3c646970
-  data.tar.gz: 60b54906c18bc75b0afe2fb5131fd31bd6a9fd39
+  metadata.gz: 1b983847ab3547066ba7f7093e4a4a61fdb3c9e8
+  data.tar.gz: c810cbc464ae2790a328dfd47e37d01b40289b34
 SHA512:
-  metadata.gz: 56d6c9a0fd49be1354d182a083ea29504051092bd362303d32b2bb47f9cbadef71abc3e5e0d33999a2346533d2a01854bac07bd08a095ffa8d566273c9c96416
-  data.tar.gz: 17abb8e5732b9f48c67459fdfeb3b99a1acbcc483a9240ae78af7c1d4c3d7592c90385c2a0bf1f2cedd066b45ef12ce21899cd6cfc61f6f4bc9b96f4636fa89b
+  metadata.gz: 349042bb09bd181050a618b8e1151f112be052874feb0f6045bdc745cbe89dbff05598c3186b4fc3683348d5b9b41d922de9cd07ee4ab7f8e08711ba34ea8b37
+  data.tar.gz: 8c5a44c84be0202671ada9534f3f75fe1b3061a3c6e3e77e043c34cce7d389a34cd19df001dc47284dcd9ea245322eb09c002724e17ae1b68f738cf55e21c32d

data/README.md

@@ -29,10 +29,10 @@ $ bundle install
 $ rails generate abraham:install
 ```
 
-Require Shepherd.js in `app/assets/javascripts/application.js`
+Require `abraham` in `app/assets/javascripts/application.js`
 
 ```
-//= require shepherd.js.js
+//= require abraham
 ```
 
 Require a Shepherd.js CSS theme in `app/assets/stylesheets/application.scss`
@@ -117,3 +117,11 @@ Abraham takes care of which buttons should appear with each step:
 ### Testing your tours
 
 Abraham loads tour definitions once when you start your server. Restart your server to see tour changes.
+
+If you'd like to run JavaScript integrations tests without the Abraham tours getting in the way, clear the Abraham configuration in your test helper, e.g.
+
+```
+Rails.application.configure do
+  config.abraham.tours = {}
+end
+```

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

@@ -0,0 +1,10 @@
+//= require jquery
+//= require jquery_ujs
+//= require js-cookie
+//= require tether
+//= require shepherd.js.js
+
+$(document).on('turbolinks:before-cache', function() {
+    // Remove visible product tours
+    $(".shepherd-step").remove();
+});

data/app/views/application/_abraham.html.erb

@@ -20,6 +20,10 @@
     });
   });
 
+  tour.on("cancel", function() {
+    Cookies.set('abraham-<%= controller_name %>-<%= action_name %>-<%= tour_name %>', 'later');
+  });
+
   <% steps.each_with_index do |(key, step), index| %>
   tour.addStep('step-<%= key %>', {
     <% if step.key?('title') %>
@@ -45,5 +49,8 @@
   });
   <% end %>
 
-  tour.start();
+  // Don't start the tour if the user dismissed it once this session
+  if (!Cookies.get('abraham-<%= controller_name %>-<%= action_name %>-<%= tour_name %>')) {
+    tour.start();
+  }
 </script>

data/lib/abraham/engine.rb

@@ -2,6 +2,7 @@
 require 'rubygems'
 require 'rails-assets-shepherd.js'
 require 'jquery-rails'
+require 'rails-assets-js-cookie'
 
 module Abraham
   class Engine < ::Rails::Engine

data/lib/abraham/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Abraham
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abraham
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Abbett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rails-assets-js-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +114,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Guide your users in the one true path.
+description: Trackable application tours for Rails with i18n support, based on Shepherd.js.
 email:
 - jonathan@act.md
 executables: []
@@ -110,6 +124,7 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/abraham_manifest.js
+- app/assets/javascripts/abraham/index.js
 - app/controllers/abraham_histories_controller.rb
 - app/helpers/abraham_helper.rb
 - app/models/abraham_history.rb
@@ -126,7 +141,7 @@ files:
 - lib/generators/abraham/templates/initializer.rb
 - lib/generators/abraham/templates/migration.rb
 - lib/tasks/abraham_tasks.rake
-homepage: http://getabraham.com
+homepage: https://github.com/actmd/abraham
 licenses:
 - MIT
 metadata: {}
@@ -149,5 +164,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Trackable application tours for Rails with i18n support.
+summary: Trackable application tours for Rails with i18n support, based on Shepherd.js.
 test_files: []