capybara-screenshot-diff 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8a34bc350e982212f3b08fc104ae14d889b827cb
-  data.tar.gz: 6e91360ac2d9e2df0a9b6df77a75380a2787db0e
+SHA256:
+  metadata.gz: 0b1699ff683e2c3cb5b32b32ae60bbb05bf15c7480c85f931d5276dec9712fb0
+  data.tar.gz: c315dcb091a812a01b2c2f2fe0690a07814dc3b87c632668f3355d2c4c994a59
 SHA512:
-  metadata.gz: 17fbf4a986169c7d2d0d77fb0e674f7e25b509beee3d5e7983e6a3f360963f0b19fb41a3708a71c6d3de3d9f8bfab9fb21e79d736f9034d78a25bc200ddc3c95
-  data.tar.gz: 6afd14b81b0d02fd27a13dbcac6fbacadad6c672f0cfa8e7e9f34526249d0eaddfb41770ae1975022311efdabd195a5fb9b805569b99729dd558217ed410bb51
+  metadata.gz: bb6b91c2e92fdce32245fa82fefc1ba48ab29f92645cdcc1513c28f2c79635c5c184ed16d81207268e3384ca04b199f2aeea98bc9f915c3faf91299cb9879e24
+  data.tar.gz: 19a7ef21e19844f845cb396bd3c8db4d24402d87f44da571a554d91ec504eb9a3326d6b31c012d2c19790c53e99e91a9514ac2bf3e9b28fd9ea16f141b2cd1d4

data/.rubocop_todo.yml

@@ -13,12 +13,12 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 43
+  Max: 44
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 283
+  Max: 302
 
 # Offense count: 6
 Metrics/CyclomaticComplexity:
@@ -27,7 +27,7 @@ Metrics/CyclomaticComplexity:
 # Offense count: 16
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 48
+  Max: 49
 
 # Offense count: 1
 # Configuration parameters: CountComments.

data/README.md

@@ -16,6 +16,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'capybara-screenshot-diff'
+gem 'oily_png', platform :ruby
 ```
 
 And then execute:
@@ -93,6 +94,8 @@ doc
 
 To store the screen shot history, add the `doc/screenshots` directory to your
  version control system (git, svn, etc).
+ 
+    Screen shots are compared to the previously COMMITTED version of the same screen shot.
 
 ### Screenshot groups
 

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

@@ -8,8 +8,7 @@ module Capybara
       class ImageCompare
         include ChunkyPNG::Color
 
-        attr_reader :annotated_new_file_name, :annotated_old_file_name, :new_file_name,
-            :old_file_name
+        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)
@@ -134,18 +133,34 @@ module Capybara
 
         def calculate_metrics
           old_file, new_file = load_image_files(@old_file_name, @new_file_name)
-          @max_color_distance = 0 if old_file == new_file
+          if old_file == new_file
+            @max_color_distance = 0
+            @max_shift_distance = 0
+            return
+          end
 
           old_image, new_image = load_images(old_file, new_file)
+          calculate_max_color_distance(new_image, old_image)
+          calculate_max_shift_limit(new_image, old_image)
+        end
 
+        def calculate_max_color_distance(new_image, old_image)
           pixel_pairs = old_image.pixels.zip(new_image.pixels)
           @max_color_distance = pixel_pairs.inject(0) do |max, (p1, p2)|
             d = ChunkyPNG::Color.euclidean_distance_rgba(p1, p2)
             [max, d].max
           end
+        end
 
-          (0...new_image.width).each do |_x|
-            (0...new_image.height).each do |y|
+        def calculate_max_shift_limit(new_img, old_img)
+          (0...new_img.width).each do |x|
+            (0...new_img.height).each do |y|
+              shift_distance =
+                shift_distance_at(new_img, old_img, x, y, color_distance_limit: @color_distance_limit)
+              if shift_distance && (@max_shift_distance.nil? || shift_distance > @max_shift_distance)
+                @max_shift_distance = shift_distance
+                return if @max_shift_distance == Float::INFINITY # rubocop: disable Lint/NonLocalExitFromIterator
+              end
             end
           end
         end
@@ -259,9 +274,13 @@ module Capybara
           end
           color_matches = color_distance == 0 || (@color_distance_limit && @color_distance_limit > 0 &&
               color_distance <= @color_distance_limit)
-          return color_matches unless @shift_distance_limit
+          return color_matches if !@shift_distance_limit || @max_shift_distance == Float::INFINITY
           shift_distance =
-            shift_distance_at(new_img, old_img, x, y, color_distance_limit: @color_distance_limit)
+            if color_matches
+              0
+            else
+              shift_distance_at(new_img, old_img, x, y, color_distance_limit: @color_distance_limit)
+            end
           if shift_distance && (@max_shift_distance.nil? || shift_distance > @max_shift_distance)
             @max_shift_distance = shift_distance
           end
@@ -293,9 +312,10 @@ module Capybara
           shift_distance = 0
           loop do
             bounds_breached = 0
-            if (y - shift_distance) >= 0 # top
+            top_row = y - shift_distance
+            if top_row >= 0 # top
               ([0, x - shift_distance].max..[x + shift_distance, new_img.width - 1].min).each do |dx|
-                if color_matches(new_img, org_color, dx, y - shift_distance, color_distance_limit)
+                if color_matches(new_img, org_color, dx, top_row, color_distance_limit)
                   return shift_distance
                 end
               end
@@ -304,7 +324,7 @@ module Capybara
             end
             if shift_distance > 0
               if (x - shift_distance) >= 0 # left
-                ([0, y - shift_distance + 1].max..[y + shift_distance, new_img.height - 2].min)
+                ([0, top_row + 1].max..[y + shift_distance, new_img.height - 2].min)
                   .each do |dy|
                   if color_matches(new_img, org_color, x - shift_distance, dy, color_distance_limit)
                     return shift_distance
@@ -323,7 +343,7 @@ module Capybara
                 bounds_breached += 1
               end
               if (x + shift_distance) < new_img.width # right
-                ([0, y - shift_distance + 1].max..[y + shift_distance, new_img.height - 2].min)
+                ([0, top_row + 1].max..[y + shift_distance, new_img.height - 2].min)
                   .each do |dy|
                   if color_matches(new_img, org_color, x + shift_distance, dy, color_distance_limit)
                     return shift_distance
@@ -336,7 +356,7 @@ module Capybara
             break if bounds_breached == 4
             shift_distance += 1
           end
-          nil
+          Float::INFINITY
         end
 
         def color_matches(new_img, org_color, dx, dy, color_distance_limit)

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

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = '0.11.3'.freeze
+      VERSION = '0.12.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.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Track your GUI changes with diff assertions