Compare commits
53 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
f233284e0c | ||
|
4f9dad26a4 | ||
|
c05989af61 | ||
|
31317a355b | ||
|
3fcb819881 | ||
|
e14af79691 | ||
|
9f2b6236a6 | ||
|
bc083c38c8 | ||
|
7eafdcab0e | ||
|
155f58500e | ||
|
86a4533435 | ||
|
02f43cea80 | ||
|
f82107ce21 | ||
|
602e90be57 | ||
|
c629422feb | ||
|
eaf6ae78c8 | ||
|
47a487126f | ||
|
36468d85bb | ||
|
4ad630c6ae | ||
|
5e2854d969 | ||
|
d199dc1892 | ||
|
e029d158d5 | ||
|
28da972b66 | ||
|
ce283c28fd | ||
|
eff726c6f4 | ||
|
bfe25af90a | ||
|
b3dbb60b39 | ||
|
160ec8e10b | ||
|
c85dade38e | ||
|
546498a14a | ||
|
1d4e2b6491 | ||
|
004e342fb0 | ||
|
5a19ffb822 | ||
|
60dcd0dd31 | ||
|
836a022704 | ||
|
aac7367d1d | ||
|
f7b751517a | ||
|
c9e0d54628 | ||
|
eac3fd0427 | ||
|
c164bdf73a | ||
|
0bdc88f4d8 | ||
|
e5e609a907 | ||
|
afab011240 | ||
|
b73cc23aea | ||
|
4531ec57d0 | ||
|
bedecc8deb | ||
|
91d1808c48 | ||
|
9c073cf2e0 | ||
|
c60b2b6cbd | ||
|
acefeb5f95 | ||
|
5a0e25b7dc | ||
|
ad05927e61 | ||
|
66f031a101 |
4
.gitignore
vendored
4
.gitignore
vendored
@ -17,6 +17,8 @@ capybara-*.html
|
||||
**.orig
|
||||
rerun.txt
|
||||
pickle-email-*.html
|
||||
# Don't commit yarn.lock, to ensure that package.json is specific enough
|
||||
yarn.lock
|
||||
yarn-error.log
|
||||
|
||||
# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
|
||||
@ -33,6 +35,7 @@ config/secrets.yml
|
||||
|
||||
# these should all be checked in to normalize the environment:
|
||||
# Gemfile.lock, .ruby-version, .ruby-gemset
|
||||
Gemfile.lock
|
||||
|
||||
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
|
||||
.rvmrc
|
||||
@ -51,3 +54,4 @@ bower.json
|
||||
.idea/
|
||||
/test/dummy/tmp/
|
||||
/test/dummy/log/
|
||||
.DS_Store
|
@ -1 +1 @@
|
||||
abraham
|
||||
walter
|
||||
|
@ -1 +1 @@
|
||||
2.5.3
|
||||
2.6.5
|
||||
|
24
Gemfile
24
Gemfile
@ -1,7 +1,25 @@
|
||||
# frozen_string_literal: true
|
||||
source 'http://rubygems.org'
|
||||
|
||||
# Declare your gem's dependencies in abraham.gemspec.
|
||||
group :development, :test do
|
||||
gem 'sassc-rails'
|
||||
end
|
||||
|
||||
# Set the Rails version. We have this switch so that we can test multiple
|
||||
# versions for Rails on Travis CI.
|
||||
# Inspired by http://aaronmiler.com/blog/testing-your-rails-engine-with-multiple-versions-of-rails/
|
||||
rails_version = ENV['RAILS_VERSION'] || 'default'
|
||||
rails = case rails_version
|
||||
when 'default'
|
||||
'~> 5.2'
|
||||
when 'master'
|
||||
{github: 'rails/rails'}
|
||||
else
|
||||
"~> #{rails_version}"
|
||||
end
|
||||
gem 'rails', rails
|
||||
|
||||
# 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
|
||||
@ -14,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'
|
||||
|
194
Gemfile.lock
194
Gemfile.lock
@ -1,194 +0,0 @@
|
||||
PATH
|
||||
remote: .
|
||||
specs:
|
||||
abraham (1.5.2)
|
||||
rails (~> 5.1)
|
||||
|
||||
GEM
|
||||
remote: http://rubygems.org/
|
||||
specs:
|
||||
actioncable (5.2.3)
|
||||
actionpack (= 5.2.3)
|
||||
nio4r (~> 2.0)
|
||||
websocket-driver (>= 0.6.1)
|
||||
actionmailer (5.2.3)
|
||||
actionpack (= 5.2.3)
|
||||
actionview (= 5.2.3)
|
||||
activejob (= 5.2.3)
|
||||
mail (~> 2.5, >= 2.5.4)
|
||||
rails-dom-testing (~> 2.0)
|
||||
actionpack (5.2.3)
|
||||
actionview (= 5.2.3)
|
||||
activesupport (= 5.2.3)
|
||||
rack (~> 2.0)
|
||||
rack-test (>= 0.6.3)
|
||||
rails-dom-testing (~> 2.0)
|
||||
rails-html-sanitizer (~> 1.0, >= 1.0.2)
|
||||
actionview (5.2.3)
|
||||
activesupport (= 5.2.3)
|
||||
builder (~> 3.1)
|
||||
erubi (~> 1.4)
|
||||
rails-dom-testing (~> 2.0)
|
||||
rails-html-sanitizer (~> 1.0, >= 1.0.3)
|
||||
activejob (5.2.3)
|
||||
activesupport (= 5.2.3)
|
||||
globalid (>= 0.3.6)
|
||||
activemodel (5.2.3)
|
||||
activesupport (= 5.2.3)
|
||||
activerecord (5.2.3)
|
||||
activemodel (= 5.2.3)
|
||||
activesupport (= 5.2.3)
|
||||
arel (>= 9.0)
|
||||
activestorage (5.2.3)
|
||||
actionpack (= 5.2.3)
|
||||
activerecord (= 5.2.3)
|
||||
marcel (~> 0.3.1)
|
||||
activesupport (5.2.3)
|
||||
concurrent-ruby (~> 1.0, >= 1.0.2)
|
||||
i18n (>= 0.7, < 2)
|
||||
minitest (~> 5.1)
|
||||
tzinfo (~> 1.1)
|
||||
addressable (2.7.0)
|
||||
public_suffix (>= 2.0.2, < 5.0)
|
||||
arel (9.0.0)
|
||||
ast (2.4.0)
|
||||
builder (3.2.3)
|
||||
capybara (3.29.0)
|
||||
addressable
|
||||
mini_mime (>= 0.1.3)
|
||||
nokogiri (~> 1.8)
|
||||
rack (>= 1.6.0)
|
||||
rack-test (>= 0.6.3)
|
||||
regexp_parser (~> 1.5)
|
||||
xpath (~> 3.2)
|
||||
childprocess (2.0.0)
|
||||
rake (< 13.0)
|
||||
concurrent-ruby (1.1.5)
|
||||
crass (1.0.4)
|
||||
erubi (1.8.0)
|
||||
ffi (1.11.1)
|
||||
globalid (0.4.2)
|
||||
activesupport (>= 4.2.0)
|
||||
i18n (1.6.0)
|
||||
concurrent-ruby (~> 1.0)
|
||||
jaro_winkler (1.5.3)
|
||||
listen (3.1.5)
|
||||
rb-fsevent (~> 0.9, >= 0.9.4)
|
||||
rb-inotify (~> 0.9, >= 0.9.7)
|
||||
ruby_dep (~> 1.2)
|
||||
loofah (2.2.3)
|
||||
crass (~> 1.0.2)
|
||||
nokogiri (>= 1.5.9)
|
||||
mail (2.7.1)
|
||||
mini_mime (>= 0.1.1)
|
||||
marcel (0.3.3)
|
||||
mimemagic (~> 0.3.2)
|
||||
metaclass (0.0.4)
|
||||
method_source (0.9.2)
|
||||
mimemagic (0.3.3)
|
||||
mini_mime (1.0.2)
|
||||
mini_portile2 (2.4.0)
|
||||
minitest (5.11.3)
|
||||
mocha (1.9.0)
|
||||
metaclass (~> 0.0.1)
|
||||
nio4r (2.5.1)
|
||||
nokogiri (1.10.4)
|
||||
mini_portile2 (~> 2.4.0)
|
||||
parallel (1.17.0)
|
||||
parser (2.6.4.0)
|
||||
ast (~> 2.4.0)
|
||||
public_suffix (4.0.1)
|
||||
rack (2.0.7)
|
||||
rack-test (1.1.0)
|
||||
rack (>= 1.0, < 3)
|
||||
rails (5.2.3)
|
||||
actioncable (= 5.2.3)
|
||||
actionmailer (= 5.2.3)
|
||||
actionpack (= 5.2.3)
|
||||
actionview (= 5.2.3)
|
||||
activejob (= 5.2.3)
|
||||
activemodel (= 5.2.3)
|
||||
activerecord (= 5.2.3)
|
||||
activestorage (= 5.2.3)
|
||||
activesupport (= 5.2.3)
|
||||
bundler (>= 1.3.0)
|
||||
railties (= 5.2.3)
|
||||
sprockets-rails (>= 2.0.0)
|
||||
rails-dom-testing (2.0.3)
|
||||
activesupport (>= 4.2.0)
|
||||
nokogiri (>= 1.6)
|
||||
rails-html-sanitizer (1.2.0)
|
||||
loofah (~> 2.2, >= 2.2.2)
|
||||
railties (5.2.3)
|
||||
actionpack (= 5.2.3)
|
||||
activesupport (= 5.2.3)
|
||||
method_source
|
||||
rake (>= 0.8.7)
|
||||
thor (>= 0.19.0, < 2.0)
|
||||
rainbow (3.0.0)
|
||||
rake (12.3.3)
|
||||
rb-fsevent (0.10.3)
|
||||
rb-inotify (0.10.0)
|
||||
ffi (~> 1.0)
|
||||
regexp_parser (1.6.0)
|
||||
rubocop (0.74.0)
|
||||
jaro_winkler (~> 1.5.1)
|
||||
parallel (~> 1.10)
|
||||
parser (>= 2.6)
|
||||
rainbow (>= 2.2.2, < 4.0)
|
||||
ruby-progressbar (~> 1.7)
|
||||
unicode-display_width (>= 1.4.0, < 1.7)
|
||||
ruby-progressbar (1.10.1)
|
||||
ruby_dep (1.5.0)
|
||||
rubyzip (1.2.3)
|
||||
sassc (2.2.0)
|
||||
ffi (~> 1.9)
|
||||
sassc-rails (2.1.2)
|
||||
railties (>= 4.0.0)
|
||||
sassc (>= 2.0)
|
||||
sprockets (> 3.0)
|
||||
sprockets-rails
|
||||
tilt
|
||||
selenium-webdriver (3.142.4)
|
||||
childprocess (>= 0.5, < 3.0)
|
||||
rubyzip (~> 1.2, >= 1.2.2)
|
||||
sprockets (3.7.2)
|
||||
concurrent-ruby (~> 1.0)
|
||||
rack (> 1, < 3)
|
||||
sprockets-rails (3.2.1)
|
||||
actionpack (>= 4.0)
|
||||
activesupport (>= 4.0)
|
||||
sprockets (>= 3.0.0)
|
||||
sqlite3 (1.4.1)
|
||||
thor (0.20.3)
|
||||
thread_safe (0.3.6)
|
||||
tilt (2.0.9)
|
||||
tzinfo (1.2.5)
|
||||
thread_safe (~> 0.1)
|
||||
unicode-display_width (1.6.0)
|
||||
webdrivers (4.1.2)
|
||||
nokogiri (~> 1.6)
|
||||
rubyzip (~> 1.0)
|
||||
selenium-webdriver (>= 3.0, < 4.0)
|
||||
websocket-driver (0.7.1)
|
||||
websocket-extensions (>= 0.1.0)
|
||||
websocket-extensions (0.1.4)
|
||||
xpath (3.2.0)
|
||||
nokogiri (~> 1.8)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
|
||||
DEPENDENCIES
|
||||
abraham!
|
||||
capybara (>= 2.15)
|
||||
listen
|
||||
mocha
|
||||
rubocop
|
||||
sassc-rails
|
||||
selenium-webdriver
|
||||
sqlite3
|
||||
webdrivers
|
||||
|
||||
BUNDLED WITH
|
||||
1.17.3
|
182
README.md
182
README.md
@ -1,25 +1,34 @@
|
||||
# Abraham
|
||||
# Walter
|
||||
|
||||
_Guide your users in the one true path._
|
||||
[](https://travis-ci.com/actmd/walter)
|
||||
|
||||

|
||||
|
||||
Abraham injects dynamically-generated [Shepherd.js](http://github.hubspot.com/shepherd/docs/welcome/) 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.
|
||||
* 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'
|
||||
|
||||
```
|
||||
|
||||
@ -27,61 +36,61 @@ 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 js-cookie shepherd.js
|
||||
$ 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 Shepherd.js CSS theme in `app/assets/stylesheets/application.scss`
|
||||
Require a CSS theme in `app/assets/stylesheets/application.scss`
|
||||
|
||||
```
|
||||
//= require "shepherd.js/dist/css/shepherd-theme-default"
|
||||
*= require walter/theme-default
|
||||
```
|
||||
|
||||
Shepherd.js provides the following themes:
|
||||
Walter provides the following themes:
|
||||
|
||||
- `shepherd-theme-arrows`
|
||||
- `shepherd-theme-arrows-fix`
|
||||
- `shepherd-theme-arrows-plain-buttons`
|
||||
- `shepherd-theme-dark`
|
||||
- `shepherd-theme-default`
|
||||
- `shepherd-theme-square`
|
||||
- `shepherd-theme-square-dark`
|
||||
- `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
|
||||
:default_theme: 'shepherd-theme-arrows'
|
||||
:tour_options: '{ defaultStepOptions: { classes: "theme-dark" } }'
|
||||
```
|
||||
|
||||
Tell Abraham where to insert its generated JavaScript in `app/views/layouts/application.html.erb`, just before the closing `body` tag:
|
||||
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 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,66 +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
|
||||
```
|
||||
|
||||
## 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
|
||||
|
||||
This Rails engine contains a test app called `dummy` with controller and system tests. They'll all get run with `rails t`.
|
||||
|
||||
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'
|
||||
```
|
||||
|
||||
### 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
|
||||
```
|
4
Rakefile
4
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
|
||||
|
@ -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();
|
||||
});
|
28
app/assets/javascripts/walter/index.js
Normal file
28
app/assets/javascripts/walter/index.js
Normal file
@ -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 = [];
|
||||
});
|
194
app/assets/stylesheets/walter/_common.scss
Normal file
194
app/assets/stylesheets/walter/_common.scss
Normal file
@ -0,0 +1,194 @@
|
||||
.shepherd-button {
|
||||
background: #3288e6;
|
||||
border: 0;
|
||||
border-radius: 3px;
|
||||
color: hsla(0, 0%, 100%, .75);
|
||||
cursor: pointer;
|
||||
margin-right: .5rem;
|
||||
padding: .5rem 1.5rem;
|
||||
transition: all .5s ease;
|
||||
}
|
||||
|
||||
.shepherd-button:not(:disabled):hover {
|
||||
background: #196fcc;
|
||||
color: hsla(0, 0%, 100%, .75);
|
||||
}
|
||||
|
||||
.shepherd-button.shepherd-button-secondary {
|
||||
background: #f1f2f3;
|
||||
color: rgba(0, 0, 0, .75);
|
||||
}
|
||||
|
||||
.shepherd-button.shepherd-button-secondary:not(:disabled):hover {
|
||||
background: #d6d9db;
|
||||
color: rgba(0, 0, 0, .75);
|
||||
}
|
||||
|
||||
.shepherd-button:disabled {
|
||||
cursor: not-allowed;
|
||||
}
|
||||
|
||||
.shepherd-footer {
|
||||
border-bottom-left-radius: 5px;
|
||||
border-bottom-right-radius: 5px;
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
padding: 0 1rem 1rem;
|
||||
}
|
||||
|
||||
.shepherd-footer .shepherd-button:last-child {
|
||||
margin-right: 0;
|
||||
}
|
||||
|
||||
.shepherd-cancel-icon {
|
||||
background: transparent;
|
||||
border: none;
|
||||
color: hsla(0, 0%, 50.2%, .75);
|
||||
font-size: 2em;
|
||||
cursor: pointer;
|
||||
font-weight: 400;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
transition: color .5s ease;
|
||||
}
|
||||
|
||||
.shepherd-cancel-icon:hover {
|
||||
color: rgba(0, 0, 0, .75);
|
||||
}
|
||||
|
||||
.shepherd-has-title .shepherd-content .shepherd-cancel-icon {
|
||||
color: hsla(0, 0%, 50.2%, .75);
|
||||
}
|
||||
|
||||
.shepherd-has-title .shepherd-content .shepherd-cancel-icon:hover {
|
||||
color: rgba(0, 0, 0, .75);
|
||||
}
|
||||
|
||||
.shepherd-title {
|
||||
display: flex;
|
||||
font-size: 1rem;
|
||||
font-weight: 400;
|
||||
flex: 1 0 auto;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.shepherd-header {
|
||||
align-items: center;
|
||||
border-top-left-radius: 5px;
|
||||
border-top-right-radius: 5px;
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
padding: 0.5rem 0rem 0;
|
||||
}
|
||||
|
||||
.shepherd-has-title .shepherd-content .shepherd-header {
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.shepherd-text {
|
||||
font-size: 1rem;
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.shepherd-text p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
.shepherd-text p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
.shepherd-content {
|
||||
border-radius: 5px;
|
||||
outline: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.shepherd-element {
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 1px 4px rgba(0, 0, 0, .2);
|
||||
//max-width: 600px;
|
||||
outline: none;
|
||||
z-index: 9999;
|
||||
line-height: 1.2;
|
||||
}
|
||||
|
||||
.shepherd-element,
|
||||
.shepherd-element *,
|
||||
.shepherd-element :after,
|
||||
.shepherd-element :before {
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
.shepherd-element .shepherd-arrow {
|
||||
border: 16px solid transparent;
|
||||
content: "";
|
||||
display: block;
|
||||
height: 16px;
|
||||
pointer-events: none;
|
||||
position: absolute;
|
||||
width: 16px;
|
||||
z-index: 10000;
|
||||
}
|
||||
|
||||
.shepherd-element.shepherd-element-attached-bottom.shepherd-element-attached-center .shepherd-arrow,
|
||||
.shepherd-element.shepherd-pinned-top .shepherd-arrow {
|
||||
bottom: 0;
|
||||
border-top-color: #232323;
|
||||
left: 50%;
|
||||
transform: translate(-50%, 100%);
|
||||
}
|
||||
|
||||
.shepherd-element.shepherd-element-attached-top.shepherd-element-attached-center .shepherd-arrow {
|
||||
border-bottom-color: #232323;
|
||||
left: 50%;
|
||||
top: 0;
|
||||
transform: translate(-50%, -100%);
|
||||
}
|
||||
|
||||
.shepherd-element.shepherd-element-attached-top.shepherd-element-attached-center.shepherd-has-title .shepherd-arrow {
|
||||
border-bottom-color: #303030;
|
||||
}
|
||||
|
||||
.shepherd-element.shepherd-element-attached-middle.shepherd-element-attached-left .shepherd-arrow,
|
||||
.shepherd-element.shepherd-pinned-right .shepherd-arrow {
|
||||
border-right-color: #232323;
|
||||
left: 0;
|
||||
top: 50%;
|
||||
transform: translate(-100%, -50%);
|
||||
}
|
||||
|
||||
.shepherd-element.shepherd-element-attached-middle.shepherd-element-attached-right .shepherd-arrow,
|
||||
.shepherd-element.shepherd-pinned-left .shepherd-arrow {
|
||||
border-left-color: #232323;
|
||||
right: 0;
|
||||
top: 50%;
|
||||
transform: translate(100%, -50%);
|
||||
}
|
||||
|
||||
.shepherd-modal-overlay-container {
|
||||
-ms-filter: progid:dximagetransform.microsoft.gradient.alpha(Opacity=50);
|
||||
filter: alpha(opacity=50);
|
||||
fill-rule: evenodd;
|
||||
height: 0;
|
||||
left: 0;
|
||||
opacity: 0;
|
||||
overflow: hidden;
|
||||
pointer-events: none;
|
||||
position: fixed;
|
||||
top: 0;
|
||||
transition: all .3s ease-out, height 0ms .3s, opacity .3s 0ms;
|
||||
width: 100vw;
|
||||
z-index: 9997;
|
||||
}
|
||||
|
||||
.shepherd-modal-overlay-container.shepherd-modal-is-visible {
|
||||
height: 100vh;
|
||||
opacity: .5;
|
||||
transition: all .3s ease-out, height 0s 0s, opacity .3s 0s;
|
||||
}
|
||||
|
||||
.shepherd-modal-overlay-container.shepherd-modal-is-visible path {
|
||||
pointer-events: all;
|
||||
}
|
117
app/assets/stylesheets/walter/shepherd.css
Normal file
117
app/assets/stylesheets/walter/shepherd.css
Normal file
@ -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;
|
||||
}
|
40
app/assets/stylesheets/walter/theme-dark.scss
Executable file
40
app/assets/stylesheets/walter/theme-dark.scss
Executable file
@ -0,0 +1,40 @@
|
||||
@import "_common";
|
||||
|
||||
.theme-dark.shepherd-element {
|
||||
background: #232323;
|
||||
|
||||
.shepherd-text {
|
||||
color: #eee;
|
||||
}
|
||||
|
||||
.shepherd-title {
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
&.shepherd-has-title .shepherd-content .shepherd-header {
|
||||
background: #303030;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-bottom.shepherd-element-attached-center .shepherd-arrow,
|
||||
&.shepherd-pinned-top .shepherd-arrow {
|
||||
border-top-color: #232323;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-top.shepherd-element-attached-center .shepherd-arrow {
|
||||
border-bottom-color: #232323;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-top.shepherd-element-attached-center.shepherd-has-title .shepherd-arrow {
|
||||
border-bottom-color: #303030;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-middle.shepherd-element-attached-left .shepherd-arrow,
|
||||
&.shepherd-pinned-right .shepherd-arrow {
|
||||
border-right-color: #232323;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-middle.shepherd-element-attached-right .shepherd-arrow,
|
||||
&.shepherd-pinned-left .shepherd-arrow {
|
||||
border-left-color: #232323;
|
||||
}
|
||||
}
|
40
app/assets/stylesheets/walter/theme-default.scss
Executable file
40
app/assets/stylesheets/walter/theme-default.scss
Executable file
@ -0,0 +1,40 @@
|
||||
@import "_common";
|
||||
|
||||
.theme-default.shepherd-element {
|
||||
background: #fff;
|
||||
|
||||
.shepherd-text {
|
||||
color: rgba(0, 0, 0, .75);
|
||||
}
|
||||
|
||||
.shepherd-title {
|
||||
color: rgba(0, 0, 0, .75);
|
||||
}
|
||||
|
||||
&.shepherd-has-title .shepherd-content .shepherd-header {
|
||||
background: #e6e6e6;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-bottom.shepherd-element-attached-center .shepherd-arrow,
|
||||
&.shepherd-pinned-top .shepherd-arrow {
|
||||
border-top-color: #fff;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-top.shepherd-element-attached-center .shepherd-arrow {
|
||||
border-bottom-color: #fff;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-top.shepherd-element-attached-center.shepherd-has-title .shepherd-arrow {
|
||||
border-bottom-color: #e6e6e6;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-middle.shepherd-element-attached-left .shepherd-arrow,
|
||||
&.shepherd-pinned-right .shepherd-arrow {
|
||||
border-right-color: #fff;
|
||||
}
|
||||
|
||||
&.shepherd-element-attached-middle.shepherd-element-attached-right .shepherd-arrow,
|
||||
&.shepherd-pinned-left .shepherd-arrow {
|
||||
border-left-color: #fff;
|
||||
}
|
||||
}
|
@ -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
|
21
app/controllers/walter_histories_controller.rb
Normal file
21
app/controllers/walter_histories_controller.rb
Normal file
@ -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
|
@ -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
|
50
app/helpers/walter_helper.rb
Normal file
50
app/helpers/walter_helper.rb
Normal file
@ -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
|
@ -1,4 +0,0 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
class AbrahamHistory < ActiveRecord::Base
|
||||
end
|
4
app/models/walter_history.rb
Normal file
4
app/models/walter_history.rb
Normal file
@ -0,0 +1,4 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
class WalterHistory < ActiveRecord::Base
|
||||
end
|
@ -1,61 +0,0 @@
|
||||
<script>
|
||||
var tour = new Shepherd.Tour({
|
||||
defaults: {
|
||||
classes: '<%= Rails.configuration.abraham.default_theme %>'
|
||||
}
|
||||
});
|
||||
|
||||
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('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>
|
77
app/views/application/_shepherd.html.erb
Normal file
77
app/views/application/_shepherd.html.erb
Normal file
@ -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>
|
@ -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__)
|
||||
|
@ -1,7 +1,8 @@
|
||||
en:
|
||||
abraham:
|
||||
walter:
|
||||
later: "Later"
|
||||
continue: "Continue"
|
||||
exit: "Exit"
|
||||
done: "Done"
|
||||
next: "Next"
|
||||
back: "Back"
|
||||
|
@ -1,5 +1,5 @@
|
||||
es:
|
||||
abraham:
|
||||
walter:
|
||||
later: "Luego"
|
||||
continue: "Continuar"
|
||||
exit: "Dejar"
|
||||
|
@ -1,5 +1,5 @@
|
||||
fr:
|
||||
abraham:
|
||||
walter:
|
||||
later: "Plus tard"
|
||||
continue: "Continuer"
|
||||
exit: "Quitter"
|
||||
|
@ -1,5 +1,5 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
Rails.application.routes.draw do
|
||||
resources :abraham_histories, only: :create
|
||||
resources :walter_histories, only: :create
|
||||
end
|
||||
|
@ -1,6 +0,0 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "abraham/engine"
|
||||
|
||||
module Abraham
|
||||
end
|
@ -1,11 +0,0 @@
|
||||
defaults: &defaults
|
||||
:default_theme: 'shepherd-theme-default'
|
||||
|
||||
development:
|
||||
<<: *defaults
|
||||
|
||||
test:
|
||||
<<: *defaults
|
||||
|
||||
production:
|
||||
<<: *defaults
|
@ -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.default_theme = abraham_config[:default_theme]
|
||||
config.abraham.tours = tours
|
||||
end
|
@ -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
|
10
lib/generators/walter/templates/initializer.rb
Normal file
10
lib/generators/walter/templates/initializer.rb
Normal file
@ -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
|
@ -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
|
14
lib/generators/walter/templates/walter.yml
Normal file
14
lib/generators/walter/templates/walter.yml
Normal file
@ -0,0 +1,14 @@
|
||||
defaults: &defaults
|
||||
# Add any valid Shepherd.js configuration JSON here
|
||||
# and it will be passed into the `new Shepherd.Tour()`
|
||||
# initializer.
|
||||
:tour_options: '{ defaultStepOptions: { classes: "theme-default" } }'
|
||||
|
||||
development:
|
||||
<<: *defaults
|
||||
|
||||
test:
|
||||
<<: *defaults
|
||||
|
||||
production:
|
||||
<<: *defaults
|
@ -1,5 +1,5 @@
|
||||
# frozen_string_literal: true
|
||||
# desc "Explaining what the task does"
|
||||
# task :abraham do
|
||||
# task :walter do
|
||||
# # Task goes here
|
||||
# end
|
||||
|
15
lib/walter.rb
Normal file
15
lib/walter.rb
Normal file
@ -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
|
@ -2,7 +2,7 @@
|
||||
|
||||
require "rubygems"
|
||||
|
||||
module Abraham
|
||||
module Walter
|
||||
class Engine < ::Rails::Engine
|
||||
end
|
||||
end
|
39
lib/walter/tourguide.rb
Normal file
39
lib/walter/tourguide.rb
Normal file
@ -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
|
@ -1,5 +1,5 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Abraham
|
||||
VERSION = "1.5.2"
|
||||
module Walter
|
||||
VERSION = "2.5"
|
||||
end
|
@ -1,9 +1,8 @@
|
||||
{
|
||||
"name": "abraham",
|
||||
"name": "walter",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"jquery": "^3.4.0",
|
||||
"js-cookie": "^2.2.0",
|
||||
"shepherd.js": "^3.1.0"
|
||||
"shepherd.js": "^8.3.1"
|
||||
}
|
||||
}
|
||||
|
@ -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
|
||||
|
@ -16,5 +16,5 @@ Capybara.register_driver(:headless_chrome) do |app|
|
||||
end
|
||||
|
||||
class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
|
||||
driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
|
||||
driven_by :selenium, using: :headless_chrome, screen_size: [1400, 1400]
|
||||
end
|
||||
|
@ -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 .
|
||||
|
@ -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 "shepherd.js/dist/css/shepherd-theme-default"
|
||||
*= require walter/theme-default
|
||||
*= require_tree .
|
||||
*/
|
@ -1,4 +0,0 @@
|
||||
/*
|
||||
Place all the styles related to the matching controller here.
|
||||
They will automatically be included in application.css.
|
||||
*/
|
@ -2,6 +2,7 @@
|
||||
|
||||
class DashboardController < ApplicationController
|
||||
def home; end
|
||||
|
||||
def other; end
|
||||
def placement; end
|
||||
def missing; end
|
||||
end
|
||||
|
@ -0,0 +1,5 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
class Foobar::DashboardController < ApplicationController
|
||||
def home; end
|
||||
end
|
@ -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>
|
||||
|
5
test/dummy/app/views/dashboard/missing.html.erb
Normal file
5
test/dummy/app/views/dashboard/missing.html.erb
Normal file
@ -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.
|
@ -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 %>
|
22
test/dummy/app/views/dashboard/placement.html.erb
Normal file
22
test/dummy/app/views/dashboard/placement.html.erb
Normal file
@ -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>
|
4
test/dummy/app/views/foobar/dashboard/home.html.erb
Normal file
4
test/dummy/app/views/foobar/dashboard/home.html.erb
Normal file
@ -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
|
@ -11,6 +11,10 @@
|
||||
<body>
|
||||
<%= yield %>
|
||||
|
||||
<%= abraham_tour %>
|
||||
<hr>
|
||||
|
||||
<p><em>current_user.id = <%= current_user.id %></em></p>
|
||||
|
||||
<%= walter_tour %>
|
||||
</body>
|
||||
</html>
|
||||
|
@ -1,5 +1,5 @@
|
||||
defaults: &defaults
|
||||
:default_theme: 'shepherd-theme-default'
|
||||
:tour_options: '{ defaultStepOptions: { classes: "theme-default" } }'
|
||||
|
||||
development:
|
||||
<<: *defaults
|
||||
|
@ -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
|
||||
|
@ -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.default_theme = abraham_config[:default_theme]
|
||||
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
|
||||
|
@ -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
|
||||
|
@ -10,10 +10,20 @@ intro:
|
||||
text: "ENGLISH Refers to an element that won't exist on the page, should skip to 4"
|
||||
attachTo:
|
||||
element: "#i-dont-exist"
|
||||
position: "right"
|
||||
placement: "right"
|
||||
4:
|
||||
title: "ENGLISH The final step"
|
||||
text: "ENGLISH Some text here too, and it's attached to the right"
|
||||
attachTo:
|
||||
element: ".notice-me"
|
||||
position: "right"
|
||||
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"
|
@ -10,10 +10,10 @@ intro:
|
||||
text: "Refers to an element that won't exist on the page, should skip to 4"
|
||||
attachTo:
|
||||
element: "#i-dont-exist"
|
||||
position: "right"
|
||||
placement: "right"
|
||||
4:
|
||||
title: "SPANISH The final step"
|
||||
text: "Some text here too, and it's attached to the right"
|
||||
attachTo:
|
||||
element: ".notice-me"
|
||||
position: "right"
|
||||
placement: "right"
|
||||
|
10
test/dummy/config/tours/dashboard/missing.en.yml
Normal file
10
test/dummy/config/tours/dashboard/missing.en.yml
Normal file
@ -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!"
|
@ -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:
|
||||
|
77
test/dummy/config/tours/dashboard/placement.en.yml
Normal file
77
test/dummy/config/tours/dashboard/placement.en.yml
Normal file
@ -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"
|
4
test/dummy/config/tours/foobar/dashboard/home.en.yml
Normal file
4
test/dummy/config/tours/foobar/dashboard/home.en.yml
Normal file
@ -0,0 +1,4 @@
|
||||
module:
|
||||
steps:
|
||||
1:
|
||||
text: "This tour should appear for the Foobar::DashboardController only"
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -11,21 +11,22 @@ class DashboardControllerTest < ActionDispatch::IntegrationTest
|
||||
I18n.locale = :en
|
||||
end
|
||||
|
||||
test "uses configured shepherd theme" do
|
||||
# default
|
||||
test "uses configured shepherd configuration" do
|
||||
# No options
|
||||
Rails.configuration.walter.tour_options = nil
|
||||
get dashboard_home_url
|
||||
assert_response :success
|
||||
assert_select "body script" do |element|
|
||||
# it's the home tour
|
||||
assert element.text.include? "classes: 'shepherd-theme-default'"
|
||||
# No options passed into Tour()
|
||||
assert element.text.include? "new Shepherd.Tour()"
|
||||
end
|
||||
|
||||
# custom
|
||||
Rails.configuration.abraham.default_theme = "my-custom-theme"
|
||||
# Custom options
|
||||
Rails.configuration.walter.tour_options = '{ defaultStepOptions: { classes: "my-custom-class" } }'
|
||||
get dashboard_home_url
|
||||
assert_select "body script" do |element|
|
||||
# it's the home tour
|
||||
assert element.text.include? "classes: 'my-custom-theme'"
|
||||
# Config-specified options passed into Tour()
|
||||
assert element.text.include? 'new Shepherd.Tour({ defaultStepOptions: { classes: "my-custom-class" } })'
|
||||
end
|
||||
end
|
||||
|
||||
|
@ -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
|
@ -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
|
||||
|
||||
@ -13,16 +13,21 @@ class ToursTest < ApplicationSystemTestCase
|
||||
# Tour Step 1
|
||||
assert_selector ".shepherd-element", visible: true
|
||||
assert_selector ".shepherd-text", text: "ENGLISH This first HOME step is centered text-only"
|
||||
assert_selector ".shepherd-button", text: "LATER"
|
||||
assert_selector ".shepherd-button", text: "CONTINUE"
|
||||
find(".shepherd-button", text: "CONTINUE").click
|
||||
assert_selector ".shepherd-button", text: "Later"
|
||||
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"
|
||||
assert_selector ".shepherd-button", text: "EXIT"
|
||||
assert_selector ".shepherd-button", text: "NEXT"
|
||||
find(".shepherd-button", text: "NEXT").click
|
||||
assert_selector ".shepherd-button", text: "Exit"
|
||||
assert_selector ".shepherd-button", text: "Next"
|
||||
find(".shepherd-button", text: "Next").click
|
||||
|
||||
# Tour Step 3 (should be skipped)
|
||||
refute_selector ".shepherd-header", text: "ENGLISH A missing step"
|
||||
@ -30,9 +35,9 @@ class ToursTest < ApplicationSystemTestCase
|
||||
# Tour Step 4
|
||||
assert_selector ".shepherd-header", text: "ENGLISH The final step"
|
||||
assert_selector ".shepherd-text", text: "ENGLISH Some text here too, and it's attached to the right"
|
||||
assert_selector ".tippy-arrow", visible: true
|
||||
assert_selector ".shepherd-button", text: "DONE"
|
||||
find(".shepherd-button", text: "DONE").click
|
||||
assert_selector ".shepherd-arrow", visible: true
|
||||
assert_selector ".shepherd-button", text: "Done"
|
||||
find(".shepherd-button", text: "Done").click
|
||||
|
||||
# Tour should no longer be visible
|
||||
refute_selector ".shepherd-element"
|
||||
@ -40,14 +45,25 @@ 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
|
||||
test "mark a tour for Later and it will not come back in this session" do
|
||||
visit dashboard_home_url
|
||||
assert_selector ".shepherd-element", visible: true
|
||||
|
||||
# Dismiss tour
|
||||
find(".shepherd-button", text: "LATER").click
|
||||
find(".shepherd-button", text: "Later").click
|
||||
|
||||
# Tour should no longer be visible
|
||||
refute_selector ".shepherd-element"
|
||||
@ -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
|
||||
|
@ -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
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
require "test_helper"
|
||||
|
||||
class AbrahamHistoryTest < ActiveSupport::TestCase
|
||||
class WalterHistoryTest < ActiveSupport::TestCase
|
||||
# test "the truth" do
|
||||
# assert true
|
||||
# end
|
||||
|
@ -3,25 +3,23 @@
|
||||
$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"]
|
||||
|
||||
s.add_dependency 'rails', '~> 5.1'
|
||||
|
||||
s.add_development_dependency 'sassc-rails'
|
||||
s.add_development_dependency 'sqlite3'
|
||||
s.add_development_dependency 'rubocop'
|
||||
s.add_development_dependency 'listen'
|
||||
s.add_development_dependency 'web-console'
|
||||
end
|
74
yarn.lock
74
yarn.lock
@ -1,74 +0,0 @@
|
||||
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
||||
# yarn lockfile v1
|
||||
|
||||
|
||||
body-scroll-lock@^2.6.1:
|
||||
version "2.6.4"
|
||||
resolved "https://registry.yarnpkg.com/body-scroll-lock/-/body-scroll-lock-2.6.4.tgz#567abc60ef4d656a79156781771398ef40462e94"
|
||||
integrity sha512-NP08WsovlmxEoZP9pdlqrE+AhNaivlTrz9a0FF37BQsnOrpN48eNqivKkE7SYpM9N+YIPjsdVzfLAUQDBm6OQw==
|
||||
|
||||
element-matches@^0.1.2:
|
||||
version "0.1.2"
|
||||
resolved "https://registry.yarnpkg.com/element-matches/-/element-matches-0.1.2.tgz#7345cb71e965bd2b12f725e524591c102198361a"
|
||||
integrity sha512-yWh1otcs3OKUWDvu/IxyI36ZI3WNaRZlI0uG/DK6fu0pap0VYZ0J5pEGTk1zakme+hT0OKHwhlHc0N5TJhY6yQ==
|
||||
|
||||
jquery@^3.4.0:
|
||||
version "3.4.1"
|
||||
resolved "https://registry.yarnpkg.com/jquery/-/jquery-3.4.1.tgz#714f1f8d9dde4bdfa55764ba37ef214630d80ef2"
|
||||
integrity sha512-36+AdBzCL+y6qjw5Tx7HgzeGCzC81MDDgaUP8ld2zhx58HdqXGoBd+tHdrBMiyjGQs0Hxs/MLZTu/eHNJJuWPw==
|
||||
|
||||
js-cookie@^2.2.0:
|
||||
version "2.2.0"
|
||||
resolved "https://registry.yarnpkg.com/js-cookie/-/js-cookie-2.2.0.tgz#1b2c279a6eece380a12168b92485265b35b1effb"
|
||||
integrity sha1-Gywnmm7s44ChIWi5JIUmWzWx7/s=
|
||||
|
||||
lodash.defer@^4.1.0:
|
||||
version "4.1.0"
|
||||
resolved "https://registry.yarnpkg.com/lodash.defer/-/lodash.defer-4.1.0.tgz#e9c158a961de1a46ea24fda34685b4ccdd358f3f"
|
||||
integrity sha1-6cFYqWHeGkbqJP2jRoW0zN01jz8=
|
||||
|
||||
lodash.iselement@^4.1.1:
|
||||
version "4.1.1"
|
||||
resolved "https://registry.yarnpkg.com/lodash.iselement/-/lodash.iselement-4.1.1.tgz#f678d4f6f3a964f9ec7f115f2546f3e4a0ba82ca"
|
||||
integrity sha1-9njU9vOpZPnsfxFfJUbz5KC6gso=
|
||||
|
||||
lodash.isobjectlike@^4.0.0:
|
||||
version "4.0.0"
|
||||
resolved "https://registry.yarnpkg.com/lodash.isobjectlike/-/lodash.isobjectlike-4.0.0.tgz#742c5fc65add27924d3d24191681aa9a17b2b60d"
|
||||
integrity sha1-dCxfxlrdJ5JNPSQZFoGqmheytg0=
|
||||
|
||||
lodash.zipobject@^4.1.3:
|
||||
version "4.1.3"
|
||||
resolved "https://registry.yarnpkg.com/lodash.zipobject/-/lodash.zipobject-4.1.3.tgz#b399f5aba8ff62a746f6979bf20b214f964dbef8"
|
||||
integrity sha1-s5n1q6j/YqdG9peb8gshT5ZNvvg=
|
||||
|
||||
popper.js@^1.14.7:
|
||||
version "1.14.7"
|
||||
resolved "https://registry.yarnpkg.com/popper.js/-/popper.js-1.14.7.tgz#e31ec06cfac6a97a53280c3e55e4e0c860e7738e"
|
||||
integrity sha512-4q1hNvoUre/8srWsH7hnoSJ5xVmIL4qgz+s4qf2TnJIMyZFUFMGH+9vE7mXynAlHSZ/NdTmmow86muD0myUkVQ==
|
||||
|
||||
shepherd.js@^3.1.0:
|
||||
version "3.1.0"
|
||||
resolved "https://registry.yarnpkg.com/shepherd.js/-/shepherd.js-3.1.0.tgz#743769a604ecc8174403fb53766a4b2609690fb5"
|
||||
integrity sha512-Q6akYrPhNBClTxXQG5URAUc1tfimOAeah7EtZ+xqVcpSPo6BY41MxOrB/u5PZPDsGnjak4woJqhgpwo7UmAyiw==
|
||||
dependencies:
|
||||
body-scroll-lock "^2.6.1"
|
||||
element-matches "^0.1.2"
|
||||
lodash.defer "^4.1.0"
|
||||
lodash.iselement "^4.1.1"
|
||||
lodash.isobjectlike "^4.0.0"
|
||||
lodash.zipobject "^4.1.3"
|
||||
smoothscroll-polyfill "^0.4.4"
|
||||
tippy.js "^4.3.4"
|
||||
|
||||
smoothscroll-polyfill@^0.4.4:
|
||||
version "0.4.4"
|
||||
resolved "https://registry.yarnpkg.com/smoothscroll-polyfill/-/smoothscroll-polyfill-0.4.4.tgz#3a259131dc6930e6ca80003e1cb03b603b69abf8"
|
||||
integrity sha512-TK5ZA9U5RqCwMpfoMq/l1mrH0JAR7y7KRvOBx0n2869aLxch+gT9GhN3yUfjiw+d/DiF1mKo14+hd62JyMmoBg==
|
||||
|
||||
tippy.js@^4.3.4:
|
||||
version "4.3.4"
|
||||
resolved "https://registry.yarnpkg.com/tippy.js/-/tippy.js-4.3.4.tgz#9a91fd5ce8c401f181b7adaa6b2c27f3d105f3ba"
|
||||
integrity sha512-O2ukxHOJTLVYZ/TfHjNd8WgAWoefX9uk5QiWRdHfX2PR2lBpUU4BJQLl7U2Ykc8K7o16gTeHEElpuRfgD5b0aA==
|
||||
dependencies:
|
||||
popper.js "^1.14.7"
|
Loading…
x
Reference in New Issue
Block a user