capybara-screenshot-diff 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4918e7dba3e123055b2c5aae345fce7dd8a1219d
-  data.tar.gz: 662f6f68099b888e068a62ec18454ddbcdf2adf6
+  metadata.gz: 3417ac0f41265b198a6807b0ae2ea3fe24d4fcae
+  data.tar.gz: efcc110c396d89cf8ed51e982c57cc1a6c3e9b4b
 SHA512:
-  metadata.gz: 6929b38a90048524ec74c867f93a2b14160c34cae83d325963bfefd0bbd28a134e9f3471360b3649226b33e43414d60da35ccab499d4101fddac08688eed91ab
-  data.tar.gz: 3638b34d359a68c75eaaa49593396efc227383126259b95ad5af12b6e75103164bd9b7f22485cf97831f83415defcb8f5072923de6cdbfedb8b450836ff692e9
+  metadata.gz: 0d1aecff95b1e1eb031397488bec689f4f1410de71a093914fc2601932237abfb8de30dce236ececb641c0b85dae350d012b6881a5e69c01b1f0eafea300fae9
+  data.tar.gz: 19bb7deb896fe5de11c94ca2d1c4309dba6a774603b859050ff1a6c31a3cc07c5b5e1cdac4355b35b154cea3db5bbf108cd3572e6b32a75845104b4935922d89

data/.rubocop.yml

@@ -18,9 +18,6 @@ Layout/MultilineOperationIndentation:
 Lint/Debugger:
   Enabled: false
 
-Metrics/ClassLength:
-  Max: 101
-
 Metrics/LineLength:
   Max: 110
 

data/.rubocop_todo.yml

@@ -1,28 +1,36 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-06-08 11:42:01 +0200 using RuboCop version 0.49.1.
+# on 2017-07-06 16:03:55 +0200 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'lib/capybara/screenshot/diff/capybara_setup.rb'
+
+# Offense count: 7
 Metrics/AbcSize:
-  Max: 31
+  Max: 26
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 186
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 7
+# Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 25
-
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 6
+  Max: 24
 
 # Offense count: 1
 Metrics/PerceivedComplexity:

data/README.md

@@ -101,6 +101,7 @@ that test will get the same prefix:
 setup do
   screenshot_section 'my_feature'
 end
+
 test 'my subfeature' do
   screenshot_group 'subfeature'
   visit '/feature'
@@ -241,6 +242,26 @@ Capybara::Screenshot.stability_time_limit = 0.5
 ```
 
 
+
+### Allowed color distance
+
+Sometimes you want to allow small differences in the images.  You can set set the difference
+threshold for the comparison using the `color_distance_limit` option to the `screenshot` method:
+
+```ruby
+test 'color threshold' do
+  visit '/'
+  screenshot 'index', color_distance_limit: 30
+end
+```
+
+The difference is calculated as the eucledian distance.  You can also set this globally:
+
+```ruby
+Capybara::Screenshot::Diff.color_distance_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.rb

@@ -17,8 +17,8 @@ module Capybara
 
     # Module to track screen shot changes
     module Diff
-      mattr_accessor :enabled
-      self.enabled = true
+      mattr_accessor :color_distance_limit
+      mattr_accessor(:enabled) { true }
     end
   end
 end

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

@@ -97,8 +97,8 @@ module ActionDispatch
 
     teardown do
       if Capybara::Screenshot::Diff.enabled && @test_screenshots
-        test_screenshot_errors =
-          @test_screenshots.map { |args| assert_image_not_changed(*args) }.compact
+        test_screenshot_errors = @test_screenshots
+          .map { |caller, name, compare| assert_image_not_changed(caller, name, compare) }.compact
         fail(test_screenshot_errors.join("\n\n")) if test_screenshot_errors.any?
       end
     end
@@ -114,7 +114,8 @@ module ActionDispatch
       FileUtils.rm_rf screenshot_dir
     end
 
