capybara-screenshot-diff 1.8.3 → 1.10.2

data/lib/capybara_screenshot_diff.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "capybara/dsl"
+require "capybara/screenshot/diff/version"
+require "capybara/screenshot/diff/utils"
+require "capybara/screenshot/diff/image_compare"
+require "capybara_screenshot_diff/snap_manager"
+require "capybara/screenshot/diff/test_methods"
+require "capybara/screenshot/diff/screenshoter"
+require "capybara/screenshot/diff/reporters/default"
+
+module CapybaraScreenshotDiff
+  class ExpectationNotMet < StandardError; end
+end
+
+module Capybara
+  module Screenshot
+    mattr_accessor :add_driver_path
+    mattr_accessor :add_os_path
+    mattr_accessor :blur_active_element
+    mattr_accessor :enabled
+    mattr_accessor :hide_caret
+    mattr_reader(:root) { (defined?(Rails) && defined?(Rails.root) && Rails.root) || Pathname(".").expand_path }
+    mattr_accessor :stability_time_limit
+    mattr_accessor :window_size
+    mattr_accessor(:save_path) { "doc/screenshots" }
+    mattr_accessor(:use_lfs)
+    mattr_accessor(:screenshot_format) { "png" }
+    mattr_accessor(:capybara_screenshot_options) { {} }
+
+    class << self
+      def root=(path)
+        @@root = Pathname(path).expand_path
+      end
+
+      def active?
+        enabled || (enabled.nil? && Diff.enabled)
+      end
+
+      def screenshot_area
+        parts = [Screenshot.save_path]
+        parts << Os.name if Screenshot.add_os_path
+        parts << Capybara.current_driver.to_s if Screenshot.add_driver_path
+        File.join(*parts)
+      end
+
+      def screenshot_area_abs
+        root / screenshot_area
+      end
+    end
+
+    # Module to track screen shot changes
+    module Diff
+      mattr_accessor(:delayed) { true }
+      mattr_accessor :area_size_limit
+      mattr_accessor(:fail_if_new) { false }
+      mattr_accessor(:fail_on_difference) { true }
+      mattr_accessor :color_distance_limit
+      mattr_accessor(:enabled) { true }
+      mattr_accessor :shift_distance_limit
+      mattr_accessor :skip_area
+      mattr_accessor(:driver) { :auto }
+      mattr_accessor :tolerance
+
+      mattr_accessor(:screenshoter) { Screenshoter }
+      mattr_accessor(:manager) { CapybaraScreenshotDiff::SnapManager }
+
+      AVAILABLE_DRIVERS = Utils.detect_available_drivers.freeze
+
+      def self.default_options
+        {
+          area_size_limit: area_size_limit,
+          color_distance_limit: color_distance_limit,
+          driver: driver,
+          screenshot_format: Screenshot.screenshot_format,
+          capybara_screenshot_options: Screenshot.capybara_screenshot_options,
+          shift_distance_limit: shift_distance_limit,
+          skip_area: skip_area,
+          stability_time_limit: Screenshot.stability_time_limit,
+          tolerance: tolerance || ((driver == :vips) ? 0.001 : nil),
+          wait: Capybara.default_max_wait_time
+        }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.10.2
 platform: ruby
 authors:
 - Uwe Kubosch
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-25 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,20 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -50,20 +49,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: chunky_png
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 description: Save screen shots and track changes with graphical diff
 email:
 - uwe@kubosch.no
@@ -77,45 +62,39 @@ files:
 - gems.rb
 - lib/capybara-screenshot-diff.rb
 - lib/capybara/screenshot/diff.rb
+- lib/capybara/screenshot/diff/area_calculator.rb
 - lib/capybara/screenshot/diff/browser_helpers.rb
+- lib/capybara/screenshot/diff/comparison.rb
 - lib/capybara/screenshot/diff/cucumber.rb
 - lib/capybara/screenshot/diff/difference.rb
 - lib/capybara/screenshot/diff/drivers.rb
 - lib/capybara/screenshot/diff/drivers/base_driver.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/reporters/default.rb
 - lib/capybara/screenshot/diff/screenshot_matcher.rb
 - lib/capybara/screenshot/diff/screenshoter.rb
-- lib/capybara/screenshot/diff/stabilization.rb
 - lib/capybara/screenshot/diff/stable_screenshoter.rb
 - lib/capybara/screenshot/diff/test_methods.rb
+- lib/capybara/screenshot/diff/utils.rb
 - lib/capybara/screenshot/diff/vcs.rb
 - lib/capybara/screenshot/diff/version.rb
-- sig/capybara/screenshot/diff/diff.rbs
-- sig/capybara/screenshot/diff/difference.rbs
-- sig/capybara/screenshot/diff/drivers/base_driver.rbs
-- sig/capybara/screenshot/diff/drivers/browser_helpers.rbs
-- sig/capybara/screenshot/diff/drivers/chunky_png_driver.rbs
-- sig/capybara/screenshot/diff/drivers/utils.rbs
-- sig/capybara/screenshot/diff/drivers/vips_driver.rbs
-- sig/capybara/screenshot/diff/image_compare.rbs
-- sig/capybara/screenshot/diff/os.rbs
-- sig/capybara/screenshot/diff/region.rbs
-- sig/capybara/screenshot/diff/screenshot_matcher.rbs
-- sig/capybara/screenshot/diff/screenshoter.rbs
-- sig/capybara/screenshot/diff/stable_screenshoter.rbs
-- sig/capybara/screenshot/diff/test_methods.rbs
-- sig/capybara/screenshot/diff/vcs.rbs
+- lib/capybara_screenshot_diff.rb
+- lib/capybara_screenshot_diff/attempts_reporter.rb
+- lib/capybara_screenshot_diff/cucumber.rb
+- lib/capybara_screenshot_diff/dsl.rb
+- lib/capybara_screenshot_diff/minitest.rb
+- lib/capybara_screenshot_diff/rspec.rb
+- lib/capybara_screenshot_diff/snap.rb
+- lib/capybara_screenshot_diff/snap_manager.rb
 homepage: https://github.com/donv/capybara-screenshot-diff
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,15 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Track your GUI changes with diff assertions
 test_files: []

data/sig/capybara/screenshot/diff/diff.rbs

@@ -1,28 +0,0 @@
-module Capybara
-  module Screenshot
-    def self.root=: ((String | Pathname) path) -> Pathname
-
-    def self.root: -> Pathname
-
-    def self.active?: () -> boolish
-
-    def self.screenshot_area: () -> String
-
-    def self.screenshot_area_abs: () -> Pathname
-
-    # Module to track screen shot changes
-    module Diff
-      AVAILABLE_DRIVERS: Array[(:vips | :chunky_png)]
-
-      ASSERTION: (top | RuntimeError)
-
-      def self.default_options: () -> ScreenshotMatcher::input_options
-
-      def self.included: (top klass) -> void
-
-      private
-
-      def track_failures: (Array[untyped] screenshots) -> void
-    end
-  end
-end

data/sig/capybara/screenshot/diff/difference.rbs

@@ -1,33 +0,0 @@
-module Capybara
-  module Screenshot
-    module Diff
-      class Difference
-        attr_reader comparison: ImageCompare::Comparison
-
-        def different?: () -> bool
-
-        def base_image: () -> top
-
-        def options: () -> Drivers::BaseDriver::options_entity
-
-        def tolerance: () -> Numeric?
-
-        def area_size_limit: () -> Numeric?
-
-        def blank?: () -> bool
-
-        def region_area_size: () -> Numeric
-
-        def ratio: () -> Numeric?
-
-        def to_h: () -> Hash[Symbol, untyped]
-
-        def coordinates: () -> Region::raw_region_entity
-
-        def inspect: () -> String
-
-        def tolerable?: () -> bool
-      end
-    end
-  end
-end

data/sig/capybara/screenshot/diff/drivers/base_driver.rbs

@@ -1,63 +0,0 @@
-module Capybara
-  module Screenshot
-    module Diff
-      module Drivers
-        class BaseDriver[ImageEntity]
-
-          type images_entity[out T] = [T, T]
-          type dimension_entity = [Numeric, Numeric]
-
-          type options_entity = {
-              area_size_limit?: Numeric?,
-              color_distance_limit?: Numeric?,
-              driver: (:auto | :vips | :chunky_png | VipsDriver | ChunkyPNGDriver)?,
-              dimensions: dimension_entity?,
-              median_filter_window_size: Numeric?,
-              shift_distance_limit?: Numeric?,
-              skip_area?: Array[Region]?,
-              stability_time_limit?: Numeric?,
-              tolerance?: Numeric?,
-              wait?: Numeric?
-            }
-
-          type color = [Integer, Integer, Integer, Integer]
-
-          def find_difference_region: (ImageEntity new_image, ImageEntity old_image, Numeric color_distance_limit, Numeric _shift_distance_limit, Integer _area_size_limit, ?fast_fail: bool) -> Difference
-
-          def inscribed?: (dimension_entity dimensions, ImageEntity i) -> boolish
-
-          def crop: (Region region, ImageEntity i) -> ImageEntity
-
-          def filter_image_with_median: (ImageEntity image, Numeric median_filter_window_size) -> ImageEntity
-
-          def add_black_box: (ImageEntity memo, Region region) -> void
-
-          def difference_level: (ImageEntity diff_mask, ImageEntity old_img, Region _region) -> Float
-
-          def image_area_size: (ImageEntity old_img) -> Integer
-
-          def height_for: (ImageEntity image) -> Integer
-
-          def width_for: (ImageEntity image) -> Integer
-
-          # Vips could not work with the same file. Per each process we require to create new file
-          def save_image_to: (ImageEntity image, String filename) -> void
-
-          def resize_image_to: (ImageEntity image, Integer new_width, Integer new_height) -> ImageEntity
-
-          def load_images: (String old_file_name, String new_file_name) -> images_entity[ImageEntity]
-
-          def from_file: (TestMethods::path_entity filename) -> ImageEntity
-
-          def dimension: (ImageEntity image) -> dimension_entity
-
-          def draw_rectangles: (images_entity[ImageEntity] images, Region region, color rgba, Integer offset) -> void
-
-          def same_pixels?: () -> boolish
-        end
-
-        def self.for: (ScreenshotMatcher::input_options) -> (VipsDriver | ChunkyPNGDriver)
-      end
-    end
-  end
-end

data/sig/capybara/screenshot/diff/drivers/browser_helpers.rbs

@@ -1,36 +0,0 @@
-module Capybara
-  class Result
-    def map: () -> Result
-  end
-  module Screenshot
-    module BrowserHelpers
-      def self.current_capybara_driver_class: () -> top
-
-      def self.selenium?: () -> boolish?
-
-      def self.window_size_is_wrong?: () -> boolish
-
-      def self.bounds_for_css: (*String css_selectors) -> Array[Region::raw_region_entity]
-
-      IMAGE_WAIT_SCRIPT: String
-
-      def self.pending_image_to_load: () -> top?
-
-      HIDE_CARET_SCRIPT: String
-
-      def self.hide_caret: () -> void
-
-      FIND_ACTIVE_ELEMENT_SCRIPT: String
-
-      type capybara_element = top
-
-      def self.blur_from_focused_element: () -> capybara_element?
-
-      GET_BOUNDING_CLIENT_RECT_SCRIPT: String
-
-      def self.all_visible_regions_for: (String selector) -> Array[Region::raw_region_entity]
-
-      def self.region_for: (Result element) -> Region::raw_region_entity
-    end
-  end
-end

data/sig/capybara/screenshot/diff/drivers/chunky_png_driver.rbs

@@ -1,89 +0,0 @@
-module ChunkyPNG
-  class Canvas
-  end
-
-  class Image
-    def self.from_blob: (String str) -> Image
-
-    def self.from_file: (String filename) -> Image
-  end
-end
-
-module Capybara
-  module Screenshot
-    module Diff
-      module Drivers
-        class ChunkyPNGDriver < BaseDriver[ChunkyPNG::Canvas]
-
-          def _load_images: (String old_file, String new_file) -> [ChunkyPNG::Image, ChunkyPNG::Image]
-
-          class DifferenceRegionFinder
-            def find_diff_rectangle: (
-                ChunkyPNG::Image org_img,
-                ChunkyPNG::Image new_img,
-                (Region | Region::raw_region_entity) area_coordinates,
-                cache: ImageCompare::cache_entity
-              ) -> Region?
-
-            def find_top: (
-                ChunkyPNG::Image old_img,
-                ChunkyPNG::Image new_img,
-                cache: ImageCompare::cache_entity
-              ) -> Region::raw_region_entity?
-
-            def find_left_right_and_top: (
-                ChunkyPNG::Image old_img,
-                ChunkyPNG::Image new_img,
-                (Region | Region::raw_region_entity) region,
-                cache: ImageCompare::cache_entity
-              ) -> Region::raw_region_entity
-
-            def find_bottom: (
-                ChunkyPNG::Image old_img,
-                ChunkyPNG::Image new_img,
-                Integer left,
-                Integer right,
-                Integer bottom,
-                cache: ImageCompare::cache_entity
-              ) -> Integer
-
-            def same_color?: (
-                ChunkyPNG::Image old_img,
-                ChunkyPNG::Image new_img,
-                Integer x,
-                Integer y,
-                ?cache: ImageCompare::cache_entity
-              ) -> boolish
-
-            def skipped_region?: (Integer x, Integer y) -> boolish
-
-            def color_distance_at: (
-                ChunkyPNG::Image new_img,
-                ChunkyPNG::Image old_img,
-                Integer x,
-                Integer y,
-                shift_distance_limit: Numeric?
-              ) -> Float
-
-            def shift_distance_at: (
-                ChunkyPNG::Image new_img,
-                ChunkyPNG::Image old_img,
-                Integer x,
-                Integer y,
-                color_distance_limit: Numeric?
-              ) -> Numeric
-
-            def color_matches: (
-                ChunkyPNG::Image new_img,
-                Integer org_color,
-                Integer x,
-                Integer y,
-                Numeric? color_distance_limit
-              ) -> boolish
-          end
-
-        end
-      end
-    end
-  end
-end

data/sig/capybara/screenshot/diff/drivers/utils.rbs

@@ -1,13 +0,0 @@
-module Capybara
-  module Screenshot
-    module Diff
-      module Utils
-        def self.detect_available_drivers: () -> Array[(:vips | :chunky_png)]
-
-        def self.find_driver_class_for: [T] (Symbol driver) -> T
-
-        def self.detect_test_framework_assert: [T < Exception] () -> T
-      end
-    end
-  end
-end

data/sig/capybara/screenshot/diff/drivers/vips_driver.rbs

@@ -1,25 +0,0 @@
-module ::Vips
-  class Image
-    def self.new_from_file: (String filename) -> Image
-  end
-end
-
-module Capybara
-  module Screenshot
-    module Diff
-      module Drivers
-        class VipsDriver < BaseDriver[Vips::Image]
-          class VipsUtil
-            def self.difference_area: (Vips::Image old_image, Vips::Image new_image, ?color_distance: ::Integer) -> Numeric
-
-            def self.difference_area_size_by: (Vips::Image difference_mask) -> Numeric
-
-            def self.difference_mask: (Vips::Image, Vips::Image, ?Numeric? color_distance) -> Vips::Image
-
-            def self.difference_region_by: (Vips::Image diff_mask) -> Region?
-          end
-        end
-      end
-    end
-  end
-end

data/sig/capybara/screenshot/diff/image_compare.rbs

@@ -1,93 +0,0 @@
-module Capybara
-  module Screenshot
-    module Diff
-      LOADED_DRIVERS: { vips: ImageCompare::driver_entity, chunky_png: ImageCompare::driver_entity }
-
-      # Compare two images_entities and determine if they are equal, different, or within some comparison
-      # range considering color values and difference area size.
-      class ImageCompare
-        TOLERABLE_OPTIONS: [:tolerance, :color_distance_limit, :shift_distance_limit, :area_size_limit]
-
-        class Comparison
-
-        end
-
-        type driver_entity = (Drivers::VipsDriver | Drivers::ChunkyPNGDriver)
-        type image_entity = (ChunkyPNG::Canvas | Vips::Image)
-        type images_entities = [image_entity, image_entity]
-        type cache_entity = (::Hash[Symbol, top] | top)
-
-        @annotated_base_image_path: Pathname
-        @annotated_image_path: Pathname
-        @difference: Difference
-        @error_message: String?
-
-        attr_reader error_message: String?
-        attr_reader annotated_base_image_path: Pathname
-        attr_reader annotated_image_path: Pathname
-        attr_reader driver: driver_entity
-        attr_reader driver_options: Drivers::BaseDriver::options_entity
-        attr_reader annotated_new_file_name: TestMethods::path_entity
-        attr_reader annotated_old_file_name: TestMethods::path_entity
-        attr_reader new_file_name: String
-        attr_reader old_file_name: String
-        attr_reader skip_area: Array[Region]?
-        attr_accessor shift_distance_limit: Numeric?
-        attr_accessor area_size_limit: Numeric?
-        attr_accessor color_distance_limit: Numeric?
-
-        @median_filter_window_size: Numeric?
-        @dimensions: Drivers::BaseDriver::dimension_entity?
-        @tolerance: Numeric?
-
-        def initialize: (TestMethods::path_entity new_file_name, TestMethods::path_entity old_file_name, ?Drivers::BaseDriver::options_entity options) -> void
-
-        # Compare the two image_entity files and return `true` or `false` as quickly as possible.
-        # Return falsely if the old file does not exist or the image_entity dimensions do not match.
-        def quick_equal?: () -> boolish
-
-        # Compare the two images_entities referenced by this object, and return `true` if they are different,
-        # and `false` if they are the same.
-        def different?: () -> bool
-
-        def clean_tmp_files: () -> void
-
-        def save: (image_entity, TestMethods::path_entity) -> void
-
-        def old_file_exists?: () -> boolish
-
-        def reset: () -> void
-
-        NEW_LINE: "\n"
-
-        private
-
-        def _different?: -> String?
-
-        def different: (Difference images) -> String
-
-        def preprocess_images: (images_entities images) -> images_entities
-
-        def preprocess_image: (image_entity image) -> image_entity
-
-        def old_file_size: () -> Integer
-
-        def new_file_size: () -> Integer
-
-        def not_different: () -> nil
-
-        def annotate_and_save_images: (Difference) -> void
-
-        def annotate_and_save_image: (Difference, image_entity, TestMethods::path_entity) -> void
-
-        DIFF_COLOR: [255, 0, 0, 255]
-
-        def annotate_difference: (image_entity, Region) -> void
-
-        SKIP_COLOR: [255, 192, 0, 255]
-
-        def annotate_skip_areas: (image_entity, Array[Region] skip_areas) -> void
-      end
-    end
-  end
-end

data/sig/capybara/screenshot/diff/os.rbs

@@ -1,11 +0,0 @@
-module Capybara
-  module Screenshot
-    module Os
-      ON_WINDOWS: bool
-      ON_MAC: bool
-      ON_LINUX: bool
-
-      def self.name: () -> ("windows" | "macos" | "linux" | "unknown")
-    end
-  end
-end

data/sig/capybara/screenshot/diff/region.rbs

@@ -1,43 +0,0 @@
-class Region
-  type raw_region_entity = [Numeric, Numeric, Numeric, Numeric]
-
-  attr_accessor x: Numeric
-
-  attr_accessor y: Numeric
-
-  attr_accessor width: Numeric
-
-  attr_accessor height: Numeric
-
-  def initialize: (Numeric x, Numeric y, Numeric width, Numeric height) -> void
-
-  def self.from_top_left_corner_coordinates: (Numeric x, Numeric y, Numeric width, Numeric height) -> Region?
-
-  def self.from_edge_coordinates: (Numeric left, Numeric `top`, Numeric right, Numeric bottom) -> Region?
-
-  def to_edge_coordinates: () -> ::Array[Numeric]
-
-  def to_top_left_corner_coordinates: () -> ::Array[Numeric]
-
-  def top: () -> Numeric
-
-  def bottom: () -> Numeric
-
-  def left: () -> Numeric
-
-  def right: () -> Numeric
-
-  def size: () -> Numeric
-
-  def to_a: () -> ::Array[Numeric]
-
-  def find_intersect_with: (Region region) -> Region?
-
-  def intersect?: (Region region) -> boolish
-
-  def move_by: (Numeric right_by, Numeric down_by) -> Region
-
-  def find_relative_intersect: (Region region) -> Region?
-
-  def cover?: (Numeric x, Numeric y) -> boolish
-end