abraham 1.3 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b64ecd0b2e348f910b5fa5f84e0e28643359bbbb
-  data.tar.gz: 5ee3ad828fc7d5181c15673a04f7092d110fb236
+SHA256:
+  metadata.gz: ca52c3a0aa0f4083eef1a33a1099d4e38daeab9356d7a4b627431c4946fc3909
+  data.tar.gz: cf910c06b3e50bd1a99e33caac9521da5483f521cf31aa2521e499d3b9868e8a
 SHA512:
-  metadata.gz: 037376d74be78e2262aad9fc1f0a6fe2b757097c4d9a6300863eb37f723b83c2e334f9277cf6233295ef1085e11d096f2ab0c56cfd1dfca43ffbedf59983b114
-  data.tar.gz: 075ef3d394aa0b30112e310f35663b3a6a701fee01f531a189f580e8120f7d0171ab0e66801555043da8f330bef91fd2e1f363326916508056a629b83f785fec
+  metadata.gz: 8982797ad163a2cd6e06d65ce1beacb97817ab2da56805bac8d39812f3c791777e0c079e8b61d3835e4f94dc13d88b23f1adc2b1ba8d9b972d574819c0f56d89
+  data.tar.gz: fa2b12411cde48ab87068e9cf5c038f9630777520bf23f9876a68a9c38ef55ed2c0136a845cb5f89a59cba68e489e102fbf85ad660ace22315b971da7b4f8c5d

data/README.md

@@ -16,22 +16,25 @@ Abraham needs to know the current user to track tour views, e.g. `current_user`
 
 ## Installation
 
-Add `abraham` and its JavaScript dependencies to your Gemfile:
+Add `abraham` to your Gemfile:
 
 ```
 gem 'abraham'
 
-source 'https://rails-assets.org' do
-  gem 'rails-assets-shepherd.js', '~> 1.8'
-  gem 'rails-assets-js-cookie', '~> 2.1'
-end
 ```
 
-Then run:
+Install the gem and run the installer:
 
 ```
 $ bundle install
 $ rails generate abraham:install
+$ rails db:migrate
+```
+
+Install the JavaScript dependencies:
+
+```
+$ yarn add jquery js-cookie shepherd.js
 ```
 
 Require `abraham` in `app/assets/javascripts/application.js`

data/Rakefile

@@ -1,33 +1,34 @@
 # frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Abraham'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Abraham"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
-load 'rails/tasks/engine.rake'
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

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

@@ -1,8 +1,6 @@
 //= require jquery
