capybara-screenshot-diff 0.14.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d9914e53a8c3d8b2b2dbdf2d30395e5c4b69197a0c257d96c6325ada3d190b6
-  data.tar.gz: 6f221ba0becc99ef9c84913f1f6ca3ab07948bc4193028930e0a5901aeee2933
+  metadata.gz: 79eb03ec72d66b7c8e8a1c2597238a0e4fed8d86c2f33150edb1d08c9d3a44b1
+  data.tar.gz: 6d50e7b3a58e317f43a534ab1fc27a953f46232a40473d58a86aac10d91db6d2
 SHA512:
-  metadata.gz: 90d7916580c53a0d7c85265f67264699edbce9b1d21e6186bdf408ab98311c63d8f7658bc0b4e842525d72d8ce2ba849132d65729a6890e3f38409ae1f9b8b88
-  data.tar.gz: 2a52e7d983d3d2a7307d00821dcbb44767e40e9e021d3ed42f079986eaa5f1350d1163c95a2385a9548d20517635f979f031bdbb24e5034f08c8a349a06907a0
+  metadata.gz: 7beaab007bfbae3db191271d312ba70ec1ab29b0ff1d519c8b79d4ca1f600d88d00222e1c6910adf9e66ece549c69f64bc5626dc2bfe4071bcaafa31d1c767ea
+  data.tar.gz: 9144c53f1a723a73ad6add946694775255132160affdc8308e84a9aa61d2b4ee32eeaa933bf471de648a8a124e8c7f359874e5fad92d844d5650d9d8607575b2

data/README.md

@@ -391,6 +391,25 @@ Capybara::Screenshot::Diff.area_size_limit = 42
 ```
 
 
+### Skipping an area
+
+Sometimes you have expected change that you want to ignore.
+You can use the `skip_area` option to the `screenshot` method to ignore an area:
+
+```ruby
+test 'unstable area' do
+  visit '/'
+  screenshot 'index', skip_area: [17, 6, 27, 16]
+end
+```
+
+The arguments are [x1, y1, x2, y2] for the area you want to ignore.  You can also set this globally:
+
+```ruby
+Capybara::Screenshot::Diff.skip_area = [0, 0, 64, 48]
+```
+
+
 ## 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

@@ -11,12 +11,13 @@ module Capybara
         attr_reader :annotated_new_file_name, :annotated_old_file_name, :new_file_name, :old_file_name
 
         def initialize(new_file_name, old_file_name = nil, dimensions: nil, color_distance_limit: nil,
-            area_size_limit: nil, shift_distance_limit: nil)
+            area_size_limit: nil, shift_distance_limit: nil, skip_area: nil)
           @new_file_name = new_file_name
           @color_distance_limit = color_distance_limit
           @area_size_limit = area_size_limit
           @shift_distance_limit = shift_distance_limit
           @dimensions = dimensions
+          @skip_area = skip_area
           @old_file_name = old_file_name || "#{new_file_name}~"
           @annotated_old_file_name = "#{new_file_name.chomp('.png')}_0.png~"
           @annotated_new_file_name = "#{new_file_name.chomp('.png')}_1.png~"
@@ -274,6 +275,7 @@ module Capybara
         end
 
         def same_color?(old_img, new_img, x, y)
+          return true if @skip_area && @skip_area[0] <= x && x <= @skip_area[2] && @skip_area[1] <= y && y <= @skip_area[3]
           color_distance =
             color_distance_at(new_img, old_img, x, y, shift_distance_limit: @shift_distance_limit)
           if !@max_color_distance || color_distance > @max_color_distance

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

@@ -19,7 +19,7 @@ module Capybara
         JS
 
         def take_stable_screenshot(comparison, color_distance_limit:, shift_distance_limit:,
-            area_size_limit:)
+            area_size_limit:, skip_area:)
           blurred_input = prepare_page_for_screenshot
           previous_file_name = comparison.old_file_name
           screenshot_started_at = last_image_change_at = Time.now
@@ -38,7 +38,7 @@ module Capybara
               stabilization_comparison =
                 ImageCompare.new(comparison.new_file_name, previous_file_name,
                     color_distance_limit: color_distance_limit, shift_distance_limit: shift_distance_limit,
-                    area_size_limit: area_size_limit)
+                    area_size_limit: area_size_limit, skip_area: skip_area)
               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

@@ -67,7 +67,8 @@ module Capybara
 
         # @return [Boolean] wether a screenshot was taken
         def screenshot(name, color_distance_limit: Diff.color_distance_limit,
-            shift_distance_limit: Diff.shift_distance_limit, area_size_limit: Diff.area_size_limit)
+            shift_distance_limit: Diff.shift_distance_limit, area_size_limit: Diff.area_size_limit,
+            skip_area: nil)
           return unless Screenshot.active?
           return if window_size_is_wrong?
 
@@ -81,11 +82,13 @@ module Capybara
           FileUtils.mkdir_p File.dirname(file_name)
           comparison = ImageCompare.new(file_name,
               dimensions: Screenshot.window_size, color_distance_limit: color_distance_limit,
-              area_size_limit: area_size_limit, shift_distance_limit: shift_distance_limit)
+              area_size_limit: area_size_limit, shift_distance_limit: shift_distance_limit,
+              skip_area: skip_area)
           checkout_vcs(name, comparison)
           take_stable_screenshot(comparison, color_distance_limit: color_distance_limit,
                                              shift_distance_limit: shift_distance_limit,
-                                             area_size_limit: area_size_limit)
+                                             area_size_limit: area_size_limit,
+                                             skip_area: skip_area)
           return unless comparison.old_file_exists?
 
           (@test_screenshots ||= []) << [caller(1..1).first, name, comparison]

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.15.0
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Track your GUI changes with diff assertions