hopskip 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmYxOTQ5NTIwN2Q3YjcxOTA5N2NmMGRlYjg1MWQ4OTlhNjk3ZTc3MA==
+  data.tar.gz: !binary |-
+    MThjZTNlODE0YzkyMjk1MTlhMDAxODY5ZWMxMjNkZTczNzBiMWMwYw==
+SHA512:
+  metadata.gz: !binary |-
+    ODY1NjFlZjRiYmIyMGEzZGM0M2E0M2Y0NDMzM2Y5NjRhZTZkMGZjZTY3YWFh
+    MDRiODA5MTgwYmE3OWNkMzc1NjJmYWIyZmFhN2Y2MjliMjAzOTVkMDdlNWY5
+    Mjc1YTRjNzNkNzgyMDZiZjAzODY5MDRhY2U1MWM3ODA2NDgyNDY=
+  data.tar.gz: !binary |-
+    YjM2ZTQ5Yjk2MTc3MDZmOTFlOGY1MGE4YzA5ZjNlMWZhNjRjMjEzZGNkYjc1
+    NDYxMzM0YTJjMDI3NTU5OGZiMGIyMTA2M2ZmOTA2NTM2MDBkNWRlOGFjNzhj
+    N2U0MDM2NjRiZjkyNDZjMmMxMzBmZDYzYWI1Njg5NzY5ZDA5MmY=

data/README.md

@@ -1,8 +1,8 @@
 # Hopskip
 
-[![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)
+| Version | Status | Quality | Coverage |
+|:--------:|:------------:|:-----:|:-----:|
+| [![Gem Version](https://badge.fury.io/rb/hopskip.png)](http://badge.fury.io/rb/hopskip) | [![Build Status](https://travis-ci.org/boxuk/hopskip.png?branch=master)](https://travis-ci.org/boxuk/hopskip) | [![Code Climate](https://codeclimate.com/github/boxuk/hopskip.png)](https://codeclimate.com/github/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.
 
@@ -86,6 +86,11 @@ index:
 
 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.
 
+
+## Error Handling
+
+If the YAML file is not correctly formatted, Hopskip will raise a `Hopskip::InvalidYAMLError` exception.
+
 ## 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

@@ -1,4 +1,7 @@
 module Hopskip
+
+  class Hopskip::InvalidYAMLError < StandardError; end
+
   class HopscotchParser
 
     require 'yaml'
@@ -9,6 +12,8 @@ module Hopskip
     def initialize(controller)
       @controller = controller
       filename = Rails.root.join('app', 'tours', "#{ @controller.controller_name }_tour.yml")
+      raise Hopskip::InvalidYAMLError unless valid_yaml_string?(File.open(filename).read)
+
       if File.exists?(filename)
         @yaml_source = YAML::load(File.open("#{ Rails.root }/app/tours/#{ @controller.controller_name }_tour.yml"))
       end
@@ -22,5 +27,13 @@ module Hopskip
       end
     end
 
+    private
+
+    def valid_yaml_string?(yaml)
+      !!YAML.load(yaml)
+    rescue Exception => e
+      return false
+    end
+
   end
 end

data/lib/hopskip/version.rb

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

data/test/dummy/app/controllers/failure_controller.rb

@@ -0,0 +1,3 @@
+class FailureController < ApplicationController
+
+end

data/test/dummy/app/tours/failure_tour.yml

@@ -0,0 +1,7 @@
+---
+index:
+  steps:
+    - title: Create A Person
+      content: "Click here to add your first person."
+      target- new_person_link
+      placement: left

data/test/dummy/log/test.log

@@ -1340,3 +1340,150 @@ 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
+Connecting to database specified by database.yml
+   (0.4ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-20 13:59:03 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (2.4ms)
+Completed 200 OK in 38.8ms (Views: 38.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-20 13:59:03 +0000
+Processing by PeopleController#show as HTML
+  Parameters: {"id"=>"1"}
+Completed 200 OK in 3.3ms (Views: 2.8ms | 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.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-20 13:59:49 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (2.3ms)
+Completed 200 OK in 19.2ms (Views: 18.6ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-20 13:59:49 +0000
+Processing by PeopleController#show as HTML
+  Parameters: {"id"=>"1"}
+Completed 200 OK in 3.1ms (Views: 2.7ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.3ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-20 14:02:08 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (3.0ms)
+Completed 200 OK in 16.8ms (Views: 16.4ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-20 14:02:08 +0000
+Processing by PeopleController#show as HTML
+  Parameters: {"id"=>"1"}
+Completed 200 OK in 3.6ms (Views: 3.1ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-20 14:03:35 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (2.0ms)
+Completed 200 OK in 16.1ms (Views: 15.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-20 14:03:35 +0000
+Processing by PeopleController#show as HTML
+  Parameters: {"id"=>"1"}
+Completed 200 OK in 3.5ms (Views: 3.1ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.4ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-20 14:03:47 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (2.1ms)
+Completed 200 OK in 17.1ms (Views: 16.5ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-20 14:03:47 +0000
+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.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-20 14:04:07 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (3.7ms)
+Completed 200 OK in 20.9ms (Views: 20.4ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-20 14:04:08 +0000
+Processing by PeopleController#show as HTML
+  Parameters: {"id"=>"1"}
+Completed 200 OK in 3.7ms (Views: 3.2ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.3ms)  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
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+Started GET "/people" for 127.0.0.1 at 2013-12-20 14:04:23 +0000
+Processing by PeopleController#index as HTML
+  Rendered people/index.html.erb within layouts/application (1.9ms)
+Completed 200 OK in 17.8ms (Views: 17.3ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Started GET "/people/1" for 127.0.0.1 at 2013-12-20 14:04:23 +0000
+Processing by PeopleController#show as HTML
+  Parameters: {"id"=>"1"}
+Completed 200 OK in 3.2ms (Views: 2.8ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction

data/test/lib/hopskip/hopscotch_parser_test.rb

@@ -11,4 +11,10 @@ class HopscotchParserTest < ActiveSupport::TestCase
     assert_nil a.show
   end
 
+  test '#invalid YAML should raise error' do
+    assert_raises Hopskip::InvalidYAMLError do
+      Hopskip::HopscotchParser.new(FailureController.new)
+    end
+  end
+
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: hopskip
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Max Woolf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -80,10 +73,12 @@ files:
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/assets/stylesheets/people.css
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/failure_controller.rb
 - test/dummy/app/controllers/people_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/helpers/people_helper.rb
 - test/dummy/app/tours/application_tour.yml
+- test/dummy/app/tours/failure_tour.yml
 - test/dummy/app/tours/people_tour.yml
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/people/index.html.erb
@@ -123,33 +118,26 @@ files:
 - test/test_helper.rb
 homepage: http://boxuk.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1049451874999815942
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1049451874999815942
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Hopscotch introductions written more cleanly in YAML
 test_files:
 - test/dummy/app/assets/javascripts/application.js
@@ -157,10 +145,12 @@ test_files:
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/assets/stylesheets/people.css
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/failure_controller.rb
 - test/dummy/app/controllers/people_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/helpers/people_helper.rb
 - test/dummy/app/tours/application_tour.yml
+- test/dummy/app/tours/failure_tour.yml
 - test/dummy/app/tours/people_tour.yml
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/people/index.html.erb