symilaa 0.0.6 → 0.0.7

data/lib/symilaa/comparison_support.rb

@@ -1,5 +1,13 @@
 module Symilaa
   module ComparisonSupport
+    def base_dir= dir
+      @base_dir = dir
+    end
+
+    def base_dir
+      @base_dir || 'artifacts'
+    end
+
     def add_text_to_image text, image
       txt = Magick::Draw.new
       image.annotate(txt, 0, 0, 0, 50, text) {
@@ -18,8 +26,7 @@ module Symilaa
       gif.write(output_file)
     end
 
-    def get_unique_file_name path, extension, inc
-      inc = 0 unless inc
+    def get_unique_file_name path, extension, inc=0
       inc = inc.to_int+1
 
       new_path = "#{path}#{inc}#{extension}"
@@ -31,42 +38,97 @@ module Symilaa
       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
+    def create_directories directories
+      directories.each do |dir|
+        path = File.join base_dir, dir
+        FileUtils.rm_rf(path) if File.exists? path
+        FileUtils.mkdir_p path
+      end
+    end
 
-      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'
+    def browser_info
+      @browser_info ||= page.driver.browser.capabilities
+    end
 
-      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
+    def browser_name
+      browser_info.browser_name
+    end
 
-      page.driver.browser.save_screenshot test_file
+    def browser_version
+      browser_info.version
+    end
 
-      screenshot_name = File.basename test_file
-      reference_file = "#{REFERENCE_SCREENSHOTS}/#{sub_directory}#{screenshot_name}"
+    def title
+      find('title').text.parameterize.underscore
+    end
 
+    def same? reference_file, test_file
       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"
+      if dodgy_browser?
+        reference_screenshot.similar_to? generated_screenshot
+      else
+        reference_screenshot == generated_screenshot
       end
     end
 
     def dodgy_browser?
       %w[chrome ie7 ie8 ie9].include? ENV['REQUIRED_BROWSER']
     end
+
+    def chrome_or_firefox_3_5
+      browser_name == 'chrome' or (browser_name == 'firefox' and browser_version == '3.5')
+    end
+
+    def version_if_required
+      "_#{browser_info.version.gsub('.', '-')}" if chrome_or_firefox_3_5? 
+    end
+
+    def reference_screenshots
+      File.join base_dir, 'reference_screenshots'
+    end
+
+    def screenshots_generated_this_run_dir
+      File.join base_dir, 'screenshots_generated_this_run'
+    end
+
+    def scenario_name
+      @gherkin_statement.parameterize.underscore if @gherkin_statement
+    end
+
+    def create_screenshot_directory sub_directory, scenario_name
+      FileUtils.mkdir_p(File.join screenshots_generated_this_run_dir, sub_directory, scenario_name)
+    end
+
+    def create_screenshot_filename sub_directory
+      file_name = "#{browser_info.browser_name.capitalize.parameterize}#{version_if_required}_#{browser_info.platform.capitalize}_#{title}"
+      get_unique_file_name "#{screenshots_generated_this_run_dir}/#{sub_directory}#{file_name}", '.png'
+    end
+
+    def save_screenshot screenshot_path
+      page.driver.browser.save_screenshot screenshot_path
+    end
+
+    def check_screen_against_reference_shot target_sub_directory
+      create_directories %w[reference_screenshots screenshots_generated_this_run differences_in_screenshots_this_run]
+      create_screenshot_directory target_sub_directory
+
+      generated_screenshot_path = create_screenshot_filename target_sub_directory
+      screenshot_name           = File.basename generated_screenshot_path
+      reference_path            = File.join reference_screenshots, target_sub_directory, screenshot_name
+      difference_file           = File.join path, "#{screenshot_name}_difference.gif"
+
+      save_screenshot generated_screenshot_path
+
+      unless same? reference_path, generated_screenshot_path
+        path = File.join differences_in_screenshots_this_run_dir, target_sub_directory
+        FileUtils.mkdir_p path
+
+        produce_gif_showing_the_difference_between reference_path, generated_screenshot_path, difference_file
+
+        fail "Some of the screenshots did not match"
+      end
+    end
   end
 end

data/lib/symilaa/version.rb

@@ -1,3 +1,3 @@
 module Symilaa
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: symilaa
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-11-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &15138960 !ruby/object:Gem::Requirement
+  requirement: &10950900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15138960
+  version_requirements: *10950900
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &15138060 !ruby/object:Gem::Requirement
+  requirement: &10950400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15138060
+  version_requirements: *10950400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15137560 !ruby/object:Gem::Requirement
+  requirement: &10949920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15137560
+  version_requirements: *10949920
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &15137100 !ruby/object:Gem::Requirement
+  requirement: &10557620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15137100
+  version_requirements: *10557620
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &15108860 !ruby/object:Gem::Requirement
+  requirement: &10557040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15108860
+  version_requirements: *10557040
 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:
@@ -113,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2857289214449860122
+      hash: 2284028661893929542
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2857289214449860122
+      hash: 2284028661893929542
 requirements: []
 rubyforge_project: symilaa
 rubygems_version: 1.8.10