fixed user id field that default creates is as integer whilst we us uuid

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>

.ruby-gemset

@@ -1 +1 @@
-abraham
+walter

.ruby-version

@@ -1 +1 @@
-2.5.3
+2.6.5

.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-
-env:
-  - 'RAILS_VERSION=5.1'
-  - 'RAILS_VERSION=5.2'
-  - 'RAILS_VERSION=6.0'
-
-before_script:
-  - 'yarn'
-  - 'bundle install'
-  - 'RAILS_ENV=test bundle exec rake db:create'
-  - 'RAILS_ENV=test bundle exec rake db:migrate'
-
-script: 'RAILS_ENV=test bundle exec rails test'

Gemfile

@@ -11,7 +11,7 @@ end
 rails_version = ENV['RAILS_VERSION'] || 'default'
 rails = case rails_version
         when 'default'
-          '~> 5.1'
+          '~> 5.2'
         when 'master'
           {github: 'rails/rails'}
         else
@@ -19,7 +19,7 @@ rails = case rails_version
         end
 gem 'rails', rails
 
-# Declare your gem's dependencies in abraham.gemspec.
+# Declare your gem's dependencies in walter.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
 gemspec
@@ -32,6 +32,10 @@ gemspec
 # To use a debugger
 # gem 'byebug', group: [:development, :test]
 
+group :development, :test do
+  gem 'turbolinks'
+end
+
 group :test do
   # Adds support for Capybara system testing and selenium driver
   gem 'capybara', '>= 2.15'

README.md

@@ -1,28 +1,34 @@
-# Abraham
+# Walter
 