-    def screenshot(name)
+    def screenshot(name, color_distance_limit: Capybara::Screenshot::Diff.color_distance_limit,
+        area_size_limit: nil)
       return unless Capybara::Screenshot.active?
       return if window_size_is_wrong?
       if @screenshot_counter
@@ -123,16 +124,15 @@ module ActionDispatch
       end
       name = full_name(name)
       file_name = "#{self.class.screenshot_area_abs}/#{name}.png"
-      org_name = "#{self.class.screenshot_area_abs}/#{name}_0.png~"
-      new_name = "#{self.class.screenshot_area_abs}/#{name}_1.png~"
 
       FileUtils.mkdir_p File.dirname(file_name)
-      committed_file_name = check_vcs(name, file_name, org_name)
-      previous_file_exists = committed_file_name && File.exist?(committed_file_name)
-      previous_size = File.size(committed_file_name) if previous_file_exists
-      take_stable_screenshot(file_name, previous_size)
-      return unless previous_file_exists
-      (@test_screenshots ||= []) << [caller[0], name, file_name, committed_file_name, new_name, org_name]
+      committed_file_name = check_vcs(name, file_name)
+      comparison = Capybara::Screenshot::Diff::ImageCompare.new(committed_file_name, file_name,
+          dimensions: Capybara::Screenshot.window_size, color_distance_limit: color_distance_limit,
+          area_size_limit: area_size_limit)
+      take_stable_screenshot(comparison)
+      return unless comparison.old_file_exists?
+      (@test_screenshots ||= []) << [caller[0], name, comparison]
     end
 
     private def window_size_is_wrong?
@@ -142,7 +142,7 @@ module ActionDispatch
           Selenium::WebDriver::Dimension.new(*Capybara::Screenshot.window_size)
     end
 
-    def check_vcs(name, file_name, org_name)
+    private def check_vcs(name, file_name)
       svn_file_name = "#{self.class.screenshot_area_abs}/.svn/text-base/#{name}.png.svn-base"
       if File.exist?(svn_file_name)
         committed_file_name = svn_file_name
@@ -155,17 +155,21 @@ module ActionDispatch
             committed_file_name = "#{wc_root}/.svn/pristine/#{checksum[0..1]}/#{checksum}.svn-base"
           end
         else
-          committed_file_name = org_name
-          redirect_target = "#{committed_file_name} #{SILENCE_ERRORS}"
-          `git show HEAD~0:./#{self.class.screenshot_area}/#{name}.png > #{redirect_target}`
-          if File.size(committed_file_name) == 0
-            FileUtils.rm_f committed_file_name
-          end
+          committed_file_name = restore_git_revision(name,
+              Capybara::Screenshot::Diff::ImageCompare.annotated_old_file_name(file_name))
         end
       end
       committed_file_name
     end
 
+    private def restore_git_revision(name, org_name)
+      committed_file_name = org_name
+      redirect_target = "#{committed_file_name} #{SILENCE_ERRORS}"
+      `git show HEAD~0:./#{self.class.screenshot_area}/#{name}.png > #{redirect_target}`
+      FileUtils.rm_f(committed_file_name) if File.size(committed_file_name) == 0
+      committed_file_name
+    end
+
     IMAGE_WAIT_SCRIPT = <<EOF.freeze
 function pending_image() {
   var images = document.images;
@@ -190,28 +194,33 @@ EOF
       end
     end
 
-    def take_stable_screenshot(file_name, original_file_size = nil)
+    private def take_stable_screenshot(comparison)
       assert_images_loaded
-      old_file_size = original_file_size
+      previous_file_size = comparison.old_file_size
       screeenshot_started_at = last_image_change_at = Time.now
       loop do
-        save_screenshot(file_name)
+        save_screenshot(comparison.new_file_name)
 
         # TODO(uwe): Remove when chromedriver take right size screenshots
-        reduce_retina_image_size(file_name)
+        reduce_retina_image_size(comparison.new_file_name)
         # EMXIF
 
         break unless Capybara::Screenshot.stability_time_limit
-        new_file_size = File.size(file_name)
-        break if new_file_size == original_file_size
-        break if new_file_size == old_file_size &&
-            (Time.now - last_image_change_at) > Capybara::Screenshot.stability_time_limit
-        last_image_change_at = Time.now if new_file_size != old_file_size
-        old_file_size = new_file_size
-        sleep 0.1
+        break if comparison.quick_equal?
+
+        if comparison.new_file_size == previous_file_size
+          if (Time.now - last_image_change_at) > Capybara::Screenshot.stability_time_limit
+            break
+          end
+        else
+          last_image_change_at = Time.now
+        end
 
         assert (Time.now - screeenshot_started_at) < Capybara.default_max_wait_time,
             "Could not get stable screenshot within #{Capybara.default_max_wait_time}s"
+
+        previous_file_size = comparison.new_file_size
+        comparison.reset
       end
     end
 
@@ -225,11 +234,13 @@ EOF
       resized_image.save(file_name)
     end
 
-    def assert_image_not_changed(caller, name, file_name, committed_file_name, new_name, org_name)
-      if Capybara::Screenshot::Diff::ImageCompare.compare(committed_file_name, file_name,
-          Capybara::Screenshot.window_size)
-        "Screenshot does not match for '#{name}'\n#{file_name}\n#{org_name}\n#{new_name}\nat #{caller}"
-      end
+    def assert_image_not_changed(caller, name, comparison)
+      return unless comparison.different?
+      "Screenshot does not match for '#{name}' (area: #{comparison.size} #{comparison.dimensions}" \
+        ", max_color_distance: #{comparison.max_color_distance.round(1)})\n" \
+        "#{comparison.new_file_name}\n#{comparison.annotated_old_file_name}\n" \
+        "#{comparison.annotated_new_file_name}\n" \
+        "at #{caller}"
     end
   end
 end

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

@@ -6,53 +6,130 @@ module Capybara
       class ImageCompare
         include ChunkyPNG::Color
 
+        attr_reader :annotated_new_file_name, :annotated_old_file_name, :new_file_name
+
         def self.compare(*args)
-          new(*args).compare
+          new(*args).different?
+        end
+
+        def self.annotated_old_file_name(new_file_name)
+          "#{new_file_name.chomp('.png')}_0.png~"
         end
 
-        def initialize(old_file_name, new_file_name, dimensions = nil)
+        def initialize(old_file_name, new_file_name, dimensions: nil, color_distance_limit: nil,
+            area_size_limit: nil)
           @old_file_name = old_file_name
-          @file_name = new_file_name
+          @new_file_name = new_file_name
+          @color_distance_limit = color_distance_limit
+          @area_size_limit = area_size_limit
           @dimensions = dimensions
+          @annotated_old_file_name = self.class.annotated_old_file_name(new_file_name)
+          @annotated_new_file_name = "#{new_file_name.chomp('.png')}_1.png~"
+          reset
         end
 
-        def compare
-          name = @file_name.chomp('.png')
-          org_file_name = "#{name}_0.png~"
-          new_file_name = "#{name}_1.png~"
+        def reset
+          @max_color_distance = 0 if @color_distance_limit
+          @left = @top = @right = @bottom = nil
+        end
+
+        # Compare the two image files and return `true` or `false` as quickly as possible.
+        # Return falsish if the old file does not exist or the image dimensions do not match.
+        def quick_equal?
+          return nil unless old_file_exists?
+          return true if new_file_size == old_file_size
+          old_file, new_file = load_image_files(@old_file_name, @new_file_name)
+          return true if old_file == new_file
+          images = load_images(old_file, new_file)
+          crop_images(images, @dimensions) if @dimensions
+
+          old_img = images.first
+          new_img = images.last
+
+          return false if sizes_changed?(old_img, new_img)
+
+          return true if old_img.pixels == new_img.pixels
+
+          @left, @top, @right, @bottom = find_top(old_img, new_img)
+
+          return true if @top.nil?
+
+          false
+        end
 
-          return nil unless File.exist? @old_file_name
+        # Compare the two images referenced by this object, and return `true` if they are different,
+        # and `false` if they are the same.
+        # Return `nil` if the old file does not exist or if the image dimensions do not match.
+        def different?
+          return nil unless old_file_exists?
 
-          images = load_images(@old_file_name, @file_name)
+          old_file, new_file = load_image_files(@old_file_name, @new_file_name)
 
-          unless images
-            clean_tmp_files(new_file_name, org_file_name)
+          if old_file == new_file
+            clean_tmp_files(@annotated_old_file_name, @annotated_new_file_name)
             return false
           end
 
+          images = load_images(old_file, new_file)
+
           crop_images(images, @dimensions) if @dimensions
-          org_img = images.first
+
+          old_img = images.first
           new_img = images.last
-          if sizes_changed?(org_img, new_img, name)
-            save_images(new_file_name, new_img, org_file_name, org_img)
+
+          if sizes_changed?(old_img, new_img)
+            save_images(@annotated_new_file_name, new_img, @annotated_old_file_name, old_img)
             return true
           end
 
-          if org_img.pixels == new_img.pixels
-            clean_tmp_files(new_file_name, org_file_name)
+          if old_img.pixels == new_img.pixels
+            clean_tmp_files(@annotated_new_file_name, @annotated_old_file_name)
             return false
           end
 
-          @left, @top, @right, @bottom = find_diff_rectangle(org_img, new_img)
-          draw_rectangles(images, @bottom, @left, @right, @top)
-          save_images(new_file_name, new_img, org_file_name, org_img)
+          @left, @top, @right, @bottom = find_diff_rectangle(old_img, new_img)
+
+          return false if @top.nil?
+          annotated_old_img, annotated_new_img = draw_rectangles(images, @bottom, @left, @right, @top)
+          save_images(@annotated_new_file_name, annotated_new_img,
+              @annotated_old_file_name, annotated_old_img)
           true
         end
 
+        def old_file_exists?
+          @old_file_name && File.exist?(@old_file_name)
+        end
+
+        def old_file_size
+          @_old_filesize ||= old_file_exists? && File.size(@old_file_name)
+        end
+
+        def new_file_size
+          File.size(@new_file_name)
+        end
+
         def dimensions
           [@left, @top, @right, @bottom]
         end
 
+        def size
+          (@right - @left + 1) * (@bottom - @top + 1)
+        end
+
+        def max_color_distance
+          return @max_color_distance if @max_color_distance
+          old_file, new_file = load_image_files(@old_file_name, @new_file_name)
+          return @max_color_distance = 0 if old_file == new_file
+
+          old_image, new_image = load_images(old_file, new_file)
+
+          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
+
         private
 
         def save_images(new_file_name, new_img, org_file_name, org_img)
@@ -60,28 +137,29 @@ module Capybara
           new_img.save(new_file_name)
         end
 
-        def clean_tmp_files(new_file_name, org_file_name)
-          File.delete(org_file_name) if File.exist?(org_file_name)
+        def clean_tmp_files(old_file_name, new_file_name)
+          File.delete(old_file_name) if File.exist?(old_file_name)
           File.delete(new_file_name) if File.exist?(new_file_name)
         end
 
-        def load_images(old_file_name, file_name)
+        def load_images(old_file, new_file)
+          [ChunkyPNG::Image.from_blob(old_file), ChunkyPNG::Image.from_blob(new_file)]
+        end
+
+        def load_image_files(old_file_name, file_name)
           old_file = File.binread(old_file_name)
           new_file = File.binread(file_name)
-
-          return false if old_file == new_file
-
-          [ChunkyPNG::Image.from_blob(old_file), ChunkyPNG::Image.from_blob(new_file)]
+          [old_file, new_file]
         end
 
-        def sizes_changed?(org_image, new_image, name)
+        def sizes_changed?(org_image, new_image)
           return unless org_image.dimension != new_image.dimension
           change_msg = [org_image, new_image].map { |i| "#{i.width}x#{i.height}" }.join(' => ')
-          puts "Image size has changed for #{name}: #{change_msg}"
+          puts "Image size has changed for #{@new_file_name}: #{change_msg}"
           true
         end
 
-        def crop_images(images, dimensions)
+        private def crop_images(images, dimensions)
           images.map! do |i|
             if i.dimension.to_a == dimensions || i.width < dimensions[0] || i.height < dimensions[1]
               i
@@ -91,38 +169,73 @@ module Capybara
           end
         end
 
-        def draw_rectangles(images, bottom, left, right, top)
-          images.each do |image|
-            image.rect(left - 1, top - 1, right + 1, bottom + 1, ChunkyPNG::Color.rgb(255, 0, 0))
+        private def draw_rectangles(images, bottom, left, right, top)
+          images.map do |image|
+            new_img = image.dup
+            new_img.rect(left - 1, top - 1, right + 1, bottom + 1, ChunkyPNG::Color.rgb(255, 0, 0))
+            new_img
+          end
+        end
+
+        private def find_diff_rectangle(org_img, new_img)
+          left, top, right, bottom = find_left_right_and_top(org_img, new_img)
+          bottom = find_bottom(org_img, new_img, left, right, bottom)
+          [left, top, right, bottom]
+        end
+
+        private def find_top(old_img, new_img)
+          old_img.height.times do |y|
+            old_img.width.times do |x|
+              return [x, y, x, y] unless same_color?(old_img, new_img, x, y)
+            end
           end
         end
 
-        def find_diff_rectangle(org_img, new_img)
-          top = bottom = nil
-          left = org_img.width - 1
-          right = 0
-          org_img.height.times do |y|
+        private def find_left_right_and_top(old_img, new_img)
+          top = @top
+          bottom = @bottom
+          left = @left || old_img.width - 1
+          right = @right || 0
+          old_img.height.times do |y|
             (0...left).find do |x|
-              next if org_img[x, y] == new_img[x, y]
+              next if same_color?(old_img, new_img, x, y)
               top ||= y
               bottom = y
               left = x
               right = x if x > right
               x
             end
-            (org_img.width - 1).step(right + 1, -1).find do |x|
-              if org_img[x, y] != new_img[x, y]
+            (old_img.width - 1).step(right + 1, -1).find do |x|
+              unless same_color?(old_img, new_img, x, y)
                 bottom = y
                 right = x
               end
             end
           end
-          (org_img.height - 1).step(bottom + 1, -1).find do |y|
-            (left..right).find do |x|
-              bottom = y if org_img[x, y] != new_img[x, y]
+          [left, top, right, bottom]
+        end
+
+        private def find_bottom(old_img, new_img, left, right, bottom)
+          if bottom
+            (old_img.height - 1).step(bottom + 1, -1).find do |y|
+              (left..right).find do |x|
+                bottom = y unless same_color?(old_img, new_img, x, y)
+              end
             end
           end
-          [left, top, right, bottom]
+          bottom
+        end
+
+        private def same_color?(old_img, new_img, x, y)
+          org_color = old_img[x, y]
+          new_color = new_img[x, y]
+          if @color_distance_limit && @color_distance_limit > 0
+            distance = ChunkyPNG::Color.euclidean_distance_rgba(org_color, new_color)
+            @max_color_distance = distance if distance > @max_color_distance
+            distance <= @color_distance_limit
+          else
+            org_color == new_color
+          end
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = '0.5.3'.freeze
+      VERSION = '0.6.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.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack