capybara-screenshot-diff 1.6.0 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85ce13b84f6e2123eb3ca30dd761437bb1a3d9e06bc7c6ae2ae7baeedab7c2c
-  data.tar.gz: 9583c84bb295c48ab0b7fe262fccdf1e5f4edd27c551a98722e3951fcc8e0134
+  metadata.gz: ecb7108c89946f6489787b491c0cd831f096d09ee656e68674887952682aee7a
+  data.tar.gz: d41e23dae6a64663d26b586235ccc4cdc10d02a43b3fefa6a8563327cde563bd
 SHA512:
-  metadata.gz: a3aeb660f1307065ac2147153878dbbbb68441c33c34c4fb2e288e227d6abad5714c3a94f7cc0934acddfc02c3c36610b06a3652a5c5b8df21c1f3a60049c1db
-  data.tar.gz: 17fda8ceb42ed9be84a7548f02bfe8940385a6abd6e8e185c2f9753f8c252c577bcafeea576a1b311e85dfb144825916b51db654d7eebadfa8d17f1231ddbcd5
+  metadata.gz: 89501dc8c7ab1b540d182dacd10f8bf2d3b24521851db20bed42eb7c066b484d5a5cfbc766a4a0d5c80539500c1eef342f55be4069da455ba1d2ba14524d2463
+  data.tar.gz: 12c02e086af0df03206eaa5ac332306b0b199c33d70b6393c64a60a70a5777e4598b4aedf67afc0a6aa06166247efd7e6a0c21652aa4c2587e13009566363b87

data/.github/workflows/test.yml

@@ -5,8 +5,8 @@ on:
     branches: [ master ]
   pull_request:
     paths:
-      - '*.rb'
-      - '*.gemfile'
+      - '**.rb'
+      - '**.gemfile'
       - '!bin/**'
 
 env:

data/lib/capybara/screenshot/diff/drivers/chunky_png_driver.rb

@@ -115,7 +115,7 @@ module Capybara
           end
 
           def crop(dimensions, i)
-            i.crop(0, 0, *dimensions)
+            i.crop(*dimensions)
           end
 
           def from_file(filename)
@@ -135,7 +135,7 @@ module Capybara
 
             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)
+            calculate_max_shift_limit(new_image, old_image) if @shift_distance_limit
           end
 
           def calculate_max_color_distance(new_image, old_image)

data/lib/capybara/screenshot/diff/drivers/utils.rb

@@ -18,6 +18,13 @@ module Capybara
           end
           result
         end
+
+        def self.detect_test_framework_assert
+          require "minitest"
+          ::Minitest::Assertion
+        rescue
+          ::RuntimeError
+        end
       end
     end
   end

data/lib/capybara/screenshot/diff/drivers/vips_driver.rb

@@ -69,7 +69,7 @@ module Capybara
           end
 
           def crop(dimensions, i)
-            i.crop(0, 0, *dimensions)
+            i.crop(*dimensions)
           end
 
           def filter_image_with_median(image, median_filter_window_size)
@@ -104,8 +104,14 @@ module Capybara
             image.width
           end
 
+          PNG_EXTENSION = ".png"
+
+          # Vips could not work with the same file. Per each process we require to create new file
           def save_image_to(image, filename)
-            image.write_to_file(filename)
+            ::Dir::Tmpname.create([filename, PNG_EXTENSION]) do |tmp_image_filename|
+              image.write_to_file(tmp_image_filename)
+              FileUtils.mv(tmp_image_filename, filename)
+            end
           end
 
           def resize_image_to(image, new_width, new_height)

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

@@ -110,11 +110,7 @@ module Capybara
           new_height = expected_image_width * driver.height_for(saved_image) / driver.width_for(saved_image)
           resized_image = driver.resize_image_to(saved_image, expected_image_width, new_height)
 
-          Dir.mktmpdir do |dir|
-            resized_image_file = "#{dir}/resized.png"
-            driver.save_image_to(resized_image, resized_image_file)
-            FileUtils.mv(resized_image_file, file_name)
-          end
+          driver.save_image_to(resized_image, file_name)
         end
 
         def stabilization_images(base_file)
@@ -143,16 +139,18 @@ module Capybara
         end
 
         def take_right_size_screenshot(comparison, crop:)
+          driver = comparison.driver
+
           save_screenshot(comparison.new_file_name)
 
           # TODO(uwe): Remove when chromedriver takes right size screenshots
-          reduce_retina_image_size(comparison.new_file_name, comparison.driver)
+          reduce_retina_image_size(comparison.new_file_name, driver)
           # ODOT
 
           if crop
-            full_img = comparison.driver.from_file(comparison.new_file_name)
-            area_img = full_img.crop(crop[0], crop[1], crop[2] - crop[0], crop[3] - crop[1])
-            comparison.driver.save_image_to(area_img, comparison.new_file_name)
+            full_img = driver.from_file(comparison.new_file_name)
+            area_img = driver.crop([crop[0], crop[1], crop[2] - crop[0], crop[3] - crop[1]], full_img)
+            driver.save_image_to(area_img, comparison.new_file_name)
           end
         end
 

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

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = "1.6.0"
+      VERSION = "1.6.3"
     end
   end
 end

data/lib/capybara/screenshot/diff.rb

@@ -52,15 +52,10 @@ module Capybara
       mattr_accessor :shift_distance_limit
       mattr_accessor :skip_area
       mattr_accessor(:driver) { :auto }
-      mattr_accessor(:tolerance) { 0.001 }
+      mattr_accessor :tolerance
 
       AVAILABLE_DRIVERS = Utils.detect_available_drivers.freeze
-      begin
-        require "minitest"
-        ASSERTION = Minitest::Assertion
-      rescue
-        ASSERTION = RuntimeError
-      end
+      ASSERTION = Utils.detect_test_framework_assert
 
       def self.default_options
         {
@@ -70,7 +65,7 @@ module Capybara
           shift_distance_limit: shift_distance_limit,
           skip_area: skip_area,
           stability_time_limit: Screenshot.stability_time_limit,
-          tolerance: tolerance,
+          tolerance: tolerance || (driver == :vips ? 0.001 : nil),
           wait: Capybara.default_max_wait_time
         }
       end
@@ -89,15 +84,31 @@ module Capybara
 
         klass.teardown do
           if Capybara::Screenshot.active? && @test_screenshots
-            test_screenshot_errors = @test_screenshots
-              .map { |caller, name, compare| assert_image_not_changed(caller, name, compare) }
-            @test_screenshots = nil # release the comparison objects from memory
-            test_screenshot_errors.compact!
-            if test_screenshot_errors.any?
-              e = ASSERTION.new(test_screenshot_errors.join("\n\n"))
-              e.set_backtrace(caller)
-              failures << e
-            end
+            track_failures(@test_screenshots, caller)
+            @test_screenshots = nil
+          end
+        end
+      end
+
+      private
+
+      EMPTY_LINE = "\n\n"
+
+      def track_failures(screenshots, original_caller)
+        test_screenshot_errors = screenshots.map do |caller, name, compare|
+          assert_image_not_changed(caller, name, compare)
+        end
+
+        test_screenshot_errors.compact!
+
+        unless test_screenshot_errors.empty?
+          error = ASSERTION.new(test_screenshot_errors.join(EMPTY_LINE))
+          error.set_backtrace(original_caller)
+
+          if is_a?(::Minitest::Runnable)
+            failures << error
+          else
+            raise error
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.3
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack