gatling 1.0.6 → 1.0.7

data/.gitignore

@@ -9,3 +9,5 @@ test*
 .DS_Store
 spec/support/ready_candidate_ref/temp/*
 reports/*
+vendor/*
+

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p125

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@gatling --create

data/Gemfile

@@ -4,9 +4,7 @@ source "http://rubygems.org"
 gemspec
 
 group :development, :test, :smoke do
-	gem 'sinatra' 	,'1.3.1'
-	gem 'rack-test'
-	gem 'rake'
-	gem 'rspec-instafail'
-	gem 'pry'
+  gem 'rake'
+  gem 'rspec-instafail'
+  gem 'pry'
 end

data/lib/gatling.rb

@@ -1,88 +1,74 @@
+#Dir["/gatling/*.rb"].each {|file| require file}
+
 require 'RMagick'
-require_relative 'gatling/capture_element'
 require 'capybara'
 require 'capybara/dsl'
-require 'gatling/config'
-
-
-module Gatling
-    class Comparison
-      include Capybara::DSL
-
-      #TODO: Training mode
-      #TODO: Diff with reports
-      #TODO: Fuzz matches
-      #TODO: Helpers for cucumber
 
-      def initialize expected, actual
-        @expected = expected
-        @actual = actual
-
-        @capture_element = Gatling::CaptureElement.new(@actual)
+require 'gatling/config'
+require 'gatling/file_helper'
+require 'gatling/image'
+require 'gatling/comparison'
+require 'gatling/capture_element'
 
+# include Gatling::Comparison
 
-        @reference_image_path = Gatling::Configuration.reference_image_path
-        @trainer_toggle = Gatling::Configuration.trainer_toggle
+#TODO: Fuzz matches
+#TODO: Helpers for cucumber
+#TODO: Make directories as needed
 
-        @expected_image = "#{@reference_image_path}/#{@expected}"
-        @expected_filename = "#{@expected}".sub(/\.[a-z]*/,'')
-      end
+module Gatling
 
-      def create_diff
-        diff_path = "#{@reference_image_path}/diff"
+  class << self
 
-        FileUtils::mkdir_p(diff_path)
+    def matches?(expected_reference_filename, actual_element)
 
-        @diff_metric.first.write("#{diff_path}/#{@expected_filename}_diff.png")
+      Gatling::FileHelper.make_required_directories
 
-        candidate = save_element_as_candidate(@cropped_element)
-        raise "element did not match #{@expected}. A diff image: #{@expected_filename}_diff.png was created in #{diff_path}. A new reference #{candidate} can be used to fix the test"
-      end
+      expected_reference_file = (File.join(Gatling::Configuration.paths[:reference], expected_reference_filename))
+      actual_image = Gatling::Image.new(:from_element, expected_reference_filename, actual_element)
 
-      def save_element_as_candidate(element)
-        candidate_path = "#{@reference_image_path}/candidate"
-        candidate = @capture_element.save_element(element, @expected_filename, candidate_path)
+      if Gatling::Configuration.trainer_toggle
+        save_image_as_reference(actual_image)
+        return true
       end
 
-      def save_element_as_reference(element)
-          if File.exists?(@expected_image) == false
-            @capture_element.save_element(element, @expected_filename, @reference_image_path)
-            puts "Saved #{@expected_image} as reference"
-          else
-            puts "#{@expected_image.upcase} ALREADY EXISTS. REFERENCE IMAGE WAS NOT OVERWRITTEN. PLEASE DELETE THE OLD FILE TO UPDATE USING TRAINER"
-          end
-      end
-
-      def matches?
-        @cropped_element = @capture_element.crop
-        if !@trainer_toggle
-          if File.exists?(@expected_image)
-            self.compare
-          else
-            candidate = self.save_element_as_candidate(@cropped_element)
-            raise "The design reference #{@expected} does not exist, #{candidate} is now available to be used as a reference. Copy candidate to root reference_image_path to use as reference"
-          end
-        else
-          self.save_element_as_reference(@cropped_element)
-          matches = true
+      if !File.exists?(expected_reference_file)
+        save_image_as_candidate(actual_image)
+        return false
+      else
+        expected_image = Gatling::Image.new(:from_file, expected_reference_filename)
+        comparison = Gatling::Comparison.new(expected_image, actual_image)
+        unless comparison.match
+          actual_image.save(:as => :candidate)
+          save_image_as_diff(comparison.diff_image)
         end
+        comparison.match
       end
+    end
 
-      def compare
-        expected_img = Magick::Image.read(@expected_image).first
-
-        @diff_metric = @cropped_element.compare_channel(expected_img, Magick::MeanAbsoluteErrorMetric)
+    private
 
-        matches = @diff_metric[1] == 0.0
+    def save_image_as_diff(image)
+      image.save(:as => :diff)
+      raise "element did not match #{image.file_name}. A diff image: #{image.file_name} was created in " +
+      "#{File.join(Gatling::Configuration.paths[:diff],image.file_name)}. " +
+      "A new reference #{File.join(Gatling::Configuration.paths[:candidate],image.file_name)} can be used to fix the test"
+    end
 
-        create_diff unless matches
+    def save_image_as_candidate(image)
+      image.save :as => :candidate
+      raise "The design reference #{image.file_name} does not exist, #{image.path} " +
+      "is now available to be used as a reference. Copy candidate to root reference_image_path to use as reference"
+    end
 
-        matches
+    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 using trainer"
+      else
+        image.save(:as => :reference)
+        puts "Saved #{image.path} as reference"
       end
     end
 
+  end
 end
-
-
-
-

data/lib/gatling/capture_element.rb

@@ -1,52 +1,31 @@
+require_relative 'image_wrangler'
+
 module Gatling
   class CaptureElement
 
-    def initialize element_to_capture
+    def initialize element_to_capture, *element_to_exclude
       @reference_image_path = Gatling::Configuration.reference_image_path
-      @element = element_to_capture
+      @element_to_capture = element_to_capture
+      @element_to_exclude = element_to_exclude.first
+
     end
 
     def capture
-      temp_dir = "#{@reference_image_path}/temp"
 
-      begin
-        FileUtils::mkdir_p(temp_dir)
-      rescue
-        puts "Could not create directory #{temp_dir}. Please make sure you have permission"
-      end
+      screenshot = self.take_screenshot
+      screenshot = exclude(screenshot, @element_to_exclude) if @element_to_exclude
+      Gatling::ImageWrangler.crop_element(screenshot, @element_to_capture)
+    end
 
+    def take_screenshot
+      temp_dir = "#{@reference_image_path}/temp"
       #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
       rescue
         raise "Could not save screenshot to #{temp_dir}. Please make sure you have permission"
       end
     end
-
-    def crop
-      element = @element.native
-      location = element.location
-      size = element.size
-      @cropped_element = self.capture.crop(location.x, location.y, size.width, size.height)
-    end
-
-    def save_element(element, element_name, path)
-      begin
-        FileUtils::mkdir_p(path)
-      rescue
-        puts "Could not create directory #{path}. Please make sure you have permission"
-      end
-
-      begin
-        element.write("#{path}/#{element_name}.png")
-        element = "#{path}/#{element_name}.png"
-      rescue
-        raise "Could not save #{element_name} to #{path}. Please make sure you have permission"
-      end
-    end
-
-
   end
 end

data/lib/gatling/comparison.rb

@@ -0,0 +1,25 @@
+module Gatling
+  class Comparison
+
+    attr_accessor :match, :diff_image
+
+    def initialize(actual_image, expected_image)
+      compare(actual_image, expected_image)
+    end
+
+    def compare(actual_image, expected_image)
+      diff_metric = actual_image.image.compare_channel(expected_image.image, Magick::MeanAbsoluteErrorMetric)
+      @match = diff_metric[1] == 0.0
+      unless @match
+        diff_image = diff_metric.first
+        @diff_image = Gatling::Image.new(:from_diff, actual_image.file_name, diff_image)
+      end
+      @match
+    end
+
+    def diff_image
+      @diff_image
+    end
+
+  end
+end

data/lib/gatling/config.rb

@@ -1,35 +1,59 @@
-module Gatling 
+module Gatling
  module Configuration
 
     class << self
 
