capybara-screenshot-diff 1.6.2 → 1.7.0

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

@@ -8,6 +8,8 @@ require "active_support/core_ext/string/strip"
 require_relative "image_compare"
 require_relative "stabilization"
 require_relative "vcs"
+require_relative "browser_helpers"
+require_relative "region"
 
 # Add the `screenshot` method to ActionDispatch::IntegrationTest
 module Capybara
@@ -16,6 +18,7 @@ module Capybara
       module TestMethods
         include Stabilization
         include Vcs
+        include BrowserHelpers
 
         def initialize(*)
           super
@@ -34,21 +37,13 @@ module Capybara
         end
 
         def full_name(name)
-          File.join group_parts.<<(name).map(&:to_s)
+          File.join group_parts.push(name).map(&:to_s)
         end
 
         def screenshot_dir
           File.join [Screenshot.screenshot_area] + group_parts
         end
 
-        def current_capybara_driver_class
-          Capybara.current_session.driver.class
-        end
-
-        def selenium?
-          current_capybara_driver_class <= Capybara::Selenium::Driver
-        end
-
         def screenshot_section(name)
           @screenshot_section = name.to_s
         end
@@ -62,7 +57,7 @@ module Capybara
         end
 
         # @return [Boolean] whether a screenshot was taken
-        def screenshot(name, options = {})
+        def screenshot(name, skip_stack_frames: 0, **options)
           return false unless Screenshot.active?
           return false if window_size_is_wrong?
 
@@ -70,12 +65,7 @@ module Capybara
 
           stability_time_limit = driver_options[:stability_time_limit]
           wait = driver_options[:wait]
-          crop = driver_options.delete(:crop)
-
-          # Allow nil or single or multiple areas
-          if driver_options[:skip_area]
-            driver_options[:skip_area] = driver_options[:skip_area].compact.flatten&.each_slice(4)&.to_a
-          end
+          crop = calculate_crop_region(driver_options)
 
           if @screenshot_counter
             name = "#{format("%02i", @screenshot_counter)}_#{name}"
@@ -84,31 +74,22 @@ module Capybara
           name = full_name(name)
           file_name = "#{Screenshot.screenshot_area_abs}/#{name}.png"
 
-          FileUtils.mkdir_p File.dirname(file_name)
+          create_output_directory_for(file_name)
+
           comparison = ImageCompare.new(file_name, nil, driver_options)
-          checkout_vcs(name, comparison)
-          begin
-            blurred_input = prepare_page_for_screenshot(timeout: wait)
-            if stability_time_limit
-              take_stable_screenshot(comparison, stability_time_limit: stability_time_limit, wait: wait, crop: crop)
-            else
-              take_right_size_screenshot(comparison, crop: crop)
-            end
-          ensure
-            blurred_input&.click
-          end
+          checkout_vcs(name, comparison.old_file_name, comparison.new_file_name)
+          take_screenshot(comparison, crop, stability_time_limit, wait)
 
           return false unless comparison.old_file_exists?
 
-          (@test_screenshots ||= []) << [caller(1..1).first, name, comparison]
+          # Allow nil or single or multiple areas
+          if driver_options[:skip_area]
+            comparison.skip_area = calculate_skip_area(driver_options[:skip_area], crop)
+          end
 
-          true
-        end
+          (@test_screenshots ||= []) << [caller[skip_stack_frames], name, comparison]
 
-        def window_size_is_wrong?
-          selenium? && Screenshot.window_size &&
-            page.driver.browser.manage.window.size !=
-              ::Selenium::WebDriver::Dimension.new(*Screenshot.window_size)
+          true
         end
 
         def assert_image_not_changed(caller, name, comparison)
@@ -116,6 +97,58 @@ module Capybara
 
           "Screenshot does not match for '#{name}' #{comparison.error_message}\nat #{caller}"
         end
