capybara-screenshot-diff 1.10.2 → 1.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffbb0b50c61fc1dcab03db91256897bed64caa09d65d37ee39765aec52e3d6fb
-  data.tar.gz: 1c762e2084bf2629eae25fb5e38792ce2232bdd62edbdbf1bff5381c074b3edd
+  metadata.gz: 24a35d04ca598ca2d4acd2ebff19dc3d839a6440de5b4744ec6f7a376d113df0
+  data.tar.gz: 5f1072b91792ce8266e74b9a916bd1f86ae5de04204e666f5d59111605480b3c
 SHA512:
-  metadata.gz: 97356f772b607b1ff67b146d1726baabbef696b362187c5aa5833657a4a443e8a6e8a30dedec49a07bda4d115e2a7a5c8482e4ba64a958072d1aaf6cd9dab8a3
-  data.tar.gz: '05880832a40006772c5fd72b28a4ebe9c28ca36ef49e70f132cab55acf1b97135bcd86bdb4d1b19893961fb344b0268d1c5d708354412c9c99efad03d3da85ab'
+  metadata.gz: bf944436f2e42f0e9c45bae1ec25e61822d92dac0ccfba259d91dc5bea18233f8397dcd6fa93ac4ef1d8157d0302f512ffa5930031f05656c8a2d2b3fd385a42
+  data.tar.gz: ee75582ecad3092d278ec3d4565b4501483cf71dff433a11f1af912c6848523f6a38223e983de1c7b4b629d88a4e14409051b5ea59490b5719cb9e4487ca8175

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

@@ -5,6 +5,12 @@ require_relative "region"
 module Capybara
   module Screenshot
     module BrowserHelpers
+      def self.resize_window_if_needed
+        if ::Capybara::Screenshot.respond_to?(:window_size) && ::Capybara::Screenshot.window_size
+          resize_to(::Capybara::Screenshot.window_size)
+        end
+      end
+
       def self.resize_to(window_size)
         if session.driver.respond_to?(:resize)
           session.driver.resize(*window_size)

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

@@ -74,7 +74,7 @@ class Region
   end
 
   def cover?(x, y)
-    left <= x && x <= right && top <= y && y <= bottom
+    x.between?(left, right) && y.between?(top, bottom)
   end
 
   def empty?

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

@@ -100,7 +100,7 @@ module Capybara
           attempts_reporter = CapybaraScreenshotDiff::AttemptsReporter.new(snapshot, @comparison_options, {wait: wait, stability_time_limit: stability_time_limit})
 
           # TODO: Move fail to the queue after tests passed
-          fail(attempts_reporter.generate)
+          raise CapybaraScreenshotDiff::UnstableImage, attempts_reporter.generate
         end
       end
     end

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

@@ -35,26 +35,6 @@ module Capybara
           @screenshot_group = nil
           @screenshot_section = nil
           @test_screenshot_errors = nil
-          @test_screenshots = []
-        end
-
-        # Verifies that all scheduled screenshots do not show any unintended differences.
-        #
-        # @param screenshots [Array(Array(Array(String), String, ImageCompare))] The list of match screenshots jobs. Defaults to all screenshots taken during the test.
-        # @return [Array, nil] Returns an array of error messages if there are screenshot differences, otherwise nil.
-        # @note This method is typically called at the end of a test to assert all screenshots are as expected.
-        def verify_screenshots!(screenshots = @test_screenshots)
-          return unless ::Capybara::Screenshot.active? && ::Capybara::Screenshot::Diff.fail_on_difference
-
-          test_screenshot_errors = screenshots.map do |caller, name, compare|
-            assert_image_not_changed(caller, name, compare)
-          end
-
-          test_screenshot_errors.compact!
-
-          test_screenshot_errors.presence
-        ensure
-          screenshots.clear
         end
 
         # Builds the full name for a screenshot, incorporating counters and group names for uniqueness.
@@ -83,8 +63,9 @@ module Capybara
 
         def screenshot_group(name)
           @screenshot_group = name.to_s
-          @screenshot_counter = @screenshot_group.present? ? 0 : nil
-          return unless Screenshot.active? && name.present?
+          @screenshot_counter = (@screenshot_group.nil? || @screenshot_group.empty?) ? nil : 0
+          name_present = !(name.nil? || name.empty?)
+          return unless Screenshot.active? && name_present
 
           FileUtils.rm_rf screenshot_dir
         end
@@ -97,14 +78,14 @@ module Capybara
         # @param job [Array(Array(String), String, ImageCompare)] The job to be scheduled, consisting of the caller context, screenshot name, and comparison object.
         # @return [Boolean] Always returns true, indicating the job was successfully scheduled.
         def schedule_match_job(job)
-          (@test_screenshots ||= []) << job
+          CapybaraScreenshotDiff.add_assertion(job)
           true
         end
 
         def group_parts
           parts = []
-          parts << @screenshot_section if @screenshot_section.present?
-          parts << @screenshot_group if @screenshot_group.present?
+          parts << @screenshot_section unless @screenshot_section.nil? || @screenshot_section.empty?
+          parts << @screenshot_group unless @screenshot_group.nil? || @screenshot_group.empty?
           parts
         end
 
@@ -120,13 +101,18 @@ module Capybara
         def screenshot(name, skip_stack_frames: 0, **options)
           return false unless Screenshot.active?
 
+          # setup
           screenshot_full_name = build_full_name(name)
-          job = build_screenshot_matches_job(screenshot_full_name, options)
 
-          caller = caller(skip_stack_frames + 1).reject { |l| l =~ /gems\/(activesupport|minitest|railties)/ }
-          unless job
+          # exercise
+          match_changes_job = build_screenshot_matches_job(screenshot_full_name, options)
+
+          # verify
+          backtrace = caller(skip_stack_frames + 1).reject { |l| l =~ /gems\/(activesupport|minitest|railties)/ }
+
+          unless match_changes_job
             if Screenshot::Diff.fail_if_new
-              _raise_error(<<-ERROR.strip_heredoc, caller)
+              _raise_error(<<-ERROR.strip_heredoc, backtrace)
                 No existing screenshot found for #{screenshot_full_name}!
                 To stop seeing this error disable by `Capybara::Screenshot::Diff.fail_if_new=false`
               ERROR
@@ -135,39 +121,26 @@ module Capybara
             return false
           end
 
-          job.prepend(caller)
+          match_changes_job.prepend(backtrace)
 
           if Screenshot::Diff.delayed
-            schedule_match_job(job)
+            schedule_match_job(match_changes_job)
           else
-            error_msg = assert_image_not_changed(*job)
-            _raise_error(error_msg, caller(2)) if error_msg
+            invoke_match_job(match_changes_job)
           end
         end
 
-        # Asserts that an image has not changed compared to its baseline.
-        #
-        # @param caller [Array(String)] The caller context, used for error reporting.
-        # @param name [String] The name of the screenshot being verified.
-        # @param comparison [Object] The comparison object containing the result and details of the comparison.
-        # @return [String, nil] Returns an error message if the screenshot differs from the baseline, otherwise nil.
-        # @note This method is used internally to verify individual screenshots.
-        def assert_image_not_changed(caller, name, comparison)
-          result = comparison.different?
-
-          # Cleanup after comparisons
-          if !result && comparison.base_image_path.exist?
-            FileUtils.mv(comparison.base_image_path, comparison.image_path, force: true)
-          elsif !comparison.dimensions_changed?
-            FileUtils.rm_rf(comparison.base_image_path)
-          end
+        private
 
-          return unless result
+        def invoke_match_job(job)
+          error_msg = CapybaraScreenshotDiff::ScreenshotAssertion.from(job).validate
 
-          "Screenshot does not match for '#{name}': #{comparison.error_message}\n#{caller.join("\n")}"
-        end
+          if error_msg
+            _raise_error(error_msg, job[0])
+          end
 
-        private
+          true
+        end
 
         def _raise_error(error_msg, backtrace)
           raise CapybaraScreenshotDiff::ExpectationNotMet.new(error_msg).tap { _1.set_backtrace(backtrace) }

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

@@ -53,7 +53,7 @@ module Capybara
           end
 
           svn_info = `svn info #{screenshot_path} #{SILENCE_ERRORS}`
-          if svn_info.present?
+          unless svn_info.empty?
             wc_root = svn_info.slice(/(?<=Working Copy Root Path: ).*$/)
             checksum = svn_info.slice(/(?<=Checksum: ).*$/)
 

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

@@ -3,7 +3,7 @@
 module Capybara
   module Screenshot
     module Diff
-      VERSION = "1.10.2"
+      VERSION = "1.10.3"
     end
   end
 end

data/lib/capybara_screenshot_diff/cucumber.rb

@@ -6,7 +6,5 @@ World(::CapybaraScreenshotDiff::DSL)
 
 Before do
   Capybara::Screenshot::Diff.delayed = false
-  if Capybara::Screenshot.active? && Capybara::Screenshot.window_size
-    Capybara::Screenshot::BrowserHelpers.resize_to(Capybara::Screenshot.window_size)
-  end
+  Capybara::Screenshot::BrowserHelpers.resize_window_if_needed
 end

data/lib/capybara_screenshot_diff/dsl.rb

@@ -2,10 +2,17 @@
 
 require "capybara_screenshot_diff"
 require "capybara/screenshot/diff/test_methods"
+require_relative "screenshot_assertion"
 
 module CapybaraScreenshotDiff
   module DSL
     include Capybara::DSL
     include Capybara::Screenshot::Diff::TestMethods
+
+    alias_method :_screenshot, :screenshot
+    def screenshot(name, **args)
+      assertion = CapybaraScreenshotDiff::ScreenshotAssertion.new(name, **args) { _screenshot(name, **args) }
+      CapybaraScreenshotDiff.add_assertion(assertion)
+    end
   end
 end

data/lib/capybara_screenshot_diff/minitest.rb

@@ -20,29 +20,29 @@ module CapybaraScreenshotDiff
       include ::CapybaraScreenshotDiff::DSL
 
       def screenshot(*args, skip_stack_frames: 0, **opts)
-        assert_nothing_raised do
-          super(*args, skip_stack_frames: skip_stack_frames + 3, **opts)
-        end
+        self.assertions += 1
+
+        super(*args, skip_stack_frames: skip_stack_frames + 3, **opts)
+      rescue ::CapybaraScreenshotDiff::ExpectationNotMet => e
+        raise ::Minitest::Assertion, e.message
       end
 
       alias_method :assert_matches_screenshot, :screenshot
 
-      def self.included(klass)
-        klass.setup do
-          if ::Capybara::Screenshot.window_size
-            ::Capybara::Screenshot::BrowserHelpers.resize_to(::Capybara::Screenshot.window_size)
-          end
-        end
-
-        klass.teardown do
-          errors = verify_screenshots!(@test_screenshots)
-
-          if errors.present?
-            assertion = ::Minitest::Assertion.new(errors.join("\n\n"))
-            assertion.set_backtrace []
-            failures << assertion
-          end
-        end
+      def setup
+        super
+        ::Capybara::Screenshot::BrowserHelpers.resize_window_if_needed
+      end
+
+      def before_teardown
+        super
+        CapybaraScreenshotDiff.verify
+      rescue CapybaraScreenshotDiff::ExpectationNotMet => e
+        assertion = ::Minitest::Assertion.new(e)
+        assertion.set_backtrace []
+        failures << assertion
+      ensure
+        CapybaraScreenshotDiff.reset
       end
     end
   end

data/lib/capybara_screenshot_diff/rspec.rb

@@ -13,20 +13,24 @@ RSpec::Matchers.define :match_screenshot do |name, **options|
 end
 
 RSpec.configure do |config|
-  config.include ::CapybaraScreenshotDiff::DSL, type: :feature
-  config.include ::CapybaraScreenshotDiff::DSL, type: :system
+  config.include CapybaraScreenshotDiff::DSL, type: :feature
+  config.include CapybaraScreenshotDiff::DSL, type: :system
 
-  config.after do
-    if self.class.include?(::CapybaraScreenshotDiff::DSL) && ::Capybara::Screenshot.active?
-      errors = verify_screenshots!(@test_screenshots)
-      # TODO: Use rspec/mock approach to postpone verification
-      raise ::CapybaraScreenshotDiff::ExpectationNotMet, errors.join("\n") if errors && !errors.empty?
+  config.before do
+    if self.class.include?(CapybaraScreenshotDiff::DSL)
+      Capybara::Screenshot::BrowserHelpers.resize_window_if_needed
     end
   end
 
-  config.before do
-    if self.class.include?(::CapybaraScreenshotDiff::DSL) && ::Capybara::Screenshot.window_size
-      ::Capybara::Screenshot::BrowserHelpers.resize_to(::Capybara::Screenshot.window_size)
+  config.after do
+    if self.class.include?(CapybaraScreenshotDiff::DSL)
+      begin
+        CapybaraScreenshotDiff.verify
+      rescue CapybaraScreenshotDiff::ExpectationNotMet => e
+        raise RSpec::Expectations::ExpectationNotMetError, e.message
+      ensure
+        CapybaraScreenshotDiff.reset
+      end
     end
   end
 end

data/lib/capybara_screenshot_diff/screenshot_assertion.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module CapybaraScreenshotDiff
+  class ScreenshotAssertion
+    attr_reader :name, :args
+    attr_accessor :compare, :caller
+
+    def initialize(name, **args, &block)
+      @name = name
+      @args = args
+
+      yield(self) if block_given?
+    end
+
+    def self.from(screenshot_job)
+      return screenshot_job if screenshot_job.is_a?(ScreenshotAssertion)
+
+      caller, name, compare = screenshot_job
+      ScreenshotAssertion.new(name).tap do |it|
+        it.caller = caller
+        it.compare = compare
+      end
+    end
+
+    def validate
+      return unless compare
+
+      self.class.assert_image_not_changed(caller, name, compare)
+    end
+
+    # Verifies that all scheduled screenshots do not show any unintended differences.
+    #
+    # @param screenshots [Array(Array(Array(String), String, ImageCompare))] The list of match screenshots jobs. Defaults to all screenshots taken during the test.
+    # @return [Array, nil] Returns an array of error messages if there are screenshot differences, otherwise nil.
+    # @note This method is typically called at the end of a test to assert all screenshots are as expected.
+    def self.verify_screenshots!(screenshots)
+      return unless ::Capybara::Screenshot.active? && ::Capybara::Screenshot::Diff.fail_on_difference
+
+      test_screenshot_errors = screenshots.map do |assertion|
+        assertion.validate
+      end
+
+      test_screenshot_errors.compact!
+
+      test_screenshot_errors.empty? ? nil : test_screenshot_errors
+    ensure
+      screenshots&.clear
+    end
+
+    # Asserts that an image has not changed compared to its baseline.
+    #
+    # @param backtrace [Array(String)] The caller context, used for error reporting.
+    # @param name [String] The name of the screenshot being verified.
+    # @param comparison [Object] The comparison object containing the result and details of the comparison.
+    # @return [String, nil] Returns an error message if the screenshot differs from the baseline, otherwise nil.
+    # @note This method is used internally to verify individual screenshots.
+    def self.assert_image_not_changed(backtrace, name, comparison)
+      result = comparison.different?
+
+      # Cleanup after comparisons
+      if !result && comparison.base_image_path.exist?
+        FileUtils.mv(comparison.base_image_path, comparison.image_path, force: true)
+      elsif !comparison.dimensions_changed?
+        FileUtils.rm_rf(comparison.base_image_path)
+      end
+
+      return unless result
+
+      "Screenshot does not match for '#{name}': #{comparison.error_message}\n#{backtrace.join("\n")}"
+    end
+  end
+
+  class AssertionRegistry
+    attr_reader :assertions
+
+    def initialize
+      @assertions = []
+    end
+
+    def add_assertion(assertion)
+      assertion = ScreenshotAssertion.from(assertion)
+      return unless assertion.compare
+
+      @assertions.push(assertion)
+
+      assertion
+    end
+
+    def assertions_present?
+      !@assertions.empty?
+    end
+
+    def verify(screenshots = CapybaraScreenshotDiff.assertions)
+      result = ScreenshotAssertion.verify_screenshots!(screenshots)
+
+      raise CapybaraScreenshotDiff::ExpectationNotMet, result.join("\n\n") if result
+    end
+
+    def failed_assertions
+      assertions.select { |screenshot_assert| screenshot_assert.compare&.different? }
+    end
+
+    def reset
+      @assertions.clear
+    end
+  end
+end
+
+module CapybaraScreenshotDiff
+  class << self
+    require "forwardable"
+    extend Forwardable
+
+    def registry
+      Thread.current[:capybara_screenshot_diff_registry] ||= AssertionRegistry.new
+    end
+
+    def_delegator :registry, :add_assertion
+    def_delegator :registry, :assertions
+    def_delegator :registry, :assertions_present?
+    def_delegator :registry, :failed_assertions
+    def_delegator :registry, :reset
+    def_delegator :registry, :verify
+  end
+end

data/lib/capybara_screenshot_diff.rb

@@ -10,7 +10,11 @@ require "capybara/screenshot/diff/screenshoter"
 require "capybara/screenshot/diff/reporters/default"
 
 module CapybaraScreenshotDiff
-  class ExpectationNotMet < StandardError; end
+  class CapybaraScreenshotDiffError < StandardError; end
+
+  class ExpectationNotMet < CapybaraScreenshotDiffError; end
+
+  class UnstableImage < CapybaraScreenshotDiffError; end
 end
 
 module Capybara
@@ -49,7 +53,7 @@ module Capybara
       end
     end
 
-    # Module to track screen shot changes
+    # Module to track screenshot changes
     module Diff
       mattr_accessor(:delayed) { true }
       mattr_accessor :area_size_limit

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.10.3
 platform: ruby
 authors:
 - Uwe Kubosch
 bindir: exe
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -88,6 +88,7 @@ files:
 - lib/capybara_screenshot_diff/dsl.rb
 - lib/capybara_screenshot_diff/minitest.rb
 - lib/capybara_screenshot_diff/rspec.rb
+- lib/capybara_screenshot_diff/screenshot_assertion.rb
 - lib/capybara_screenshot_diff/snap.rb
 - lib/capybara_screenshot_diff/snap_manager.rb
 homepage: https://github.com/donv/capybara-screenshot-diff
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Track your GUI changes with diff assertions
 test_files: []