-      attr_accessor 'reference_image_path', 'trainer_toggle'
+      attr_accessor :reference_image_path, :trainer_toggle
+
+      attr_reader :paths
 
       def reference_image_path
-        begin
-        @reference_image_path ||= File.join(Rails.root, 'spec/reference_images')
-        rescue
-          raise "Not using Rails? Please set the reference_image_path"
-        end
+        @reference_image_path ||= set_default_path
+      end
+
+      def 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')]
       end
 
       def trainer_toggle
         @trainer_value = ENV['GATLING_TRAINER']
-        
+
         case @trainer_value
           when nil
             @trainer_value = nil
           when 'true'
             @trainer_value = true
           when 'false'
-            @trainer_value = false  
+            @trainer_value = false
           else
             @trainer_value = false
-            puts 'Unknown GATLING_TRAINER argument. Please supply true, false or nil. DEFAULTING TO FALSE'       
+            puts 'Unknown GATLING_TRAINER argument. Please supply true, false or nil. DEFAULTING TO FALSE'
         end
         @trainer_toggle ||= @trainer_value ||= false
       end
 
+      def path_from_type(type)
+        if paths.keys.include? type
+          return paths[type]
+        else
+          raise "Unkown image type '#{type}'"
+        end
+      end
+
+      private
+
+      def set_default_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::Configuration.reference_image_path=[refpath]"
+        end
+        @reference_image_path
+      end
     end
 
   end

data/lib/gatling/file_helper.rb

@@ -0,0 +1,17 @@
+module Gatling
+  class FileHelper
+    class << self
+
+      def make_required_directories
+        Gatling::Configuration.paths.each { | key, directory | make_dir directory  }
+      end
+
+      private
+
+      def make_dir(path)
+        FileUtils::mkdir_p(File.join(path))
+      end
+      
+    end
+  end
+end

data/lib/gatling/image.rb

@@ -0,0 +1,50 @@
+module Gatling
+  class Image
+
+    attr_accessor :file_name, :path, :image
+
+    attr_reader :type
+
+    def initialize(type, file_name, element_or_image = nil)
+
+      @file_name = file_name
+
+      case type
+      when :from_file
+        @image = image_from_file(file_name)
+      when :from_element
+        @image = image_from_element(element_or_image)
+      when :from_diff
+        @image = element_or_image
+      else
+        raise 'WRONG IMAGE TYPE'
+      end
+
+    end
+
+    def save type
+      @path = File.join(Gatling::Configuration.path_from_type(type[:as]), @file_name)
+      @image.write @path
+      @path
+    end
+
+    def exists?
+      File.exists?(File.join(Gatling::Configuration.path_from_type(:reference), @file_name))
+    end
+
+    private
+
+    def image_from_element element
+      Gatling::CaptureElement.new(element).capture
+    end
+
+    def image_from_file file_name
+      Magick::Image.read(File.join(Gatling::Configuration.path_from_type(:reference), file_name)).first
+    end
+
+
+  end
+
+end
+
+

data/lib/gatling/image_wrangler.rb

@@ -0,0 +1,25 @@
+module Gatling
+  class ImageWrangler
+
+    def self.get_element_position element
+
+      element = element.native
+      position = Hash.new{}
+      position[:x] = element.location.x
+      position[:y] = element.location.y
+      position[:width] = element.size.width
+      position[:height] = element.size.height
+      position
+    end
+
+    def self.crop_element image, element_to_crop
+      position = get_element_position(element_to_crop)
+      @cropped_element = image.crop(position[:x], position[:y], position[:width], position[:height])
+    end
+
+    def self.exclude image, element_to_exclude
+    end
+
+
+  end
+end

data/lib/gatling/matchers/look_like_matcher.rb

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

data/lib/gatling/version.rb

@@ -1,3 +1,3 @@
 module Gatling
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

