capybara-screenshot-diff 1.8.3 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e7e3bdfacb7c2fad912c72ade765c9ec6a50f306048a374d8056fc02c27d643
-  data.tar.gz: c1527905de61a1d801c545729d68b811ba91db5902c1ff209b4dc212fa252971
+  metadata.gz: 87328c5152c18c006da12b39c30f0389ac0f7b71174530473681ac98e035b884
+  data.tar.gz: ec54883ea6de4b75fa5be917fee79e5098a18cd1c5ea3ebbfceb567661e148d3
 SHA512:
-  metadata.gz: c9c7868fe6d13263db039cf2a7fbb85234abee8f3bc05dd51fc5cc78579a96c1de3f2275782f5c806e9b154472ad51a991cfad1847a54d4811460597a3a4b8fe
-  data.tar.gz: 209f71e33b2b4bdead447293c0e286de6b6e1d945f4e12889e1b4f94675bb8bc035956f19a9897ceeedf278999598bb095991ecd34f2eaffa219d088ea19d577
+  metadata.gz: 7e5f89855ddaf008feab8705c6e13f495b654a7dd382fe209ac5e5917fca00553765dfcf411b90cd83aecd931fec6055502dcf3cf7ee0d69c21e8edaa891cbdc
+  data.tar.gz: 9f402d5ff1ed20d02c0e6fd3d7d025fc7e82287e7d159a6fb892c21cf0f8bf6db74257ba22560631ef179f191cce2de78f099b4a47b637a9d6f91eaededa7ddd

data/Rakefile

@@ -17,23 +17,13 @@ Rake::TestTask.new("test:integration") do |t|
   t.test_files = FileList["test/integration/**/*_test.rb"]
 end
 
-Rake::TestTask.new("test:signatures") do |t|
-  ENV["RBS_TEST_DOUBLE_SUITE"] ||= "minitest"
-  ENV["RBS_TEST_TARGET"] ||= "Capybara::Screenshot::Diff::*"
-  ENV["RBS_TEST_OPT"] ||= "-rset -rpathname -Isig"
-
-  t.libs << "test"
-  t.ruby_opts << "-r rbs/test/setup"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
 task "clobber" do
   puts "Cleanup tmp/*.png"
   FileUtils.rm_rf(Dir["./tmp/*"])
 end
 
 task "test:benchmark" do
-  require_relative "./scripts/benchmark/find_region_benchmark"
+  require_relative "scripts/benchmark/find_region_benchmark"
   benchmark = Capybara::Screenshot::Diff::Drivers::FindRegionBenchmark.new
 
   puts "For Medium Screen Size: 800x600"

data/capybara-screenshot-diff.gemspec

@@ -16,14 +16,13 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{(^(\.|tmp|bin|test|spec|features|gemfiles|scripts)/)|(^(\.|Dockerfile|CONTRIBUTING|README))})
+    f.match(%r{(^(\.|tmp|bin|test|spec|features|gemfiles|scripts|foo)/)|(^(\.|Dockerfile|CONTRIBUTING|README))})
   end
 
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "actionpack", ">= 6.1", "< 8"
+  spec.add_runtime_dependency "actionpack", ">= 6.1", "< 9"
   spec.add_runtime_dependency "capybara", ">= 2", "< 4"
-  spec.add_runtime_dependency "chunky_png", "~> 1.3"
 end

data/gems.rb

@@ -8,13 +8,15 @@ gemspec path: __dir__
 gem "rake"
 
 # Image processing libraries
-gem "oily_png", platform: :ruby, git: "https://github.com/donv/oily_png", branch: "patch-2"
+gem "chunky_png", ">= 1.3", require: false
+gem "oily_png", platform: :ruby, git: "https://github.com/wvanbergen/oily_png", ref: "44042006e79efd42ce4b52c1d78a4c70f0b4b1b2"
 gem "ruby-vips", require: false
 
 # Test
 gem "minitest", require: false
 gem "minitest-stub-const", require: false
 gem "simplecov", require: false
+gem "rspec", require: false
 
 # Capybara Server
 gem "puma", require: false
@@ -22,8 +24,7 @@ gem "rackup", require: false
 
 # Capybara Drivers
 gem "cuprite", require: false
-gem "selenium-webdriver", require: false
-gem "webdrivers", "~> 5.0", require: false
+gem "selenium-webdriver", ">= 4.11", require: false
 
 # Test Frameworks
 # gem "cucumber", require: false
@@ -31,5 +32,4 @@ gem "webdrivers", "~> 5.0", require: false
 
 group :tools do
   gem "standard", require: false
-  gem "rbs", require: false, platform: :ruby
 end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Screenshot
+    module Diff
+      class AreaCalculator
+        def initialize(crop_coordinates, skip_area)
+          @crop_coordinates = crop_coordinates
+          @skip_area = skip_area
+        end
+
+        def calculate_crop
+          return @_calculated_crop if defined?(@_calculated_crop)
+          return @_calculated_crop = nil unless @crop_coordinates
+
+          # TODO: Move out from this class, this should be done on before screenshot and should not depend on Browser
+          @crop_coordinates = BrowserHelpers.bounds_for_css(@crop_coordinates).first if @crop_coordinates.is_a?(String)
+          @_calculated_crop = Region.from_edge_coordinates(*@crop_coordinates)
+        end
+
+        # Cast skip areas params into Region
+        # and if there is crop then makes absolute coordinates to eb relative to crop top left corner
+        def calculate_skip_area
+          return nil unless @skip_area
+
+          crop_region = calculate_crop
+          skip_area = Array(@skip_area)
+
+          css_selectors, coords_list = skip_area.compact.partition { |region| region.is_a? String }
+          regions, coords_list = coords_list.partition { |region| region.is_a? Region }
+
+          regions.concat(build_regions_for(BrowserHelpers.bounds_for_css(*css_selectors))) unless css_selectors.empty?
+          regions.concat(build_regions_for(coords_list.flatten.each_slice(4))) unless coords_list.empty?
+
+          regions.compact!
+
+          if crop_region
+            regions
+              .map! { |region| crop_region.find_relative_intersect(region) }
+              .filter! { |region| region&.present? }
+          end
+
+          regions
+        end
+
+        private
+
+        def build_regions_for(coordinates)
+          coordinates
+            .map { |entry| Region.from_edge_coordinates(*entry) }
+            .tap { |it| it.compact! }
+        end
+      end
+    end
+  end
+end

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

@@ -30,13 +30,13 @@ module Capybara
 
       IMAGE_WAIT_SCRIPT = <<~JS
         function pending_image() {
-          var images = document.images;
+          const images = document.images
           for (var i = 0; i < images.length; i++) {
-            if (!images[i].complete) {
-                return images[i].src;
+            if (!images[i].complete && images[i].loading !== "lazy") {
+                return images[i].src
             }
           }
-          return false;
+          return false
         }(window)
       JS
 
@@ -83,7 +83,7 @@ module Capybara
       end
 
       def self.region_for(element)
-        element.evaluate_script(GET_BOUNDING_CLIENT_RECT_SCRIPT).map { |point| point.negative? ? 0 : point.to_i }
+        element.evaluate_script(GET_BOUNDING_CLIENT_RECT_SCRIPT).map { |point| point.negative? ? 0 : point.ceil.to_i }
       end
 
       def self.session

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Capybara::Screenshot::Diff
+  class Comparison < Struct.new(:new_image, :base_image, :options, :driver, :new_image_path, :base_image_path)
+  end
+end

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

@@ -1,11 +1,3 @@
 # frozen_string_literal: true
 
-require "capybara/screenshot/diff"
-require "capybara/screenshot/diff/test_methods"
-
-World(Capybara::Screenshot::Diff::TestMethods)
-
-Before do
-  Capybara::Screenshot::Diff.delayed = false
-  Capybara::Screenshot::BrowserHelpers.resize_to(Capybara::Screenshot.window_size) if Capybara::Screenshot.window_size
-end
+require "capybara_screenshot_diff/cucumber"

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

@@ -5,13 +5,17 @@ require "json"
 module Capybara
   module Screenshot
     module Diff
-      class Difference < Struct.new(:region, :meta, :comparison)
+      class Difference < Struct.new(:region, :meta, :comparison, :failed_by)
         def different?
-          !(blank? || tolerable?)
+          failed? || !(blank? || tolerable?)
         end
 
-        def base_image
-          comparison.base_image
+        def equal?
+          !different?
+        end
+
+        def failed?
+          !!failed_by
         end
 
         def options

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "chunky_png"
 require "capybara/screenshot/diff/difference"
 
 module Capybara
@@ -31,10 +30,6 @@ module Capybara
           def dimension(image)
             [width_for(image), height_for(image)]
           end
-
-          def inscribed?(dimensions, i)
-            width_for(i) < dimensions[0] || height_for(i) < dimensions[1]
-          end
         end
       end
     end

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

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-require "chunky_png"
+begin
+  require "chunky_png"
+rescue LoadError => e
+  raise 'Required chunky_png gem is missing. Add `gem "chunky_png"` to Gemfile' if e.message.match?(/chunky_png/i)
+  raise
+end
 
 require "capybara/screenshot/diff/drivers/base_driver"
 
@@ -35,12 +40,12 @@ module Capybara
             i.crop(*region.to_top_left_corner_coordinates)
           end
 
-          def from_file(filename)
-            ChunkyPNG::Image.from_file(filename.to_s)
+          def from_file(filename_or_path)
+            ChunkyPNG::Image.from_file(filename_or_path.to_s)
           end
 
           def save_image_to(image, filename)
-            image.save(filename)
+            image.save(filename, :fast_rgba)
           end
 
           def resize_image_to(image, new_width, new_height)
@@ -48,7 +53,7 @@ module Capybara
           end
 
           def load_image_files(old_file_name, file_name)
-            [File.binread(old_file_name), File.binread(file_name)]
+            [old_file_name.binread, file_name.binread]
           end
 
           def draw_rectangles(images, region, (r, g, b), offset: 0)

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

@@ -15,6 +15,8 @@ module Capybara
       # Compare two images and determine if they are equal, different, or within some comparison
       # range considering color values and difference area size.
       module Drivers
+        DEFAULT_HIGHLIGHT_COLOR = [255, 0, 0, 255].freeze
+
         class VipsDriver < BaseDriver
           def find_difference_region(comparison)
             new_image, base_image, options = comparison.new_image, comparison.base_image, comparison.options
@@ -26,9 +28,8 @@ module Capybara
             result = Difference.new(region, {}, comparison)
 
             unless result.blank?
-              meta = {}
-              meta[:difference_level] = difference_level(diff_mask, base_image) if comparison.options[:tolerance]
-              result.meta = meta
+              result.meta[:difference_level] = difference_level(diff_mask, base_image) if comparison.options[:tolerance]
+              result.meta[:diff_mask] = diff_mask
             end
 
             result
@@ -49,6 +50,8 @@ module Capybara
           end
 
           def add_black_box(memo, region)
+            return memo unless region
+
             memo.draw_rect([0, 0, 0, 0], *region.to_top_left_corner_coordinates, fill: true)
           end
 
@@ -100,6 +103,14 @@ module Capybara
             (comparison.new_image == comparison.base_image).min == 255
           end
 
+          def merge(new_image, base_image)
+            base_image.composite2(new_image, :over)
+          end
+
+          def highlight_mask(diff_mask, merged_image, color: DEFAULT_HIGHLIGHT_COLOR)
+            diff_mask.ifthenelse(color, merged_image * 0.75)
+          end
+
           private
 
           def same_as?(region, base_image)

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

@@ -5,7 +5,7 @@ module Capybara
     module Diff
       module Drivers
         def self.for(driver_options = {})
-          driver_option = driver_options.fetch(:driver, :chunky_png)
+          driver_option = driver_options.is_a?(Hash) ? driver_options.fetch(:driver, :chunky_png) : driver_options
           return driver_option unless driver_option.is_a?(Symbol)
 
           Utils.find_driver_class_for(driver_option).new

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "capybara/screenshot/diff/comparison"
+
 module Capybara
   module Screenshot
     module Diff
@@ -11,22 +13,13 @@ module Capybara
         TOLERABLE_OPTIONS = [:tolerance, :color_distance_limit, :shift_distance_limit, :area_size_limit].freeze
 
         attr_reader :driver, :driver_options
-
-        attr_reader :annotated_image_path, :annotated_base_image_path,
-          :image_path, :base_image_path,
-          :new_file_name, :old_file_name
+        attr_reader :image_path, :base_image_path
+        attr_reader :difference, :error_message
 
         def initialize(image_path, base_image_path, options = {})
           @image_path = Pathname.new(image_path)
-
-          @new_file_name = @image_path.to_s
-          @annotated_image_path = @image_path.sub_ext(".diff.png")
-
           @base_image_path = Pathname.new(base_image_path)
 
-          @old_file_name = @base_image_path.to_s
-          @annotated_base_image_path = @base_image_path.sub_ext(".diff.png")
-
           @driver_options = options.dup
 
           @driver = Drivers.for(@driver_options)
@@ -35,104 +28,104 @@ module Capybara
         # Compare the two image files and return `true` or `false` as quickly as possible.
         # Return falsely if the old file does not exist or the image dimensions do not match.
         def quick_equal?
-          @error_message = nil
-          return false unless image_files_exist?
-          # TODO: Confirm this change. There are screenshots with the same size, but there is a big difference
+          require_images_exists!
+
+          # NOTE: This is very fuzzy logic, but so far it's helps to support current performance.
           return true if new_file_size == old_file_size
 
           comparison = load_and_process_images
 
           unless driver.same_dimension?(comparison)
-            @error_message = build_error_for_different_dimensions(comparison)
+            self.difference = build_failed_difference(comparison, {different_dimensions: true})
             return false
           end
 
-          return true if driver.same_pixels?(comparison)
+          if driver.same_pixels?(comparison)
+            self.difference = build_no_difference(comparison)
+            return true
+          end
 
-          # Could not make any difference to be tolerable, so skip and return as not equal
+          # NOTE: Could not make any difference to be tolerable, so skip and return as not equal.
           return false if without_tolerable_options?
 
-          @difference = driver.find_difference_region(comparison)
-          return true unless @difference.different?
+          self.difference = driver.find_difference_region(comparison)
 
-          @error_message = @difference.inspect
-          false
+          !difference.different?
         end
 
         # Compare the two image referenced by this object, and return `true` if they are different,
         # and `false` if they are the same.
         def different?
-          @error_message = nil
+          processed.difference.different?
+        end
 
-          @error_message = _different?
+        def reporter
+          @reporter ||= begin
+            current_difference = difference || build_no_difference(nil)
+            Capybara::Screenshot::Diff::Reporters::Default.new(current_difference)
+          end
+        end
 
-          clean_tmp_files unless @error_message
+        def processed?
+          !!difference
+        end
 
-          !@error_message.nil?
+        def processed
+          self.difference = find_difference unless processed?
+          @error_message ||= reporter.generate
+          self
         end
 
-        def build_error_for_different_dimensions(comparison)
-          change_msg = [comparison.base_image, comparison.new_image]
-            .map { |i| driver.dimension(i).join("x") }
-            .join(" => ")
+        private
 
-          "Screenshot dimension has been changed for #{@new_file_name}: #{change_msg}"
+        def find_difference
+          require_images_exists!
+
+          comparison = load_and_process_images
+
+          unless driver.same_dimension?(comparison)
+            return build_failed_difference(comparison, {different_dimensions: true})
+          end
+
+          if driver.same_pixels?(comparison)
+            build_no_difference(comparison)
+          else
+            driver.find_difference_region(comparison)
+          end
         end
 
-        def clean_tmp_files
-          @annotated_base_image_path.unlink if @annotated_base_image_path.exist?
-          @annotated_image_path.unlink if @annotated_image_path.exist?
+        def require_images_exists!
+          raise ArgumentError, "There is no original (base) screenshot version to compare, located: #{base_image_path}" unless base_image_path.exist?
+          raise ArgumentError, "There is no new screenshot version to compare, located: #{image_path}" unless image_path.exist?
         end
 
-        def save(image, image_path)
-          driver.save_image_to(image, image_path.to_s)
+        def difference=(new_difference)
+          @error_message = nil
+          @reporter = nil
+          @difference = new_difference
         end
 
         def image_files_exist?
           @base_image_path.exist? && @image_path.exist?
         end
 
-        NEW_LINE = "\n"
-
-        attr_reader :error_message
-
-        private
-
         def without_tolerable_options?
           (@driver_options.keys & TOLERABLE_OPTIONS).empty?
         end
 
-        def _different?
-          raise "There is no original (base) screenshot version to compare, located: #{@base_image_path}" unless @base_image_path.exist?
-          raise "There is no new screenshot version to compare, located: #{@image_path}" unless @image_path.exist?
-
-          comparison = load_and_process_images
-
-          unless driver.same_dimension?(comparison)
-            return build_error_for_different_dimensions(comparison)
-          end
-
-          return not_different if driver.same_pixels?(comparison)
-
-          @difference = driver.find_difference_region(comparison)
-          return not_different unless @difference.different?
-
-          different(@difference)
+        def build_failed_difference(comparison, failed_by)
+          Difference.new(
+            nil,
+            {difference_level: nil, max_color_distance: 0},
+            comparison,
+            failed_by
+          )
         end
 
         def load_and_process_images
-          images = driver.load_images(old_file_name, new_file_name)
+          images = driver.load_images(base_image_path, image_path)
           base_image, new_image = preprocess_images(images)
-          Comparison.new(new_image, base_image, @driver_options)
-        end
-
-        def build_error_message(difference)
-          [
-            "(#{difference.inspect})",
-            new_file_name,
-            annotated_base_image_path.to_path,
-            annotated_image_path.to_path
-          ].join(NEW_LINE)
+          Comparison.new(new_image, base_image, @driver_options, driver, image_path, base_image_path)
         end
 
         def skip_area
@@ -143,15 +136,6 @@ module Capybara
           @driver_options[:median_filter_window_size]
         end
 
-        def dimensions
-          @driver_options[:dimensions]
-        end
-
-        def different(difference)
-          annotate_and_save_images(difference)
-          build_error_message(difference)
-        end
-
         def preprocess_images(images)
           images.map { |image| preprocess_image(image) }
         end
@@ -159,17 +143,19 @@ module Capybara
         def preprocess_image(image)
           result = image
 
-          # FIXME: How can we access to this method from public interface? Is this not documented feature?
-          if dimensions && driver.inscribed?(dimensions, result)
-            result = driver.crop(dimensions, result)
-          end
-
           if skip_area
             result = ignore_skipped_area(result)
           end
 
           if median_filter_window_size
-            result = blur_image_by(image, median_filter_window_size)
+            if driver.is_a?(Drivers::VipsDriver)
+              result = blur_image_by(image, median_filter_window_size)
+            else
+              warn(
+                "[capybara-screenshot-diff] Median filter has been skipped for #{image_path} " \
+                  "because it is not supported by #{driver.class.name}"
+              )
+            end
           end
 
           result
@@ -180,48 +166,28 @@ module Capybara
         end
 
         def ignore_skipped_area(image)
-          skip_area.reduce(image) { |memo, region| driver.add_black_box(memo, region) }
+          skip_area&.reduce(image) { |memo, region| driver.add_black_box(memo, region) }
         end
 
         def old_file_size
-          @old_file_size ||= image_files_exist? && File.size(@old_file_name)
+          base_image_path.size
         end
 
         def new_file_size
-          File.size(@new_file_name)
-        end
-
-        def not_different
-          nil
+          image_path.size
         end
 
-        def annotate_and_save_images(difference)
-          annotate_and_save_image(difference, difference.comparison.new_image, @annotated_image_path)
-          annotate_and_save_image(difference, difference.comparison.base_image, @annotated_base_image_path)
+        def build_no_difference(comparison = nil)
+          Difference.new(
+            nil,
+            {difference_level: nil, max_color_distance: 0},
+            comparison || build_comparison
+          ).freeze
         end
 
-        def annotate_and_save_image(difference, image, image_path)
-          image = annotate_difference(image, difference.region)
-          image = annotate_skip_areas(image, difference.skip_area) if difference.skip_area
-          save(image, image_path.to_path)
-        end
-
-        DIFF_COLOR = [255, 0, 0, 255].freeze
-
-        def annotate_difference(image, region)
-          driver.draw_rectangles(Array[image], region, DIFF_COLOR, offset: 1).first
+        def build_comparison
+          Capybara::Screenshot::Diff::Comparison.new(nil, nil, driver_options, driver, image_path, base_image_path).freeze
         end
-
-        SKIP_COLOR = [255, 192, 0, 255].freeze
-
-        def annotate_skip_areas(image, skip_areas)
-          skip_areas.reduce(image) do |memo, region|
-            driver.draw_rectangles(Array[memo], region, SKIP_COLOR).first
-          end
-        end
-      end
-
-      class Comparison < Struct.new(:new_image, :base_image, :options)
       end
     end
   end

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

@@ -7,13 +7,6 @@ class Region
     @x, @y, @width, @height = x, y, width, height
   end
 
-  def self.from_top_left_corner_coordinates(x, y, width, height)
-    return nil unless x && y && width && height
-    return nil if width < 0 || height < 0
-
-    Region.new(x, y, width, height)
-  end
-
   def self.from_edge_coordinates(left, top, right, bottom)
     return nil unless left && top && right && bottom
     return nil if right < left || bottom < top
@@ -83,4 +76,32 @@ class Region
   def cover?(x, y)
     left <= x && x <= right && top <= y && y <= bottom
   end
+
+  def empty?
+    width.zero? || height.zero?
+  end
+
+  def blank?
+    empty?
+  end
+
+  def present?
+    !empty?
+  end
+
+  def inspect
+    "Region(x: #{x}, y: #{y}, width: #{width}, height: #{height})"
+  end
+
+  # need to add this method to make it work with assert_equal
+  def ==(other)
+    case other
+    when Region
+      x == other.x && y == other.y && width == other.width && height == other.height
+    when Array
+      to_a == other
+    else
+      false
+    end
+  end
 end