capybara-screenshot-diff 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e4f48d95925d0da6d7b8afcb53b0179c0477fb034ea88e9e2dde8db02d4fb61
-  data.tar.gz: 9c6c456601df79a02b4b647f3c0cca0c0439194534c73522054c87d39926b89c
+  metadata.gz: 60b85259abbdb45d903015705a59c40d376523f4987c0285a0534657a1f71c5a
+  data.tar.gz: 5e5f95c2f086a9ce774c54fae55d4b38fdd8cd401df2ab1912d34e4925952f3c
 SHA512:
-  metadata.gz: 54f1f31ec364031eed15cadd22a3e2305874802480efb9ca0b0b2c35a6954293b31552971751f143fc2a6056a96d6d49df31f0c16c3d2785491ed7664f3b1f7c
-  data.tar.gz: 872732c38c6f1822b68d56b94b27c5aeba37ffd1f39379a4e15f76b8ed248d62c787514daa724ed10f22cda1f56b4442dd0753889fc28b99d2fb8299be16c821
+  metadata.gz: 5684af40410133d5ed7c4364433e124af1a6164eb651fa2e3fcfadf171b9f56c0845f541774546c11c80adb18babd45034886241896f4435d61c90476238e92d
+  data.tar.gz: 8ccbadc67bb64ea977247cb5c501380b4c2c6aa70eb784c73d90e087f5e60875636c375c8ceba1e1367b2fed4d36fe80b20c8584510131878f9d69682ce26691

data/.rubocop.yml

@@ -55,6 +55,9 @@ Style/Documentation:
 Style/DoubleNegation:
   Enabled: false
 
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
 Style/NumericPredicate:
   Enabled: false
 

data/.rubocop_todo.yml

@@ -19,7 +19,7 @@ Metrics/BlockLength:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 304
+  Max: 309
 
 # Offense count: 5
 Metrics/CyclomaticComplexity:
@@ -33,7 +33,7 @@ Metrics/MethodLength:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 107
+  Max: 123
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs.

data/.travis.yml

@@ -6,7 +6,7 @@ rvm:
   - ruby-2.6.3
   - ruby-2.5.5
   - ruby-2.4.6
-  - truffleruby-19.2.0
+  - truffleruby
 
 gemfile:
   - gemfiles/rails60.gemfile

data/README.md

@@ -274,7 +274,7 @@ configuration options that that are relevant.
 The most likely one you'll want to modify is ...
 
 ```ruby
-Capybara::Screenshot::Diff.save_path = "other/path"
+Capybara::Screenshot.save_path = "other/path"
 ```
 
 The `save_path` option is relative to `Capybara::Screenshot.root`.

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

@@ -5,12 +5,13 @@ require 'chunky_png'
 module Capybara
   module Screenshot
     module Diff
-      # Compare two images and determine if they are equal, different, or within som comparison
+      # Compare two images and determine if they are equal, different, or within some comparison
       # range considering color values and difference area size.
       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, :area_size_limit,
+            :color_distance_limit, :new_file_name, :old_file_name, :shift_distance_limit, :skip_area
 
         def initialize(new_file_name, old_file_name = nil, dimensions: nil, color_distance_limit: nil,
             area_size_limit: nil, shift_distance_limit: nil, skip_area: nil)
@@ -21,8 +22,8 @@ module Capybara
           @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~"
+          @annotated_old_file_name = "#{new_file_name.chomp('.png')}.committed.png"
+          @annotated_new_file_name = "#{new_file_name.chomp('.png')}.latest.png"
           reset
         end
 
@@ -97,10 +98,7 @@ 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,
-              @annotated_old_file_name, annotated_old_img)
+          save_annotated_images(images)
           true
         end
 
@@ -117,6 +115,8 @@ module Capybara
         end
 
         def dimensions
+          return unless @left || @top || @right || @bottom
+
           [@left, @top, @right, @bottom]
         end
 
@@ -136,6 +136,13 @@ module Capybara
 
         private
 
+        def save_annotated_images(images)
+          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)
+        end
+
         def calculate_metrics
           old_file, new_file = load_image_files(@old_file_name, @new_file_name)
           if old_file == new_file

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

@@ -52,7 +52,9 @@ module Capybara
               end
             end
 
-            previous_file_name = "#{comparison.new_file_name.chomp('.png')}_x#{format('%02i', i)}.png~"
+            previous_file_name = "#{comparison.new_file_name.chomp('.png')}" \
+                "_x#{format('%02i', i)}_#{(Time.now - screenshot_started_at).round(1)}s" \
+                "_#{stabilization_comparison.dimensions&.to_s&.gsub(', ', '_') || :initial}.png~"
             FileUtils.mv comparison.new_file_name, previous_file_name
 
             check_max_wait_time(comparison, screenshot_started_at,
@@ -117,9 +119,25 @@ module Capybara
         def check_max_wait_time(comparison, screenshot_started_at, wait:, shift_distance_limit:)
           shift_factor = shift_distance_limit ? (shift_distance_limit * 2 + 1) ^ 2 : 1
           max_wait_time = wait * shift_factor
-          assert((Time.now - screenshot_started_at) < max_wait_time,
-              "Could not get stable screenshot within #{max_wait_time}s\n" \
-                      "#{stabilization_images(comparison.new_file_name).join("\n")}")
+          return if (Time.now - screenshot_started_at) < max_wait_time
+
+          # FIXME(uwe): Change to store the failure and only report if the test succeeds functionally.
+          previous_file = comparison.old_file_name
+          stabilization_images(comparison.new_file_name).each do |file_name|
+            if File.exist? previous_file
+              stabilization_comparison =
+                ImageCompare.new(file_name, previous_file,
+                    color_distance_limit: comparison.color_distance_limit,
+                    shift_distance_limit: comparison.shift_distance_limit,
+                    area_size_limit: comparison.area_size_limit, skip_area: comparison.skip_area)
+              assert stabilization_comparison.different?
+              FileUtils.mv stabilization_comparison.annotated_new_file_name, file_name
+              FileUtils.rm stabilization_comparison.annotated_old_file_name
+            end
+            previous_file = file_name
+          end
+          fail("Could not get stable screenshot within #{max_wait_time}s\n" \
+                    "#{stabilization_images(comparison.new_file_name).join("\n")}")
         end
 
         def assert_images_loaded(timeout:)

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

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = '1.3.0'
+      VERSION = '1.3.1'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack