gatling 1.1.2 → 1.1.3

data/.gitignore

@@ -15,3 +15,4 @@ vendor/*
 *.iml
 *.ipr
 *.iws
+/bin

data/README.rdoc

@@ -28,19 +28,22 @@ Also created are subfolders:
 - /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
 
-=== max_no_tries - sets how many times Gatling will try and match the element against the reference image. Handy to reduce fragility of tests due to animations and load times. Defaults to 5.
+==== max_no_tries 
+- sets how many times Gatling will try and match the element against the reference image. Handy to reduce fragility of tests due to animations and load times. Defaults to 5.
 
-=== Sleep_between_tries - sets the sleep time (in seconds) between match tries (requires max_no_tries > 1). Defaults to 0.5
+==== 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.
+==== 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:
+==== 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
-    Gatling.browser_folders = true
+  Gatling.config do |c|
+    c.reference_image_path = 'some/path'
+    c.max_no_tries = 4
+    c.sleep_between_tries = 5
+    c.browser_folders = false
   end
 
 GATLING::CONFIGURATION will be depreciated in future versions.
@@ -59,8 +62,26 @@ Gatling will take care of cropping the element and try and make a targeted match
 
 If the matcher fails, the test will fail, an exception will be raised and both a diff image and a new candidate image will be created.
 
-If no reference image exits, the test will fail, an exception will be raised and a candidate will be created which can be used as a reference
-(see Training mode below)
+If no reference image exits, the test will still pass and a reference file will be created for future comparisons.
+
+-------------------------------------
+
+=== Training mode:
+
+<b>GATLING_TRAINER WILL BE DEPRECIATED.</b> Gatling now saves reference files natively when files do not exists.
+
+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:
+        $GATLING_TRAINER = true rspec spec/my_spec.rb
 
 -------------------------------------
 

data/gatling.gemspec

@@ -19,8 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency('rmagick', ['>=2.13.1'])
-  s.add_runtime_dependency('rspec-core',['>=2.8.0'])
-  s.add_runtime_dependency('rspec',['>=2.8.0'])
+  s.add_runtime_dependency('rspec',['>=2.9.0'])
   s.add_runtime_dependency('capybara',['>=1.1.2'])
 
   s.add_development_dependency('rake',['>=0.9.2'])

data/lib/gatling.rb

@@ -2,7 +2,7 @@ require 'RMagick'
 require 'capybara'
 require 'capybara/dsl'
 
-require 'gatling/config'
+require 'gatling/configuration'
 require 'gatling/image'
 require 'gatling/comparison'
 require 'gatling/capture_element'
@@ -12,51 +12,45 @@ require 'gatling/capture_element'
 #TODO: Make directories as needed
 
 module Gatling
-
   class << self
 
-    attr_accessor :reference_image_path, :max_no_tries, :sleep_between_tries, :browser_folders
-
     def matches?(expected_reference_filename, actual_element)
+ 
+      @actual_element = actual_element
+      @expected_reference_filename = expected_reference_filename
+      @expected_reference_file = (File.join(Gatling::Configuration.path(:reference), expected_reference_filename))
 
-      expected_reference_file = (File.join(Gatling::Configuration.path(:reference), expected_reference_filename))
-
-      if ENV['GATLING_TRAINER']
-        raise 'GATLING_TRAINER has been depreciated. Gatling will now create reference files where ones are missing. Delete bad references and re-run Gatling to re-train'
-      end  
 
-      if !File.exists?(expected_reference_file)
-        actual_image = Gatling::ImageFromElement.new(actual_element, expected_reference_filename)
-        save_image_as_reference(actual_image)
+      if !File.exists?(@expected_reference_file)
+        save_reference
         return true
       else
-        comparison = compare_until_match(actual_element, expected_reference_filename, Gatling::Configuration.max_no_tries)
+        reference_file = Gatling::ImageFromFile.new(expected_reference_filename)
+        comparison = compare_until_match(actual_element, reference_file, Gatling::Configuration.max_no_tries)
         matches = comparison.matches?
         if !matches
           comparison.actual_image.save(:candidate)
           save_image_as_diff(comparison.diff_image)
         end
-        matches
+        matches 
       end
     end
 
-    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 < max_no_tries
-        actual_image = Gatling::ImageFromElement.new(actual_element, expected_reference_filename)
-        comparison = Gatling::Comparison.new(actual_image, expected_image)
-        match = comparison.matches?
+    def compare_until_match actual_element, reference_file, max_no_tries = Gatling::Configuration.max_no_tries, sleep_time = Gatling::Configuration.sleep_between_tries
+      max_no_tries.times do |i|
+        actual_image = Gatling::ImageFromElement.new(actual_element, reference_file.file_name)
+        @comparison = Gatling::Comparison.new(actual_image, reference_file)
+        match = @comparison.matches?
         if !match
           sleep sleep_time
-          try += 1
           #TODO: Send to logger instead of puts
-          puts "Tried to match #{try} times"
+          i += 1
+          puts "Tried to match #{i} times"
+        else
+          return(@comparison)
         end
       end
-      comparison
+      @comparison
     end
 
     def save_image_as_diff(image)
@@ -72,17 +66,18 @@ module Gatling
       "is now available to be used as a reference. Copy candidate to root reference_image_path to use as reference"
     end
 
-    def save_image_as_reference(image)
-      if image.exists?
-        puts "#{image.path} already exists. reference image was not overwritten. please delete the old file to update reference"
-      else
-        image.save(:reference)
-        puts "Saved #{image.path} as reference"
-      end
+    def save_reference
+      ImageFromElement.new(@actual_element,@expected_reference_filename).verify_and_save
     end
 
-    def config
-      yield
+    def config(&block)
+      begin
+        config_class = Gatling::Configuration
+        raise "No block provied" unless block_given?
+        block.call(config_class)
+      rescue
+         raise "Config block has changed. Example: Gatling.config {|c| c.reference_image_path = 'some/path'}. Please see README"  
+      end   
     end
 
   end

data/lib/gatling/capture_element.rb

@@ -1,27 +1,23 @@
 require 'fileutils'
+require 'gatling'
 
 module Gatling
-  class CaptureElement
+  module CaptureElement
+    extend Gatling::Configuration 
 
-    def initialize element_to_capture, *element_to_exclude
-      @reference_image_path = Gatling::Configuration.reference_image_path
-      @element_to_capture = element_to_capture
-      # @element_to_exclude = element_to_exclude.first
-
-    end
-
-    def capture
+    def self.capture(element)
       # Getting the element position before screenshot because of a side effect
       # of WebDrivers getLocationOnceScrolledIntoView method which scrolls the page
       # regardless of whether the object is in view or not
-      element_position = get_element_position @element_to_capture
-      screenshot = self.take_screenshot
-      screenshot = exclude(screenshot, @element_to_exclude) if @element_to_exclude
-      crop_element(screenshot, @element_to_capture, element_position)
+      element_position = get_element_position(element)
+      screenshot = take_screenshot
+
+      crop_element(screenshot, element, element_position)
     end
 
-    def take_screenshot
-      temp_dir = File.join(@reference_image_path, 'temp')
+    private
+    def self.take_screenshot
+      temp_dir = Gatling::Configuration.path(:temp)
       FileUtils.mkdir_p(temp_dir) unless File.exists?(temp_dir)
       #captures the uncropped full screen
       begin
@@ -33,7 +29,7 @@ module Gatling
       end
     end
 
-    def get_element_position element
+    def self.get_element_position element
       element = element.native
       position = Hash.new{}
       position[:x] = element.location.x
@@ -43,8 +39,8 @@ module Gatling
       position
     end
 
-    def crop_element image, element_to_crop, position
-      @cropped_element = image.crop(position[:x], position[:y], position[:width], position[:height])
+    def self.crop_element image, element_to_crop, position
+      cropped_element = image.crop(position[:x], position[:y], position[:width], position[:height])
     end
 
   end

data/lib/gatling/configuration.rb

@@ -0,0 +1,67 @@
+require 'logger'
+
+module Gatling
+  module Configuration
+
+    class << self
+
+      attr_accessor :reference_image_path, :max_no_tries, :sleep_between_tries, :browser_folders
+
+      attr_reader :paths
+
+      def reference_image_path
+        @reference_image_path ||= default_reference_path
+        @browser_folders ? (reference_path_with_browser_folders) : @reference_image_path
+      end
+
+      def max_no_tries
+        @max_no_tries ||= 5
+      end
+
+      def sleep_between_tries
+        @sleep_between_tries ||= 0.5  
+      end
+
+      def path(type)
+        paths =  {: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')}
+        paths[type]
+      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 reference_image_path=[refpath] in your configuration block"
+        end
+        reference_image_path
+      end
+
+      def reference_path_with_browser_folders
+        begin
+          reference_images_path = File.join(@reference_image_path, browser)
+        rescue
+          reference_images_path = @reference_image_path
+        end
+        reference_images_path
+      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."
+          return nil
+        end
+        browser.to_s
+      end
+
+    end
+
+  end
+end

data/lib/gatling/image.rb

@@ -6,25 +6,22 @@ module Gatling
     attr_reader :type
 
     def initialize image, file_name
-
       @file_name = file_name
-
       @image = image
-
     end
 
-    def save type
-      @path = path(type)
-      FileUtils::mkdir_p(File.dirname(@path)) unless File.exists?(@path)
-      @image.write @path
-      @path
+    def save(type = :reference)
+      save_path = path(type)
+      FileUtils::mkdir_p(File.dirname(save_path)) unless File.exists?(save_path)
+      @image.write save_path
+      save_path
     end
 
     def exists?
       File.exists?(path)
     end
 
-    def path type = :reference
+    def path(type = :reference)
       @path = File.join(Gatling::Configuration.path(type), @file_name)
     end
 
@@ -32,9 +29,30 @@ module Gatling
 
   class ImageFromElement < Image
 
-    def initialize element, file_name
+    def initialize(element, file_name)
       super(image, file_name)
-      @image = Gatling::CaptureElement.new(element).capture
+      @element = element
+      @image = capture_image
+    end
+
+    def verify_and_save
+      Gatling::Configuration.max_no_tries.times do
+        comparable = capture_image
+        matches = Gatling::Comparison.new(self,Image.new(comparable,@file_name)).matches?
+        if matches
+          self.save
+          puts "Saved #{self.path} as reference"
+          return()
+        else
+          @image = comparable  
+        end  
+      end
+      raise 'Could not save a stable image. This could be due to animations or page load times. Saved a reference image, delete it to re-try'
+    end
+
+    private
+    def capture_image
+      Gatling::CaptureElement.capture(@element)
     end
 
     #TODO: make save a relevant subclass method
@@ -42,8 +60,9 @@ module Gatling
 
   class ImageFromFile < Image
 
-    def initialize file_name
+    def initialize(file_name)
       super(image, file_name)
+
       @image = Magick::Image.read(path).first
     end
 

data/lib/gatling/version.rb

@@ -1,3 +1,4 @@
+
 module Gatling
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/spec/acceptance/gatling_acceptance_spec.rb

@@ -8,7 +8,7 @@ describe 'Gatling' do
   end
 
   before(:each) do
-    @ref_path = Gatling.reference_image_path = File.join(spec_support_root, 'ref_path')
+    @ref_path = Gatling::Configuration.reference_image_path = File.join(spec_support_root, 'ref_path')
   end
 
   after(:each) do
@@ -48,7 +48,7 @@ describe 'Gatling' do
                          "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)
+        expect {Gatling.matches?("black.png", red_element)}.to 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
@@ -64,7 +64,7 @@ describe 'Gatling' do
                          "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)
+        expect {Gatling.matches?("black.png", red_element)}.to 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
@@ -73,15 +73,6 @@ describe 'Gatling' do
     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

@@ -5,7 +5,7 @@ describe 'rspec matcher' do
 
   before(:each) do
     @black_box = 'black.png'
-    @ref_path = Gatling.reference_image_path = File.join(spec_support_root, 'ref_path')
+    @ref_path = Gatling::Configuration.reference_image_path = File.join(spec_support_root, 'ref_path')
     create_images_for_web_page
   end
 
@@ -25,7 +25,7 @@ describe 'rspec matcher' 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
+      expect{red_element.should look_like(@black_box)}.to raise_error
     end
 
   end

data/spec/capture_spec.rb

@@ -2,88 +2,32 @@ require 'spec_helper'
 
 describe Gatling::CaptureElement do
 
+  # creating a dummy class to test a module
+  class SomeClass
+  end
+
   before :each do
-    capybara_node = mock (Capybara::Node::Element)
-    Gatling::Configuration.should_receive(:reference_image_path).and_return("./")
-    @capture_element = Gatling::CaptureElement.new capybara_node, capybara_node
+    subject = SomeClass.new
+    subject.extend(Gatling::CaptureElement)
   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
-
-
-  class Point
-    attr_accessor :x, :y
-  end
-
-  class Size
-    attr_accessor :width, :height
-  end
-
-  it 'should get the position of the css element' do
-
-    #Overiding the stupid public method:y of YAML module
-
-    location = Point.new
-    location.x = 1
-    location.y = 2
-
-    size = Size.new
-    size.width = 100
-    size.height = 200
+  it '.capture should return a cropped image' do
+      capybara_element = mock(Capybara::Node::Element)
+      position = {:x => 1, :y => 2, :width => 100, :height => 200}
+      magick_image = Magick::Image.new(position[:width],position[:height])
 
-    mock_element = mock
-    mock_element.stub(:native).and_return(mock_element)
-    mock_element.stub(:location).and_return(location)
-    mock_element.stub(:size).and_return(size)
 
-    position = @capture_element.get_element_position mock_element
+      subject.should_receive(:get_element_position).with(capybara_element).and_return(position)
+      subject.should_receive(:take_screenshot).and_return(magick_image)
+      subject.should_receive(:crop_element).and_return(magick_image)
 
-    position[:x].should eql(1)
-    position[:y].should eql(2)
-    position[:width].should eql(100)
-    position[:height].should eql(200)
+      image = subject.capture(capybara_element)
+      image.class.should == Magick::Image
   end
 
-  end
-
-
-
-  # it 'should exclude a specified element from capture' do
-  #  element_to_capture =
-
-  #  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
 

data/spec/comparison_spec.rb

@@ -9,10 +9,6 @@ describe Gatling::Comparison do
     @orange = Gatling::Image.new(orange, "orange.png")
   end
 
-  describe 'will make images from ' do
-
-  end
-
   describe 'will compare two images' do
 
     it 'will return true if the images are identical' do

data/spec/configuration_spec.rb

@@ -31,29 +31,25 @@ describe Gatling::Configuration do
       end
 
       it "should default to <Rails.root>/spec/reference_images in a rails environment" do
-        Gatling::Configuration.reference_image_path.should eql("fake_rails_root/spec/reference_images")
+        subject.reference_image_path.should  == "fake_rails_root/spec/reference_images"
       end
 
       it "should be overrideable in a rails environment" do
-        Gatling.reference_image_path = "my custom path"
-        Gatling::Configuration.reference_image_path.should eql("my custom path")
+        subject.reference_image_path = "my custom path"
+        subject.reference_image_path.should == "my custom path"
       end
 
       it 'should return the directory for a type of image' do
-        Gatling.reference_image_path = "a_path"
+        subject.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'
+        subject.reference_image_path = '/some/ref/path'
       end
 
       it "should default to custom folders off" do
@@ -61,7 +57,7 @@ describe Gatling::Configuration do
       end
 
       it "should allow setting custom folders on" do
-        Gatling::Configuration.browser_folders = true
+        subject.browser_folders = true
         subject.browser_folders.should == true
       end
 
@@ -106,8 +102,8 @@ describe Gatling::Configuration do
     end
 
     it "should be settable" do
-      Gatling::Configuration.sleep_between_tries = 55
-      subject.sleep_between_tries.should eql 55
+      subject.sleep_between_tries = 55
+      subject.sleep_between_tries.should == 55
     end
   end
 
@@ -116,36 +112,68 @@ describe Gatling::Configuration do
     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'
+        Gatling.config do |c|
+          c.reference_image_path = 'custom_path'
         end
-        subject.reference_image_path.should eql 'custom_path'
+        subject.reference_image_path.should == 'custom_path'
       end
 
       it "for max_no_tries" do
-        Gatling.config do |setting|
-          Gatling.max_no_tries = 3
+        Gatling.config do |c|
+          c.max_no_tries = 3
         end
-        subject.max_no_tries.should eql 3
+
+        subject.max_no_tries.should == 3
       end
 
       it "sleep_between_tries" do
-        Gatling.config do |setting|
-          Gatling.sleep_between_tries = 0.7
+        Gatling.config do |c|
+          c.sleep_between_tries = 0.7
         end
-        subject.sleep_between_tries.should eql 0.7
+        subject.sleep_between_tries.should == 0.7
       end
 
-      it "browser_folders" do
-        Gatling.config do |setting|
-          Gatling.browser_folders = true
+     it "for browser_folders" do
+        Gatling.config do |c|
+          c.browser_folders = true
         end
-        subject.browser_folders.should eql true
+
+        subject.browser_folders.should == true
       end
 
     end
   end
 
+  describe "config block" do
+
+    it 'should be able to set a config block' do
+      Gatling.config do |c|
+        c.reference_image_path = 'some/path'
+        c.max_no_tries = 4
+        c.sleep_between_tries = 5
+        c.browser_folders = false
+      end
+
+      subject.reference_image_path.should == 'some/path'
+      subject.max_no_tries.should == 4
+      subject.sleep_between_tries.should == 5
+      subject.browser_folders.should == false
+    end 
+
+    it 'should raise depreciation alert when calling old block' do
+      expect {
+        Gatling.config do |c|
+          Gatling.reference_image_path = 'some/path'
+          Gatling.max_no_tries = 4
+          Gatling.sleep_between_tries = 5
+          Gatling.browser_folders = false
+      end
+      }.to raise_error "Config block has changed. Example: Gatling.config {|c| c.reference_image_path = 'some/path'}. Please see README"
+    end
+
+   
+  end
+
 
 
 

data/spec/gatling_spec.rb

@@ -3,92 +3,85 @@ include Capybara::DSL
 
 describe Gatling do
 
-  before :all do
-    @box = 'box'
-    @black_box = 'black.png'
-    @red_box = 'red.png'
+  after :all do
+    config_clean_up
   end
 
-  describe '#Gatling' do
+  let(:actual_image)      { mock("Gatling::Image") }
+  let(:expected_image)    { mock("Gatling::Image") }
+  let(:comparison)        { mock("Gatling::Comparison") }
+  let(:element)           { mock("Gatling::CaptureElement") }
 
+  
+  describe 'comparison' do
     before :each do
-      @image_class_mock = mock(Gatling::Image)
+      Gatling::ImageFromFile.stub!(:new).and_return(expected_image)
+      Gatling::ImageFromElement.stub!(:new).and_return(actual_image)
+      Gatling::Comparison.stub!(:new).and_return(comparison)
+      expected_image.should_receive(:file_name).and_return('expected_image.png')
     end
 
     it 'will return true if the images are identical' do
-        @apple = mock("Gatling::Image")
-        @orange = 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::Comparison.stub!(:new).and_return(@comparison)
-        @comparison.stub!(:matches?).and_return(true)
+        comparison.stub!(:matches?).and_return(true)
         File.stub!(:exists?).and_return(true)
-        subject.matches?("orange.png", @element).should be_true
+
+        subject.matches?("expected_image.png", @element).should be_true
+    end
+  end  
+
+
+  describe 'saving images' do
+    before :each do
+      @image_class_mock = mock(Gatling::Image)
     end
 
+
     it "#save_image_as_diff" do
       @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
+
+      expect {subject.save_image_as_diff(@image_class_mock)}.to raise_error
     end
 
     it "#save_image_as_candidate" do
       @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
+      expect {subject.save_image_as_candidate(@image_class_mock)}.to raise_error
     end
 
     describe "#save_image_as_reference" do
 
-      it "when image.exists? == true" do
-        @image_class_mock.should_receive(:exists?).and_return(true)
-        @image_class_mock.should_receive(:path).and_return(@path)
-        @image_class_mock.should_not_receive(:save)
-        subject.save_image_as_reference(@image_class_mock)
-      end
+      let(:image) {mock('image.png')}
+      let(:reference_image) {Gatling::ImageFromElement.stub(:new).and_return(image)}
+      let(:comparison) {mock("comparison")}
 
-      it "when image_exists? == false" do
-        @image_class_mock.should_receive(:exists?).and_return(false)
-        @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)
+      before :each do
+        Gatling.stub!(:compare_until_match).and_return(comparison)
       end
 
     end
+  end  
 
+  describe "#compare_until_match" do
 
+    before :each do
+      Gatling::ImageFromElement.stub!(:new).and_return(actual_image)
+      Gatling::ImageFromFile.stub!(:new).and_return(expected_image)
+      Gatling::Comparison.stub!(:new).and_return(comparison)
 
+      expected_image.should_receive(:file_name).at_least(:once).and_return('expected_image.png')
     end
 
-describe "#compare_until_match" do
-
-      before do
-        @ref_image = mock("Gatling::Image")
-        @actual_image = mock("Gatling::Image")
-        @element  = mock("Gatling::CaptureElement")
-        @comparison = mock("Gatling::Comparison")
-        Gatling::ImageFromFile.stub!(:new).and_return(@ref_image)
-        Gatling::ImageFromElement.stub!(:new).and_return(@actual_image)
-        Gatling::Comparison.stub!(:new).and_return(@comparison)
-      end
-
-      it "should try match for a specified amount of times" do
-        @comparison.should_receive(:matches?).exactly(3).times
-        Gatling.compare_until_match(@element, "orange.png", 3)
-      end
+    it "should try match for a specified amount of times" do
+      comparison.should_receive(:matches?).exactly(3).times.and_return(false)
+      Gatling.compare_until_match(@element, expected_image, 3, 0.1)
+    end
 
-      it "should pass after a few tries if match is found" do
-        @comparison.should_receive(:matches?).exactly(1).times.and_return(true)
-        Gatling.compare_until_match(@element, "orange.png", 3)
-      end
+    it "should pass after a few tries if match is found" do
+      comparison.should_receive(:matches?).exactly(1).times.and_return(true)
+      Gatling.compare_until_match(@element, expected_image, 3, 0.1)
+    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

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 describe Gatling::Image do
 
-  before :all do
-    @ref_path = './image_tests'
-    @expected_temp_path = File.join @ref_path, 'temp'
-    @expected_temp_image_path = File.join @expected_temp_path, 'image.png'
+  let(:example_image)           { Magick::Image.new(1,1) }
+  let(:ref_path)                { 'spec/reference_images/image.png' }
+
+  before :each do
+    Gatling::Configuration.reference_image_path = 'spec/reference_images'
   end
 
   after :each do
@@ -13,92 +14,28 @@ describe Gatling::Image do
   end
 
   describe 'should initialize from' do
-
-    it 'image file type' do
+    it 'ImageFromFile - IO file read' do
       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])
+      Magick::Image.should_receive(:read).with(ref_path).and_return([example_image])
+      
       subject = Gatling::ImageFromFile.new("image.png")
-      subject.image.should == image_mock
-      subject.file_name.should == 'image.png'
-    end
-
-    it 'web element type' do
-      mock_element = mock(Capybara::Node::Element)
-      mock_capture_element = mock(Gatling::CaptureElement)
-      mock_image = mock(Magick::Image)
-
-      Gatling::CaptureElement.should_receive(:new).and_return mock_capture_element
-      mock_capture_element.should_receive(:capture).and_return mock_image
-      subject = Gatling::ImageFromElement.new(mock_element, "image.png")
-      subject.image.should == mock_image
+      subject.image.should == example_image
       subject.file_name.should == 'image.png'
     end
 
-    it 'diff image' do
-      mock_image = mock(Magick::Image)
-      subject = Gatling::Image.new(mock_image, 'image.png')
-      subject.image.should == mock_image
-      subject.file_name.should == 'image.png'
-    end
+    
   end
 
-  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
-      mock_image = mock(Magick::Image)
-      mock_image.should_receive(:write).with('./image_tests/temp/image.png').and_return()
-      subject = Gatling::Image.new(mock_image, 'image.png')
-      subject.image = mock_image
-      subject.file_name = 'image.png'
-      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)
+  describe "save" do
+    it 'will save an image' do
+      example_image.should_receive(:write).with(ref_path).and_return()
 
-      mock_image = stub(Magick::Image)
-      mock_image.should_receive(:write).with(expected_full_path).and_return()
-
-      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(:temp)
-      subject.path(:temp).should == expected_full_path
-    end
-
-    it 'will save an image if directory exist' do
-      mock_image = stub(Magick::Image)
-      mock_image.should_receive(:write).with(@expected_temp_image_path).and_return()
-
-      File.should_receive(:exists?).with(@expected_temp_image_path).and_return(true)
+      File.should_receive(:exists?).with(ref_path).and_return(true)
       FileUtils.should_not_receive(:mkdir_p)
-      subject = Gatling::Image.new(mock_image, 'image.png')
-
-      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
-      mock_image = mock(Magick::Image)
-      File.should_receive(:exists?).with './image_tests/image.png'
-      subject = Gatling::Image.new(mock_image, 'image.png')
-      subject.file_name = 'image.png'
-      subject.exists?
-    end
+      subject = Gatling::Image.new(example_image, "image.png")
 
-    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')
+      subject.save
+      subject.path.should == ref_path
     end
   end
 
@@ -125,4 +62,47 @@ describe Gatling::Image do
 
   end
 
+  describe "ImageFromElement" do
+
+    let(:mock_element) { mock(Capybara::Node::Element) }
+    let(:comparison)   { mock('comparison') }
+
+    it 'should initialize from a web element' do
+      Gatling::CaptureElement.should_receive(:capture).with(mock_element).and_return(example_image)
+
+      subject = Gatling::ImageFromElement.new(mock_element, "image.png")
+      subject.image.class.should == example_image.class
+      subject.file_name.should == 'image.png'
+    end
+
+    describe '.save_and_verify' do
+
+      it 'should verify the element and then save' do
+        Gatling::Comparison.should_receive(:new).exactly(2).times.and_return(comparison)
+        comparison.should_receive(:matches?).exactly(2).times.and_return(false,true)
+
+        Gatling::CaptureElement.should_receive(:capture).exactly(3).times.with(mock_element).and_return(example_image)
+
+        subject = Gatling::ImageFromElement.new(mock_element, "image.png")
+        subject.should_receive(:save)
+
+        Gatling::Configuration.max_no_tries = 3
+
+        subject.verify_and_save
+      end
+      
+      it 'should raise an exception if can\'t create a stable image' do
+        Gatling::Configuration.max_no_tries = 1
+        Gatling::CaptureElement.stub!(:capture).and_return(mock_element)
+        Gatling::Comparison.stub!(:matches?).and_return(false)
+
+        subject = Gatling::ImageFromElement.new(mock_element, "image.png")
+
+        expect {subject.verify_and_save}.to raise_error
+      end 
+    end
+
+
+  end
+
 end

data/spec/integration/gatling_integration_spec.rb

@@ -28,7 +28,7 @@ describe 'Gatling' do
                        "is now available to be used as a reference. " +
                        "Copy candidate to root reference_image_path to use as reference"
 
-      expect {Gatling.matches?(@black_box, mock_element)}.should raise_error(RuntimeError, expected_error)
+      expect {Gatling.matches?(@black_box, mock_element)}.to raise_error(RuntimeError, expected_error)
 
       File.exists?(File.join(@ref_path, 'candidate', @black_box)).should be_true
     end

data/spec/spec_helper.rb

@@ -8,7 +8,6 @@ require 'fileutils'
 require 'pry'
 
 #todo: spec folders clean up method
-
 RSpec.configure do |config|
   config.color_enabled = true
   config.formatter     = 'documentation'
@@ -21,6 +20,7 @@ Capybara.run_server = false
 def config_clean_up
   Gatling::Configuration.reference_image_path = nil
   Gatling::Configuration.browser_folders = false
+  Gatling::Configuration.max_no_tries = nil
 end
 
 def remove_refs(dir)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gatling
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-07 00:00:00.000000000 Z
+date: 2012-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &70284092348740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,32 +21,31 @@ dependencies:
         version: 2.13.1
   type: :runtime
   prerelease: false
-  version_requirements: *70284092348740
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: &70284092347260 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *70284092347260
+        version: 2.13.1
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70284092346420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70284092346420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70284092345580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +53,15 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70284092345580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70284092344680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +69,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70284092344680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec-instafail
-  requirement: &70284092343720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +85,15 @@ dependencies:
         version: 0.1.8
   type: :development
   prerelease: false
-  version_requirements: *70284092343720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70284092343120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,11 +101,25 @@ dependencies:
         version: 0.9.8.2
   type: :development
   prerelease: false
-  version_requirements: *70284092343120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.8.2
 description: Add visual comparison matchers for rspec
 email:
 - grotbart@gmail.com
-executables: []
+executables:
+- autospec
+- coderay
+- htmldiff
+- ldiff
+- nokogiri
+- pry
+- rackup
+- rake
+- rspec
 extensions: []
 extra_rdoc_files: []
 files:
@@ -103,11 +131,20 @@ files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- bin/autospec
+- bin/coderay
+- bin/htmldiff
+- bin/ldiff
+- bin/nokogiri
+- bin/pry
+- bin/rackup
+- bin/rake
+- bin/rspec
 - gatling.gemspec
 - lib/gatling.rb
 - lib/gatling/capture_element.rb
 - lib/gatling/comparison.rb
-- lib/gatling/config.rb
+- lib/gatling/configuration.rb
 - lib/gatling/image.rb
 - lib/gatling/matchers/look_like_matcher.rb
 - lib/gatling/version.rb
@@ -145,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: gatling
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Automated visual testing

data/lib/gatling/config.rb

@@ -1,84 +0,0 @@
-require 'logger'
-
-module Gatling
-  module Configuration
-
-    class << self
-
-      attr_accessor :reference_image_path, :max_no_tries, :sleep_between_tries, :browser_folders
-
-      attr_reader :paths
-
-      def reference_image_path
-        construct_path
-      end
-
-      def max_no_tries
-        Gatling.max_no_tries || @max_no_tries ||= 5
-      end
-
-      def sleep_between_tries
-        Gatling.sleep_between_tries || @sleep_between_tries ||= 0.5
-      end
-
-      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')]
-        if paths.keys.include? type
-          return paths[type]
-        else
-          raise "Unkown image type '#{type}'"
-        end
-      end
-
-      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_images_path = File.join(path, browser)
-        rescue
-          reference_images_path = path
-        end
-        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
-end