capybara-screenshot-diff 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2120b8b0ac6dc51602035b78721b827f0cf46ff
-  data.tar.gz: da5976f808661db8cb1202b9220a93577f785c26
+  metadata.gz: ea2eb0302f1b07c925218f42f50e34a92ea53d6a
+  data.tar.gz: bf0641106aec6b525fd13912b7863b616a8d16df
 SHA512:
-  metadata.gz: c4c01c8b9fc384c468f3e01e1ee92c4a17fe53b42a60cbd3e6fc86b040d442fa936993ddc10b1043e3fc219bd225e3ccb87ada0749f3793695dca58bcaf5dadf
-  data.tar.gz: 84f94aea83761a7dc55ce972cb98cedc31c7c2db0806834048528fdf636c320d4d1a352afa82102a2334d3042ce6b3bd27adaacd6e881d8150d187e1cbfc975c
+  metadata.gz: 61c6f15802542903bee2236fb7b72b65fae467b45e885515f15bac7da2dd60d4faa6a2b03e9de90450a1f66710c9c853c31c75e284befae8adab177d89cf3ac4
+  data.tar.gz: d1a8ac84a126b5227d00e43e37115a27547ca9877d4e6ec4da0cd1c37980899b8da441e39c50c6de51775359604c99a497a6a0101f589e75e23b123bebcc35f6

data/.rubocop_todo.yml

@@ -13,11 +13,11 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 177
+  Max: 181
 
 # Offense count: 3
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 10
 
 # Offense count: 9
 # Configuration parameters: CountComments.
@@ -26,4 +26,4 @@ Metrics/MethodLength:
 
 # Offense count: 2
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 10

data/README.md

@@ -259,8 +259,8 @@ This will remove the focus from the active element, removing the blinking cursor
 ### Allowed color distance
 
 Sometimes you want to allow small differences in the images.  For example, Chrome renders the same
-page slightly differently sometimes.  You can set set the difference threshold for the comparison
-using the `color_distance_limit` option to the `screenshot` method:
+page slightly differently sometimes.  You can set set the color difference threshold for the
+comparison using the `color_distance_limit` option to the `screenshot` method:
 
 ```ruby
 test 'color threshold' do
@@ -276,6 +276,25 @@ Capybara::Screenshot::Diff.color_distance_limit = 42
 ```
 
 
+### Allowed difference size
+
+You can set set a threshold for the differing area size for the comparison
+using the `area_size_limit` option to the `screenshot` method:
+
+```ruby
+test 'area threshold' do
+  visit '/'
+  screenshot 'index', area_size_limit: 17
+end
+```
+
+The difference is calculated as `width * height`.  You can also set this globally:
+
+```ruby
+Capybara::Screenshot::Diff.area_size_limit = 42
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/capybara/screenshot/diff/image_compare.rb

@@ -24,6 +24,7 @@ module Capybara
         def reset
           @max_color_distance = @color_distance_limit ? 0 : nil
           @left = @top = @right = @bottom = nil
+          @_old_filesize = nil
         end
 
         # Compare the two image files and return `true` or `false` as quickly as possible.
@@ -47,6 +48,11 @@ module Capybara
 
           return true if @top.nil?
 
+          if @area_size_limit
+            @left, @top, @right, @bottom = find_diff_rectangle(old_img, new_img)
+            return true if size <= @area_size_limit
+          end
+
           false
         end
 
@@ -78,6 +84,8 @@ module Capybara
 
           return not_different if @top.nil?
 
+          return not_different if @area_size_limit && size <= @area_size_limit
+
           annotated_old_img, annotated_new_img = draw_rectangles(images, @bottom, @left, @right, @top)
 
           save_images(@annotated_new_file_name, annotated_new_img,

data/lib/capybara/screenshot/diff/stabilization.rb

@@ -60,7 +60,7 @@ module Capybara
           # ODOT
         end
 
-        def take_stable_screenshot(comparison)
+        def take_stable_screenshot(comparison, color_distance_limit: , area_size_limit: )
           input = prepare_page_for_screenshot
           previous_file_name = comparison.old_file_name
           screenshot_started_at = last_image_change_at = Time.now
@@ -76,7 +76,8 @@ module Capybara
 
             if previous_file_name
               stabilization_comparison =
-                Capybara::Screenshot::Diff::ImageCompare.new(comparison.new_file_name, previous_file_name)
+                ImageCompare.new(comparison.new_file_name, previous_file_name,
+                    color_distance_limit: color_distance_limit, area_size_limit: area_size_limit)
               if stabilization_comparison.quick_equal?
                 if (Time.now - last_image_change_at) > Capybara::Screenshot.stability_time_limit
                   clean_stabilization_images(comparison.new_file_name)

data/lib/capybara/screenshot/diff/test_methods.rb

@@ -7,15 +7,13 @@ require_relative 'image_compare'
 require_relative 'stabilization'
 require_relative 'vcs'
 
-# TODO(uwe): Move this code to module Capybara::Screenshot::Diff::TestMethods,
-#            and use Module#prepend/include to insert.
 # Add the `screenshot` method to ActionDispatch::IntegrationTest
 module Capybara
   module Screenshot
     module Diff
       module TestMethods
-        include Capybara::Screenshot::Diff::Stabilization
-        include Capybara::Screenshot::Diff::Vcs
+        include Stabilization
+        include Vcs
 
         def initialize(*)
           super
@@ -38,7 +36,7 @@ module Capybara
         end
 
         def screenshot_dir
-          File.join [Capybara::Screenshot.screenshot_area] + group_parts
+          File.join [Screenshot.screenshot_area] + group_parts
         end
 
         def current_capybara_driver_class
@@ -61,36 +59,36 @@ module Capybara
         def screenshot_group(name)
           @screenshot_group = name.to_s
           @screenshot_counter = 0
-          return unless Capybara::Screenshot.active? && name.present?
+          return unless Screenshot.active? && name.present?
           FileUtils.rm_rf screenshot_dir
         end
 
-        def screenshot(name, color_distance_limit: Capybara::Screenshot::Diff.color_distance_limit,
-            area_size_limit: nil)
-          return unless Capybara::Screenshot.active?
+        def screenshot(name, color_distance_limit: Diff.color_distance_limit,
+            area_size_limit: Diff.area_size_limit)
+          return unless Screenshot.active?
           return if window_size_is_wrong?
           if @screenshot_counter
             name = "#{format('%02i', @screenshot_counter)}_#{name}"
             @screenshot_counter += 1
           end
           name = full_name(name)
-          file_name = "#{Capybara::Screenshot.screenshot_area_abs}/#{name}.png"
+          file_name = "#{Screenshot.screenshot_area_abs}/#{name}.png"
 
           FileUtils.mkdir_p File.dirname(file_name)
-          comparison = Capybara::Screenshot::Diff::ImageCompare.new(file_name,
-              dimensions: Capybara::Screenshot.window_size, color_distance_limit: color_distance_limit,
-              area_size_limit: area_size_limit)
+          comparison = ImageCompare.new(file_name, dimensions: Screenshot.window_size,
+              color_distance_limit: color_distance_limit, area_size_limit: area_size_limit)
           checkout_vcs(name, comparison)
-          take_stable_screenshot(comparison)
+          take_stable_screenshot(comparison, color_distance_limit: color_distance_limit,
+              area_size_limit: area_size_limit)
           return unless comparison.old_file_exists?
           (@test_screenshots ||= []) << [caller(1..1).first, name, comparison]
         end
 
         def window_size_is_wrong?
-          selenium? && Capybara::Screenshot.window_size &&
+          selenium? && Screenshot.window_size &&
             (!page.driver.chrome? || ON_WINDOWS) && # TODO(uwe): Allow for Chrome when it works
             page.driver.browser.manage.window.size !=
-              Selenium::WebDriver::Dimension.new(*Capybara::Screenshot.window_size)
+              Selenium::WebDriver::Dimension.new(*Screenshot.window_size)
         end
 
         def assert_image_not_changed(caller, name, comparison)

data/lib/capybara/screenshot/diff/version.rb

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = '0.9.0'.freeze
+      VERSION = '0.9.1'.freeze
     end
   end
 end

data/lib/capybara/screenshot/diff.rb

@@ -32,6 +32,7 @@ module Capybara
 
     # Module to track screen shot changes
     module Diff
+      mattr_accessor :area_size_limit
       mattr_accessor :color_distance_limit
       mattr_accessor(:enabled) { true }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-31 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack