gatling 1.0.8 → 1.0.9

data/.gitignore

@@ -11,3 +11,7 @@ spec/support/ready_candidate_ref/temp/*
 reports/*
 vendor/*
 /.rbenv*
+.rakeTasks
+*.iml
+*.ipr
+*.iws

data/README.rdoc

@@ -8,7 +8,7 @@ An integrated visual RSpec matcher which makes real visual testing easy.
 
   gem install gatling
 
-In spec_helper.rb :
+In spec_helper.rb:
 
   #main app
   require 'gatling'
@@ -32,13 +32,16 @@ Also created are subfolders:
 
 === Sleep_between_tries - sets the sleep time (in seconds) between match tries (requires max_no_tries > 1). Defaults to 0.5
 
+=== browser_folders - *Currently only available with Selenium-Webdriver / Capybara* - create reference folders based on the current Selenium driver's browser. Allows for cross-browser visual testing.
+
 === Configuration settings are set with the following:
 
-Gatling.config do |setting|
-  Gatling.reference_image_path = 'my_custom_path'
-  Gatling.max_no_tries = 3
-  Gatling.sleep_between_tries = 0.7
-end
+  Gatling.config do |setting|
+    Gatling.reference_image_path = 'my_custom_path'
+    Gatling.max_no_tries = 3
+    Gatling.sleep_between_tries = 0.7
+    Gatling.browser_folders = true
+  end
 
 GATLING::CONFIGURATION will be depreciated in future versions.
 -------------------------------------

data/Rakefile

@@ -7,7 +7,7 @@ require File.expand_path('spec/spec_helper.rb')
 task :default => :full_build
 
 desc "full build, run all the tests"
-task :full_build => [:unit, :acceptance]
+task :full_build => [:unit,:acceptance]
 
 desc "Run unit tests"
 RSpec::Core::RakeTask.new(:unit) do |t|

data/lib/gatling.rb

@@ -7,6 +7,7 @@ require 'gatling/image'
 require 'gatling/comparison'
 require 'gatling/capture_element'
 
+
 #TODO: Helpers for cucumber
 #TODO: Make directories as needed
 
@@ -14,13 +15,12 @@ module Gatling
 
   class << self
 
-    attr_accessor :reference_image_path, :max_no_tries, :sleep_between_tries
+    attr_accessor :reference_image_path, :max_no_tries, :sleep_between_tries, :browser_folders
 
     def matches?(expected_reference_filename, actual_element)
 
       expected_reference_file = (File.join(Gatling::Configuration.path(:reference), expected_reference_filename))
 
-
       if Gatling::Configuration.trainer_toggle
         actual_image = Gatling::ImageFromElement.new(actual_element, expected_reference_filename)
         save_image_as_reference(actual_image)
@@ -35,26 +35,26 @@ module Gatling
         comparison = compare_until_match(actual_element, expected_reference_filename, Gatling::Configuration.max_no_tries)
         matches = comparison.matches?
         if !matches
-          comparison.actual_image.save(:as => :candidate)
+          comparison.actual_image.save(:candidate)
           save_image_as_diff(comparison.diff_image)
         end
         matches
       end
     end
 
-    def compare_until_match actual_element, expected_reference_filename, max_no_tries
-      tries = max_no_tries
+    def compare_until_match actual_element, expected_reference_filename, max_no_tries = Gatling::Configuration.max_no_tries, sleep_time = Gatling::Configuration.sleep_between_tries
       try = 0
       match = false
       expected_image = Gatling::ImageFromFile.new(expected_reference_filename)
       comparison = nil
-      while !match && try < tries
+      while !match && try < max_no_tries
         actual_image = Gatling::ImageFromElement.new(actual_element, expected_reference_filename)
-        comparison = Gatling::Comparison.new(expected_image, actual_image)
+        comparison = Gatling::Comparison.new(actual_image, expected_image)
         match = comparison.matches?
         if !match
-          sleep 0.5
+          sleep sleep_time
           try += 1
+          #TODO: Send to logger instead of puts
           puts "Tried to match #{try} times"
         end
       end
@@ -62,15 +62,15 @@ module Gatling
     end
 
     def save_image_as_diff(image)
-      image.save(:as => :diff)
+      image.save(:diff)
       raise "element did not match #{image.file_name}. A diff image: #{image.file_name} was created in " +
-      "#{File.join(Gatling::Configuration.path(:diff),image.file_name)}. " +
-      "A new reference #{File.join(Gatling::Configuration.path(:candidate),image.file_name)} can be used to fix the test"
+      "#{image.path(:diff)} " +
+      "A new reference #{image.path(:candidate)} can be used to fix the test"
     end
 
     def save_image_as_candidate(image)
-      image.save :as => :candidate
-      raise "The design reference #{image.file_name} does not exist, #{image.path} " +
+      image.save(:candidate)
+      raise "The design reference #{image.file_name} does not exist, #{image.path(:candidate)} " +
       "is now available to be used as a reference. Copy candidate to root reference_image_path to use as reference"
     end
 
@@ -78,7 +78,7 @@ module Gatling
       if image.exists?
         puts "#{image.path} already exists. reference image was not overwritten. please delete the old file to update using trainer"
       else
-        image.save(:as => :reference)
+        image.save(:reference)
         puts "Saved #{image.path} as reference"
       end
     end

data/lib/gatling/capture_element.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require_relative 'image_wrangler'
 
 module Gatling
@@ -19,14 +20,17 @@ module Gatling
     end
 
     def take_screenshot
-      temp_dir = "#{@reference_image_path}/temp"
+      temp_dir = File.join(@reference_image_path, 'temp')
+      FileUtils.mkdir_p(temp_dir) unless File.exists?(temp_dir)
       #captures the uncropped full screen
       begin
-        Capybara.page.driver.browser.save_screenshot("#{temp_dir}/temp.png")
-        temp_screenshot = Magick::Image.read("#{temp_dir}/temp.png").first
+        temp_screenshot_filename = File.join(temp_dir, "temp-#{Process.pid}.png")
+        Capybara.page.driver.browser.save_screenshot(temp_screenshot_filename)
+        temp_screenshot = Magick::Image.read(temp_screenshot_filename).first
       rescue
         raise "Could not save screenshot to #{temp_dir}. Please make sure you have permission"
       end
     end
   end
-end
+end
+

data/lib/gatling/comparison.rb

@@ -6,16 +6,53 @@ module Gatling
     def initialize actual_image, expected_image
       @actual_image = actual_image
       @expected_image = expected_image
-      @comparison = @actual_image.image.compare_channel(@expected_image.image, Magick::MeanAbsoluteErrorMetric)
+      @comparison = compare_image
       @match = @comparison[1] == 0.0
-      if !@matches
-         @diff_image =Gatling::Image.new(@comparison.first, @expected_image.file_name)
-      end
+      @diff_image =Gatling::Image.new(@comparison.first, @expected_image.file_name) unless @matches
     end
 
     def matches?
       @match
     end
 
+    def compare_image
+      compare_images_with_same_size? ? compare_images_with_same_size : compare_images_with_different_size
+    end
+
+    def compare_images_with_same_size
+      images_to_compare = prep_images_for_comparison
+      images_to_compare.first.compare_channel(images_to_compare.last, Magick::MeanAbsoluteErrorMetric)
+    end
+
+    def compare_images_with_different_size
+      row = [@actual_image.image.rows, @expected_image.image.rows].max
+      column = [@actual_image.image.columns, @expected_image.image.columns].max
+
+      images_to_compare = prep_images_for_comparison do |image|
+        expanded_image = image.extent(column, row)
+        expanded_image.background_color = 'white'
+        expanded_image
+      end
+      images_to_compare.first.compare_channel(images_to_compare.last, Magick::MeanAbsoluteErrorMetric)
+    end
+
+    def compare_images_with_same_size?
+      @actual_image.image.rows == @expected_image.image.rows && @actual_image.image.columns == @expected_image.image.columns
+    end
+
+    def prep_images_for_comparison
+      [
+          @actual_image,
+          @expected_image,
+      ].collect do |gatling_image|
+        image = gatling_image.image.clone
+        image = yield image if block_given?
+
+        # Important: ensure the image 0,0 is reset to the top-left of the image before comparison
+        image.offset = 0
+        image
+      end
+    end
+
   end
 end

data/lib/gatling/config.rb

@@ -1,14 +1,16 @@
+require 'logger'
+
 module Gatling
   module Configuration
 
     class << self
 
-      attr_accessor :reference_image_path, :trainer_toggle, :max_no_tries, :sleep_between_tries
+      attr_accessor :reference_image_path, :trainer_toggle, :max_no_tries, :sleep_between_tries, :browser_folders
 
       attr_reader :paths
 
       def reference_image_path
-        Gatling.reference_image_path || @reference_image_path ||= set_default_path
+        @reference_image_path ||= construct_path
       end
 
       def max_no_tries
@@ -21,9 +23,9 @@ module Gatling
 
       def path(type)
         paths = Hash[:reference => reference_image_path,
-                     :candidate => File.join(reference_image_path, 'candidate'),
-                     :diff => File.join(reference_image_path, 'diff'),
-                     :temp => File.join(reference_image_path, 'temp')]
+                    :candidate => File.join(reference_image_path, 'candidate'),
+                    :diff => File.join(reference_image_path, 'diff'),
+                    :temp => File.join(reference_image_path, 'temp')]
         if paths.keys.include? type
           return paths[type]
         else
@@ -49,16 +51,51 @@ module Gatling
       end
 
 
-      def set_default_path
+      def construct_path
         private
+        reference_image_path = user_set_reference_path || default_reference_path
+        reference_image_path = reference_path_with_browser_folders(reference_image_path) if browser_folders
+        reference_image_path
+      end
+
+      def user_set_reference_path
+        Gatling.reference_image_path
+      end
+
+      def default_reference_path
+        begin
+          reference_image_path = File.join(Rails.root, 'spec/reference_images')
+        rescue
+          reference_image_path = 'spec/reference_images'
+          puts "Currently defaulting to #{@reference_image_path}. Overide this by setting Gatling.reference_image_path=[refpath]"
+        end
+        reference_image_path
+      end
+
+      def reference_path_with_browser_folders path
         begin
-          @reference_image_path ||= File.join(Rails.root, 'spec/reference_images')
+          reference_images_path = File.join(path, browser)
         rescue
-          @reference_image_path = 'spec/reference_images'
-          puts "Currently defaulting to #{@reference_image_path}. Overide this by setting Gatling::Configuration.reference_image_path=[refpath]"
+          reference_images_path = path
         end
-        @reference_image_path
+        reference_images_path
       end
+
+      def browser_folders
+        Gatling.browser_folders || @browser_folders ||= false
+      end
+
+      def browser
+        begin
+          browser = Capybara.page.driver.browser.browser
+        rescue
+          browser = Selenium.page.driver.browser.browser
+        rescue
+          raise "Currently custom folders are only supported by Capybara. ENV variables are coming."
+        end
+        browser.to_s
+      end
+
     end
 
   end

data/lib/gatling/image.rb

@@ -14,15 +14,18 @@ module Gatling
     end
 
     def save type
-      path = Gatling::Configuration.path(type[:as])
-      FileUtils::mkdir_p(path) unless File.exists?(path)
-      @path = File.join(path, @file_name)
+      @path = path(type)
+      FileUtils::mkdir_p(File.dirname(@path)) unless File.exists?(@path)
       @image.write @path
       @path
     end
 
     def exists?
-      File.exists?(File.join(Gatling::Configuration.path(:reference), @file_name))
+      File.exists?(path)
+    end
+
+    def path type = :reference
+      @path = File.join(Gatling::Configuration.path(type), @file_name)
     end
 
   end
@@ -34,7 +37,7 @@ module Gatling
 
       @image = Gatling::CaptureElement.new(element).capture
     end
-    
+
     #TODO: make save a relevant subclass method
   end
 
@@ -42,13 +45,11 @@ module Gatling
 
     def initialize file_name
       super(image, file_name)
-
-      @image = Magick::Image.read(File.join(Gatling::Configuration.path(:reference), @file_name)).first
+      @image = Magick::Image.read(path).first
     end
 
     #TODO: make save a relevant subclass method
-    
+
   end
 end
 
-

data/lib/gatling/matchers/look_like_matcher.rb

@@ -1,6 +1,6 @@
 require 'gatling'
 
-RSpec::Matchers.define :look_like do |expected|
+RSpec::Matchers.define:look_like do |expected|
   match do |actual|
     compare = Gatling.matches?(expected, actual)
   end

data/lib/gatling/version.rb

@@ -1,3 +1,3 @@
 module Gatling
-  VERSION = "1.0.8"
+  VERSION = "1.0.9"
 end

data/spec/acceptance/gatling_acceptance_spec.rb

@@ -8,12 +8,12 @@ describe 'Gatling' do
   end
 
   before(:each) do
-    @ref_path = Gatling::Configuration.reference_image_path = File.join(spec_support_root, 'ref_path')
+    @ref_path = Gatling.reference_image_path = File.join(spec_support_root, 'ref_path')
   end
 
   after(:each) do
     remove_refs(@ref_path)
-    Gatling::Configuration.trainer_toggle = false
+    config_clean_up
   end
 
   describe 'Gatling, when no reference image exists' do
@@ -42,25 +42,37 @@ describe 'Gatling' do
       Gatling.matches?("black.png", black_element).should be_true
     end
 
-    it 'will return false, creates new diff and candidate images if the images are different' do
-      red_element = element_for_spec('#red')
-      expected_error = "element did not match #{"black.png"}. " +
-                       "A diff image: #{"black.png"} was created in #{@ref_path}/diff/#{"black.png"}. " +
-                       "A new reference #{@ref_path}/candidate/#{"black.png"} can be used to fix the test"
+    describe 'between different images of the same size' do
 
-      expect {Gatling.matches?("black.png", red_element)}.should raise_error(RuntimeError, expected_error)
+      it 'will return false, creates new diff and candidate images' do
+        red_element = element_for_spec('#red')
+        expected_error = "element did not match #{"black.png"}. " +
+                         "A diff image: #{"black.png"} was created in #{@ref_path}/diff/#{"black.png"} " +
+                         "A new reference #{@ref_path}/candidate/#{"black.png"} can be used to fix the test"
+
+        expect {Gatling.matches?("black.png", red_element)}.should raise_error(RuntimeError, expected_error)
+
+        File.exists?(File.join(@ref_path,'diff', "black.png")).should be_true
+        File.exists?(File.join(@ref_path,'candidate', "black.png")).should be_true
+      end
 
-      File.exists?(File.join(@ref_path,'diff', "black.png")).should be_true
-      File.exists?(File.join(@ref_path,'candidate', "black.png")).should be_true
     end
 
-    # it 'will try to match a specified amount of time before failing' do
-    #      red_element = element_for_spec('#red')
-    #      Gatling.should_receive(:matches?).and_return(false)
-    #      Gatling.should_receive(:try_until_match)
-    #      Gatling.matches?("black.png", red_element)
-    #    end
+    describe 'between images of the different size' do
+
+      it 'will return false, creates new diff and candidate images' do
+        red_element = element_for_spec('#differentSize')
+        expected_error = "element did not match #{"black.png"}. " +
+                         "A diff image: #{"black.png"} was created in #{@ref_path}/diff/#{"black.png"} " +
+                         "A new reference #{@ref_path}/candidate/#{"black.png"} can be used to fix the test"
 
+        expect {Gatling.matches?("black.png", red_element)}.should raise_error(RuntimeError, expected_error)
+
+        File.exists?(File.join(@ref_path,'diff', "black.png")).should be_true
+        File.exists?(File.join(@ref_path,'candidate', "black.png")).should be_true
+      end
+
+    end
   end
 
   describe 'Gatling trainer toggle' do
@@ -79,7 +91,7 @@ describe 'Gatling' do
     it 'will warn if a reference already exists and not overwrite it' do
       create_square_image(@ref_path, 'black')
       Gatling::Configuration.trainer_toggle = true
-      expected_message = " already exists. reference image was not overwritten. " +
+      expected_message = "#{File.join(@ref_path,"black.png")} already exists. reference image was not overwritten. " +
                          "please delete the old file to update using trainer"
       black_element = element_for_spec
       reference_file_ctime = File.ctime(File.join(@ref_path,"black.png"))
@@ -91,4 +103,16 @@ describe 'Gatling' do
       reference_file_ctime.eql?(File.ctime(File.join(@ref_path, "black.png"))).should be_true
     end
   end
+
+  describe 'Gatling browser folders' do
+
+    it 'should set image path according to the driver\'s browser' do
+      Gatling.browser_folders = true
+      Gatling.reference_image_path = '/some/random/path'
+      Gatling::Configuration.reference_image_path.should == '/some/random/path/firefox'
+      Gatling.browser_folders = false
+    end
+  end
+
+
 end

data/spec/acceptance/rspec_matcher_spec.rb

@@ -3,14 +3,14 @@ include Capybara::DSL
 
 describe 'rspec matcher' do
 
-  before(:all) do
+  before(:each) do
     @black_box = 'black.png'
-    @ref_path = Gatling::Configuration.reference_image_path = File.join(spec_support_root, 'ref_path')
+    @ref_path = Gatling.reference_image_path = File.join(spec_support_root, 'ref_path')
     create_images_for_web_page
   end
 
   after(:each) do
-    Gatling::Configuration.trainer_toggle = false
+    config_clean_up
     remove_refs(@ref_path)
   end
 
@@ -18,11 +18,11 @@ describe 'rspec matcher' do
 
     it 'will pass if images matches reference' do
       create_square_image(@ref_path, 'black')
-      black_element = element_for_spec("#black")
+       black_element = element_for_spec("#black")
       black_element.should look_like("black.png")
     end
 
-    it 'will fail if images dosent matches reference' do
+    it "will fail if images doesn't matches reference" do
       create_square_image(@ref_path, 'black')
       red_element = element_for_spec("#red")
       expect{red_element.should look_like(@black_box)}.should raise_error

data/spec/capture_spec.rb

@@ -1,23 +1,54 @@
 require 'spec_helper'
 
 describe Gatling::CaptureElement do
-  
-  before do
 
+  before :each do
     capybara_node = mock (Capybara::Node::Element)
-    Gatling::Configuration.reference_image_path="./"
-    Gatling::CaptureElement.new capybara_node, capybara_node
+    Gatling::Configuration.should_receive(:reference_image_path).and_return("./")
+    @capture_element = Gatling::CaptureElement.new capybara_node, capybara_node
   end
 
- 
+  after :each do
+    config_clean_up
+  end
+
+  describe 'take_screenshot' do
+    before do
+      @webdriver = double('webdriver')
+      Capybara.stub_chain(:page, :driver, :browser).and_return(@webdriver)
+
+      @expected_temp_screenshot_file_pattern = /.*\/temp\/temp-\d+.png/
+    end
+
+    it 'should create temp directory when it does not exist' do
+      @webdriver.stub!(:save_screenshot)
+      Magick::Image.stub!(:read).and_return([])
+
+      File.stub!(:'exists?').and_return(false)
+      FileUtils.should_receive(:mkdir_p).with('./temp')
+
+      @capture_element.take_screenshot
+    end
+
+
+    it 'should work when Gatling is called concurrently from multiple processes' do
+      @webdriver.should_receive(:save_screenshot).with(@expected_temp_screenshot_file_pattern)
+      Magick::Image.should_receive(:read).with(@expected_temp_screenshot_file_pattern).and_return([])
+
+      @capture_element.take_screenshot
+    end
+  end
+
+
 
   # it 'should exclude a specified element from capture' do
-  #  element_to_capture =  
+  #  element_to_capture =
 
-  #  element_to_exclude = 'womething.child' 
+  #  element_to_exclude = 'womething.child'
   # # @cropped_and_censored_element = (element_to_capture, element_to_exclude).exclude
   #  @cropped_and_censored_element.should_not equal(@element_to_capture)
   #  @cropped_and_censored_element.should_not equal(@element_to_exclude)
   # end
 
-end
+end
+

data/spec/comparison_spec.rb

@@ -25,8 +25,46 @@ describe Gatling::Comparison do
   end
 
   describe 'Diff images' do
-    it 'will give us a diff' do
-      Gatling::Comparison.new(@apple, @orange).diff_image.class.should == Gatling::Image
+    describe 'for two images with the same size' do
+      it 'will be generated' do
+        Gatling::Comparison.new(@apple, @orange).diff_image.class.should == Gatling::Image
+      end
+    end
+
+    describe 'for two images with different sizes' do
+      before do
+        @apple_image = Magick::Image.new(30,300) { self.background_color = "green" }
+        @orange_image = Magick::Image.new(80,100) { self.background_color = "orange" }
+
+        @apple = Gatling::Image.new(@apple_image, "apple.png")
+        @orange = Gatling::Image.new(@orange_image, "orange.png")
+
+        @diff_image = Gatling::Comparison.new(@apple, @orange).diff_image
+      end
+
+      it 'will be generated' do
+        @diff_image.class.should == Gatling::Image
+      end
+
+      it 'will be extended to cover the difference in both images' do
+        @diff_image.image.columns.should eql 80
+        @diff_image.image.rows.should eql 300
+      end
+
+      describe 'with two different offset' do
+        before do
+          @apple_image.offset = 50
+          @orange_image.offset = 2
+
+          @diff_image = Gatling::Comparison.new(@apple, @orange).diff_image
+        end
+
+        it 'will remove image offset from the diff image' do
+          @diff_image.image.offset.should eql 0
+        end
+
+      end
+
     end
   end
 end

data/spec/configuration_spec.rb

@@ -2,15 +2,14 @@ require 'spec_helper'
 
 describe Gatling::Configuration do
 
-  after :each do
-      Gatling::Configuration.reference_image_path = nil
-      Gatling.reference_image_path = nil
-  end
 
   describe "#reference_image_path" do
 
+    after :each do
+      config_clean_up
+    end
 
-    describe "Without Rails" do
+    describe "without Rails" do
       it "should default to './spec/reference_images' when not in a rails environment" do
         Gatling::Configuration.reference_image_path.should eql("spec/reference_images")
       end
@@ -36,10 +35,55 @@ describe Gatling::Configuration do
       end
 
       it "should be overrideable in a rails environment" do
-        Gatling::Configuration.reference_image_path = "my custom path"
+        subject.reference_image_path = "my custom path"
         Gatling::Configuration.reference_image_path.should eql("my custom path")
       end
 
+      it 'should return the directory for a type of image' do
+        Gatling::Configuration.reference_image_path = "a_path"
+        subject.path(:temp).should == 'a_path/temp'
+      end
+
+      it 'should thrown an error when you ask for the path of an unknown image type' do
+        expect { Gatling::Configuration.path(:unknown)}.should raise_error "Unkown image type 'unknown'"
+      end
+
+    end
+
+    describe "creating custom reference folders" do
+
+      before :each do
+        Gatling.reference_image_path = '/some/ref/path'
+      end
+
+      it "should default to custom folders off" do
+        subject.browser_folders.should == false
+      end
+
+      it "should allow setting custom folders on" do
+        Gatling::Configuration.browser_folders = true
+        subject.browser_folders.should == true
+      end
+
+
+      it "should set reference_image_path to default when browser can\'t be found" do
+        subject.browser_folders = true
+        Capybara.page.driver.browser.should_receive(:browser).at_least(:once).and_raise(StandardError.new)
+        subject.reference_image_path.should == '/some/ref/path'
+      end
+
+      it "should create custom folder for each browser according to ENV" do
+        pending
+      end
+
+      it "should set the image reference path for each browser according to selenium driver if no ENV is set" do
+        subject.browser_folders = true
+        subject.stub!(:browser).and_return('chrome')
+        subject.reference_image_path.should == '/some/ref/path/chrome'
+        subject.browser_folders = false
+      end
+
+
     end
   end
 
@@ -75,16 +119,6 @@ describe Gatling::Configuration do
     end
   end
 
-  describe 'paths' do
-    it 'should return the directory for a type of image' do
-      Gatling::Configuration.reference_image_path = "a_path"
-      subject.path(:temp).should == 'a_path/temp'
-    end
-
-    it 'should thrown an error when you ask for the path of an unknown image type' do
-      expect { Gatling::Configuration.path(:unknown)}.should raise_error "Unkown image type 'unknown'"
-    end
-  end
 
   describe "#max_no_tries" do
 
@@ -112,17 +146,40 @@ describe Gatling::Configuration do
 
   describe "settings" do
 
-    it "should accept a block of settings and parse them correctly" do
-      Gatling.config do |setting|
-        Gatling.reference_image_path = 'custom_path'
-        Gatling.max_no_tries = 3
-        Gatling.sleep_between_tries = 0.7
+    describe "should accept a block of settings and parse them correctly" do
+
+      it "for reference_image_path" do
+        Gatling.config do |setting|
+          Gatling.reference_image_path = 'custom_path'
+        end
+        subject.reference_image_path.should eql 'custom_path'
+      end
+
+      it "for max_no_tries" do
+        Gatling.config do |setting|
+          Gatling.max_no_tries = 3
+        end
+        subject.max_no_tries.should eql 3
       end
-      subject.reference_image_path.should eql 'custom_path'
-      subject.max_no_tries.should eql 3
-      subject.sleep_between_tries.should eql 0.7
-    end
 
+      it "sleep_between_tries" do
+        Gatling.config do |setting|
+          Gatling.sleep_between_tries = 0.7
+        end
+        subject.sleep_between_tries.should eql 0.7
+      end
+
+      it "browser_folders" do
+        Gatling.config do |setting|
+          Gatling.browser_folders = true
+        end
+        subject.browser_folders.should eql true
+      end
+
+    end
   end
 
+
+
+
 end

data/spec/gatling_spec.rb

@@ -4,15 +4,9 @@ include Capybara::DSL
 describe Gatling do
 
   before :all do
-    @spec_support_root = spec_support_root
     @box = 'box'
     @black_box = 'black.png'
     @red_box = 'red.png'
-    @ref_path = Gatling::Configuration.reference_image_path = './ref_path'
-  end
-
-  after :each  do
-    Gatling::Configuration.trainer_toggle = false
   end
 
   describe '#Gatling' do
@@ -35,13 +29,13 @@ describe Gatling do
     end
 
     it "#save_image_as_diff" do
-      @image_class_mock.should_receive(:save).with(:as => :diff).and_return(@ref_path)
+      @image_class_mock.should_receive(:save).with(:diff).and_return(@ref_path)
       @image_class_mock.should_receive(:file_name).at_least(:once).and_return("some_name")
       expect {subject.save_image_as_diff(@image_class_mock)}.should raise_error
     end
 
     it "#save_image_as_candidate" do
-      @image_class_mock.should_receive(:save).with(:as => :candidate).and_return(@ref_path)
+      @image_class_mock.should_receive(:save).with(:candidate).and_return(@ref_path)
       @image_class_mock.should_receive(:file_name).at_least(:once).and_return("some_name")
       @image_class_mock.should_receive(:path).and_return(@path)
       expect {subject.save_image_as_candidate(@image_class_mock)}.should raise_error
@@ -58,7 +52,7 @@ describe Gatling do
 
       it "when image_exists? == false" do
         @image_class_mock.should_receive(:exists?).and_return(false)
-        @image_class_mock.should_receive(:save).with(:as => :reference).and_return(@ref_path)
+        @image_class_mock.should_receive(:save).with(:reference).and_return(@ref_path)
         @image_class_mock.should_receive(:path).and_return(@path)
         subject.save_image_as_reference(@image_class_mock)
       end
@@ -72,12 +66,12 @@ describe Gatling do
 describe "#compare_until_match" do
 
       before do
-        @apple = mock("Gatling::Image")
-        @orange = mock("Gatling::Image")
-        @element  = mock(Gatling::CaptureElement)
+        @ref_image = mock("Gatling::Image")
+        @actual_image = mock("Gatling::Image")
+        @element  = mock("Gatling::CaptureElement")
         @comparison = mock("Gatling::Comparison")
-        Gatling::ImageFromFile.stub!(:new).and_return(@orange)
-        Gatling::ImageFromElement.stub!(:new).and_return(@orange)
+        Gatling::ImageFromFile.stub!(:new).and_return(@ref_image)
+        Gatling::ImageFromElement.stub!(:new).and_return(@actual_image)
         Gatling::Comparison.stub!(:new).and_return(@comparison)
       end
 
@@ -90,5 +84,11 @@ describe "#compare_until_match" do
         @comparison.should_receive(:matches?).exactly(1).times.and_return(true)
         Gatling.compare_until_match(@element, "orange.png", 3)
       end
+
+      it 'should compare image from the element with image from the file' do
+        @comparison.stub!(:matches?).and_return(true)
+        Gatling::Comparison.should_receive(:new).with(@actual_image, @ref_image).and_return(@comparison)
+        Gatling.compare_until_match(@element, "orange.png", 3)
+      end
   end
 end

data/spec/image_spec.rb

@@ -3,19 +3,22 @@ require 'spec_helper'
 describe Gatling::Image do
 
   before :all do
-    ref_path = './image_tests'
-    Gatling::Configuration.reference_image_path = ref_path
-    @expected_path = File.join ref_path, 'temp'
-    @expected_full_path = File.join @expected_path, 'image.png'
+    @ref_path = './image_tests'
+    @expected_temp_path = File.join @ref_path, 'temp'
+    @expected_temp_image_path = File.join @expected_temp_path, 'image.png'
+  end
+
+  after :each do
+    config_clean_up
   end
 
   describe 'should initialize from' do
 
     it 'image file type' do
-      File.stub(:exists?).and_return true
+      File.stub(:exists?).and_return(true)
       image_mock = mock(Magick::Image)
+      Gatling::Configuration.should_receive(:reference_image_path).any_number_of_times.and_return(@ref_path)
       Magick::Image.should_receive(:read).with('./image_tests/image.png').and_return([image_mock])
-
       subject = Gatling::ImageFromFile.new("image.png")
       subject.image.should == image_mock
       subject.file_name.should == 'image.png'
@@ -44,7 +47,7 @@ describe Gatling::Image do
   describe "Images file handling" do
 
     before :each do
-
+      Gatling::Configuration.should_receive(:reference_image_path).any_number_of_times.and_return(@ref_path)
     end
 
     it 'will save an image to the correct path for the type' do
@@ -53,32 +56,35 @@ describe Gatling::Image do
       subject = Gatling::Image.new(mock_image, 'image.png')
       subject.image = mock_image
       subject.file_name = 'image.png'
-      subject.save(:as => :temp)
+      subject.save(:temp)
     end
 
     it 'will create directory, then save and image if directory doesnt exist' do
+      image_path = 'path/to/image/in/sub/directory/image.png'
+      expected_full_path = File.join(Gatling::Configuration.path(:temp), image_path)
+      expected_image_dir = File.dirname(expected_full_path)
 
       mock_image = stub(Magick::Image)
-      mock_image.should_receive(:write).with(@expected_full_path).and_return()
+      mock_image.should_receive(:write).with(expected_full_path).and_return()
 
-      File.should_receive(:exists?).with(@expected_path).and_return(false)
-      FileUtils.should_receive(:mkdir_p).with(@expected_path)
-      subject = Gatling::Image.new(mock_image, 'image.png')
+      File.should_receive(:exists?).with(expected_full_path).and_return(false)
+      FileUtils.should_receive(:mkdir_p).with(expected_image_dir)
+      subject = Gatling::Image.new(mock_image, image_path)
 
-      subject.save(:as => :temp)
-      subject.path.should == @expected_full_path
+      subject.save(:temp)
+      subject.path(:temp).should == expected_full_path
     end
 
-    it 'will save and image if directory exista' do
+    it 'will save an image if directory exist' do
       mock_image = stub(Magick::Image)
-      mock_image.should_receive(:write).with(@expected_full_path).and_return()
+      mock_image.should_receive(:write).with(@expected_temp_image_path).and_return()
 
-      File.should_receive(:exists?).with(@expected_path).and_return(true)
+      File.should_receive(:exists?).with(@expected_temp_image_path).and_return(true)
       FileUtils.should_not_receive(:mkdir_p)
       subject = Gatling::Image.new(mock_image, 'image.png')
 
-      subject.save(:as => :temp)
-      subject.path.should == @expected_full_path
+      subject.save(:temp)
+      subject.path(:temp).should == @expected_temp_image_path
     end
 
     it 'should check if a file exists, with the file name and type' do
@@ -88,9 +94,35 @@ describe Gatling::Image do
       subject.file_name = 'image.png'
       subject.exists?
     end
+
+    it 'image object should default to reference type' do
+      mock_image = mock(Magick::Image)
+      subject = Gatling::Image.new(mock_image, 'image.png')
+      subject.path.should == File.join(@ref_path,'image.png')
+    end
   end
 
+  describe "it creates a path from path types" do
+
+    before :each do
+      Gatling::Configuration.should_receive(:reference_image_path).any_number_of_times.and_return('/some/path')
+      mock_image = mock(Magick::Image)
+      @subject = Gatling::Image.new(mock_image, 'image.png')
+    end
+
+    it "from reference" do
+      # expected_path = '/some/path/reference'
+      @subject.path.should == '/some/path/image.png'
+    end
 
-end
+    it "from diff" do
+      @subject.path(:diff).should == '/some/path/diff/image.png'
+    end
+
+    it "from candidate" do
+      @subject.path(:candidate).should == '/some/path/candidate/image.png'
+    end
+
+  end
 
-describe Gatling::ImageFromElement
+end

data/spec/image_wrangler_spec.rb

@@ -12,7 +12,7 @@ describe Gatling::ImageWrangler do
 
   it 'should get the position of the css element' do
 
-    #Overiding the stupid public method :y of YAML module
+    #Overiding the stupid public method:y of YAML module
 
     location = Point.new
     location.x = 1

data/spec/spec_helper.rb

@@ -18,6 +18,12 @@ Capybara.app_host = "file://#{File.expand_path(File.dirname(__FILE__))}/support/
 Capybara.default_driver = :selenium
 Capybara.run_server = false
 
+def config_clean_up
+  Gatling::Configuration.trainer_toggle = false
+  Gatling::Configuration.reference_image_path = nil
+  Gatling::Configuration.browser_folders = false
+end
+
 def remove_refs(dir)
   Dir.glob("#{dir}/**/*.png").each {|image| FileUtils.rm image}
 end