-//= require jquery_ujs
-//= require js-cookie
-//= require tether
-//= require shepherd.js.js
+//= require js-cookie/src/js.cookie
+//= require shepherd.js/dist/js/shepherd
 
 $(document).on('turbolinks:before-cache', function() {
     // Remove visible product tours

data/app/controllers/abraham_histories_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class AbrahamHistoriesController < ApplicationController
   def create
     @abraham_history = AbrahamHistory.new(abraham_history_params)
@@ -14,8 +15,8 @@ class AbrahamHistoriesController < ApplicationController
 
   private
 
-  # Never trust parameters from the scary internet, only allow the white list through.
-  def abraham_history_params
-    params.require(:abraham_history).permit(:controller_name, :action_name, :tour_name)
-  end
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def abraham_history_params
+      params.require(:abraham_history).permit(:controller_name, :action_name, :tour_name)
+    end
 end

data/app/helpers/abraham_helper.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
+
 module AbrahamHelper
   def abraham_tour
     # Do we have tours for this controller/action in the user's locale?
     tours = Rails.configuration.abraham.tours["#{controller_name}.#{action_name}.#{I18n.locale}"]
 
-    unless tours
-      # How about the default locale?
-      tours = Rails.configuration.abraham.tours["#{controller_name}.#{action_name}.#{I18n.default_locale}"]
-    end
+    tours ||= Rails.configuration.abraham.tours["#{controller_name}.#{action_name}.#{I18n.default_locale}"]
 
     if tours
       completed = AbrahamHistory.where(
@@ -19,10 +17,18 @@ module AbrahamHelper
 
       if remaining.any?
         # Generate the javascript snippet for the next remaining tour
-        render(partial: 'application/abraham',
+        render(partial: "application/abraham",
                locals: { tour_name: remaining.first,
-                         steps: tours[remaining.first]['steps'] })
+                         steps: tours[remaining.first]["steps"] })
       end
     end
   end
+
+  def abraham_cookie_prefix
+    "abraham-#{Rails.application.class.parent.to_s.underscore}-#{current_user.id}-#{controller_name}-#{action_name}"
+  end
+
+  def abraham_domain
+    request.host
+  end
 end

data/app/models/abraham_history.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
+
 class AbrahamHistory < ActiveRecord::Base
 end

data/app/models/application_record.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 end

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

@@ -13,6 +13,7 @@
       dataType: "json",
       contentType: "application/json",
       data: JSON.stringify({
+        authenticity_token: '<%= form_authenticity_token %>',
         controller_name: '<%= controller_name %>',
         action_name: '<%= action_name %>',
         tour_name: '<%= tour_name %>'
@@ -21,7 +22,7 @@
   });
 
   tour.on("cancel", function() {
-    Cookies.set('abraham-<%= controller_name %>-<%= action_name %>-<%= tour_name %>', 'later');
+    Cookies.set('<%= abraham_cookie_prefix %>-<%= tour_name %>', 'later', { domain: '<%= abraham_domain %>' });
   });
 
   <% steps.each_with_index do |(key, step), index| %>
@@ -54,7 +55,7 @@
   <% end %>
 
   // Don't start the tour if the user dismissed it once this session
-  if (!Cookies.get('abraham-<%= controller_name %>-<%= action_name %>-<%= tour_name %>')) {
+  if (!Cookies.get('<%= abraham_cookie_prefix %>-<%= tour_name %>', { domain: '<%= abraham_domain %>' })) {
     tour.start();
   }
 </script>

data/config/routes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Rails.application.routes.draw do
   resources :abraham_histories, only: :create
 end

data/lib/abraham.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'abraham/engine'
+
+require "abraham/engine"
 
 module Abraham
 end

data/lib/abraham/engine.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-require 'rubygems'
+
+require "rubygems"
 
 module Abraham
   class Engine < ::Rails::Engine
-    require 'rails-assets-shepherd.js'
-    require 'jquery-rails'
-    require 'rails-assets-js-cookie'
   end
 end

data/lib/abraham/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Abraham
-  VERSION = '1.3'
+  VERSION = "1.4"
 end

data/lib/generators/abraham/install_generator.rb

@@ -1,27 +1,30 @@
 # frozen_string_literal: true
-require 'rails/generators'
-require 'rails/generators/active_record'
+
+require "rails/generators"
+require "rails/generators/active_record"
 
 module Abraham
   module Generators
     class InstallGenerator < ActiveRecord::Generators::Base
-      argument :name, type: :string, default: 'random_name'
+      argument :name, type: :string, default: "random_name"
 
       class_option :'skip-migration', type: :boolean, desc: "Don't generate a migration for the histories table"
       class_option :'skip-initializer', type: :boolean, desc: "Don't generate an initializer"
 
-      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      source_root File.expand_path(File.join(File.dirname(__FILE__), "templates"))
 
       # Copies the migration template to db/migrate.
       def copy_files
-        return if options['skip-migration']
-        migration_template 'migration.rb', 'db/migrate/create_abraham_histories.rb'
+        return if options["skip-migration"]
+
+        migration_template "migration.rb", "db/migrate/create_abraham_histories.rb"
       end
 
       def create_initializer
-        return if options['skip-initializer']
-        copy_file 'initializer.rb', 'config/initializers/abraham.rb'
-        copy_file 'abraham.yml', 'config/abraham.yml'
+        return if options["skip-initializer"]
+
+        copy_file "initializer.rb", "config/initializers/abraham.rb"
+        copy_file "abraham.yml", "config/abraham.yml"
       end
     end
   end

data/lib/generators/abraham/templates/initializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Rails.application.configure do
   tours = {}
 

data/lib/generators/abraham/templates/migration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class CreateAbrahamHistories < ActiveRecord::Migration[5.0]
   def change
     create_table :abraham_histories do |t|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abraham
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
 platform: ruby
 authors:
 - Jonathan Abbett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,42 +16,22 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.1
-- !ruby/object:Gem::Dependency
-  name: sass-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,35 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails-assets-shepherd.js
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: rails-assets-js-cookie
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -161,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Trackable application tours for Rails with i18n support, based on Shepherd.js.