hopskip 0.1.2 → 0.1.3

data/README.md

@@ -2,9 +2,15 @@
 
 [![Code Climate](https://codeclimate.com/github/boxuk/hopskip.png)](https://codeclimate.com/github/boxuk/hopskip)
 [![Build Status](https://travis-ci.org/boxuk/hopskip.png?branch=master)](https://travis-ci.org/boxuk/hopskip)
+[![Coverage Status](https://coveralls.io/repos/boxuk/hopskip/badge.png?branch=master)](https://coveralls.io/r/boxuk/hopskip?branch=master)
 
 Write [hopscotch](https://github.com/linkedin/hopscotch) introductions simply by adding YAML files to your Rails application.
 
+## Requirements
+
+* Rails 3.2+
+* Hopscotch `js` and `css` files available. You can use just a standard installation in the asset pipeline or [this gem](https://github.com/ccschmitz/hopscotch-rails).
+
 ## Install
 
 Add `hopskip` to your `Gemfile`
@@ -24,29 +30,62 @@ Add the `hopskip` template to your application layout. It doesn't matter where,
         ├── dashboards_tour.yml
         └── projects_tour.yml
 
-Where each file is name `xyz_tour.yml` where `x` is the name of the controller.
+Where each file is name `xyz_tour.yml` where `xyz` is the name of the controller.
 
 The contents of each of these files should look similar to this:
 
-    ---
-    index:
-      steps:
-        - title: Welcome to My App
-          content: "Some Text..."
-          target: left_util
-          placement: right
-
-        - title: Dashboard
-          content: "This is your dashboard"
-          target: left_util
-          placement: bottom
-    show:
-      steps:
-        - title: another title...
-      #...
+```YAML
+---
+index:
+  steps:
+    - title: Welcome to My App
+      content: "Some Text..."
+      target: left_util
+      placement: right
+
+    - title: Dashboard
+      content: "This is your dashboard"
+      target: left_util
+      placement: bottom
+show:
+  steps:
+    - title: another title...
+  #...
+```
 
 You can generate an example tour file by using the included generator:
 
     rails generate tour [controller_name]
 
-For a full list of params, check out the hopscotch docs.
+For a full list of params, check out the hopscotch docs.
+
+## Advanced Usage
+
+You can also attach methods to the `onClose`, `onEnd` and other callback methods included with hopscotch. Simply define a hopscotch helper in your view:
+
+```JavaScript
+<script>
+  hopscotch.registerHelper('showError', function() {
+    alert("This is an error!");
+  });
+</script>
+```
+  In your tour file, you can now ask that this method is called at various points in the tour's lifecycle:
+
+```YAML
+---
+index:
+  steps:
+    - title: Welcome to My App
+      content: "Some Text..."
+      target: left_util
+      placement: right
+      onNext:
+        - showError
+```
+
+The `showError` helper will now be executed when next is clicked on the first step. You can pass as many helpers as you like to each callback methods.
+
+## We use Hopskip
+
+We use Hopskip in [FleetSuite](http://www.boxuk.com/fleetsuite/), a business management system offering a set of collaborative project management tools to optimise processes.

data/lib/hopskip/hopscotch_parser.rb

@@ -9,11 +9,8 @@ module Hopskip
     def initialize(controller)
       @controller = controller
       filename = Rails.root.join('app', 'tours', "#{ @controller.controller_name }_tour.yml")
-      puts filename
       if File.exists?(filename)
         @yaml_source = YAML::load(File.open("#{ Rails.root }/app/tours/#{ @controller.controller_name }_tour.yml"))
-      else
-        puts 'cannot find file!'
       end
     end
 

data/lib/hopskip/version.rb

@@ -1,3 +1,3 @@
 module Hopskip
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/test/dummy/log/test.log

@@ -1302,3 +1302,41 @@ Processing by PeopleController#show as HTML
   Parameters: {"id"=>"1"}
 Completed 200 OK in 3.4ms (Views: 3.0ms | ActiveRecord: 0.0ms)
    (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.5ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-11 11:13:07 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (2.8ms)
+Completed 200 OK in 18.8ms (Views: 18.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-11 11:13:07 +0000
+Processing by PeopleController#show as HTML
+  Parameters: {"id"=>"1"}
+Completed 200 OK in 2.8ms (Views: 2.5ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-11 11:40:37 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (2.4ms)
+Completed 200 OK in 35.1ms (Views: 34.5ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-11 11:40:37 +0000
+Processing by PeopleController#show as HTML
+  Parameters: {"id"=>"1"}
+Completed 200 OK in 3.0ms (Views: 2.7ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction

data/test/dummy/test/integration/user_flows_test.rb

@@ -3,7 +3,6 @@ require 'test_helper'
 class UserFlowsTest < ActionDispatch::IntegrationTest
   test '#index shows the hopscotch' do
     get '/people'
-    puts @response.body
     assert_tag tag: 'script', parent: { :tag => 'body' }
     assert_response :success
   end

data/test/test_helper.rb

@@ -1,4 +1,6 @@
 # Configure Rails Environment
+require 'coveralls'
+Coveralls.wear!
 ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hopskip
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -72,7 +72,7 @@ files:
 - lib/hopskip/version.rb
 - lib/hopskip.rb
 - lib/tasks/hopskip_tasks.rake
-- MIT-LICENSE
+- LICENCE.md
 - Rakefile
 - README.md
 - test/dummy/app/assets/javascripts/application.js
@@ -135,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4064894685666321658
+      hash: 1049451874999815942
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4064894685666321658
+      hash: 1049451874999815942
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25