@@ -32,9 +38,9 @@ def spec_support_root
 end
 
 def create_images_for_web_page
-  asset_path = File.join(spec_support_root, 'assets')
-  create_square_image(asset_path, 'black')
-  create_square_image(asset_path, 'red')
+  asset_reference_path = File.join(spec_support_root, 'assets')
+  create_square_image(asset_reference_path, 'black')
+  create_square_image(asset_reference_path, 'red')
 end
 
 def create_square_image(path, color)

data/spec/support/assets/fruit_app.html

@@ -18,5 +18,6 @@
     <img src='./black.png' id="black"/>
     <img src='./red.png' id="red"/>
 	</div>
+    <img src='./purple.png' id="differentSize" width="15px" height="180px"/>
 </body>
 </html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gatling
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &70304962876040 !ruby/object:Gem::Requirement
+  requirement: &70099690488660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.13.1
   type: :runtime
   prerelease: false
-  version_requirements: *70304962876040
+  version_requirements: *70099690488660
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &70304962875260 !ruby/object:Gem::Requirement
+  requirement: &70099690488120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70304962875260
+  version_requirements: *70099690488120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70304962874240 !ruby/object:Gem::Requirement
+  requirement: &70099690536780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70304962874240
+  version_requirements: *70099690536780
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70304962873720 !ruby/object:Gem::Requirement
+  requirement: &70099690536300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70304962873720
+  version_requirements: *70099690536300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70304962873040 !ruby/object:Gem::Requirement
+  requirement: &70099690535820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70304962873040
+  version_requirements: *70099690535820
 - !ruby/object:Gem::Dependency
   name: rspec-instafail
-  requirement: &70304962872180 !ruby/object:Gem::Requirement
+  requirement: &70099690535340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.1.8
   type: :development
   prerelease: false
-  version_requirements: *70304962872180
+  version_requirements: *70099690535340
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70304962920060 !ruby/object:Gem::Requirement
+  requirement: &70099690534800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: 0.9.8.2
   type: :development
   prerelease: false
-  version_requirements: *70304962920060
+  version_requirements: *70099690534800
 description: Add visual comparison matchers for rspec
 email:
 - grotbart@gmail.com
@@ -123,7 +123,6 @@ files:
 - spec/image_spec.rb
 - spec/image_wrangler_spec.rb
 - spec/integration/gatling_integration_spec.rb
-- spec/rspec_matcher_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/assets/fruit_app.html
@@ -161,7 +160,6 @@ test_files:
 - spec/image_spec.rb
 - spec/image_wrangler_spec.rb
 - spec/integration/gatling_integration_spec.rb
-- spec/rspec_matcher_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/assets/fruit_app.html

data/spec/rspec_matcher_spec.rb

@@ -1,39 +0,0 @@
-require 'spec_helper'
-include Capybara::DSL
-
-describe 'rspec matcher' do
-
-  before(:all) do
-    @black_box = 'black.png'
-    @ref_path = Gatling::Configuration.reference_image_path = File.join(spec_support_root, 'ref_path')
-    create_images_for_web_page
-  end
-
-  after(:each) do
-    Gatling::Configuration.trainer_toggle = false
-    remove_refs(@ref_path)
-  end
-
-  describe 'initializing and runnin gatling' do
-
-    it 'will pass if images matches refernce' do
-      create_square_image(@ref_path, 'black')
-      black_element = element_for_spec("#black")
-      black_element.should look_like(@black_box)
-    end
-
-    it 'will fail if images dosent matches refernce' do
-      create_square_image(@ref_path, 'black')
-      red_element = element_for_spec("#red")
-      expect{red_element.should look_like(@black_box)}.should raise_error
-    end
-
-    it 'will return true if it makes a new reference image in trainer mode' do
-      Gatling::Configuration.trainer_toggle =  true
-      black_element = element_for_spec("#black")
-      black_element.should look_like(@black_box)
-      File.exists?(File.join(@ref_path, @black_box)).should be_true
-    end
-
-  end
-end