capybara-screenshot-diff 1.8.3 → 1.9.0

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

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

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

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

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

@@ -1,39 +0,0 @@
-# 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 caller, 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

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