symilaa 0.0.4 → 0.0.5

data/lib/symilaa/comparison_support.rb

@@ -0,0 +1,72 @@
+module Symilaa
+  module ComparisonSupport
+    def add_text_to_image text, image
+      txt = Draw.new
+      image.annotate(txt, 0, 0, 0, 50, text) {
+        txt.gravity = Magick::SouthGravity
+        txt.pointsize = 25
+        txt.stroke = '#ff0000'
+        txt.fill = '#ff0000'
+        txt.font_weight = Magick::BoldWeight
+      }
+    end
+
+    def produce_gif_showing_the_difference_between reference_shot, test_shot, output_file
+      gif = Magick::ImageList.new(reference_shot, test_shot)
+      add_text_to_image "Test Screenshot", gif[1]
+      gif.delay = 100
+      gif.write(output_file)
+    end
+
+    def get_unique_file_name path, extension, inc
+      inc = 0 unless inc
+      inc = inc.to_int+1
+
+      new_path = "#{path}#{inc}#{extension}"
+
+      if File.exists?("#{new_path}")
+        get_unique_file_name path, extension, inc
+      else
+        new_path
+      end
+    end
+
+    def check_screen_against_reference_shot sub_directory
+      sub_directory = "#{sub_directory}#{@gherkin_statement.parameterize.underscore}/"
+
+      FileUtils.mkdir_p("#{SCREENSHOTS_GENERATED_THIS_RUN_DIR}/#{sub_directory}")
+
+      browser_info = page.driver.browser.capabilities
+
+      version_if_required = "_#{browser_info.version.gsub('.', '-')}" unless browser_info.browser_name == 'firefox' and browser_info.version != '3.5' or browser_info.browser_name == 'chrome'
+
+      title = find('title').text
+      file_name = "#{browser_info.browser_name.capitalize.parameterize}#{version_if_required}_#{browser_info.platform.capitalize}_#{title.parameterize.underscore}"
+      test_file = get_unique_file_name "#{SCREENSHOTS_GENERATED_THIS_RUN_DIR}/#{sub_directory}#{file_name}", '.png', nil
+
+      page.driver.browser.save_screenshot test_file
+
+      screenshot_name = File.basename test_file
+      reference_file = "#{REFERENCE_SCREENSHOTS}/#{sub_directory}#{screenshot_name}"
+
+      reference_screenshot = Image.new reference_file
+      generated_screenshot = Image.new test_file
+
+      same = if dodgy_browser?
+               reference_screenshot.similar_to? generated_screenshot
+             else
+               reference_screenshot == generated_screenshot
+             end
+
+      unless same
+        FileUtils.mkdir_p("#{DIFFERENCES_IN_SCREENSHOTS_THIS_RUN_DIR}/#{sub_directory}")
+        produce_gif_showing_the_difference_between(reference_file, test_file, "#{DIFFERENCES_IN_SCREENSHOTS_THIS_RUN_DIR}/#{sub_directory}#{screenshot_name}_difference.gif")
+        fail "Some of the screenshots did not match"
+      end
+    end
+
+    def dodgy_browser?
+      %w[chrome ie7 ie8 ie9].include? ENV['REQUIRED_BROWSER']
+    end
+  end
+end

data/lib/symilaa/{screenshot.rb → image.rb}

@@ -2,7 +2,7 @@ require 'RMagick'
 require 'fileutils'
 
 module Symilaa
-  class Screenshot
+  class Image
     SIMILARITY_THRESHOLD = 41.4
 
     attr_reader :path

data/lib/symilaa/version.rb

@@ -1,3 +1,3 @@
 module Symilaa
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/symilaa.rb

@@ -1,2 +1,4 @@
 require "symilaa/version"
-require 'symilaa/screenshot'
+require 'symilaa/comparison_support'
+require 'symilaa/image'
+

data/symilaa.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   s.add_development_dependency "minitest"
   s.add_development_dependency "guard-minitest"
+  s.add_development_dependency "rake"
 
   s.add_development_dependency 'rb-inotify' if RUBY_PLATFORM =~ /linux/
 

data/test/symilaa/test_screenshot.rb

@@ -1,87 +1,87 @@
 gem 'minitest'
 require 'minitest/autorun'
-require_relative '../../lib/symilaa/screenshot'
+require_relative '../../lib/symilaa/image'
 
 module Symilaa
-  class TestScreenshot < Minitest::Unit::TestCase
+  class TestImage < Minitest::Unit::TestCase
     def test_equality_when_images_altered
-      one = Screenshot.new grylls
-      two = Screenshot.new grylls_different
+      one = Image.new grylls
+      two = Image.new grylls_different
 
       refute one == two
     end
 
     def test_equality_when_images_similar
-      one = Screenshot.new grylls
-      two = Screenshot.new grylls_slightly_different
+      one = Image.new grylls
+      two = Image.new grylls_slightly_different
 
       refute one == two
     end
 
     def test_equality_when_identical
-      one = Screenshot.new grylls
-      two = Screenshot.new grylls
+      one = Image.new grylls
+      two = Image.new grylls
 
       assert one == two
     end
 
     def test_similar_when_identical
-      one = Screenshot.new grylls
-      two = Screenshot.new grylls
+      one = Image.new grylls
+      two = Image.new grylls
 
       assert one.similar_to? two
     end
     
     def test_similar_when_similar
-      one = Screenshot.new grylls
-      two = Screenshot.new grylls_slightly_different
+      one = Image.new grylls
+      two = Image.new grylls_slightly_different
 
       assert one.similar_to? two
     end
    
     def test_different_sized_images_are_different
-      one = Screenshot.new grylls
-      two = Screenshot.new the_queen
+      one = Image.new grylls
+      two = Image.new the_queen
 
       refute one.similar_to? two
       refute one == two
     end
 
     def test_css_font_size_change
-      ref  = Screenshot.new fixture 'diagnostics/reference/font_size.png'
-      diff = Screenshot.new fixture 'diagnostics/generated/font_size.png'
+      ref  = Image.new fixture 'diagnostics/reference/font_size.png'
+      diff = Image.new fixture 'diagnostics/generated/font_size.png'
 
       refute ref == diff
       refute ref.similar_to? diff
     end
 
     def test_css_change_of_gradient
-      ref  = Screenshot.new fixture 'diagnostics/reference/gradient.png'
-      diff = Screenshot.new fixture 'diagnostics/generated/gradient.png'
+      ref  = Image.new fixture 'diagnostics/reference/gradient.png'
+      diff = Image.new fixture 'diagnostics/generated/gradient.png'
 
       refute ref == diff, "Images with different gradients should not be the same"
       refute ref.similar_to?(diff), "Images with different gradients should not be similar"
     end
 
     def test_lightbox_difference
-      ref  = Screenshot.new fixture 'diagnostics/reference/lightbox.png'
-      diff = Screenshot.new fixture 'diagnostics/generated/lightbox.png'
+      ref  = Image.new fixture 'diagnostics/reference/lightbox.png'
+      diff = Image.new fixture 'diagnostics/generated/lightbox.png'
 
       refute ref == diff, "Internet Explorer's rendering of a lightbox is different every time"
       assert ref.similar_to?(diff), "Internet Explorer's rendering of a lightbox is similar enough each time"
     end
 
     def test_rounded_corners_in_ie9
-      ref  = Screenshot.new fixture 'diagnostics/reference/rounded_corner_ie9.png'
-      diff = Screenshot.new fixture 'diagnostics/generated/rounded_corner_ie9.png'
+      ref  = Image.new fixture 'diagnostics/reference/rounded_corner_ie9.png'
+      diff = Image.new fixture 'diagnostics/generated/rounded_corner_ie9.png'
 
       refute ref == diff
       assert ref.similar_to?(diff)
     end
 
     def test_active_input_state_in_ie9
-      ref  = Screenshot.new fixture 'diagnostics/reference/active_input_ie9.png'
-      diff = Screenshot.new fixture 'diagnostics/generated/active_input_ie9.png'
+      ref  = Image.new fixture 'diagnostics/reference/active_input_ie9.png'
+      diff = Image.new fixture 'diagnostics/generated/active_input_ie9.png'
 
       refute ref == diff
       assert ref.similar_to?(diff)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: symilaa
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000Z
+date: 2012-11-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &22820560 !ruby/object:Gem::Requirement
+  requirement: &11679260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22820560
+  version_requirements: *11679260
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &22819920 !ruby/object:Gem::Requirement
+  requirement: &11678820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22819920
+  version_requirements: *11678820
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &11678220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11678220
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &22819220 !ruby/object:Gem::Requirement
+  requirement: &11677500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22819220
+  version_requirements: *11677500
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &22818440 !ruby/object:Gem::Requirement
+  requirement: &11239900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22818440
+  version_requirements: *11239900
 description: ! "Using the wonders of RMagick, this wonderful gem will produce a boolean
   result based on the computed similarity\n    of the two images passed."
 email:
@@ -69,7 +80,8 @@ files:
 - README.md
 - Rakefile
 - lib/symilaa.rb
-- lib/symilaa/screenshot.rb
+- lib/symilaa/comparison_support.rb
+- lib/symilaa/image.rb
 - lib/symilaa/version.rb
 - symilaa.gemspec
 - test/fixtures/bear_grylls.png
@@ -99,12 +111,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3943333428684723224
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3943333428684723224
 requirements: []
 rubyforge_project: symilaa
 rubygems_version: 1.8.10