data/spec/capture_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Gatling::CaptureElement do
+  
+  before do
+
+    capybara_node = mock (Capybara::Node::Element)
+    Gatling::Configuration.reference_image_path="./"
+    Gatling::CaptureElement.new capybara_node, capybara_node
+  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

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Gatling::Comparison do
+
+  before do
+    apple = Magick::Image.new(100,100) { self.background_color = "green" }
+    orange = Magick::Image.new(100,100) { self.background_color = "orange" }
+    @apple = Gatling::Image.new(:from_diff, 'apple.png', apple)
+    @orange = Gatling::Image.new(:from_diff, 'orange.png', orange)
+  end
+
+  describe 'will compare two images' do
+
+    it 'will return true if the images are identical' do
+      subject = Gatling::Comparison.new(@apple, @apple)
+      subject.match.should == true
+    end
+
+    it 'will return false if the images are different' do
+      subject = Gatling::Comparison.new(@apple, @orange)
+      subject.match.should == false
+    end
+  end
+
+  describe 'Diff images' do
+    it 'will give us a diff' do
+      subject = Gatling::Comparison.new(@apple, @orange)
+      subject.diff_image.class.should == Gatling::Image
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -1,67 +1,86 @@
 require 'spec_helper'
 
-describe "Gatling::Configuration" do
+describe Gatling::Configuration do
 
   describe "#reference_image_path" do
+    before :each do
+      Gatling::Configuration.reference_image_path = nil
+    end 
 
-    before do
-      begin
-        # Check that rails exists, otherwise fake it for the test
-        Module.const_get("Rails")
-      rescue NameError
-        module Rails
-          def self.root
-            "fake_rails_root"
+    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    
+    end
+
+    describe "with rails" do
+
+      before do
+        begin
+          # Check that rails exists, otherwise fake it for the test
+          Module.const_get("Rails")
+        rescue NameError
+          module Rails
+            def self.root
+              "fake_rails_root"
+            end
           end
         end
       end
-    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")
+      end
 
-    it "should default to <Rails.root>/spec/reference_images" do
-      Gatling::Configuration.reference_image_path.should eql("fake_rails_root/spec/reference_images")
-    end
+      it "should be overrideable in a rails environment" do
+        Gatling::Configuration.reference_image_path = "my custom path"
+        Gatling::Configuration.reference_image_path.should eql("my custom path")
+      end
 
-    it "should be overrideable" do
-      Gatling::Configuration.reference_image_path = "my custom path"
-      Gatling::Configuration.reference_image_path.should eql("my custom path")
     end
-
-
-  end
+  end  
 
   describe '#trainer_toggle' do
 
     it 'should default to false' do
       Gatling::Configuration.trainer_toggle.should eql(false)
     end
-    
+
     it 'can be toggled to true' do
       Gatling::Configuration.trainer_toggle = true
       Gatling::Configuration.trainer_toggle.should eql(true)
     end
-    
+
     it 'toggeled using GATLING_TRAINER = false' do
       ENV['GATLING_TRAINER'] = 'false'
       Gatling::Configuration.trainer_toggle.should eql(false)
     end
-    
+
     it 'toggeled using GATLING_TRAINER = true' do
       ENV['GATLING_TRAINER'] = 'true'
       Gatling::Configuration.trainer_toggle.should eql(true)
     end
-    
+
     it 'toggeled using GATLING_TRAINER = nil' do
       ENV['GATLING_TRAINER'] = nil
       Gatling::Configuration.trainer_toggle.should eql(false)
     end
-   
+
     after(:each) do
       Gatling::Configuration.trainer_toggle = false
       ENV['GATLING_TRAINER'] = nil
     end
-
   end
 
+  describe 'paths' do
+    it 'should return the directory for a type of image' do
+      Gatling::Configuration.reference_image_path = "a_path"
+      Gatling::Configuration.path_from_type(: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_from_type(:unknown)}.should raise_error "Unkown image type 'unknown'"
+    end
+  end  
+
 end

data/spec/file_helper_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Gatling::FileHelper do
+
+  describe ':make_dir' do
+    before :all do
+      Gatling::Configuration.reference_image_path = './gatling' 
+    end
+
+    it 'should make required directories' do
+      FileUtils.should_receive(:mkdir_p).with './gatling/candidate'
+      FileUtils.should_receive(:mkdir_p).with './gatling/diff'
+      FileUtils.should_receive(:mkdir_p).with './gatling'
+      FileUtils.should_receive(:mkdir_p).with './gatling/temp'  
+      Gatling::FileHelper.make_required_directories
+    end
+  end
+end

data/spec/gatling_spec.rb

@@ -1,107 +1,89 @@
 require 'spec_helper'
 include Capybara::DSL
 
-
 describe 'Gatling' do
 
-
   before(:all) do
-
-    include Rack::Test::Methods
-
-    def app
-      Sinatra::Application
-    end
-
-    #expected image to compare with
-    @example_good_image = 'smiley-faceicon.png'
-
     @spec_support_root = spec_support_root
+    @black_box = 'black.png'
+    @red_box = 'red.png'
+    create_images_for_web_page
   end
 
+  before(:each) do
+    @ref_path = Gatling::Configuration.reference_image_path = File.join(spec_support_root, 'ref_path')
+  end
 
   after(:each) do
     remove_refs(@ref_path)
+    Gatling::Configuration.trainer_toggle = false
   end
-  
-  
-
-  describe 'creating an initial reference (expected) image' do
 
-    before(:each) do
-      @ref_path = Gatling::Configuration.reference_image_path = File.join(@spec_support_root, 'ref_path')
-    end
+  describe 'Gatling, when no reference image exists' do
 
-      it "should notify that no reference exists for image and create a candidate" do
-        gatling = gatling_for_spec('smiley-faceicon.png')
-        expect {gatling.matches?}.should raise_error(RuntimeError, "The design reference #{@example_good_image} does not exist, #{@ref_path}/candidate/#{@example_good_image} is now available to be used as a reference. Copy candidate to root reference_image_path to use as reference")
-        File.exists?(File.join(@ref_path,'candidate','smiley-faceicon.png')).should be_true
-      end
-    end
+    it "will notify that no reference image exists and create a candidate image" do
+      black_element = element_for_spec
+      expected_error = "The design reference #{@black_box} does not exist, #{@ref_path}/candidate/#{@black_box} " +
+                       "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, black_element)}.should raise_error(RuntimeError, expected_error)
 
+      File.exists?(File.join(@ref_path, 'candidate', @black_box)).should be_true
+    end
+  end
 
-  describe 'image comparison' do
+  describe 'Gatling image comparison' do
 
     before(:each) do
-     # @ready_ref = Gatling::Configuration.reference_image_path = File.join(@spec_support_root, 'ready_candidate_ref')
-     @ref_path = Gatling::Configuration.reference_image_path = File.join(@spec_support_root, 'ref_path')
-     save_element_for_test
+      create_square_image(@ref_path, 'black')
     end
 
-    it 'images match' do
-      @gatling = gatling_for_spec('smiley-faceicon.png')
-      @gatling.matches?.should be_true
+    it 'will return true if the images are identical' do
+      black_element = element_for_spec('#black')
+
+      Gatling.matches?(@black_box, black_element).should be_true
     end
 
-    it 'images do not match and diff created' do
-       #convert -fill none -stroke black -strokewidth 5 smiley-faceicon.png -draw 'arc 155,25 185,45 180' sad-faceicon.png
-       convert_element_to_bad_element(File.join(@ref_path,"#{@example_good_image}"))
-       gatling = gatling_for_spec('smiley-faceicon.png')
-       expect {gatling.matches?}.should raise_error(RuntimeError, "element did not match #{@example_good_image}. A diff image: smiley-faceicon_diff.png was created in #{@ref_path}/diff. A new reference #{@ref_path}/candidate/#{@example_good_image} can be used to fix the test")
-       File.exists?(File.join(@ref_path,'diff','smiley-faceicon_diff.png')).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_box}. " +
+                       "A diff image: #{@black_box} was created in #{@ref_path}/diff/#{@black_box}. " +
+                       "A new reference #{@ref_path}/candidate/#{@black_box} can be used to fix the test"
+
+      expect {Gatling.matches?(@black_box, red_element)}.should raise_error(RuntimeError, expected_error)
+
+      File.exists?(File.join(@ref_path,'diff', @black_box)).should be_true
+      File.exists?(File.join(@ref_path,'candidate', @black_box)).should be_true
+    end
   end
 
+  describe 'Gatling trainer toggle' do
 
+    it 'will save a reference file if no reference file already exists' do
+      Gatling::Configuration.trainer_toggle = true
+      File.exists?(File.join(@ref_path, @black_box)).should be_false
+      $stdout.should_receive(:puts).with "Saved #{@ref_path}/#{@black_box} as reference"
+      black_element = element_for_spec
 
-  describe 'trainer toggle' do
+      expect {Gatling.matches?(@black_box, black_element)}.should_not raise_error
 
-    before(:each) do
-      @ref_path = Gatling::Configuration.reference_image_path = File.join(@spec_support_root, 'ref_path')
+      File.exists?(File.join(@ref_path, @black_box)).should be_true
     end
 
-    it 'should save a reference file to the nominated folder without raising an exception' 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
-      gatling = gatling_for_spec('smiley-faceicon.png')
+      expected_message = " 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_box))
+
+      $stdout.should_receive(:puts).with expected_message
+      expect {Gatling.matches?(@black_box, black_element)}.should_not raise_error
 
-      expect {gatling.matches?}.should_not raise_error
-      File.exists?(File.join(@ref_path,'smiley-faceicon.png')).should be_true
-    end
-    
-    it 'should alert that the file should be deleted if a reference already exists and not overwrite file' do
-      save_element_for_test
-      Gatling::Configuration.trainer_toggle = true
-      gatling = gatling_for_spec('smiley-faceicon.png')
-      
-      reference_file_ctime = File.ctime(File.join(@ref_path,'smiley-faceicon.png'))
       sleep(1)
-      expect {gatling.matches?}.should_not raise_error
-      
-      #checks if file was overwritten by comparing the time stamps
-      reference_file_ctime.eql?(File.ctime(File.join(@ref_path,'smiley-faceicon.png'))).should be_true
+      reference_file_ctime.eql?(File.ctime(File.join(@ref_path, @black_box))).should be_true
     end
-
   end
-  
-  
-  
-  
-  # MOCK SELENIUM ELEMENT
-  # correct size (340px*42px)
-  # image magick saves screenshot
-  #create diff creates the correct candidate
-  
-  
 end
-

data/spec/image_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Gatling::Image do
+
+  before :all do
+    Gatling::Configuration.reference_image_path = './image_tests'
+  end
+
+  describe 'should initialize from' do
+
+    it 'image file type' do
+        File.stub(:exists?).and_return true
+        image_mock = mock(Magick::Image)
+        Magick::Image.should_receive(:read).with('./image_tests/image.png').and_return([image_mock])
+
+        subject = Gatling::Image.new(:from_file, '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::Image.new(:from_element, 'image.png', mock_element)
+      subject.image.should == mock_image
+      subject.file_name.should == 'image.png'
+    end
+
+    it 'diff image' do
+       mock_image = mock(Magick::Image)
+       subject = Gatling::Image.new(:from_diff, 'image.png', mock_image)
+       subject.image.should == mock_image
+       subject.file_name.should == 'image.png'
+    end
+  end
+
+  it 'should be ok with nil' do
+    pending
+  end
+
+  it 'should save an image to the 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(:from_diff, 'image.png', mock_image)
+    subject.image = mock_image
+    subject.file_name = 'image.png'
+    subject.save(:as => :temp)
+    subject.path.should == './image_tests/temp/image.png'
+  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(:from_diff, 'image.png', mock_image)
+    subject.file_name = 'image.png'
+    subject.exists?
+  end
+end

data/spec/image_wrangler_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Gatling::ImageWrangler do
+
+  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
+
+    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 = Gatling::ImageWrangler.get_element_position(mock_element)
+
+    position[:x].should eql(1)
+    position[:y].should eql(2)
+    position[:width].should eql(100)
+    position[:height].should eql(200)
+  end
+
+
+
+
+end

data/spec/rspec_matcher_spec.rb

@@ -1,46 +1,39 @@
 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
 
-    include Rack::Test::Methods
+  describe 'initializing and runnin gatling' do
 
-    def app
-      Sinatra::Application
+    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
-        
-    #expected image to compare with
-    @example_good_image = 'smiley-faceicon.png'
 
-    @spec_support_root = spec_support_root
-    
-    @ref_path = Gatling::Configuration.reference_image_path = File.join(@spec_support_root, 'ref_path')
-  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
 
-  after(:each) do
-    remove_refs(@ref_path)
-  end
-  
-  it 'should initialize and run gatling' do
-
-    save_element_for_test
-    
-    visit('/')
-    @element = page.find(:css, "#smiley")
-    @element.should look_like('smiley-faceicon.png')
-  end
-  
-  it 'should initialize and run training mode when GATLING_TRAINER is toggled' do
-    ENV['GATLING_TRAINER'] = 'true'
-   
-    visit('/')
-    @element = page.find(:css, "#smiley")
-    @element.should look_like('smiley-faceicon.png')
-    File.exists?(File.join(@ref_path,'smiley-faceicon.png')).should be_true
   end
-  
-end
+end

data/spec/spec_helper.rb

@@ -1,68 +1,54 @@
-require  File.join(File.dirname(__FILE__), '/support/assets/smiley_app')
-
 require 'rubygems'
-require 'sinatra'
-Sinatra::Application.environment = :test
-require 'rack/test'
-# require 'spec'
-# require 'spec/autorun'
-# require 'spec/interop/test'
 require 'capybara'
 require 'capybara/dsl'
 require 'capybara/rspec'
 require 'gatling'
 require 'gatling/matchers/look_like_matcher'
 require 'fileutils'
+require 'pry'
+
+#todo: spec folders clean up method
 
 RSpec.configure do |config|
   config.color_enabled = true
   config.formatter     = 'documentation'
 end
 
-Capybara.app = Sinatra::Application
+Capybara.app_host = "file://#{File.expand_path(File.dirname(__FILE__))}/support/assets"
 Capybara.default_driver = :selenium
-
-def app
-  @app ||= Sinatra::Application
-end
-
-set :run, false
-set :environment, :test
+Capybara.run_server = false
 
 def remove_refs(dir)
- FileUtils.rm_rf dir.to_s
+  Dir.glob("#{dir}/**/*.png").each {|image| FileUtils.rm image}
 end
 
-def gatling_for_spec(expected)
-  visit('/')
-  @element = page.find(:css, "#smiley")
-
-  @gatling = Gatling::Comparison.new(expected, @element)
+def element_for_spec(css = '#black')
+  visit('/fruit_app.html')
+  @element = page.find(:css, css)
 end
 
 def spec_support_root
-   File.join(File.dirname(__FILE__), 'support')
+  File.join(File.dirname(__FILE__), 'support')
 end
 
-def save_element_for_test
-  Gatling::Configuration.trainer_toggle = true
-  gatling_for_spec('smiley-faceicon.png').matches?
-  Gatling::Configuration.trainer_toggle = false
+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')
 end
 
-def convert_element_to_bad_element(image_file)
-  #convert -fill none -stroke black -strokewidth 5 smiley-faceicon.png -draw 'arc 155,25 185,45 180' sad-faceicon.png
-  image = Magick::Image.read(image_file).first
-  frown = Magick::Draw.new
-  frown.stroke('black')
-  frown.stroke_width(5)
-  frown.fill_opacity(0)
-  frown.stroke_opacity(10)
-  frown.arc(155,25,185,45,180,0)
-  frown.draw(image)
-  bad_element = image.write(image_file)
-end
-
-#todo: spec folders clean up method
+def create_square_image(path, color)
+  # We make the images, rather then check them in because otherwise the comparison tests
+  # become very flakey depending on the graphics set up on the computer running them
+  FileUtils::mkdir_p(path)
 
+  reference_file = Magick::Image.new(100,100) { self.background_color = 'white' }
+  square = Magick::Draw.new
+  square.fill_opacity(100)
+  square.fill_color(color)
+  square.rectangle(10,10, 90,90)
+  square.draw(reference_file)
 
+  reference_file.write(File.join(path, "#{color}.png"))
+  reference_file
+end

data/spec/support/assets/fruit_app.html

@@ -0,0 +1,11 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+        "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+    <title>The Smiley Site</title>
+</head>
+<body>
+    <img src='./black.png' id="black"/>
+    <img src='./red.png' id="red"/>
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gatling
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-28 00:00:00.000000000Z
+date: 2012-03-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &70095506844640 !ruby/object:Gem::Requirement
+  requirement: &70287958354680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095506844640
+  version_requirements: *70287958354680
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &70095506844220 !ruby/object:Gem::Requirement
+  requirement: &70287958354160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095506844220
+  version_requirements: *70287958354160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70095506843800 !ruby/object:Gem::Requirement
+  requirement: &70287958353700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095506843800
+  version_requirements: *70287958353700
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70095506843380 !ruby/object:Gem::Requirement
+  requirement: &70287958353180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095506843380
+  version_requirements: *70287958353180
 description: Add visual comparison matchers for rspec
 email:
 - grotbart@gmail.com
@@ -64,29 +64,36 @@ extra_rdoc_files: []
 files:
 - .DS_Store
 - .gitignore
+- .rbenv-version
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- foo.rb
 - gatling.gemspec
 - lib/gatling.rb
 - lib/gatling/capture_element.rb
+- lib/gatling/comparison.rb
 - lib/gatling/config.rb
+- lib/gatling/file_helper.rb
+- lib/gatling/image.rb
+- lib/gatling/image_wrangler.rb
 - lib/gatling/matchers/look_like_matcher.rb
 - lib/gatling/version.rb
 - pkg/gatling-0.0.1.gem
 - reports/rspec_unit_test_output.html
+- spec/capture_spec.rb
+- spec/comparison_spec.rb
 - spec/configuration_spec.rb
+- spec/file_helper_spec.rb
 - spec/gatling_spec.rb
+- spec/image_spec.rb
+- spec/image_wrangler_spec.rb
 - spec/rspec_matcher_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/support/assets/public/smiley-faceicon.jpg
-- spec/support/assets/smiley-bad.jpg
-- spec/support/assets/smiley_app.rb
-- spec/support/assets/views/smiley_site.erb
+- spec/support/assets/fruit_app.html
 homepage: http://github.com/GabrielRotbart/gatling
 licenses: []
 post_install_message: 
@@ -107,17 +114,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: gatling
-rubygems_version: 1.8.12
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Automated visual testing
 test_files:
+- spec/capture_spec.rb
+- spec/comparison_spec.rb
 - spec/configuration_spec.rb
+- spec/file_helper_spec.rb
 - spec/gatling_spec.rb
+- spec/image_spec.rb
+- spec/image_wrangler_spec.rb
 - spec/rspec_matcher_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/support/assets/public/smiley-faceicon.jpg
-- spec/support/assets/smiley-bad.jpg
-- spec/support/assets/smiley_app.rb
-- spec/support/assets/views/smiley_site.erb
+- spec/support/assets/fruit_app.html

data/foo.rb

@@ -1,9 +0,0 @@
-puts ENV['GEM_PATH']
-def foo
-  puts ">"
-  bar = false unless ENV['BARRR']='true'
-  puts ">>>"
-  puts bar.inspect
-end
-
-foo

data/spec/support/assets/smiley_app.rb

@@ -1,18 +0,0 @@
-require 'sinatra'
-
-set :app_file, __FILE__
-
-set :root, File.expand_path(File.dirname(__FILE__))
-set :static, true
-
-get '/' do
-  erb :smiley_site
-end
-
-get '/root' do
-  'root is ' + settings.root
-end
-
-get '/public' do
-  'root is ' + settings.public_directory
-end  

data/spec/support/assets/views/smiley_site.erb

@@ -1,19 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-        "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-    <title>The Smiley Site</title>
-    <style type="text/css">
-       div {width:100%;}
-            img
-            {
-            border:1
-            }
-    </style>
-</head>
-<body>
-    <div style="width:340px;text-align:center;float:left;" id="smiley">
-        <img src="smiley-faceicon.jpg" alt="Smiley" height="42" width="42" />
-    </div>
-</body>
-</html>