capybara-screenshot-diff 1.7.1 → 1.8.1

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

@@ -0,0 +1,93 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,43 @@
+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

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

@@ -0,0 +1,60 @@
+module Capybara
+  module Screenshot
+    module Diff
+      class ScreenshotMatcher
+
+        type job_entity = Array[top]
+
+        attr_reader base_screenshot_path: TestMethods::path_entity
+        attr_reader driver_options: Drivers::BaseDriver::options_entity
+        attr_reader screenshot_full_name: TestMethods::path_entity
+        attr_reader screenshot_path: Pathname
+
+        def build_screenshot_matches_job: -> job_entity?
+        def cleanup: -> void
+
+        def self.base_image_path_from: (TestMethods::path_entity) -> Pathname
+
+        private
+
+        def build_screenshoter_for: (capture_options_entity capture_options, Drivers::BaseDriver::options_entity driver_options) -> (Screenshoter | StableScreenshoter)
+
+        def checkout_base_screenshot: -> void
+
+        def take_comparison_screenshot: (capture_options_entity capture_options, Drivers::BaseDriver::options_entity driver_options, TestMethods::path_entity screenshot_path) -> void
+
+        def create_output_directory_for: (Pathname file_name) -> void
+
+        type skip_area_entity = String | Region::raw_region_entity
+        type flex_skip_area_entity = (skip_area_entity | Array[skip_area_entity])
+        type flex_crop_entity = (nil | String | Region | Region::raw_region_entity)
+
+        def calculate_skip_area: (flex_skip_area_entity skip_area, flex_crop_entity crop) -> Array[Region]
+
+        type input_region = (Region::raw_region_entity | String | Region)
+
+        type input_options = {
+            area_size_limit: Numeric?,
+            color_distance_limit: Numeric?,
+            driver: (:auto | :vips | :chunky_png | ImageCompare::driver_entity)?,
+            median_filter_window_size: Numeric?,
+            shift_distance_limit: Numeric?,
+            skip_area: nil | Array[input_region] | input_region,
+            stability_time_limit: Numeric?,
+            tolerance: Numeric?,
+            wait: Numeric?
+          }
+
+        def calculate_crop_region: (input_options driver_options) -> Region?
+
+        type capture_options_entity = {
+            stability_time_limit: Numeric?,
+            wait: Numeric?,
+            crop: Region?
+          }
+
+        def build_regions_for: ((Enumerable[Region::raw_region_entity]) coordinates) -> Array[Region?]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Capybara
+  module Screenshot
+    class Screenshoter
+      @_csd_retina_warned: bool?
+
+      attr_reader capture_options: Diff::ScreenshotMatcher::capture_options_entity
+
+      attr_reader comparison_options: Diff::Drivers::BaseDriver::options_entity
+
+      attr_reader driver: Diff::ImageCompare::driver_entity
+
+      def initialize: (?Diff::ScreenshotMatcher::capture_options_entity capture_options, Diff::ImageCompare::driver_entity driver) -> void
+
+      def crop: () -> Numeric?
+
+      def wait: () -> Numeric?
+
+      def self.attempts_screenshot_paths: (Diff::TestMethods::path_entity base_file) -> Array[String]
+
+      def self.cleanup_attempts_screenshots: (Diff::TestMethods::path_entity base_file) -> void
+
+      # Try to get screenshot from browser.
+      # On `stability_time_limit` it checks that page stop updating by comparison several screenshot attempts
+      # On reaching `wait` limit then it has been failed. On failing we annotate screenshot attempts to help to debug
+      def take_comparison_screenshot: (Diff::TestMethods::path_entity screenshot_path) -> void
+
+      def self.gen_next_attempt_path: (Diff::TestMethods::path_entity screenshot_path, Integer iteration) -> Pathname
+
+      def take_screenshot: (Diff::TestMethods::path_entity screenshot_path) -> void
+
+      def browser_save_screenshot: (Diff::TestMethods::path_entity screenshot_path) -> void
+
+      def process_screenshot: (Diff::TestMethods::path_entity screenshot_path) -> void
+
+      def reduce_retina_image_size: (Diff::TestMethods::path_entity file_name) -> void
+
+      def notice_how_to_avoid_this: () -> void
+
+      def prepare_page_for_screenshot: (timeout: Numeric) -> BrowserHelpers::capybara_element?
+
+      def wait_images_loaded: (timeout: Numeric) -> void
+
+      private
+
+      def selenium_with_retina_screen?: () -> boolish
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Capybara
+  module Screenshot
+    module Diff
+      class StableScreenshoter
+        STABILITY_OPTIONS: [:stability_time_limit, :wait]
+
+        @_csd_retina_warned: boolish
+
+        @comparison_options: Drivers::BaseDriver::options_entity
+        @screenshoter: (StableScreenshoter | Screenshoter)
+        @stability_time_limit: Numeric
+
+        def take_comparison_screenshot: (TestMethods::path_entity screenshot_path) -> void
+
+        def take_stable_screenshot: (TestMethods::path_entity) -> Pathname?
+
+        private
+
+        def annotate_attempts_and_fail!: (TestMethods::path_entity screenshot_path) -> void
+
+        def build_comparison_for: (TestMethods::path_entity attempt_path, TestMethods::path_entity previous_attempt_path) -> ImageCompare
+
+        def prepare_page_for_screenshot: (timeout: Numeric) -> top?
+
+        def annotate_stabilization_images: (Array[String]) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# Add the `screenshot` method to ActionDispatch::IntegrationTest
+module Capybara
+  module Screenshot
+    module Diff
+      module TestMethods
+        type name_entity = (Symbol | String)
+        type path_entity = (string | Pathname)
+
+        @screenshot_counter: Numeric?
+        @screenshot_group: String?
+        @screenshot_section: String?
+        @test_screenshot_errors: Array[top]?
+        @test_screenshots: Array[[Array[String]?, String, ImageCompare]]?
+
+        def initialize: (*untyped) -> untyped
+
+        def group_parts: () -> Array[String]
+
+        def build_full_name: (name_entity name) -> String
+
+        def schedule_match_job: ([untyped, untyped, untyped] job) -> true
+
+        def screenshot_dir: () -> String
+
+        def screenshot_section: (name_entity name) -> void
+
+        def screenshot_group: (name_entity? name) -> void
+
+        def screenshot: (name_entity name, ?skip_stack_frames: ::Integer, **untyped options) -> boolish
+
+        def assert_image_not_changed: (String name, ImageCompare comparison) -> ::String?
+
+        private
+
+        def build_screenshot_matches_job: (String, Drivers::BaseDriver::options_entity) -> ScreenshotMatcher::job_entity?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Capybara
+  module Screenshot
+    module Diff
+      module Vcs
+        SILENCE_ERRORS: String
+
+        def self.checkout_vcs: (Pathname screenshot_path, Pathname checkout_path) -> bool
+
+        def self.restore_git_revision: (Pathname screenshot_path, Pathname checkout_path) -> bool
+
+        def self.restore_svn_revision: -> bool
+
+        def self.svn?: -> bool
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot-diff
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.1
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2023-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -71,42 +71,45 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitattributes"
-- ".github/dependabot.yml"
-- ".github/workflows/lint.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".standard.yml"
-- CONTRIBUTING.md
-- Dockerfile
 - LICENSE.txt
-- README.md
 - Rakefile
-- bin/bundle
-- bin/console
-- bin/install-vips
-- bin/rake
-- bin/setup
-- bin/standardrb
 - capybara-screenshot-diff.gemspec
-- 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/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/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/vcs.rb
 - lib/capybara/screenshot/diff/version.rb
-- tmp/.keep
+- 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
 homepage: https://github.com/donv/capybara-screenshot-diff
 licenses:
 - MIT
@@ -120,14 +123,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Track your GUI changes with diff assertions

data/.gitattributes

@@ -1,4 +0,0 @@
-*.gemspec diff=ruby
-*.rake    diff=ruby
-*.rb      diff=ruby
-*.md      diff=md

data/.github/dependabot.yml

@@ -1,8 +0,0 @@
----
-version: 2
-
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"

data/.github/workflows/lint.yml

@@ -1,25 +0,0 @@
-name: Ruby Linter
-
-on:
-  pull_request:
-    paths:
-      - '*.rb'
-      - '!bin/**'
-
-jobs:
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.1'
-          bundler-cache: true
-
-      - name: Run Standard Ruby linter
-        run: bin/standardrb --no-fix --fail-fast

data/.github/workflows/test.yml

@@ -1,138 +0,0 @@
-name: Test
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    paths:
-      - '**.rb'
-      - '**.gemfile'
-      - '!bin/**'
-
-env:
-  BUNDLE_GEMFILE: 'gemfiles/rails70_gems.rb'
-  FERRUM_PROCESS_TIMEOUT: '15'
-  WD_CACHE_TIME: '864000' # 10 days
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  test:
-    name: Functional Testing
-    runs-on: ubuntu-22.04 # In order to install libvips 8.9+ version
-    timeout-minutes: 5
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.1'
-          bundler-cache: true
-
-      - name: Install libvips
-        run: sudo apt install libvips libvips-dev libvips-tools
-
-      - name: Run Tests with coverage
-        run: bundle exec rake test
-        env:
-          COVERAGE: enabled
-
-      - name: Upload Screenshots
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: screenshots
-          retention-days: 1
-          path: |
-            test/fixtures/app/doc/screenshots/
-            tmp/capybara/screenshots-diffs/
-
-      - name: Upload Coverage
-        uses: actions/upload-artifact@v3
-        with:
-          name: coverage
-          retention-days: 1
-          path: coverage
-
-  matrix:
-    name: Test Integration Rails & Ruby
-    needs: [ 'test' ]
-    runs-on: ubuntu-20.04
-    timeout-minutes: 5
-
-    strategy:
-      matrix:
-        ruby-version: [ '3.1', '3.0', '2.7', 'jruby' ]
-        gemfile:
-          - 'rails70_gems.rb'
-          - 'rails61_gems.rb'
-          - 'rails60_gems.rb'
-        exclude:
-          - ruby-version: 'jruby'
-            gemfile: 'rails70_gems.rb'
-    env:
-      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-
-      - name: Install libvips
-        run: sudo apt install libvips libvips-dev libvips-tools
-
-      - name: Run tests
-        run: bundle exec rake test
-
-  matrix_screenshot_driver:
-    name: Test Integration Capybara & Image Drivers
-    needs: [ 'test' ]
-    runs-on: ubuntu-20.04
-    timeout-minutes: 5
-
-    strategy:
-      matrix:
-        screenshot-driver: [ 'vips', 'chunky_png' ]
-        capybara-driver: [ 'selenium_headless', 'selenium_chrome_headless' ]
-        include:
-          - screenshot-driver: 'chunky_png'
-            capybara-driver: 'cuprite'
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.1'
-          bundler-cache: true
-
-      - name: Install libvips
-        run: sudo apt install libvips libvips-dev libvips-tools
-
-      - name: Run tests
-        run: bundle exec rake test:integration
-        env:
-          SCREENSHOT_DRIVER: ${{ matrix.screenshot-driver }}
-          CAPYBARA_DRIVER: ${{ matrix.capybara-driver }}
-
-      - name: Upload Screenshots
-        uses: actions/upload-artifact@v3
-        if: failure()
-        with:
-          name: screenshots-${{ matrix.screenshot-driver }}-${{ matrix.capybara-driver }}
-          retention-days: 1
-          path: |
-            test/fixtures/app/doc/screenshots/
-            tmp/capybara/screenshots-diffs/

data/.gitignore

@@ -1,14 +0,0 @@
-*~
-/.bundle/
-/.idea
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/gemfiles/*.lock
-/gems.locked
-/pkg/
-/spec/reports/
-/tmp/
-/test/fixtures/**/*.committed.png
-/test/fixtures/**/*.latest.png

data/.standard.yml

@@ -1,12 +0,0 @@
-fix: true               # default: false
-parallel: true          # default: false
-format: progress        # default: Standard::Formatter
-ruby_version: 2.7       # default: RUBY_VERSION
-default_ignores: false  # default: true
-
-ignore:                 # default: []
-  - 'bin/**/*'
-  - 'gemfiles/vendor/**/*'
-  - 'gemfiles/**/*':
-    - Security/Eval
-  - 'vendor/**/*'