capybara-screenshot-diff 1.7.0 → 1.8.0

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

@@ -2,38 +2,17 @@
 
 require "chunky_png"
 
+require "capybara/screenshot/diff/drivers/base_driver"
+
 module Capybara
   module Screenshot
     module Diff
       # Compare two images and determine if they are equal, different, or within some comparison
       # range considering color values and difference area size.
       module Drivers
-        class ChunkyPNGDriver
+        class ChunkyPNGDriver < BaseDriver
           include ChunkyPNG::Color
 
-          attr_reader :new_file_name, :old_file_name
-          attr_accessor :skip_area, :color_distance_limit, :shift_distance_limit
-
-          def initialize(new_file_name, old_file_name = nil, options = {})
-            options = old_file_name if old_file_name.is_a?(Hash)
-
-            @new_file_name = new_file_name
-            @old_file_name = old_file_name || "#{new_file_name}#{ImageCompare::TMP_FILE_SUFFIX}"
-
-            @color_distance_limit = options[:color_distance_limit]
-            @shift_distance_limit = options[:shift_distance_limit]
-            @skip_area = options[:skip_area]
-
-            reset
-          end
-
-          # Resets the calculated data about the comparison with regard to the "new_image".
-          # Data about the original image is kept.
-          def reset
-            @max_color_distance = @color_distance_limit ? 0 : nil
-            @max_shift_distance = @shift_distance_limit ? 0 : nil
-          end
-
           def load_images(old_file_name, new_file_name)
             old_bytes, new_bytes = load_image_files(old_file_name, new_file_name)
 
@@ -48,65 +27,8 @@ module Capybara
             image
           end
 
-          def difference_level(_diff_mask, old_img, region)
-            size(region).to_f / image_area_size(old_img)
-          end
-
-          def image_area_size(old_img)
-            width_for(old_img) * height_for(old_img)
-          end
-
-          def shift_distance_equal?
-            # Stub
-            false
-          end
-
-          def shift_distance_different?
-            # Stub
-            true
-          end
-
-          def find_difference_region(new_image, old_image, color_distance_limit, shift_distance_limit, area_size_limit, fast_fail: false)
-            return nil, nil if new_image.pixels == old_image.pixels
-
-            if fast_fail && !(color_distance_limit || shift_distance_limit || area_size_limit)
-              return build_region_for_whole_image(new_image), nil
-            end
-
-            region = find_top(old_image, new_image)
-            region = if region.nil? || region[1].nil?
-              nil
-            else
-              find_diff_rectangle(old_image, new_image, region)
-            end
-
-            [region, nil]
-          end
-
-          def height_for(image)
-            image.height
-          end
-
-          def width_for(image)
-            image.width
-          end
-
-          def max_color_distance
-            calculate_metrics unless @max_color_distance
-            @max_color_distance
-          end
-
-          def max_shift_distance
-            calculate_metrics unless @max_shift_distance || !@shift_distance_limit
-            @max_shift_distance
-          end
-
-          def adds_error_details_to(log)
-            max_color_distance = self.max_color_distance.ceil(1)
-            max_shift_distance = self.max_shift_distance
-
-            log[:max_color_distance] = max_color_distance
-            log.merge!(max_shift_distance: max_shift_distance) if max_shift_distance
+          def find_difference_region(comparison)
+            DifferenceRegionFinder.new(comparison, self).perform
           end
 
           def crop(region, i)
@@ -114,46 +36,7 @@ module Capybara
           end
 
           def from_file(filename)
-            ChunkyPNG::Image.from_file(filename)
-          end
-
-          # private
-
-          def calculate_metrics
-            old_file, new_file = load_image_files(@old_file_name, @new_file_name)
-
-            if old_file == new_file
-              @max_color_distance = 0
-              @max_shift_distance = 0
-              return
-            end
-
-            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) if @shift_distance_limit
-          end
-
-          def calculate_max_color_distance(new_image, old_image)
-            pixel_pairs = old_image.pixels.zip(new_image.pixels)
-            @max_color_distance = pixel_pairs.inject(0) { |max, (p1, p2)|
-              next max unless p1 && p2
-
-              d = ChunkyPNG::Color.euclidean_distance_rgba(p1, p2)
-              [max, d].max
-            }
-          end
-
-          def calculate_max_shift_limit(new_img, old_img)
-            (0...new_img.width).each do |x|
-              (0...new_img.height).each do |y|
-                shift_distance =
-                  shift_distance_at(new_img, old_img, x, y, color_distance_limit: @color_distance_limit)
-                if shift_distance && (@max_shift_distance.nil? || shift_distance > @max_shift_distance)
-                  @max_shift_distance = shift_distance
-                  return if @max_shift_distance == Float::INFINITY # rubocop: disable Lint/NonLocalExitFromIterator
-                end
-              end
-            end
+            ChunkyPNG::Image.from_file(filename.to_s)
           end
 
           def save_image_to(image, filename)
@@ -165,203 +48,248 @@ module Capybara
           end
 
           def load_image_files(old_file_name, file_name)
-            old_file = File.binread(old_file_name)
-            new_file = File.binread(file_name)
-            [old_file, new_file]
-          end
-
-          def dimension_changed?(old_image, new_image)
-            return unless old_image.dimension != new_image.dimension
-
-            change_msg = [old_image, new_image].map { |i| "#{i.width}x#{i.height}" }.join(" => ")
-            warn "Image size has changed for #{@new_file_name}: #{change_msg}"
-            true
+            [File.binread(old_file_name), File.binread(file_name)]
           end
 
-          def draw_rectangles(images, region, (r, g, b))
+          def draw_rectangles(images, region, (r, g, b), offset: 0)
             border_color = ChunkyPNG::Color.rgb(r, g, b)
             border_shadow = ChunkyPNG::Color.rgba(r, g, b, 100)
 
             images.map do |image|
               new_img = image.dup
-              new_img.rect(region.left - 1, region.top - 1, region.right + 1, region.bottom + 1, border_color)
+              new_img.rect(region.left - offset, region.top - offset, region.right + offset, region.bottom + offset, border_color)
               new_img.rect(region.left, region.top, region.right, region.bottom, border_shadow)
               new_img
             end
           end
 
+          def same_pixels?(comparison)
+            comparison.new_image == comparison.base_image
+          end
+
           private
 
-          def build_region_for_whole_image(new_image)
-            Region.from_edge_coordinates(0, 0, width_for(new_image), height_for(new_image))
+          def _load_images(old_file, new_file)
+            [ChunkyPNG::Image.from_blob(old_file), ChunkyPNG::Image.from_blob(new_file)]
           end
 
-          def find_diff_rectangle(org_img, new_img, area_coordinates)
-            left, top, right, bottom = find_left_right_and_top(org_img, new_img, area_coordinates)
-            bottom = find_bottom(org_img, new_img, left, right, bottom)
+          class DifferenceRegionFinder
+            attr_accessor :skip_area, :color_distance_limit, :shift_distance_limit
 
-            Region.from_edge_coordinates(left, top, right, bottom)
-          end
+            def initialize(comparison, driver = nil)
+              @comparison = comparison
+              @driver = driver
 
-          def find_top(old_img, new_img)
-            old_img.height.times do |y|
-              old_img.width.times do |x|
-                return [x, y, x, y] unless same_color?(old_img, new_img, x, y)
-              end
+              @color_distance_limit = comparison.options[:color_distance_limit]
+              @shift_distance_limit = comparison.options[:shift_distance_limit]
+              @skip_area = comparison.options[:skip_area]
             end
-            nil
-          end
 
-          def find_left_right_and_top(old_img, new_img, region)
-            region = region.is_a?(Region) ? region.to_edge_coordinates : region
+            def perform
+              find_difference_region(@comparison)
+            end
 
-            left = region[0] || old_img.width - 1
-            top = region[1]
-            right = region[2] || 0
-            bottom = region[3]
+            def find_difference_region(comparison)
+              new_image, base_image, = comparison.new_image, comparison.base_image
 
-            old_img.height.times do |y|
-              (0...left).find do |x|
-                next if same_color?(old_img, new_img, x, y)
+              meta = {}
+              meta[:max_color_distance] = 0
+              meta[:max_shift_distance] = 0 if shift_distance_limit
 
-                top ||= y
-                bottom = y
-                left = x
-                right = x if x > right
-                x
+              region = find_top(base_image, new_image, cache: meta)
+              region = if region.nil? || region[1].nil?
+                nil
+              else
+                find_diff_rectangle(base_image, new_image, region, cache: meta)
               end
-              (old_img.width - 1).step(right + 1, -1).find do |x|
-                unless same_color?(old_img, new_img, x, y)
-                  bottom = y
-                  right = x
+
+              result = Difference.new(region, meta, comparison)
+
+              unless result.blank?
+                meta[:max_color_distance] = meta[:max_color_distance].ceil(1) if meta[:max_color_distance]
+
+                if comparison.options[:tolerance]
+                  meta[:difference_level] = difference_level(nil, base_image, region)
                 end
               end
+
+              result
             end
 
-            [left, top, right, bottom]
-          end
+            def difference_level(_diff_mask, base_image, region)
+              image_area_size = @driver.image_area_size(base_image)
+              return nil if image_area_size.zero?
+
+              region.size.to_f / image_area_size
+            end
 
-          def find_bottom(old_img, new_img, left, right, bottom)
-            if bottom
-              (old_img.height - 1).step(bottom + 1, -1).find do |y|
-                (left..right).find do |x|
-                  bottom = y unless same_color?(old_img, new_img, x, y)
+            def find_diff_rectangle(org_img, new_img, area_coordinates, cache:)
+              left, top, right, bottom = find_left_right_and_top(org_img, new_img, area_coordinates, cache: cache)
+              bottom = find_bottom(org_img, new_img, left, right, bottom, cache: cache)
+
+              Region.from_edge_coordinates(left, top, right, bottom)
+            end
+
+            def find_top(old_img, new_img, cache:)
+              old_img.height.times do |y|
+                old_img.width.times do |x|
+                  return [x, y, x, y] unless same_color?(old_img, new_img, x, y, cache: cache)
                 end
               end
+              nil
             end
 
-            bottom
-          end
+            def find_left_right_and_top(old_img, new_img, region, cache:)
+              region = region.is_a?(Region) ? region.to_edge_coordinates : region
+
+              left = region[0] || old_img.width - 1
+              top = region[1]
+              right = region[2] || 0
+              bottom = region[3]
+
+              old_img.height.times do |y|
+                (0...left).find do |x|
+                  next if same_color?(old_img, new_img, x, y, cache: cache)
 
-          def same_color?(old_img, new_img, x, y)
-            return true if skipped_region?(x, y)
+                  top ||= y
+                  bottom = y
+                  left = x
+                  right = x if x > right
+                  x
+                end
+                (old_img.width - 1).step(right + 1, -1).find do |x|
+                  unless same_color?(old_img, new_img, x, y, cache: cache)
+                    bottom = y
+                    right = x
+                  end
+                end
+              end
 
-            color_distance =
-              color_distance_at(new_img, old_img, x, y, shift_distance_limit: @shift_distance_limit)
-            if !@max_color_distance || color_distance > @max_color_distance
-              @max_color_distance = color_distance
+              [left, top, right, bottom]
             end
-            color_matches = color_distance == 0 || (@color_distance_limit && @color_distance_limit > 0 &&
-              color_distance <= @color_distance_limit)
-            return color_matches if !@shift_distance_limit || @max_shift_distance == Float::INFINITY
-
-            shift_distance = (color_matches && 0) ||
-              shift_distance_at(new_img, old_img, x, y, color_distance_limit: @color_distance_limit)
-            if shift_distance && (@max_shift_distance.nil? || shift_distance > @max_shift_distance)
-              @max_shift_distance = shift_distance
+
+            def find_bottom(old_img, new_img, left, right, bottom, cache:)
+              if bottom
+                (old_img.height - 1).step(bottom + 1, -1).find do |y|
+                  (left..right).find do |x|
+                    bottom = y unless same_color?(old_img, new_img, x, y, cache: cache)
+                  end
+                end
+              end
+
+              bottom
             end
-            color_matches
-          end
 
-          def skipped_region?(x, y)
-            return false unless @skip_area
+            def same_color?(old_img, new_img, x, y, cache:)
+              return true if skipped_region?(x, y)
 
-            @skip_area.any? { |region| region.cover?(x, y) }
-          end
+              color_distance =
+                color_distance_at(new_img, old_img, x, y, shift_distance_limit: @shift_distance_limit)
+
+              if color_distance > cache[:max_color_distance]
+                cache[:max_color_distance] = color_distance
+              end
+
+              color_matches = color_distance == 0 ||
+                (!!@color_distance_limit && @color_distance_limit > 0 && color_distance <= @color_distance_limit)
 
-          def color_distance_at(new_img, old_img, x, y, shift_distance_limit:)
-            org_color = old_img[x, y]
-            if shift_distance_limit
-              start_x = [0, x - shift_distance_limit].max
-              end_x = [x + shift_distance_limit, new_img.width - 1].min
-              xs = (start_x..end_x).to_a
-              start_y = [0, y - shift_distance_limit].max
-              end_y = [y + shift_distance_limit, new_img.height - 1].min
-              ys = (start_y..end_y).to_a
-              new_pixels = xs.product(ys)
-              distances = new_pixels.map { |dx, dy|
-                new_color = new_img[dx, dy]
-                ChunkyPNG::Color.euclidean_distance_rgba(org_color, new_color)
-              }
-              distances.min
-            else
-              ChunkyPNG::Color.euclidean_distance_rgba(org_color, new_img[x, y])
+              return color_matches if !@shift_distance_limit || cache[:max_shift_distance] == Float::INFINITY
+
+              shift_distance = (color_matches && 0) ||
+                shift_distance_at(new_img, old_img, x, y, color_distance_limit: @color_distance_limit)
+              if shift_distance && (cache[:max_shift_distance].nil? || shift_distance > cache[:max_shift_distance])
+                cache[:max_shift_distance] = shift_distance
+              end
+
+              color_matches
             end
-          end
 
-          def shift_distance_at(new_img, old_img, x, y, color_distance_limit:)
-            org_color = old_img[x, y]
-            shift_distance = 0
-            loop do
-              bounds_breached = 0
-              top_row = y - shift_distance
-              if top_row >= 0 # top
-                ([0, x - shift_distance].max..[x + shift_distance, new_img.width - 1].min).each do |dx|
-                  if color_matches(new_img, org_color, dx, top_row, color_distance_limit)
-                    return shift_distance
-                  end
+            def skipped_region?(x, y)
+              return false unless @skip_area
+
+              @skip_area.any? { |region| region.cover?(x, y) }
+            end
+
+            def color_distance_at(new_img, old_img, x, y, shift_distance_limit:)
+              org_color = old_img[x, y]
+              if shift_distance_limit
+                start_x = [0, x - shift_distance_limit].max
+                end_x = [x + shift_distance_limit, new_img.width - 1].min
+                xs = (start_x..end_x).to_a
+                start_y = [0, y - shift_distance_limit].max
+                end_y = [y + shift_distance_limit, new_img.height - 1].min
+                ys = (start_y..end_y).to_a
+                new_pixels = xs.product(ys)
+
+                distances = new_pixels.map do |dx, dy|
+                  ChunkyPNG::Color.euclidean_distance_rgba(org_color, new_img[dx, dy])
                 end
+                distances.min
               else
-                bounds_breached += 1
+                ChunkyPNG::Color.euclidean_distance_rgba(org_color, new_img[x, y])
               end
-              if shift_distance > 0
-                if (x - shift_distance) >= 0 # left
-                  ([0, top_row + 1].max..[y + shift_distance, new_img.height - 2].min)
-                    .each do |dy|
-                    if color_matches(new_img, org_color, x - shift_distance, dy, color_distance_limit)
+            end
+
+            def shift_distance_at(new_img, old_img, x, y, color_distance_limit:)
+              org_color = old_img[x, y]
+              shift_distance = 0
+              loop do
+                bounds_breached = 0
+                top_row = y - shift_distance
+                if top_row >= 0 # top
+                  ([0, x - shift_distance].max..[x + shift_distance, new_img.width - 1].min).each do |dx|
+                    if color_matches(new_img, org_color, dx, top_row, color_distance_limit)
                       return shift_distance
                     end
                   end
                 else
                   bounds_breached += 1
                 end
-                if (y + shift_distance) < new_img.height # bottom
-                  ([0, x - shift_distance].max..[x + shift_distance, new_img.width - 1].min).each do |dx|
-                    if color_matches(new_img, org_color, dx, y + shift_distance, color_distance_limit)
-                      return shift_distance
+                if shift_distance > 0
+                  if (x - shift_distance) >= 0 # left
+                    ([0, top_row + 1].max..[y + shift_distance, new_img.height - 2].min)
+                      .each do |dy|
+                      if color_matches(new_img, org_color, x - shift_distance, dy, color_distance_limit)
+                        return shift_distance
+                      end
                     end
+                  else
+                    bounds_breached += 1
                   end
-                else
-                  bounds_breached += 1
-                end
-                if (x + shift_distance) < new_img.width # right
-                  ([0, top_row + 1].max..[y + shift_distance, new_img.height - 2].min)
-                    .each do |dy|
-                    if color_matches(new_img, org_color, x + shift_distance, dy, color_distance_limit)
-                      return shift_distance
+                  if (y + shift_distance) < new_img.height # bottom
+                    ([0, x - shift_distance].max..[x + shift_distance, new_img.width - 1].min).each do |dx|
+                      if color_matches(new_img, org_color, dx, y + shift_distance, color_distance_limit)
+                        return shift_distance
+                      end
                     end
+                  else
+                    bounds_breached += 1
+                  end
+                  if (x + shift_distance) < new_img.width # right
+                    ([0, top_row + 1].max..[y + shift_distance, new_img.height - 2].min)
+                      .each do |dy|
+                      if color_matches(new_img, org_color, x + shift_distance, dy, color_distance_limit)
+                        return shift_distance
+                      end
+                    end
+                  else
+                    bounds_breached += 1
                   end
-                else
-                  bounds_breached += 1
                 end
-              end
-              break if bounds_breached == 4
+                break if bounds_breached == 4
 
-              shift_distance += 1
+                shift_distance += 1
+              end
+              Float::INFINITY
             end
-            Float::INFINITY
-          end
 
-          def color_matches(new_img, org_color, x, y, color_distance_limit)
-            new_color = new_img[x, y]
-            return new_color == org_color unless color_distance_limit
-
-            color_distance = ChunkyPNG::Color.euclidean_distance_rgba(org_color, new_color)
-            color_distance <= color_distance_limit
-          end
+            def color_matches(new_img, org_color, x, y, color_distance_limit)
+              new_color = new_img[x, y]
+              return new_color == org_color unless color_distance_limit
 
-          def _load_images(old_file, new_file)
-            [ChunkyPNG::Image.from_blob(old_file), ChunkyPNG::Image.from_blob(new_file)]
+              color_distance = ChunkyPNG::Color.euclidean_distance_rgba(org_color, new_color)
+              color_distance <= color_distance_limit
+            end
           end
         end
       end

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

@@ -19,6 +19,22 @@ module Capybara
           result
         end
 
+        def self.find_driver_class_for(driver)
+          driver = AVAILABLE_DRIVERS.first if driver == :auto
+
+          LOADED_DRIVERS[driver] ||=
+            case driver
+            when :chunky_png
+              require "capybara/screenshot/diff/drivers/chunky_png_driver"
+              Drivers::ChunkyPNGDriver
+            when :vips
+              require "capybara/screenshot/diff/drivers/vips_driver"
+              Drivers::VipsDriver
+            else
+              fail "Wrong adapter #{driver.inspect}. Available adapters: #{AVAILABLE_DRIVERS.inspect}"
+            end
+        end
+
         def self.detect_test_framework_assert
           require "minitest"
           ::Minitest::Assertion