eyes_selenium 6.12.10 → 6.12.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 228cadf12facab0fbdb1f164b9609b54aafc1a408f88a2b9df63709ddc797181
-  data.tar.gz: 6cb98f7c2f7c5d13a2f8c6b1fe42dd69281941778a7f3f54b63575355c8d9fec
+  metadata.gz: df7d203ca83fdc495ffbd6de949384c1a125f65420e6d8611d87fc19ba9ff193
+  data.tar.gz: e4b8281a5aeb3722f28cac7589d8fcf89f04a649c762cca9aa4918f1f3c642f8
 SHA512:
-  metadata.gz: 67d8699dce20e60370679c617ba835422140679c608a1c4e2dcdd398a6be2f5f0d82b762fb8ded56213023ba5fb1c500be643f855b6076a9dc4a4707a83ae629
-  data.tar.gz: 861f38380e65017928d9c292457c34694d71b239d71de606318f1ac710cb40695e3b36d62567fde9cf1b58f2881f52ed6171366c659476e8c33e623910b3ac26
+  metadata.gz: 93add90018bebfcbc13441b6ad4461d8420811641064d7ce5ff81cf83ee838d39a153aa8a9066da3d19f6266ecc0782c446412a35d33666dba2e0c2db937d87c
+  data.tar.gz: 57493f61f118394fb0a74c602e91d814305f938b0ba1bf3f5bc598585c07aff9bd4de535fe77aedf635b93aaf910945414e0fb64a7f210c102858000f8cde42d

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [6.12.11](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_selenium@6.12.10...ruby/eyes_selenium@6.12.11) (2025-12-14)
+
+
+### Dependencies
+
+* @applitools/core-base bumped to 1.31.0
+  #### Features
+
+  * Baseline branch fallback list | FLD-3837 ([#3373](https://github.com/Applitools-Dev/sdk/issues/3373)) ([e94bb10](https://github.com/Applitools-Dev/sdk/commit/e94bb10ad6b49322a56e4ce6dfde560b237e9ac0))
+* @applitools/core bumped to 4.54.0
+  #### Features
+
+  * Baseline branch fallback list | FLD-3837 ([#3373](https://github.com/Applitools-Dev/sdk/issues/3373)) ([e94bb10](https://github.com/Applitools-Dev/sdk/commit/e94bb10ad6b49322a56e4ce6dfde560b237e9ac0))
+
+
+
+* @applitools/nml-client bumped to 1.11.13
+
+* @applitools/ec-client bumped to 1.12.15
+
+* eyes_universal bumped to 4.54.0
+
+* eyes_core bumped to 6.9.11
+
+
 ## [6.12.10](https://github.com/Applitools-Dev/sdk/compare/ruby/eyes_selenium@6.12.9...ruby/eyes_selenium@6.12.10) (2025-12-07)
 
 

data/eyes_selenium.gemspec

@@ -27,9 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w(lib)
-  spec.add_dependency 'eyes_core', "= 6.9.10"
-  spec.add_dependency 'selenium-webdriver', '>= 3'
-  spec.add_dependency 'css_parser'
-  spec.add_dependency 'crass'
-  spec.add_dependency 'state_machines'
+  spec.add_dependency 'eyes_core', "= 6.9.11"
+  spec.add_dependency 'selenium-webdriver', '>= 3', '< 5'
 end

data/lib/applitools/eyes_selenium/version.rb

@@ -2,7 +2,7 @@
 
 module Applitools
   module EyesSelenium
-    VERSION = '6.12.10'.freeze
+    VERSION = '6.12.11'.freeze
   end
 end
 

data/lib/applitools/selenium/browsers_info.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 module Applitools
   module Selenium
     class BrowsersInfo < Set

data/lib/applitools/selenium/concerns/selenium_eyes.rb

@@ -6,39 +6,6 @@ module Applitools
       module SeleniumEyes
         USE_DEFAULT_MATCH_TIMEOUT = -1
 
-        # Validates the contents of an iframe and matches it with the expected output.
-        #
-        # @param [Hash] options The specific parameters of the desired screenshot.
-        # @option options [Array] :target_frames The frames to check.
-        def check_in_frame(options)
-          Applitools::ArgumentGuard.is_a? options, 'options', Hash
-
-          frames = options.delete :target_frames
-
-          Applitools::ArgumentGuard.is_a? frames, 'target_frames: []', Array
-
-          return yield if block_given? && frames.empty?
-
-          original_frame_chain = driver.frame_chain
-
-          logger.info 'Switching to target frame according to frames path...'
-          driver.switch_to.frames(frames_path: frames)
-          frame_chain_to_reset = driver.frame_chain
-          logger.info 'Done!'
-
-          ensure_frame_visible
-
-          yield if block_given?
-
-          reset_frames_scroll_position(frame_chain_to_reset)
-
-          logger.info 'Switching back into top level frame...'
-          driver.switch_to.default_content
-          return unless original_frame_chain
-          logger.info 'Switching back into original frame...'
-          driver.switch_to.frames frame_chain: original_frame_chain
-        end
-
         # Takes a snapshot of the application under test and matches it with the expected output.
         #
         # @param [String] tag An optional tag to be assosiated with the snapshot.

data/lib/applitools/selenium/driver.rb

@@ -52,7 +52,7 @@ module Applitools::Selenium
     # @param options [Hash] The options.
     # @option options [Selenium::WebDriver::Driver] :driver The Selenium webdriver instance.
     # @option options [Boolean] :is_mobile_device Whether is a mobile device or not.
-    def initialize(eyes, options)
+    def initialize(eyes, **options)
       super(options[:driver])
       @is_mobile_device = options.fetch(:is_mobile_device, false)
       @eyes = eyes

data/lib/applitools/selenium/eyes.rb

@@ -7,11 +7,7 @@ module Applitools
         server_url = options.delete(:server_url)
         server_url = args.first unless server_url
         runner = options.delete(:visual_grid_runner) || options.delete(:runner) || Applitools::ClassicRunner.new
-        if runner.is_a? Applitools::Selenium::VisualGridRunner
-          super Applitools::Selenium::VisualGridEyes.new(runner, server_url)
-        else
-          super Applitools::Selenium::SeleniumEyes.new(server_url, runner: runner)
-        end
+        super Applitools::Selenium::SeleniumEyes.new(server_url, runner: runner)
       end
     end
   end

data/lib/applitools/selenium/selenium_eyes.rb

@@ -15,12 +15,6 @@ module Applitools::Selenium
 
     DEFAULT_STITCHING_OVERLAP = 0 # Pixels
 
-    ENTIRE_ELEMENT_SCREENSHOT = 0
-
-    FULLPAGE_SCREENSHOT = 1
-
-    VIEWPORT_SCREENSHOT = 2
-
     extend Forwardable
     # @!visibility public
 
@@ -39,20 +33,6 @@ module Applitools::Selenium
         end
       end
 
-      def obtain_screenshot_type(is_element, inside_a_frame, stitch_content, force_fullpage)
-        if stitch_content || force_fullpage
-          unless inside_a_frame
-            return FULLPAGE_SCREENSHOT if force_fullpage && !stitch_content
-            return FULLPAGE_SCREENSHOT if stitch_content && !is_element
-          end
-          return ENTIRE_ELEMENT_SCREENSHOT if inside_a_frame
-          return ENTIRE_ELEMENT_SCREENSHOT if stitch_content
-        else
-          return VIEWPORT_SCREENSHOT unless stitch_content || force_fullpage
-        end
-        VIEWPORT_SCREENSHOT
-      end
-
       # Set the viewport size.
       #
       # @param [Applitools::Selenium::Driver] driver The driver instance.
@@ -87,10 +67,10 @@ module Applitools::Selenium
     #   May be set to an Applitools::RectangleSize instance or +nil+ (default).
     #   @return [Applitools::RectangleSize] explicit_entire_size
 
-    attr_accessor :base_agent_id, :screenshot, :force_full_page_screenshot, :hide_scrollbars,
+    attr_accessor :base_agent_id, :force_full_page_screenshot, :hide_scrollbars,
       :wait_before_screenshots, :debug_screenshots, :stitch_mode, :disable_horizontal_scrolling,
       :disable_vertical_scrolling, :explicit_entire_size, :debug_screenshot_provider, :stitching_overlap,
-      :full_page_capture_algorithm_left_top_offset, :screenshot_type, :send_dom, :use_dom, :enable_patterns,
+      :full_page_capture_algorithm_left_top_offset, :send_dom, :use_dom, :enable_patterns,
       :utils,
       :config
     attr_accessor :driver
@@ -161,8 +141,10 @@ module Applitools::Selenium
     #   Default value is 'SEQUENTAL'
     # @return [Selenium::WebDriver::Driver] The original driver without wrapping
     def open(options = {})
-      original_driver = options[:driver]
-      
+      # Handle deprecated :browser parameter
+      original_driver = get_driver(options)
+      options[:driver] = original_driver
+
       # Real implementation using universal SDK
       universal_open(options)
 
@@ -190,8 +172,7 @@ module Applitools::Selenium
     # @!visibility private
     def get_viewport_size(web_driver = driver)
       Applitools::ArgumentGuard.not_nil 'web_driver', web_driver
-      # self.utils.extract_viewport_size(driver)
-      driver_config_json = web_driver.universal_driver_config
+      driver_config_json = Applitools::Selenium.universal_driver_config(web_driver)
 
       Applitools::EyesLogger.debug 'extract_viewport_size()'
       viewport_size = runner.universal_client.core_get_viewport_size(driver_config_json)
@@ -219,145 +200,13 @@ module Applitools::Selenium
         name = first_arg[:name] || first_arg[:tag]
       end
 
-      logger.info "check(#{name}) is called"
+      logger.debug "check(#{name}) is called"
       self.tag_for_debug = name
       Applitools::ArgumentGuard.is_a? target, 'target', Applitools::Selenium::Target
 
-      return universal_check(name, target)
-
-      target_to_check = target.finalize
-      original_overflow = nil
-      original_position_provider = position_provider
-      original_force_full_page_screenshot = force_full_page_screenshot
-
-      timeout = target_to_check.options[:timeout] || USE_DEFAULT_MATCH_TIMEOUT
-
-      self.eyes_screenshot_factory = lambda do |image|
-        Applitools::Selenium::ViewportScreenshot.new(
-          image,
-          region_provider: region_to_check
-        )
-      end
-
-      self.prevent_dom_processing = send_dom?(target_to_check) ? false : true
-
-      # rubocop:disable BlockLength
-      check_in_frame target_frames: target_to_check.frames do
-        begin
-          match_data = Applitools::MatchWindowData.new(default_match_settings)
-          match_data.tag = name
-          match_data.variation_group_id = target_to_check.options[:variation_group_id] if target_to_check.options[:variation_group_id]
-          eyes_element = target_to_check.region_to_check.call(driver)
-
-          unless force_full_page_screenshot
-            region_visibility_strategy.move_to_region(
-              original_position_provider,
-              Applitools::Location.new(eyes_element.location.x.to_i, eyes_element.location.y.to_i)
-            )
-            driver.find_element(:css, 'html').scroll_data_attribute = true
-          end
-
-          region_provider = Applitools::Selenium::RegionProvider.new(driver, region_for_element(eyes_element))
-
-          self.region_to_check = region_provider
-
-          match_data.read_target(target_to_check, driver)
-          match_data.use_dom = use_dom unless match_data.use_dom
-          match_data.enable_patterns = enable_patterns unless match_data.enable_patterns
-
-          is_element = eyes_element.is_a? Applitools::Selenium::Element
-          inside_a_frame = !driver.frame_chain.empty?
-
-          self.screenshot_type = self.class.obtain_screenshot_type(
-            is_element,
-            inside_a_frame,
-            target_to_check.options[:stitch_content],
-            force_full_page_screenshot
-          )
-
-          case screenshot_type
-          when ENTIRE_ELEMENT_SCREENSHOT
-            if eyes_element.is_a? Applitools::Selenium::Element
-              original_overflow = eyes_element.overflow
-              eyes_element.overflow = 'hidden'
-              eyes_element.scroll_data_attribute = true
-              eyes_element.overflow_data_attribute = original_overflow
-              self.position_provider = Applitools::Selenium::CssTranslateElementPositionProvider.new(
-                driver,
-                eyes_element
-              )
-              ensure_block = -> { eyes_element.overflow = original_overflow if original_overflow }
-            end
-          else
-            if hide_scrollbars
-              begin
-                original_overflow = self.utils.hide_scrollbars driver
-                driver.find_element(:css, 'html').overflow_data_attribute = original_overflow
-              rescue Applitools::EyesDriverOperationException => e
-                logger.warn "Failed to hide scrollbars! Error: #{e.message}"
-              ensure
-                ensure_block = lambda do
-                  begin
-                    self.utils.set_overflow driver, original_overflow if original_overflow
-                  rescue Applitools::EyesDriverOperationException => e
-                    logger.warn "Failed to revert overflow! Error: #{e.message}"
-                  end
-                end
-              end
-            end
-          end
-
-          check_window_base(
-            region_provider, timeout, match_data
-          )
-        ensure
-          ensure_block.call if ensure_block
-          self.check_frame_or_element = false
-          self.force_full_page_screenshot = original_force_full_page_screenshot
-          self.position_provider = original_position_provider
-          self.region_to_check = nil
-          self.full_page_capture_algorithm_left_top_offset = Applitools::Location::TOP_LEFT
-          region_visibility_strategy.return_to_original_position original_position_provider
-        end
-        # rubocop:enable BlockLength
-      end
-      self.prevent_dom_processing = false
-    end
-
-    # Creates a region instance.
-    #
-    # @param [Applitools::Element] element The element.
-    # @return [Applitools::Region] The relevant region.
-    def region_for_element(element)
-      return element if element.is_a? Applitools::Region
-
-      p = element.location
-      d = element.size
-
-      border_left_width = element.border_left_width
-      border_top_width = element.border_top_width
-      border_right_width = element.border_right_width
-      border_bottom_width = element.border_bottom_width
-
-      Applitools::Region.new(
-        p.x.round + border_left_width,
-        p.y.round + border_top_width,
-        d.width - border_left_width - border_right_width,
-        d.height - border_top_width - border_bottom_width
-      ).tap do |r|
-        border_padding = Applitools::PaddingBounds.new(
-          border_left_width,
-          border_top_width,
-          border_right_width,
-          border_bottom_width
-        )
-        r.padding(border_padding)
-      end
+      universal_check(name, target)
     end
 
-    private :check_in_frame
-    private :region_for_element
-
     # @!visibility private
     def scroll_to_region
       region_visibility_strategy.is_a? Applitools::Selenium::MoveToRegionVisibilityStrategy
@@ -372,16 +221,6 @@ module Applitools::Selenium
       end
     end
 
-    def dom_data
-      return {} if prevent_dom_processing
-      begin
-        Applitools::Selenium::DomCapture.full_window_dom(driver, server_connector, logger, position_provider)
-      rescue Applitools::EyesError => e
-        logger.error "DOM capture failed! #{e.message}"
-        return {}
-      end
-    end
-
     def send_dom?(target)
       target.options[:send_dom].nil? ? send_dom : target.options[:send_dom]
     end
@@ -406,99 +245,6 @@ module Applitools::Selenium
       :region_visibility_strategy, :eyes_screenshot_factory, :force_driver_resolution_as_viewport_size,
       :prevent_dom_processing
 
-    def image_provider
-      Applitools::Selenium::TakesScreenshotImageProvider.new(
-        driver,
-        debug_screenshot_provider: debug_screenshot_provider
-      )
-    end
-
-    def capture_screenshot
-      logger.info 'Getting screenshot (capture_screenshot() has been invoked)'
-
-      update_scaling_params
-
-      algo = Applitools::Selenium::FullPageCaptureAlgorithm.new(
-        debug_screenshot_provider: debug_screenshot_provider
-      )
-      case screenshot_type
-      when ENTIRE_ELEMENT_SCREENSHOT
-        self.screenshot = entire_element_screenshot(algo)
-      when FULLPAGE_SCREENSHOT
-        self.screenshot = full_page_screenshot(algo)
-      when VIEWPORT_SCREENSHOT
-        self.screenshot = viewport_screenshot
-      end
-    end
-
-    def full_page_screenshot(algo)
-      logger.info 'Full page screenshot requested'
-      original_frame = driver.frame_chain
-      driver.switch_to.default_content
-      region_provider = Applitools::Selenium::RegionProvider.new(driver, Applitools::Region::EMPTY)
-
-      full_page_image = algo.get_stitched_region(
-        image_provider: image_provider,
-        region_to_check: region_provider,
-        origin_provider: Applitools::Selenium::ScrollPositionProvider.new(driver),
-        position_provider: position_provider,
-        scale_provider: scale_provider,
-        cut_provider: cut_provider,
-        wait_before_screenshots: wait_before_screenshots,
-        eyes_screenshot_factory: eyes_screenshot_factory,
-        stitching_overlap: stitching_overlap
-      )
-
-      unless original_frame.empty?
-        logger.info 'Switching back to original frame...'
-        driver.switch_to.frames frame_chain: original_frame
-        logger.info 'Done switching!'
-      end
-      logger.info 'Creating EyesWebDriver screenshot instance..'
-      result = Applitools::Selenium::FullpageScreenshot.new(
-        full_page_image,
-        region_provider: region_to_check
-      )
-      logger.info 'Done creating EyesWebDriver screenshot instance!'
-      result
-    end
-
-    def entire_element_screenshot(algo)
-      logger.info 'Entire element screenshot requested'
-      entire_frame_or_element = algo.get_stitched_region(
-        image_provider: image_provider,
-        region_to_check: region_to_check,
-        origin_provider: position_provider,
-        position_provider: position_provider,
-        scale_provider: scale_provider,
-        cut_provider: cut_provider,
-        wait_before_screenshots: wait_before_screenshots,
-        eyes_screenshot_factory: eyes_screenshot_factory,
-        stitching_overlap: stitching_overlap,
-        top_left_position: full_page_capture_algorithm_left_top_offset
-      )
-
-      logger.info 'Building screenshot object (EyesStitchedElementScreenshot)...'
-      result = Applitools::Selenium::EntireElementScreenshot.new(
-        entire_frame_or_element,
-        region_provider: region_to_check
-      )
-      logger.info 'Done!'
-      result
-    end
-
-    def viewport_screenshot
-      logger.info 'Viewport screenshot requested'
-      sleep wait_before_screenshots
-      image = image_provider.take_screenshot
-      scale_provider.scale_image(image) if scale_provider
-      local_cut_provider = (
-      cut_provider || Applitools::Selenium::FixedCutProvider.viewport(image, viewport_size, region_to_check)
-      )
-      local_cut_provider.cut(image) if local_cut_provider
-      eyes_screenshot_factory.call(image)
-    end
-
     def vp_size=(value, skip_check_if_open = false)
       raise Applitools::EyesNotOpenException.new 'set_viewport_size: Eyes not open!' unless skip_check_if_open || open?
       original_frame = driver.frame_chain
@@ -517,9 +263,13 @@ module Applitools::Selenium
     alias set_viewport_size vp_size=
 
     def get_driver(options)
-      # TODO: remove the "browser" related block when possible. It's for backward compatibility.
+      # DEPRECATED: The "browser" parameter is deprecated in favor of "driver".
+      # This support will be removed in version 7.0.
+      # Please update your code to use :driver instead of :browser.
+      # Example: eyes.open(driver: driver, ...) instead of eyes.open(browser: driver, ...)
       if options.key?(:browser)
-        logger.warn('"browser" key is deprecated, please use "driver" instead.')
+        logger.warn('"browser" key is deprecated and will be removed in version 7.0. ' \
+                    'Please use "driver" instead.')
         return options[:browser]
       end
 
@@ -634,12 +384,6 @@ module Applitools::Selenium
       add_mouse_trigger_base(mouse_action, control, cursor)
     end
 
-    def get_app_output_with_screenshot(*_args)
-      result = super
-      self.screenshot_url = nil
-      result
-    end
-
     public :add_text_trigger, :add_mouse_trigger, :add_mouse_trigger_by_region_and_location
 
     protected
@@ -689,49 +433,5 @@ module Applitools::Selenium
 
       nil
     end
-
-    def ensure_frame_visible
-      original_fc = driver.frame_chain
-      return original_fc if original_fc.empty?
-      fc = Applitools::Selenium::FrameChain.new other: original_fc
-      until fc.empty?
-        driver.switch_to.parent_frame
-        position_provider.position = fc.pop.location
-      end
-      driver.switch_to.frames(frame_chain: original_fc)
-      original_fc
-    end
-
-    def reset_frames_scroll_position(original_fc)
-      return original_fc if original_fc.empty?
-      fc = Applitools::Selenium::FrameChain.new other: original_fc
-      until fc.empty?
-        driver.switch_to.parent_frame
-        position_provider.position = fc.pop.parent_scroll_position
-      end
-      driver.switch_to.frames(frame_chain: original_fc)
-      original_fc
-    end
-
-    class << self
-      def position_provider(stitch_mode, driver, disable_horizontal = false, disable_vertical = false,
-        explicit_entire_size = nil)
-
-        max_width = nil
-        max_height = nil
-        unless explicit_entire_size.nil?
-          max_width = explicit_entire_size.width
-          max_height = explicit_entire_size.height
-        end
-        case stitch_mode
-        when Applitools::Selenium::StitchModes::SCROLL
-          Applitools::Selenium::ScrollPositionProvider.new(driver, disable_horizontal, disable_vertical,
-            max_width, max_height)
-        when Applitools::Selenium::StitchModes::CSS
-          Applitools::Selenium::CssTranslatePositionProvider.new(driver, disable_horizontal, disable_vertical,
-            max_width, max_height)
-        end
-      end
-    end
   end
 end