abraham 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 934942f3a067c17e06029f1095f7abf5b570d5e7b63a8d16601769df4d3300e1
-  data.tar.gz: 2389400109634350208fff528edf7c70577982677f34e8af9ef84dcb49aa9d5a
+  metadata.gz: d6094c0e5929d5da7e61f12bd1e60a11e450a05e2c3b99afc349b0b7d847edca
+  data.tar.gz: 2b6df2f7d73f7b0c312b13ca3bc5adf16452437f1fd97faea90468093193f5fa
 SHA512:
-  metadata.gz: ec5c02fcd3b19038b65b9a3af6ce3d84f585c47e465a914021d05a18c340665fb1891fb590fb76b332a05eb5d7e6736e89aba9e854cf94ad0acb921c4cc623ce
-  data.tar.gz: c00a73dfe7269459459fadaa4db889de665ec0601273fa431d94372cf38383e4f0a5c1b5959fbf0a7f5ea681fb149948dadc2ec4670e09941b54356979500274
+  metadata.gz: 978175580bd5132ea570ea0c14421f6ac0def8ca523ce5dfea730c3934c49180c6f9909fd35f161190afddf02aade22c9d447cb74546c419d8cd143e77129d3e
+  data.tar.gz: 9c46128409adfc46ed76abe7f07601d4e5035c63641c13e50b747e51a2e532910326ed77f63f7b2406feb4f5930feb8dbdbe10e5b660f858409f1ce7cf8f186c

data/README.md

@@ -15,7 +15,8 @@ Abraham injects dynamically-generated [Shepherd](https://shepherdjs.dev/) JavaSc
 
 ## Requirements
 
-Abraham needs to know the current user to track tour views, e.g. `current_user` from Devise.
+* Abraham needs to know the current user to track tour views, e.g. `current_user` from Devise.
+* Abraham is tested on Rails 5.2, 6.0, and 6.1
 
 ## Installation
 
@@ -95,7 +96,7 @@ NB: You must specify a locale in the filename, even if you're only supporting on
 
 ### Tour content
 
-A tour is composed of a series of steps. A step may have a title and must have a description. You may attach a step to a particular element on the page, and place the callout to the left, right, top, or bottom.
+A tour is composed of a series of steps. A step may have a title and must have a description. You may attach a step to a particular element on the page, and place the callout in a particular position (see below).
 
 ```yaml
 intro:
@@ -122,6 +123,18 @@ Abraham takes care of which buttons should appear with each step:
 * "Exit" and "Next" buttons on intermediate steps
 * "Done" button on the last step
 
+When you specify an `attachTo` element, use the `placement` option to choose where the callout should appear relative to that element:
+
+* `bottom` / `bottom center`
+* `bottom left`
+* `bottom right`
+* `center` / `middle` / `middle center`
+* `left` / `middle left'
+* `right` / `middle right`
+* `top` / `top center`
+* `top left`
+* `top right`
+
 Abraham tries to be helpful when your tour steps attach to page elements that are missing:
 
 * If your first step is attached to a particular element, and that element is not present on the page, the tour won't start. ([#28](https://github.com/actmd/abraham/issues/28))
@@ -161,10 +174,26 @@ If you have any trouble at all, please [submit an issue](https://github.com/actm
 
 Contributions are welcome!
 
-Create a feature branch (using git-flow) and submit as a pull request.
+Create a feature branch (using git-flow) and submit as a pull request (with a base branch of `develop`).
 
 Everyone interacting in Abraham's codebase, issue tracker, etc. is expected to follow the [Contributor Covenent Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct).
 
+### Getting started with the source code
+
+Abraham uses `rvm` with a gemset to ensure the appropriate version of Ruby and its dependencies. Make sure that's installed before you get started.
+
+```
+~ git clone git@github.com:actmd/abraham.git
+Cloning into 'abraham'...
+~ cd abraham
+ruby-2.5.3 - #gemset created /Users/jon/.rvm/gems/ruby-2.5.3@abraham
+ruby-2.5.3 - #generating abraham wrappers - please wait
+~ bundle install
+Bundle complete! 13 Gemfile dependencies, 73 gems now installed.
+Use `bundle info [gemname]` to see where a bundled gem is installed.
+~ yarn install
+```
+
 ### Testing
 
 #### Testing locally
@@ -183,7 +212,7 @@ gem 'abraham', path: '~/Workspace/abraham'
 
 #### Automated testing
 
-We use TravisCI to automatically test this engine with Rails 5.1, 5.2, and 6.0. For test history, venture over to [TravisCI](https://travis-ci.com/actmd/abraham).
+We use TravisCI to automatically test this engine with Rails 5.2, 6.0, and 6.1. For test history, venture over to [TravisCI](https://travis-ci.com/actmd/abraham).
 
 ### Releasing
 

data/Rakefile

@@ -26,10 +26,10 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "lib"
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"
   t.verbose = false
+  t.warning = false 
 end
 
 task default: :test

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

@@ -1,8 +1,7 @@
-//= require jquery
 //= require js-cookie/src/js.cookie
 //= require shepherd.js/dist/js/shepherd
 
-$(document).on('turbolinks:before-cache', function() {
-    // Remove visible product tours
-    $(".shepherd-step").remove();
+document.addEventListener('turbolinks:before-cache', function() {
+  // Remove visible product tours
+  document.querySelectorAll(".shepherd-element").forEach(function(el) { el.remove() });
 });

data/app/controllers/abraham_histories_controller.rb

@@ -15,7 +15,6 @@ 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

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

@@ -2,13 +2,11 @@
   var tour = new Shepherd.Tour(<%= Rails.configuration.abraham.tour_options.html_safe unless Rails.configuration.abraham.tour_options.nil? %>);
 
   tour.on("complete", function() {
-    // ajax
-    return $.ajax({
-      url: "/abraham_histories/",
-      type: "POST",
-      dataType: "json",
-      contentType: "application/json",
-      data: JSON.stringify({
+    // Make AJAX call to save history of tour completion
+    return fetch("/abraham_histories/", {
+      method: "POST",
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
         authenticity_token: '<%= form_authenticity_token %>',
         controller_name: '<%= controller_name %>',
         action_name: '<%= action_name %>',

data/lib/abraham/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abraham
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Jonathan Abbett
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sassc-rails
@@ -115,7 +115,7 @@ homepage: https://github.com/actmd/abraham
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -130,9 +130,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Trackable application tours for Rails with i18n support, based on Shepherd.js.
 test_files: []