+
+        private
+
+        def calculate_crop_region(driver_options)
+          crop_coordinates = driver_options.delete(:crop)
+          return nil unless crop_coordinates
+
+          crop_coordinates = bounds_for_css(crop_coordinates).first if crop_coordinates.is_a?(String)
+          Region.from_edge_coordinates(*crop_coordinates)
+        end
+
+        def create_output_directory_for(file_name)
+          FileUtils.mkdir_p File.dirname(file_name)
+        end
+
+        def take_screenshot(comparison, crop, stability_time_limit, wait)
+          blurred_input = prepare_page_for_screenshot(timeout: wait)
+          if stability_time_limit
+            take_stable_screenshot(
+              comparison,
+              crop: crop,
+              stability_time_limit: stability_time_limit,
+              wait: wait
+            )
+          else
+            take_right_size_screenshot(comparison, crop: crop)
+          end
+        ensure
+          blurred_input&.click
+        end
+
+        def calculate_skip_area(skip_area, crop)
+          crop_region = crop && Region.new(*crop)
+          skip_area = Array(skip_area)
+
+          css_selectors, regions = skip_area.compact.partition { |region| region.is_a? String }
+
+          result = []
+          result.concat(build_regions_for(bounds_for_css(*css_selectors))) unless css_selectors.empty?
+          result.concat(build_regions_for(regions.flatten&.each_slice(4))) unless regions.empty?
+          result.compact!
+
+          result.map! { |region| crop_region.find_relative_intersect(region) } if crop_region
+
+          result
+        end
+
+        def build_regions_for(coordinates)
+          coordinates.map do |region_coordinates|
+            Region.from_edge_coordinates(*region_coordinates)
+          end
+        end
       end
     end
   end

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

@@ -18,22 +18,23 @@ module Capybara
           FileUtils.rm_f(target_file_name) unless $CHILD_STATUS == 0
         end
 
-        def checkout_vcs(name, comparison)
+        def checkout_vcs(name, old_file_name, new_file_name)
           svn_file_name = "#{Capybara::Screenshot.screenshot_area_abs}/.svn/text-base/#{name}.png.svn-base"
+
           if File.exist?(svn_file_name)
             committed_file_name = svn_file_name
-            FileUtils.cp committed_file_name, comparison.old_file_name
+            FileUtils.cp committed_file_name, old_file_name
           else
-            svn_info = `svn info #{comparison.new_file_name} #{SILENCE_ERRORS}`
+            svn_info = `svn info #{new_file_name} #{SILENCE_ERRORS}`
             if svn_info.present?
               wc_root = svn_info.slice(/(?<=Working Copy Root Path: ).*$/)
               checksum = svn_info.slice(/(?<=Checksum: ).*$/)
               if checksum
                 committed_file_name = "#{wc_root}/.svn/pristine/#{checksum[0..1]}/#{checksum}.svn-base"
-                FileUtils.cp committed_file_name, comparison.old_file_name
+                FileUtils.cp committed_file_name, old_file_name
               end
             else
-              restore_git_revision(name, comparison.old_file_name)
+              restore_git_revision(name, old_file_name)
             end
           end
         end

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

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = "1.6.2"
+      VERSION = "1.7.0"
     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,19 +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)
-              if defined?(failures)
-                failures << e
-              else
-                raise e
-              end
-            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.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -72,6 +72,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/dependabot.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -88,18 +89,19 @@ files:
 - bin/setup
 - bin/standardrb
 - capybara-screenshot-diff.gemspec
-- gemfiles/rails52.gemfile
 - gemfiles/rails60_gems.rb
 - gemfiles/rails61_gems.rb
 - gemfiles/rails70_gems.rb
 - gems.rb
 - lib/capybara-screenshot-diff.rb
 - lib/capybara/screenshot/diff.rb
+- lib/capybara/screenshot/diff/browser_helpers.rb
 - lib/capybara/screenshot/diff/drivers/chunky_png_driver.rb
 - lib/capybara/screenshot/diff/drivers/utils.rb
 - lib/capybara/screenshot/diff/drivers/vips_driver.rb
 - lib/capybara/screenshot/diff/image_compare.rb
 - lib/capybara/screenshot/diff/os.rb
+- lib/capybara/screenshot/diff/region.rb
 - lib/capybara/screenshot/diff/stabilization.rb
 - lib/capybara/screenshot/diff/test_methods.rb
 - lib/capybara/screenshot/diff/vcs.rb
@@ -118,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/gemfiles/rails52.gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-gems = "#{File.dirname __dir__}/gems.rb"
-eval File.read(gems), binding, gems
-
-gem "actionpack", "~>5.2.1"