gatling 1.0.4 → 1.0.5

data/README.rdoc

@@ -4,13 +4,25 @@ Gatling Comparison allows one to build an Rspec / Capybara custom matcher compar
 
 -------------------------------------
 
-Usage:
+=== Installation:
+
+  gem install gatling
+
+In spec_helper.rb :
+
+  #main app
+  require 'gatling'
+
+  #plug and play custom rspec matcher
+  require 'gatling/matchers/look_like_matcher'
+
+=== Usage:
 
 Identify an element to match, for example:
 
         @element = page.find(:css, #button)
 	
-Use Gatling's custom matcher and specify the reference image:
+Use Gatling's custom matcher (conveniently supplied in the gatling gem) and specify the reference image:
 
         @element.should look_like('button_ref.png')
 	
@@ -24,14 +36,33 @@ If no reference image exits, the test will fail, an exception will be raised and
 
 -------------------------------------
 
-Usage, training mode:
+=== The path config:
+
+For Rails application, a default reference images folder will be created at spec/reference_images. This folder is root to all the reference
+images to be compares. 
 
-Gatling can be run in training mode which will create all the initial reference images. 
+Also created are subfolders: 
+- /candidate  - will hold candidate images which can be used as reference images
+- /diff - will hold the diff images generated by failed comparison tests
+- /temp - will only ever hold one screenshot at a time, used to create the cropped element
 
-CAUTION: Trainer mode will pass all the test which rely on the Gatling custom matcher. Please make sure you are saving 'clean' references.
+==== For non-Rails apps or just to change the root reference folder specify in spec_help:
 
+  Gatling::Configuration.reference_image_path = "my custom path"
 
-To set trainer mode, prefix rspec with $GATLING_TRAINER = true 
+
+-------------------------------------
+
+=== Training mode:
+
+Gatling can be run in training mode which will create reference images where ones do not exist. 
+
+<b>CAUTION: Trainer mode will pass all the test which rely on the Gatling custom matcher, this can mean a false green build. 
+Please make sure you are saving 'clean' references</b>
+
+Trainer mode will not overwrite existing references. If you are updating, just delete the old reference image.
+
+To set trainer mode, prefix rspec command line with $GATLING_TRAINER = true 
 
 
 Example:        
@@ -39,8 +70,11 @@ Example:
 
 -------------------------------------
 
-Non-gem dependencies: Imagemagick must be installed: 
-        $sudo apt-get install imagemagick
+==== Non-gem dependencies:
+
+Imagemagick must be installed: 
+
+  $sudo apt-get install imagemagick
 
 -------------------------------------
 

data/lib/gatling/matchers/look_like_matcher.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'gatling'
 
 RSpec::Matchers.define :look_like do |expected|

data/lib/gatling/version.rb

@@ -1,3 +1,3 @@
 module Gatling
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gatling
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000Z
+date: 2012-02-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &70217162793980 !ruby/object:Gem::Requirement
+  requirement: &70364760127060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70217162793980
+  version_requirements: *70364760127060
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &70217162793300 !ruby/object:Gem::Requirement
+  requirement: &70364756259500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70217162793300
+  version_requirements: *70364756259500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70217162792460 !ruby/object:Gem::Requirement
+  requirement: &70364756259080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70217162792460
+  version_requirements: *70364756259080
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70217162791640 !ruby/object:Gem::Requirement
+  requirement: &70364756258660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70217162791640
+  version_requirements: *70364756258660
 description: Add visual comparison matchers for rspec
 email:
 - grotbart@gmail.com
@@ -87,7 +87,6 @@ files:
 - spec/support/assets/smiley-bad.jpg
 - spec/support/assets/smiley_app.rb
 - spec/support/assets/views/smiley_site.erb
-- spec/support/ready_candidate_ref/smiley-faceicon.png
 homepage: http://github.com/GabrielRotbart/gatling
 licenses: []
 post_install_message: 
@@ -122,4 +121,3 @@ test_files:
 - spec/support/assets/smiley-bad.jpg
 - spec/support/assets/smiley_app.rb
 - spec/support/assets/views/smiley_site.erb
-- spec/support/ready_candidate_ref/smiley-faceicon.png