-[![Build Status](https://travis-ci.com/actmd/abraham.svg?branch=master)](https://travis-ci.com/actmd/abraham)
+[![Build Status](https://travis-ci.com/actmd/walter.svg?branch=master)](https://travis-ci.com/actmd/walter)
 
-_Guide your users in the one true path._
-
-![Watercolor Sheep](https://upload.wikimedia.org/wikipedia/commons/e/e4/Watercolor_Sheep_Drawing.jpg)
-
-Abraham injects dynamically-generated [Shepherd](https://shepherdjs.dev/) JavaScript code into your Rails application whenever a user should see a guided tour. Skip a tour, and we'll try again next time; complete a tour, and it won't show up again.
+<p align="center">
+<i>Product tours like a badass.</i>
+<br/>
+<img src="https://img.icons8.com/doodle/240/000000/walter-white.png"/>
+<br/>
+<a style='font-size: 12px;' href="https://icons8.com/icon/5iWNvQRbAKx9/walter-white">Walter White icon by Icons8</a>
+</p>
+Walter makes it easy to show guided tours to users of your Rails application. When Walter shows a tour, it keeps track of whether the user has completed it (so it doesn't get shown again) or dismissed it for later (so it reappears in a future user session).
 
 * Define tour content with simple YAML files, in any/many languages.
 * Organize tours by controller and action.
-* Plays nicely with Turbolinks.
-* Ships with two basic CSS themes (default & dark) -- or write your own
+* Trigger tours automatically on page load or manually via JavaScript method.
+* Built with the [Shepherd JS](https://shepherdjs.dev/) library. Plays nicely with Turbolinks.
+* Ships with two basic CSS themes (default & dark) — or write your own
+* Show video/html content in your 
 
 ## Requirements
 
-Abraham needs to know the current user to track tour views, e.g. `current_user` from Devise.
+* Walter needs to know the current user to track tour views, e.g. `current_user` from Devise.
+* Walter is tested on Rails 5.2, 6.0, and 6.1
 
 ## Installation
 
-Add `abraham` to your Gemfile:
+Add `walter` to your Gemfile:
 
 ```
-gem 'abraham'
+gem 'walter'
 
 ```
 
@@ -30,34 +36,34 @@ Install the gem and run the installer:
 
 ```
 $ bundle install
-$ rails generate abraham:install
+$ rails generate walter:install
 $ rails db:migrate
 ```
 
 Install the JavaScript dependencies:
 
 ```
-$ yarn add jquery@^3.4.0 js-cookie@^2.2.0 shepherd.js@^6.0.0-beta
+$ yarn add js-cookie@^2.2.0 shepherd.js@^6.0.0-beta
 ```
 
-Require `abraham` in `app/assets/javascripts/application.js`
+Require `walter` in `app/assets/javascripts/application.js`
 
 ```
-//= require abraham
+//= require walter
 ```
 
 Require a CSS theme in `app/assets/stylesheets/application.scss`
 
 ```
-*= require abraham/theme-default
+*= require walter/theme-default
 ```
 
-Abraham provides the following themes:
+Walter provides the following themes:
 
 - `theme-default`
 - `theme-dark`
 
-Update `config/abraham.yml` if you choose a different theme:
+Update `config/walter.yml` if you choose a different theme:
 
 ```
 defaults: &defaults
@@ -66,22 +72,25 @@ defaults: &defaults
 
 You can also [write your own Shepherd theme](https://shepherdjs.dev/docs/tutorial-03-styling.html) based on Shepherd's [default CSS](https://github.com/shipshapecode/shepherd/releases/download/v6.0.0-beta.1/shepherd.css).
 
-Tell Abraham where to insert its generated JavaScript in `app/views/layouts/application.html.erb`, just before the closing `body` tag:
+Tell Walter where to insert its generated JavaScript in `app/views/layouts/application.html.erb`, just before the closing `body` tag:
 
 ```erb
-<%= abraham_tour %>
+<%= walter_tour %>
 </body>
 </html>
 ```
 
 ## Defining your tours
 
-Define your tours in the `config/tours` directory. Its directory structure should mirror your application's controllers, and the tour files should mirror your actions/views.
+Define your tours in the `app/tours` directory corresponding to the views defined in your application. Its directory structure mirrors your application's controllers, and the tour files mirror your actions/views. (As of version 2.4.0, Walter respects controllers organized into modules.)
 
 ```
-config/
+app/
 └── tours/
-    └── blog/
+    ├── admin/
+    │   └── articles/  
+    │       └── edit.en.yml    
+    ├── blog/
     │   ├── show.en.yml
     │   └── show.es.yml    
     └── articles/
@@ -91,11 +100,15 @@ config/
         └── show.es.yml
 ```
 
-NB: You must specify a locale in the filename, even if you're only supporting one language.
+For example, per above, when a Spanish-speaking user visits `/articles/`, they'll see the tours defined by `config/tours/articles/index.es.yml`.
+
+(Note: You must specify a locale in the filename, even if you're only supporting one language.)
 
 ### 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.
+Within a tour file, each tour is composed of a series of **steps**. A step may have a `title` and must have `text`. You may attach a step to a particular element on the page, and place the callout in a particular position.
+
+In this example, we define a tour called "intro" with 3 steps:
 
 ```yaml
 intro:
@@ -116,92 +129,71 @@ intro:
         placement: "bottom"
 ```
 
-Abraham takes care of which buttons should appear with each step:
+Walter takes care of which buttons should appear with each step:
 
 * "Later" and "Continue" buttons on the first step
-* "Exit" and "Next" buttons on intermediate steps
+* "Exit", "Back" and "Continue" 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`
+
+Walter 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/walter/issues/28))
+* If your tour has an intermediate step attached to a missing element, Walter will skip that step and automatically show the next. ([#6](https://github.com/actmd/walter/issues/6))
+
+### Automatic vs. manual tours
+
+By default, Walter will automatically start a tour that the current user hasn't seen yet.
+You can instead define a tour to be triggered manually using the `trigger` option:
+
+```yml
+walkthrough:
+  trigger: "manual"
+  steps:
+    1:
+      text: "This walkthrough will show you how to..."
+```
+
+This tour will not start automatically; instead, use the `Walter.startTour` method with the tour name:
+
+```
+<button id="startTour">Start tour</button>
+
+<script>
+  document.querySelector("#startTour").addEventListener("click", function() {
+    Walter.startTour("walkthrough"));
+  });
+</script>
+```
+
+...or if you happen to use jQuery:
+
+```
+<script>
+  $("#startTour").on("click", function() { Walter.startTour('walkthrough'); })
+</script>
+```
+
 ### Testing your tours
 
-Abraham loads tour definitions once when you start your server. Restart your server to see tour changes.
+Walter 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.
+If you'd like to run JavaScript integrations tests without the Walter tours getting in the way, clear the Walter configuration in your test helper, e.g.
 
 ```
 Rails.application.configure do
-  config.abraham.tours = {}
+  config.walter.tours = {}
 end
 ```
 
-## Upgrading from version 1
-
-Abraham v1 was built using Shepherd 1.8, v2 now uses Shepherd 6 -- quite a jump, yes.
-
-If you were using Abraham v1, you'll want to take the following steps to upgrade:
-
-1. Update your gem to the latest version
-1. Fix your yarn dependencies to use the right versions
-1. Shepherd no longer provides a set of themes. Abraham maintains two of the legacy themes: default and dark. You'll want to choose one of those or migrate your theme to the new Shepherd structure.
-1. Abraham now exposes the entire Shepherd configuration object, so your `abraham.yml` file should now fully define the `tour_options` value instead of `default_theme`
-1. There's been a slight change to `initializers/abraham.rb`. You can just change line 22 to:
-
-```rb
-config.abraham.tour_options = abraham_config[:tour_options]
-```
-
-If you have any trouble at all, please [submit an issue](https://github.com/actmd/abraham/issues) for assistance!
-
-## Contributing
-
-Contributions are welcome!
-
-Create a feature branch (using git-flow) and submit as a pull request.
-
-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).
-
-### Testing
-
-#### Testing locally
-
-This Rails engine contains a test app called `dummy` with controller and system tests. They'll all get run with `rails t`.
-
-Please note that if you change anything in the `lib/generators` folder (i.e. configuration, intializer, migration) you'll need to migrate the `dummy` app accordingly.
-
-Final testing should be done in a standalone Rails app, following the README instructions.
-
-To install the `abraham` gem with a local path:
-
-```
-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).
-
-### Releasing
-
-Create a git-flow release:
-
-```
-$ git flow release start VERSION_NUMBER
-```
-
-Edit `lib/abraham/version.rb` and increase the version number.
-
-Build the gem and push to Rubygems:
-
-```
-$ rake build
-$ gem push pkg/abraham-VERSION_NUMBER.gem
-```
-
-Finish the git-flow release and push to GitHub:
-
-```
-$ git flow release finish
-$ git push origin develop
-$ git push origin master
-$ git push --tags
-```

Rakefile

@@ -10,7 +10,7 @@ require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "Abraham"
+  rdoc.title    = "Walter"
   rdoc.options << "--line-numbers"
   rdoc.rdoc_files.include("README.md")
   rdoc.rdoc_files.include("lib/**/*.rb")
@@ -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

app/assets/javascripts/abraham/index.js

@@ -1,8 +0,0 @@
-//= 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();
-});

app/assets/javascripts/walter/index.js

@@ -0,0 +1,28 @@
+//= require js-cookie/src/js.cookie
+//= require shepherd.js/dist/js/shepherd
+
+var Walter = new Object();
+
+Walter.tours = {};
+Walter.incompleteTours = [];
+Walter.startTour = function(tourName) {
+  if (!Shepherd.activeTour) {
+  	setTimeout(function(){Walter.tours[tourName].start()}, 300);
+  }
+};
+Walter.startNextIncompleteTour = function() {
+  if (Walter.incompleteTours.length) {
+  	Walter.tours[Walter.incompleteTours[0]].checkAndStart();
+  }
+};
+
+document.addEventListener("DOMContentLoaded", Walter.startNextIncompleteTour);
+document.addEventListener("turbolinks:load", Walter.startNextIncompleteTour);
+
+document.addEventListener('turbolinks:before-cache', function() {
+  // Remove visible product tours
+  document.querySelectorAll(".shepherd-element").forEach(function(el) { el.remove() });
+  // Clear Walter data
+  Walter.tours = {};
+  Walter.incompleteTours = [];
+});

app/assets/stylesheets/walter/_common.scss

@@ -79,7 +79,7 @@
   border-top-right-radius: 5px;
   display: flex;
   justify-content: flex-end;
-  padding: 0.5rem 1rem 0;
+  padding: 0.5rem 0rem 0;
 }
 
 .shepherd-has-title .shepherd-content .shepherd-header {
@@ -108,7 +108,7 @@
 .shepherd-element {
   border-radius: 5px;
   box-shadow: 0 1px 4px rgba(0, 0, 0, .2);
-  max-width: 400px;
+  //max-width: 600px;
   outline: none;
   z-index: 9999;
   line-height: 1.2;

app/assets/stylesheets/walter/shepherd.css

@@ -0,0 +1,117 @@
+.shepherd-button:hover {
+    background: #16202D;
+    color: #ffffff;
+}
+
+.shepherd-button.shepherd-button-secondary {
+    background: #CAD5D5;
+}
+
+.shepherd-button.shepherd-button-secondary:hover {
+    color: #CAD5D5;
+    background: #16202D;
+}
+
+.shepherd-cancel-icon {
+    font-family: "GT Pressura", sans-serif;
+}
+
+.shepherd-element {
+    border: solid 4px #16202D;
+}
+
+.shepherd-element,
+.shepherd-header,
+.shepherd-footer {
+    border-radius: 0;
+}
+
+.shepherd-element .shepherd-arrow {
+    border-width: 0;
+    height: auto;
+    width: auto;
+}
+
+.shepherd-arrow::before {
+    display: none;
+}
+
+.shepherd-element .shepherd-arrow:after {
+    content: url('../assets/img/arrow.svg');
+    display: inline-block;
+}
+
+.shepherd-element[data-popper-placement^='top'] .shepherd-arrow,
+.shepherd-element.shepherd-pinned-top .shepherd-arrow {
+    bottom: -35px;
+}
+
+.shepherd-element[data-popper-placement^='top'] .shepherd-arrow:after,
+.shepherd-element.shepherd-pinned-top .shepherd-arrow:after {
+    transform: rotate(270deg);
+}
+
+.shepherd-element[data-popper-placement^='bottom'] .shepherd-arrow {
+    top: -35px;
+}
+
+.shepherd-element[data-popper-placement^='bottom'] .shepherd-arrow:after {
+    transform: rotate(90deg);
+}
+
+.shepherd-element[data-popper-placement^='left'] .shepherd-arrow,
+.shepherd-element.shepherd-pinned-left .shepherd-arrow {
+    right: -35px;
+}
+
+.shepherd-element[data-popper-placement^='left'] .shepherd-arrow:after,
+.shepherd-element.shepherd-pinned-left .shepherd-arrow:after {
+    transform: rotate(180deg);
+}
+
+.shepherd-element[data-popper-placement^='right'] .shepherd-arrow,
+.shepherd-element.shepherd-pinned-right .shepherd-arrow {
+    left: -35px;
+}
+
+.shepherd-footer {
+    padding: 0;
+}
+
+.shepherd-footer button:not(:last-of-type) {
+    border-right: solid 4px #16202D;
+}
+
+.shepherd-has-title .shepherd-content .shepherd-cancel-icon {
+    margin-top: -7px;
+}
+
+.shepherd-has-title .shepherd-content .shepherd-header {
+    background: transparent;
+    font-family: "GT Pressura", sans-serif;
+    padding-bottom: 0;
+    padding-left: 2rem;
+}
+
+.shepherd-has-title .shepherd-content .shepherd-header .shepherd-title {
+    font-size: 1.2rem;
+    text-transform: uppercase;
+}
+
+.shepherd-text {
+    font-size: 1.2rem;
+    padding: 2rem;
+}
+
+.shepherd-text a, .shepherd-text a:visited,
+.shepherd-text a:active {
+    border-bottom: 1px dotted;
+    border-bottom-color: rgba(0, 0, 0, 0.75);
+    color: rgba(0, 0, 0, 0.75);
+    text-decoration: none;
+}
+
+.shepherd-text a:hover, .shepherd-text a:visited:hover,
+.shepherd-text a:active:hover {
+    border-bottom-style: solid;
+}

app/controllers/abraham_histories_controller.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-class AbrahamHistoriesController < ApplicationController
-  def create
-    @abraham_history = AbrahamHistory.new(abraham_history_params)
-    @abraham_history.creator_id = current_user.id
-    respond_to do |format|
-      if @abraham_history.save
-        format.json { render json: @abraham_history, status: :created }
-      else
-        format.json { render json: @abraham_history.errors, status: :unprocessable_entity }
-      end
-    end
-  end
-
-  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
-end

app/controllers/walter_histories_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class WalterHistoriesController < ApplicationController
+  def create
+    @walter_history = WalterHistory.new(walter_history_params)
+    @walter_history.creator_id = current_user.id
+    respond_to do |format|
+      if @walter_history.save
+        format.json { render json: @walter_history, status: :created }
+      else
+        format.json { render json: @walter_history.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  private
+
+    def walter_history_params
+      params.require(:walter_history).permit(:controller_name, :action_name, :tour_name)
+    end
+end

app/helpers/abraham_helper.rb

@@ -1,34 +0,0 @@
-# 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}"]
-
-    tours ||= Rails.configuration.abraham.tours["#{controller_name}.#{action_name}.#{I18n.default_locale}"]
-
-    if tours
-      completed = AbrahamHistory.where(
-        creator_id: current_user.id,
-        controller_name: controller_name,
-        action_name: action_name
-      )
-      remaining = tours.keys - completed.map(&:tour_name)
-
-      if remaining.any?
-        # Generate the javascript snippet for the next remaining tour
-        render(partial: "application/abraham",
-               locals: { tour_name: remaining.first,
-                         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

app/helpers/walter_helper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module WalterHelper
+  def walter_tour
+    # Do we have tours for this controller/action in the user's locale?
+    tours = Walter.tours["#{controller_path}.#{action_name}.#{I18n.locale}"]
+    # Otherwise, default to the default locale
+    tours ||= Walter.tours["#{controller_path}.#{action_name}.#{I18n.default_locale}"]
+
+    if tours
+      # Have any automatic tours been completed already?
+      completed = WalterHistory.where(
+        creator_id: current_user.id,
+        controller_name: controller_path,
+        action_name: action_name
+      )
+
+      tour_keys_completed = completed.map(&:tour_name)
+      tour_keys = tours.keys
+
+      tour_html = ''
+
+      tour_keys.each do |key|
+        tour_html += (render(partial: "application/shepherd",
+               locals: { tour_name: key,
+                         tour_completed: tour_keys_completed.include?(key),
+                         trigger: tours[key]["trigger"],
+                         tour_delay: tours[key]['delay']||500,
+                         steps: tours[key]["steps"] }))
+      end
+      tour_html.html_safe
+    end
+  end
+
+  def walter_cookie_prefix
+    "walter-#{fetch_application_name.to_s.underscore}-#{current_user.id}-#{controller_path}-#{action_name}"
+  end
+
+  def fetch_application_name
+    if Module.method_defined?(:module_parent)
+      Rails.application.class.module_parent
+    else
+      Rails.application.class.parent
+    end
+  end
+
+  def walter_domain
+    request.host
+  end
+end

app/models/abraham_history.rb

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

app/models/walter_history.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class WalterHistory < ActiveRecord::Base
+end

app/views/application/_abraham.html.erb

@@ -1,58 +0,0 @@
-<script>
-  const 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({
-        authenticity_token: '<%= form_authenticity_token %>',
-        controller_name: '<%= controller_name %>',
-        action_name: '<%= action_name %>',
-        tour_name: '<%= tour_name %>'
-      })
-    });
-  });
-
-  tour.on("cancel", function() {
-    Cookies.set('<%= abraham_cookie_prefix %>-<%= tour_name %>', 'later', { domain: '<%= abraham_domain %>' });
-  });
-
-  <% steps.each_with_index do |(key, step), index| %>
-  tour.addStep({
-    id: 'step-<%= key %>',
-    <% if step.key?('title') %>
-    title: "<%= step['title'] %>",
-    <% end %>
-    text: "<%= step['text'] %>",
-    <% if step.key?('attachTo') %>
-    attachTo: { element: "<%= step['attachTo']['element'] %>", on: "<%= step['attachTo']['placement'] %>" },
-    showOn: function() {
-      // Only display this step if its selector is present
-      return document.querySelector("<%= step['attachTo']['element'] %>") ? true : false
-    },
-    <% end %>
-    buttons: [
-    <% if index == 0 %>
-      { text: '<%= t('abraham.later') %>', action: tour.cancel, classes: 'shepherd-button-secondary' },
-      { text: '<%= t('abraham.continue') %>', action: tour.next }
-    <% else %>
-        <% if index == steps.size - 1 %>
-      { text: '<%= t('abraham.done') %>', action: tour.complete }
-        <% else %>
-      { text: '<%= t('abraham.exit') %>', action: tour.cancel, classes: 'shepherd-button-secondary' },
-      { text: '<%= t('abraham.next') %>', action: tour.next }
-        <% end %>
-    <% end %>
-    ]
-  });
-  <% end %>
-
-  // Don't start the tour if the user dismissed it once this session
-  if (!Cookies.get('<%= abraham_cookie_prefix %>-<%= tour_name %>', { domain: '<%= abraham_domain %>' })) {
-    tour.start();
-  }
-</script>

app/views/application/_shepherd.html.erb

@@ -0,0 +1,77 @@
+<script>
+  Walter.tours["<%= tour_name %>"] = new Shepherd.Tour(<%= Rails.configuration.walter.tour_options.html_safe unless Rails.configuration.walter.tour_options.nil? %>);
+
+  <% if trigger != 'manual' %>
+  Walter.tours["<%= tour_name %>"].on("complete", function() {
+    // Make AJAX call to save history of tour completion
+    return fetch("/walter_histories/", {
+      method: "POST",
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify({
+        authenticity_token: '<%= form_authenticity_token %>',
+        controller_name: '<%= controller_path %>',
+        action_name: '<%= action_name %>',
+        tour_name: '<%= tour_name %>'
+      })
+    });
+  });
+
+  Walter.tours["<%= tour_name %>"].on("cancel", function() {
+    Cookies.set('<%= walter_cookie_prefix %>-<%= tour_name %>', 'later', { domain: '<%= walter_domain %>' });
+  });
+  <% end %>
+
+  <% steps.each_with_index do |(key, step), index| %>
+  Walter.tours["<%= tour_name %>"].addStep({
+    id: 'step-<%= key %>',
+    <% if step.key?('title') %>
+    title: "<%== step['title'] %>",
+    <% end %>
+    text: "<%== step['text'] %>",
+    <% if step.key?('attachTo') %>
+    attachTo: { element: "<%= step['attachTo']['element'] %>", on: "<%= step['attachTo']['placement'] %>" },
+    showOn: function() {
+      // Only display this step if its selector is present
+      return document.querySelector("<%= step['attachTo']['element'] %>") ? true : false
+    },
+    <% end %>
+    buttons: [
+    <% if index == steps.size - 1 %>
+        <% if steps.size > 1 %>
+          { text: '<%= t('walter.back') %>', action: Walter.tours["<%= tour_name %>"].back, classes: 'shepherd-button-secondary' },
+        <% end %>
+      { text: '<%= t('walter.done') %>', action: Walter.tours["<%= tour_name %>"].complete },
+    <% else %>
+      <% if index == 0 %>
+        { text: '<%= t('walter.later') %>', action: Walter.tours["<%= tour_name %>"].cancel, classes: 'shepherd-button-secondary' },
+      <% else %>
+      { text: '<%= t('walter.back') %>', action: Walter.tours["<%= tour_name %>"].back, classes: 'shepherd-button-secondary' },
+      <% end %>
+      { text: '<%= t('walter.continue') %>', action: Walter.tours["<%= tour_name %>"].next },
+    <% end %>
+    ]
+  });
+  <% end %>
+
+  <% if trigger != "manual" %>
+    Walter.tours["<%= tour_name %>"].checkAndStart = function (start) {
+      return function () {
+        // Don't start the tour if the user dismissed it once this session
+        var tourMayStart = !Cookies.get('<%= walter_cookie_prefix %>-<%= tour_name %>', {domain: '<%= walter_domain %>'});
+        <% if steps.first[1]['attachTo'] %>
+        // Don't start the tour if the first step's element is missing
+        tourMayStart = tourMayStart && document.querySelector("<%= steps.first[1]['attachTo']['element'] %>");
+        <% end %>
+        
+        if (tourMayStart) {
+          setTimeout(function(){start();}, <%= tour_delay %>); // need to delay this
+        }
+      }
+    }(Walter.tours["<%= tour_name %>"].start)
+
+    <% if !tour_completed %>
+    Walter.incompleteTours.push("<%= tour_name %>");
+    <% end %>
+  <% end %>
+
+</script>

bin/rails

@@ -5,7 +5,7 @@
 # installed from the root of your application.
 
 ENGINE_ROOT = File.expand_path("..", __dir__)
-ENGINE_PATH = File.expand_path("../lib/abraham/engine", __dir__)
+ENGINE_PATH = File.expand_path("../lib/walter/engine", __dir__)
 
 # Set up gems listed in the Gemfile.
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)

config/locales/en.yml

@@ -1,7 +1,8 @@
 en:
-  abraham:
+  walter:
     later: "Later"
     continue: "Continue"
     exit: "Exit"
     done: "Done"
     next: "Next"
+    back: "Back"

config/locales/es.yml

@@ -1,5 +1,5 @@
 es:
-  abraham:
+  walter:
     later: "Luego"
     continue: "Continuar"
     exit: "Dejar"

config/locales/fr.yml

@@ -1,5 +1,5 @@
 fr:
-  abraham:
+  walter:
     later: "Plus tard"
     continue: "Continuer"
     exit: "Quitter"

config/routes.rb

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

lib/abraham.rb

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

lib/generators/abraham/templates/initializer.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-Rails.application.configure do
-  tours = {}
-
-  if Rails.root.join('config/tours').exist?
-    Dir[Rails.root.join('config/tours/*/')].each do |dir|
-      Dir[dir + '*.yml'].each do |yml|
-        path_parts = yml.split(File::SEPARATOR)
-        controller = path_parts[path_parts.size - 2]
-        file_parts = path_parts[path_parts.size - 1].split('.')
-        action = file_parts[0]
-        locale = file_parts[1]
-        t = YAML.load_file(yml)
-        tours["#{controller}.#{action}.#{locale}"] = t
-      end
-    end
-  end
-
-  abraham_config = Rails.application.config_for :abraham
-  config.abraham = ActiveSupport::OrderedOptions.new
-  config.abraham.tour_options = abraham_config[:tour_options]
-  config.abraham.tours = tours
-end

lib/generators/walter/install_generator.rb

@@ -3,13 +3,14 @@
 require "rails/generators"
 require "rails/generators/active_record"
 
-module Abraham
+module Walter
   module Generators
     class InstallGenerator < ActiveRecord::Generators::Base
       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"
+      class_option :'skip-config', type: :boolean, desc: "Don't generate a config file"
 
       source_root File.expand_path(File.join(File.dirname(__FILE__), "templates"))
 
@@ -17,14 +18,19 @@ module Abraham
       def copy_files
         return if options["skip-migration"]
 
-        migration_template "migration.rb", "db/migrate/create_abraham_histories.rb"
+        migration_template "migration.rb", "db/migrate/create_walter_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"
+        copy_file "initializer.rb", "config/initializers/walter.rb"
+      end
+
+      def create_config
+        return if options["skip-config"]
+
+        copy_file "walter.yml", "config/walter.yml"
       end
     end
   end

lib/generators/walter/templates/initializer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  tours_path ="app/tours"
+  walter_config = Rails.application.config_for :walter
+  config.walter = ActiveSupport::OrderedOptions.new
+  config.walter.tour_options = walter_config[:tour_options]
+  config.walter.tours_path = tours_path
+  Walter::Tourguide.load_tours(tours_path)
+end

lib/generators/walter/templates/migration.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-class CreateAbrahamHistories < ActiveRecord::Migration[5.0]
+class CreateWalterHistories < ActiveRecord::Migration[5.0]
   def change
-    create_table :abraham_histories do |t|
+    create_table :walter_histories do |t|
       t.string :controller_name
       t.string :action_name
       t.string :tour_name
-      t.references :creator, null: false, index: true
+      t.string :creator_id, null: false, index: true
 
       t.timestamps index: true
     end

lib/tasks/abraham_tasks.rake

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # desc "Explaining what the task does"
-# task :abraham do
+# task :walter do
 #   # Task goes here
 # end

lib/walter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "walter/engine"
+
+module Walter
+  require 'walter/tourguide'
+
+  def self.load_tours(tp=nil)
+    Walter::Tourguide.instance.load_tours(tp)
+  end
+
+  def self.tours
+    Walter::Tourguide.instance.tours
+  end
+end

lib/walter/engine.rb

@@ -2,7 +2,7 @@
 
 require "rubygems"
 
-module Abraham
+module Walter
   class Engine < ::Rails::Engine
   end
 end

lib/walter/tourguide.rb

@@ -0,0 +1,39 @@
+module Walter
+  class Tourguide
+    include Singleton
+    @tours = {}
+    attr_accessor :reload
+
+    def initialize
+      super
+      @reload = true
+    end
+
+    def tours
+      load_tours
+      @tours
+    end
+
+    def load_tours(tours_path=nil)
+      return unless @reload
+
+      @tours = {}
+      tours_path ||= Rails.application.config.walter.tours_path
+      tours_root = Pathname.new(Rails.root.join(tours_path))
+      if Rails.root.join(tours_path).exist?
+        Dir.glob(Rails.root.join("#{tours_path}/**/*.yml")).each do |yml|
+          relative_filename = Pathname.new(yml).relative_path_from(tours_root)
+          # `controller_path` is either "controller_name" or "module_name/controller_name"
+          controller_path, filename = relative_filename.split
+          file_parts = filename.to_s.split(".")
+          action = file_parts[0]
+          locale = file_parts[1]
+          t = YAML.load_file(yml)
+          @tours["#{controller_path}.#{action}.#{locale}"] = t
+        end
+      end
+      puts "#{@tours.size} tours loaded"
+      @reload = ENV['WALTER_RELOAD_TOURS'].present? || Rails.env.development?
+    end
+  end
+end

lib/walter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Abraham
-  VERSION = "2.0.0"
+module Walter
+  VERSION = "2.5"
 end

package.json

@@ -1,9 +1,8 @@
 {
-  "name": "abraham",
+  "name": "walter",
   "private": true,
   "dependencies": {
-    "jquery": "^3.4.0",
     "js-cookie": "^2.2.0",
-    "shepherd.js": "^6.0.0-beta"
+    "shepherd.js": "^8.3.1"
   }
 }

test/abraham_test.rb

@@ -2,8 +2,8 @@
 
 require "test_helper"
 
-class Abraham::Test < ActiveSupport::TestCase
+class Walter::Test < ActiveSupport::TestCase
   test "truth" do
-    assert_kind_of Module, Abraham
+    assert_kind_of Module, Walter
   end
 end

test/dummy/app/assets/javascripts/application.js

@@ -10,5 +10,6 @@
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
-//= require abraham
+//= require turbolinks
+//= require walter
 //= require_tree .

test/dummy/app/assets/stylesheets/application.scss

@@ -10,6 +10,6 @@
  * files in this directory. Styles in this file should be added after the last require_* statement.
  * It is generally better to create a new file per style scope.
  *
- *= require abraham/theme-default
+ *= require walter/theme-default
  *= require_tree .
  */

test/dummy/app/controllers/dashboard_controller.rb

@@ -2,6 +2,7 @@
 
 class DashboardController < ApplicationController
   def home; end
-
   def other; end
+  def placement; end
+  def missing; end
 end

test/dummy/app/controllers/foobar/dashboard_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Foobar::DashboardController < ApplicationController
+  def home; end
+end

test/dummy/app/views/dashboard/home.html.erb

@@ -1,6 +1,26 @@
 <h1>Dashboard#home</h1>
 <p>Find me in app/views/dashboard/home.html.erb</p>
 
+<%= link_to "Other Page", dashboard_other_url %>
+
 <div class="notice-me" style="width:300px;height:300px;background-color:whitesmoke;">
     a content element to notice
 </div>
+
+<button id="restart_automatic">Restart the automatic tour</button>
+<button id="show_manual">Show manual tour</button>
+<button id="show_another_manual">Show ANOTHER manual tour</button>
+
+<script>
+  document.querySelector("#restart_automatic").addEventListener("click", function() {
+    Walter.startTour("intro");
+  });
+
+  document.querySelector("#show_manual").addEventListener("click", function() {
+    Walter.startTour("a_manual_tour");
+  });
+
+  document.querySelector("#show_another_manual").addEventListener("click", function() {
+    Walter.startTour("another_manual_tour");
+  });
+</script>

test/dummy/app/views/dashboard/missing.html.erb

@@ -0,0 +1,5 @@
+<h1>missing</h1>
+
+This page does not have the first step attachTo element,
+so we would expect the tour not to start,
+even though the second step could be rendered.

test/dummy/app/views/dashboard/other.html.erb

@@ -1,2 +1,4 @@
 <h1>Dashboard#other</h1>
 <p>Find me in app/views/dashboard/other.html.erb</p>
+
+<%= link_to "Home Page", dashboard_home_url %>

test/dummy/app/views/dashboard/placement.html.erb

@@ -0,0 +1,22 @@
+<h1>Dashboard#placement</h1>
+<p>Find me in app/views/dashboard/placement.html.erb</p>
+
+<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vitae leo sagittis, sodales ante tincidunt, tincidunt tellus. Integer rutrum id quam maximus pellentesque. Morbi non justo ac dui mollis commodo nec sit amet neque. Sed et nunc quis nibh sagittis facilisis. Vivamus pharetra mauris in leo pulvinar, hendrerit pharetra eros mattis. Praesent eleifend convallis purus in facilisis. Donec molestie turpis sed ligula hendrerit malesuada. Curabitur porttitor eros ex, mattis malesuada ligula ullamcorper a. Donec accumsan at turpis ac tristique. Fusce finibus metus at lacinia sollicitudin. In efficitur mauris ante, nec lacinia nunc fermentum sit amet.</p>
+
+<p>Cras a ullamcorper nisl, sed vulputate nisi. In hac habitasse platea dictumst. Sed pulvinar diam ultricies leo accumsan efficitur. Nullam pharetra velit risus, in vestibulum tortor finibus eget. Phasellus varius, ante sed maximus placerat, lectus nisl tempus ligula, sed tincidunt nulla odio ut augue. Phasellus dignissim, lacus non faucibus cursus, purus quam euismod mi, eu porta mi dui quis diam. Pellentesque in vulputate sem, a suscipit nunc. Etiam non elementum felis. Suspendisse rutrum, odio finibus rutrum ornare, orci quam consectetur massa, id bibendum lorem sem ut nulla. Nunc euismod varius ipsum quis commodo. Maecenas massa arcu, gravida a odio sed, tristique placerat nisl. In eget ligula tempor, iaculis felis at, ultricies augue. Praesent ac tellus sed risus dignissim ornare a at erat. Donec id finibus tortor, eget semper ante. Cras sed erat ultricies, pellentesque arcu vel, egestas ex.</p>
+
+<p>Proin viverra arcu ut purus maximus gravida. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras rhoncus leo sit amet lacus gravida, vitae viverra nunc aliquam. Suspendisse porttitor neque ac libero mollis, ac fermentum enim iaculis. Suspendisse malesuada, diam eget elementum maximus, ex dolor dapibus diam, sed scelerisque urna nisi luctus odio. Sed sed porttitor elit, et gravida sapien. Ut mattis vehicula iaculis. Sed pretium lorem id erat gravida dapibus. Etiam vitae faucibus arcu, ac fermentum lorem.</p>
+
+<div class="notice-me" style="width: 300px; height: 300px; margin-left: 400px; background-color: whitesmoke;">
+    a content with room for placement all around
+</div>
+
+<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec vitae leo sagittis, sodales ante tincidunt, tincidunt tellus. Integer rutrum id quam maximus pellentesque. Morbi non justo ac dui mollis commodo nec sit amet neque. Sed et nunc quis nibh sagittis facilisis. Vivamus pharetra mauris in leo pulvinar, hendrerit pharetra eros mattis. Praesent eleifend convallis purus in facilisis. Donec molestie turpis sed ligula hendrerit malesuada. Curabitur porttitor eros ex, mattis malesuada ligula ullamcorper a. Donec accumsan at turpis ac tristique. Fusce finibus metus at lacinia sollicitudin. In efficitur mauris ante, nec lacinia nunc fermentum sit amet.</p>
+
+<p>Cras a ullamcorper nisl, sed vulputate nisi. In hac habitasse platea dictumst. Sed pulvinar diam ultricies leo accumsan efficitur. Nullam pharetra velit risus, in vestibulum tortor finibus eget. Phasellus varius, ante sed maximus placerat, lectus nisl tempus ligula, sed tincidunt nulla odio ut augue. Phasellus dignissim, lacus non faucibus cursus, purus quam euismod mi, eu porta mi dui quis diam. Pellentesque in vulputate sem, a suscipit nunc. Etiam non elementum felis. Suspendisse rutrum, odio finibus rutrum ornare, orci quam consectetur massa, id bibendum lorem sem ut nulla. Nunc euismod varius ipsum quis commodo. Maecenas massa arcu, gravida a odio sed, tristique placerat nisl. In eget ligula tempor, iaculis felis at, ultricies augue. Praesent ac tellus sed risus dignissim ornare a at erat. Donec id finibus tortor, eget semper ante. Cras sed erat ultricies, pellentesque arcu vel, egestas ex.</p>
+
+<p>Proin viverra arcu ut purus maximus gravida. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras rhoncus leo sit amet lacus gravida, vitae viverra nunc aliquam. Suspendisse porttitor neque ac libero mollis, ac fermentum enim iaculis. Suspendisse malesuada, diam eget elementum maximus, ex dolor dapibus diam, sed scelerisque urna nisi luctus odio. Sed sed porttitor elit, et gravida sapien. Ut mattis vehicula iaculis. Sed pretium lorem id erat gravida dapibus. Etiam vitae faucibus arcu, ac fermentum lorem.</p>
+
+<p>Sed mollis lectus a tellus interdum efficitur. Maecenas et mauris neque. Aliquam erat volutpat. Cras vehicula mollis varius. Aenean quis pretium libero, sit amet sodales urna. Maecenas a elementum neque. Maecenas quis pharetra ex. Maecenas at lorem odio. Etiam malesuada non justo non porta. Donec massa lectus, suscipit non leo nec, vulputate tincidunt turpis. Integer ullamcorper, diam id pharetra tempor, erat arcu semper ex, eu rhoncus libero mauris sed ipsum. Duis bibendum dui ipsum, at fringilla sapien gravida eget. Nam finibus blandit dui.</p>
+
+<p>Integer accumsan enim eget leo placerat, at imperdiet libero porta. Nam in cursus sapien. Maecenas nunc enim, posuere a nulla bibendum, convallis aliquet odio. Curabitur a magna dolor. Vestibulum sed eros quis nisl aliquet condimentum. Phasellus ut odio a enim molestie gravida. Praesent sagittis mi sit amet lacus varius, vitae fermentum lorem iaculis. Ut fringilla turpis nec est fringilla finibus. Nullam accumsan tortor non massa tincidunt egestas. Nunc ac eros dignissim, mattis dui sed, mattis enim. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec purus dolor, consectetur in dui vitae, aliquet aliquam orci. Nulla iaculis lorem et sem gravida, in sollicitudin elit dictum. Vestibulum consectetur sapien sed vestibulum venenatis. Cras id libero vel risus ullamcorper cursus in sit amet erat. </p>

test/dummy/app/views/foobar/dashboard/home.html.erb

@@ -0,0 +1,4 @@
+<h1>Foobar::Dashboard#home</h1>
+<p>Find me in app/views/foobar/dashboard/home.html.erb</p>
+
+We should get a unique tour for this module, not the same one as Dashboard#home

test/dummy/app/views/layouts/application.html.erb

@@ -11,6 +11,10 @@
   <body>
     <%= yield %>
 
-    <%= abraham_tour %>
+    <hr>
+
+    <p><em>current_user.id = <%= current_user.id %></em></p>
+
+    <%= walter_tour %>
   </body>
 </html>

test/dummy/config/application.rb

@@ -5,7 +5,7 @@ require_relative "boot"
 require "rails/all"
 
 Bundler.require(*Rails.groups)
-require "abraham"
+require "walter"
 
 module Dummy
   class Application < Rails::Application
@@ -13,6 +13,9 @@ module Dummy
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
 
-    config.active_record.sqlite3.represent_boolean_as_integer = true
+    # For Rails 5.2 - 6.0, we need to set this configuration
+    if (Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR > 1) || (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR < 1)
+      config.active_record.sqlite3.represent_boolean_as_integer = true
+    end
   end
 end

test/dummy/config/initializers/abraham.rb

@@ -2,23 +2,23 @@
 
 Rails.application.configure do
   tours = {}
+  tours_root = Pathname.new(Rails.root.join("config/tours"))
 
   if Rails.root.join("config/tours").exist?
-    Dir[Rails.root.join("config/tours/*/")].each do |dir|
-      Dir[dir + "*.yml"].each do |yml|
-        path_parts = yml.split(File::SEPARATOR)
-        controller = path_parts[path_parts.size - 2]
-        file_parts = path_parts[path_parts.size - 1].split(".")
-        action = file_parts[0]
-        locale = file_parts[1]
-        t = YAML.load_file(yml)
-        tours["#{controller}.#{action}.#{locale}"] = t
-      end
+    Dir.glob(Rails.root.join("config/tours/**/*.yml")).each do |yml|
+      relative_filename = Pathname.new(yml).relative_path_from(tours_root)
+      # `controller_path` is either "controller_name" or "module_name/controller_name"
+      controller_path, filename = relative_filename.split
+      file_parts = filename.to_s.split(".")
+      action = file_parts[0]
+      locale = file_parts[1]
+      t = YAML.load_file(yml)
+      tours["#{controller_path}.#{action}.#{locale}"] = t
     end
   end
 
-  abraham_config = Rails.application.config_for :abraham
-  config.abraham = ActiveSupport::OrderedOptions.new
-  config.abraham.tour_options = abraham_config[:tour_options]
-  config.abraham.tours = tours
+  walter_config = Rails.application.config_for :walter
+  config.walter = ActiveSupport::OrderedOptions.new
+  config.walter.tour_options = walter_config[:tour_options]
+  config.walter.tours = tours
 end

test/dummy/config/routes.rb

@@ -2,8 +2,13 @@
 
 Rails.application.routes.draw do
   get "dashboard/home"
-
   get "dashboard/other"
+  get "dashboard/placement"
+  get "dashboard/missing"
+
+  namespace :foobar do
+    get "dashboard/home"
+  end
 
   # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
 end

test/dummy/config/tours/dashboard/home.en.yml

@@ -17,3 +17,13 @@ intro:
       attachTo:
         element: ".notice-me"
         placement: "right"
+a_manual_tour:
+  trigger: manual
+  steps:
+    1:
+      text: "You triggered the manual tour"
+another_manual_tour:
+  trigger: manual
+  steps:
+    1:
+      text: "You triggered the OTHER manual tour"

test/dummy/config/tours/dashboard/missing.en.yml

@@ -0,0 +1,10 @@
+tour:
+  steps:
+    1:
+      title: "This step points to a missing element"
+      text: "This should not skip to the second step"
+      attachTo:
+        element: "#i-dont-exist"
+        placement: "right"
+    2:
+      text: "You should not see me!"

test/dummy/config/tours/dashboard/other.en.yml

@@ -3,6 +3,9 @@ tour_one:
     1:
       title: "TOUR ONE step one ENGLISH"
       text: "we show this on your first visit"
+      attachTo:
+        element: "p"
+        placement: "top"
 
 tour_two:
   steps:

test/dummy/config/tours/dashboard/placement.en.yml

@@ -0,0 +1,77 @@
+intro:
+  steps:
+    1:
+      text: "bottom"
+      attachTo:
+        element: ".notice-me"
+        placement: "bottom"
+    2:
+      text: "bottom center"
+      attachTo:
+        element: ".notice-me"
+        placement: "bottom center"
+    3:
+      text: "bottom left"
+      attachTo:
+        element: ".notice-me"
+        placement: "bottom left"
+    4:
+      text: "bottom right"
+      attachTo:
+        element: ".notice-me"
+        placement: "bottom right"
+    5:
+      text: "center"
+      attachTo:
+        element: ".notice-me"
+        placement: "center"
+    6:
+      text: "left"
+      attachTo:
+        element: ".notice-me"
+        placement: "left"
+    7:
+      text: "middle"
+      attachTo:
+        element: ".notice-me"
+        placement: "middle"
+    8:
+      text: "middle center"
+      attachTo:
+        element: ".notice-me"
+        placement: "middle center"
+    9:
+      text: "middle left"
+      attachTo:
+        element: ".notice-me"
+        placement: "middle left"
+    10:
+      text: "middle right"
+      attachTo:
+        element: ".notice-me"
+        placement: "middle right"
+    11:
+      text: "right"
+      attachTo:
+        element: ".notice-me"
+        placement: "right"
+    12:
+      text: "top"
+      attachTo:
+        element: ".notice-me"
+        placement: "top"
+    13:
+      text: "top center"
+      attachTo:
+        element: ".notice-me"
+        placement: "top center"
+    14:
+      text: "top left"
+      attachTo:
+        element: ".notice-me"
+        placement: "top left"
+    15:
+      text: "top right"
+      attachTo:
+        element: ".notice-me"
+        placement: "top right"

test/dummy/config/tours/foobar/dashboard/home.en.yml

@@ -0,0 +1,4 @@
+module:
+  steps:
+    1:
+      text: "This tour should appear for the Foobar::DashboardController only"

test/dummy/db/migrate/20161118143752_create_abraham_histories.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-class CreateAbrahamHistories < ActiveRecord::Migration[5.0]
+class CreateWalterHistories < ActiveRecord::Migration[5.0]
   def change
-    create_table :abraham_histories do |t|
+    create_table :walter_histories do |t|
       t.string :controller_name
       t.string :action_name
       t.string :tour_name

test/dummy/db/schema.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -14,16 +12,16 @@
 
 ActiveRecord::Schema.define(version: 2016_11_18_143752) do
 
-  create_table "abraham_histories", force: :cascade do |t|
+  create_table "walter_histories", force: :cascade do |t|
     t.string "controller_name"
     t.string "action_name"
     t.string "tour_name"
     t.integer "creator_id", null: false
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.index ["created_at"], name: "index_abraham_histories_on_created_at"
-    t.index ["creator_id"], name: "index_abraham_histories_on_creator_id"
-    t.index ["updated_at"], name: "index_abraham_histories_on_updated_at"
+    t.index ["created_at"], name: "index_walter_histories_on_created_at"
+    t.index ["creator_id"], name: "index_walter_histories_on_creator_id"
+    t.index ["updated_at"], name: "index_walter_histories_on_updated_at"
   end
 
 end

test/dummy/test/controllers/abraham_histories_controller_test.rb

@@ -2,10 +2,10 @@
 
 require "test_helper"
 
-class AbrahamHistoriesControllerTest < ActionDispatch::IntegrationTest
-  test "should create AbrahamHistory" do
-    assert_difference ["AbrahamHistory.count"] do
-      post abraham_histories_url, as: :json, params: { abraham_history: { action_name: "foo", controller_name: "bar", tour_name: "baz" } }
+class WalterHistoriesControllerTest < ActionDispatch::IntegrationTest
+  test "should create WalterHistory" do
+    assert_difference ["WalterHistory.count"] do
+      post walter_histories_url, as: :json, params: { walter_history: { action_name: "foo", controller_name: "bar", tour_name: "baz" } }
     end
   end
 end

test/dummy/test/controllers/dashboard_controller_test.rb

@@ -13,7 +13,7 @@ class DashboardControllerTest < ActionDispatch::IntegrationTest
 
   test "uses configured shepherd configuration" do
     # No options
-    Rails.configuration.abraham.tour_options = nil
+    Rails.configuration.walter.tour_options = nil
     get dashboard_home_url
     assert_response :success
     assert_select "body script" do |element|
@@ -22,7 +22,7 @@ class DashboardControllerTest < ActionDispatch::IntegrationTest
     end
 
     # Custom options
-    Rails.configuration.abraham.tour_options = '{ defaultStepOptions: { classes: "my-custom-class" } }'
+    Rails.configuration.walter.tour_options = '{ defaultStepOptions: { classes: "my-custom-class" } }'
     get dashboard_home_url
     assert_select "body script" do |element|
       # Config-specified options passed into Tour()

test/dummy/test/controllers/foobar/dashboard_controller_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class Foobar::DashboardControllerTest < ActionDispatch::IntegrationTest
+  test "home should have home tour code" do
+    get foobar_dashboard_home_url
+    assert_response :success
+
+    assert_select "body script" do |element|
+      # it's the Foobar module home tour
+      assert element.text.include? "This tour should appear for the Foobar::DashboardController only"
+    end
+  end
+end

test/dummy/test/system/tours_test.rb

@@ -3,7 +3,7 @@ require "application_system_test_case"
 class ToursTest < ApplicationSystemTestCase
   setup do
     @user_id = Random.rand(1..99999)
-    @cookie_name = "abraham-dummy-#{@user_id}-dashboard-home-intro"
+    @cookie_name = "walter-dummy-#{@user_id}-dashboard-home-intro"
     ApplicationController.any_instance.stubs(:current_user).returns(OpenStruct.new(id: @user_id))
   end
 
@@ -17,6 +17,11 @@ class ToursTest < ApplicationSystemTestCase
     assert_selector ".shepherd-button", text: "Continue"
     find(".shepherd-button", text: "Continue").click
 
+    # Now try to manually trigger another tour
+    find('#show_manual').click
+    # Even though we triggered another tour, it should not appear since one is already active
+    assert_selector ".shepherd-element", count: 1, visible: true
+
     # Tour Step 2
     assert_selector ".shepherd-header", text: "ENGLISH This step has a title"
     assert_selector ".shepherd-text", text: "ENGLISH This intermediate step has some text"
@@ -40,6 +45,17 @@ class ToursTest < ApplicationSystemTestCase
     # Tour should not reappear on reload
     visit dashboard_home_url
     refute_selector ".shepherd-element"
+
+    # Now start a manual tour
+    find('#show_manual').click
+    assert_selector ".shepherd-element", visible: true
+    assert_selector ".shepherd-text", text: "You triggered the manual tour"
+    assert_selector ".shepherd-button", text: "Done"
+    find(".shepherd-button", text: "Done").click
+
+    # Even though we finished the manual tour, we can start it again right away
+    find('#show_manual').click
+    assert_selector ".shepherd-element", visible: true
   end
 
   test "mark a tour for Later and it will not come back in this session" do
@@ -63,4 +79,36 @@ class ToursTest < ApplicationSystemTestCase
     visit dashboard_home_url
     assert_selector ".shepherd-element", visible: true
   end
+
+  test "navigate with turbolinks between pages with tours" do
+    visit dashboard_home_url
+    assert_selector ".shepherd-element", visible: true
+    # Navigate to other page
+    find("a").click
+    assert_selector ".shepherd-element", visible: true
+  end
+
+  test "tour with missing first step attachTo does not appear" do
+    visit dashboard_missing_url
+    # No tour should be visible, since the first step is invalid
+    refute_selector ".shepherd-element"
+  end
+
+  test "page with two incomplete tours shows them on consecutive visits" do
+    # First tour should appear at first visit
+    visit dashboard_other_url
+    assert_selector ".shepherd-element", visible: true
+    assert_selector ".shepherd-header", text: "TOUR ONE step one ENGLISH"
+    find(".shepherd-button", text: "Done").click
+
+    # Second tour should appear at second visit
+    visit dashboard_other_url
+    assert_selector ".shepherd-element", visible: true
+    assert_selector ".shepherd-header", text: "TOUR TWO step one ENGLISH"
+    find(".shepherd-button", text: "Done").click
+
+    # Now no tours should appear since they're both done
+    visit dashboard_other_url
+    refute_selector ".shepherd-element"
+  end
 end

test/install_generator_test.rb

@@ -2,10 +2,10 @@
 
 require "test_helper"
 require "rails/generators"
-require "generators/abraham/install_generator"
+require "generators/walter/install_generator"
 
 class InstallGeneratorTest < Rails::Generators::TestCase
-  tests Abraham::Generators::InstallGenerator
+  tests Walter::Generators::InstallGenerator
   destination File.expand_path("../tmp", __dir__)
 
   setup :prepare_destination
@@ -13,7 +13,7 @@ class InstallGeneratorTest < Rails::Generators::TestCase
   test "should generate a migration" do
     begin
       run_generator
-      assert_migration "db/migrate/create_abraham_histories"
+      assert_migration "db/migrate/create_walter_histories"
     ensure
       FileUtils.rm_rf destination_root
     end
@@ -22,7 +22,7 @@ class InstallGeneratorTest < Rails::Generators::TestCase
   test "should skip the migration when told to do so" do
     begin
       run_generator ["--skip-migration"]
-      assert_no_migration "db/migrate/create_abraham_histories"
+      assert_no_migration "db/migrate/create_walter_histories"
     ensure
       FileUtils.rm_rf destination_root
     end
@@ -31,8 +31,8 @@ class InstallGeneratorTest < Rails::Generators::TestCase
   test "should generate an initializer" do
     begin
       run_generator
-      assert_file "config/initializers/abraham.rb"
-      assert_file "config/abraham.yml"
+      assert_file "config/initializers/walter.rb"
+      assert_file "config/walter.yml"
     ensure
       FileUtils.rm_rf destination_root
     end
@@ -41,7 +41,7 @@ class InstallGeneratorTest < Rails::Generators::TestCase
   test "should skip the initializer when told to do so" do
     begin
       run_generator ["--skip-initializer"]
-      assert_no_file "config/initializers/abraham.rb"
+      assert_no_file "config/initializers/walter.rb"
     ensure
       FileUtils.rm_rf destination_root
     end

test/models/abraham_history_test.rb

@@ -2,7 +2,7 @@
 
 require "test_helper"
 
-class AbrahamHistoryTest < ActiveSupport::TestCase
+class WalterHistoryTest < ActiveSupport::TestCase
   # test "the truth" do
   #   assert true
   # end

walter.gemspec

@@ -3,17 +3,16 @@
 $LOAD_PATH.push File.expand_path("lib", __dir__)
 
 # Maintain your gem's version:
-require "abraham/version"
+require "walter/version"
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
-  s.name        = "abraham"
-  s.version     = Abraham::VERSION
-  s.authors     = ["Jonathan Abbett"]
-  s.email       = ["jonathan@act.md"]
-  s.homepage    = "https://github.com/actmd/abraham"
-  s.summary     = "Trackable application tours for Rails with i18n support, based on Shepherd.js."
-  s.description = "Trackable application tours for Rails with i18n support, based on Shepherd.js."
+  s.name        = "walter"
+  s.version     = Walter::VERSION
+  s.authors     = ["Mike Sutton"]
+  s.email       = ["tech@wizewerx.com"]
+  s.summary     = "Application tours for Rails"
+  s.description = "Application tours for Rails"
   s.license     = "MIT"
 
   s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
@@ -22,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'listen'
+  s.add_development_dependency 'web-console'
 end