eyes_selenium 6.9.0 → 6.9.2

data/lib/applitools/selenium/configuration.rb

@@ -42,6 +42,29 @@ module Applitools
         value
       end
 
+      def add_multi_device_target(*args)
+        ios_devices = []
+
+        if args.length == 1 && args[0].is_a?(Hash)
+          # Single hash passed directly
+          ios_devices << create_ios_device_info(args[0])
+        elsif args.any? { |arg| arg.is_a?(Hash) }
+          # One of the arguments is a hash with device configuration
+          hash_arg = args.find { |arg| arg.is_a?(Hash) }
+          ios_devices << create_ios_device_info(hash_arg)
+        else
+          # Multiple device names as symbols or strings
+          args.each do |device_name|
+            ios_devices << create_ios_device_info(device_name: device_name)
+          end
+        end
+
+        # Add each iOS device to the configuration
+        add_browsers(*ios_devices)
+        # Return the configuration object for method chaining
+        self
+      end
+
       def add_browser(*args)
         case args.size
         when 0
@@ -93,6 +116,7 @@ module Applitools
         add_browsers(mobile_device_infos)
       end
 
+      # Move viewport_size above the private methods
       def viewport_size
         user_defined_vp = super
         user_defined_vp = nil if user_defined_vp.respond_to?(:square) && user_defined_vp.square == 0
@@ -102,6 +126,36 @@ module Applitools
         nil
       end
 
+      private
+
+      def create_ios_device_info(options)
+        if options.is_a?(Symbol)
+          # If a symbol is passed, treat it as a device name
+          Applitools::Selenium::IosDeviceInfo.new(device_name: options)
+        else
+          # Otherwise, pass the options hash to IosDeviceInfo
+          Applitools::Selenium::IosDeviceInfo.new(options)
+        end
+      end
+
+      def handle_device_target(target)
+        if target.is_a?(Applitools::Selenium::IosDeviceTarget)
+          ios_device_info = Applitools::Selenium::IosDeviceInfo.new(
+            device_name: target.device_name,
+            screen_orientation: target.screen_orientation,
+            ios_version: target.version
+          )
+          add_browser(ios_device_info)
+        elsif target.is_a?(Applitools::Selenium::DeviceTarget)
+          device_name = target.device_name
+          orientation = target.screen_orientation || Orientations::PORTRAIT
+          add_device_emulation(device_name, orientation)
+        else
+          raise Applitools::EyesIllegalArgument,
+                'Expected arguments to be device names, hashes with configuration, or DeviceTarget instances'
+        end
+      end
+
     end
   end
 end

data/lib/applitools/selenium/driver.rb

@@ -3,6 +3,15 @@
 require 'socket'
 require 'selenium-webdriver'
 
+# MIGRATION NOTE:
+# This legacy driver wrapper is being maintained for backward compatibility.
+# New code should avoid using these wrappers and instead:
+# 1. Use unwrapped Selenium WebDriver objects directly
+# 2. Use the universal_driver_config method to obtain the standard format for Universal SDK
+# 3. Use element IDs rather than wrapped element objects
+#
+# For more details on the migration path, see spec/core/universal_eyes_driver_spec.rb
+
 module Applitools::Selenium
   class Driver < SimpleDelegator
     extend Forwardable

data/lib/applitools/selenium/element.rb

@@ -1,5 +1,14 @@
 # frozen_string_literal: false
 
+# MIGRATION NOTE:
+# This legacy element wrapper is being maintained for backward compatibility.
+# New code should avoid using these wrappers and instead:
+# 1. Use unwrapped Selenium WebDriver elements directly
+# 2. When passing elements to Eyes, use the element's ID rather than the wrapped object
+# 3. Work with the universal SDK directly when possible
+#
+# For more details on the migration path, see spec/core/universal_eyes_driver_spec.rb
+
 module Applitools::Selenium
   class Element < SimpleDelegator
     JS_GET_COMPUTED_STYLE_FORMATTED_STR = <<-JS.freeze

data/lib/applitools/selenium/entire_element_screenshot.rb

@@ -1,20 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'eyes_screenshot'
+# Empty placeholder for backward compatibility
+# This class has been removed as its functionality is now handled by the Universal SDK
 
-module Applitools::Selenium
-  # @!visibility private
-  class EntireElementScreenshot < Applitools::Selenium::EyesScreenshot
-    def sub_screenshot(*_args)
-      self
-    end
-
-    def screenshot_offset
-      region_provider.eye_region.location
-    end
+require 'applitools/selenium/eyes_screenshot'
 
-    def top_left_location
-      @top_left_location ||= screenshot_offset
+module Applitools
+  module Selenium
+    # Empty placeholder class to maintain backward compatibility
+    class EntireElementScreenshot < Applitools::Selenium::EyesScreenshot
     end
   end
-end
+end

data/lib/applitools/selenium/eyes_screenshot.rb

@@ -1,60 +1,14 @@
 # frozen_string_literal: true
 
+# Empty placeholder for backward compatibility
+# This class has been removed as its functionality is now handled by the Universal SDK
+
+require 'applitools/core/eyes_screenshot'
+
 module Applitools
   module Selenium
+    # Empty placeholder class to maintain backward compatibility
     class EyesScreenshot < Applitools::EyesScreenshot
-      attr_accessor :driver, :region_provider
-      def_delegators '@driver', :frame_chain
-
-      def initialize(image, options = {})
-        super image
-        self.region_provider = options[:region_provider] if options[:region_provider]
-        Applitools::ArgumentGuard.is_a?(
-          region_provider,
-          'options[:region_provider]',
-          Applitools::Selenium::RegionProvider
-        )
-        self.driver = region_provider.driver
-      end
-
-      def convert_location(location, _from, _to)
-        location.offset_negative(top_left_location)
-      end
-
-      # Returns the location in the screenshot.
-      #
-      # @param [Applitools::Location] location The location.
-      # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] coordinate_type The type of the coordinate.
-      # @return [Applitools::Location] The location instance in the screenshot.
-      def location_in_screenshot(location, coordinate_type)
-        raise Applitools::Selenium::UnsupportedCoordinateType, coordinate_type unless
-            coordinate_type == Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative]
-
-        location = convert_location(
-          location, coordinate_type, Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
-        )
-
-        unless image_region.contains?(location.x, location.y)
-          raise Applitools::OutOfBoundsException,
-            "Location #{location} (#{coordinate_type}) is not visible in screenshot!"
-        end
-        location
-      end
-
-      def intersected_region(region, original_coordinate_types, result_coordinate_types)
-        raise Applitools::Selenium::UnsupportedCoordinateType, original_coordinate_types unless
-            original_coordinate_types == Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative]
-        raise Applitools::Selenium::UnsupportedCoordinateType, result_coordinate_types unless
-            result_coordinate_types == Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
-
-        return Applitools::Region::EMPTY if region.empty?
-
-        intersected_region = convert_region_location(
-          region, original_coordinate_types, Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
-        )
-
-        intersected_region.intersect(image_region)
-      end
     end
   end
-end
+end

data/lib/applitools/selenium/full_page_capture_algorithm.rb

@@ -171,7 +171,7 @@ module Applitools::Selenium
         if region_provider.region(false).size.square > 0
           a_screenshot = a_screenshot.sub_screenshot(
             region_provider.region(false),
-            Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative],
+            :context_relative,
             false
           )
         end
@@ -193,7 +193,7 @@ module Applitools::Selenium
 
         image_to_stitch = a_screenshot.sub_screenshot(
           replacement_region_in_screenshot,
-          Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative],
+          :context_relative,
           false
         ).image
 

data/lib/applitools/selenium/fullpage_screenshot.rb

@@ -1,37 +1,14 @@
 # frozen_string_literal: true
-require_relative 'eyes_screenshot'
-module Applitools::Selenium
-  class FullpageScreenshot < Applitools::Selenium::EyesScreenshot
-    def sub_screenshot(region, _coordinate_type, throw_if_clipped = false, force_nil_if_clipped = false)
-      logger.info "get_subscreenshot(#{region}, #{throw_if_clipped})"
-      Applitools::ArgumentGuard.not_nil region, 'region'
 
-      as_is_subscreenshot_region = region.intersect(image_region)
+# Empty placeholder for backward compatibility
+# This class has been removed as its functionality is now handled by the Universal SDK
 
-      if as_is_subscreenshot_region.empty? || (throw_if_clipped && as_is_subscreenshot_region.size != region.size)
-        return nil if force_nil_if_clipped
-        raise Applitools::OutOfBoundsException.new "Region #{region} is out" \
-          ' of screenshot bounds'
-      end
+require 'applitools/selenium/eyes_screenshot'
 
-      sub_screenshot_image = Applitools::Screenshot.from_image(
-        image.crop(
-          as_is_subscreenshot_region.left,
-          as_is_subscreenshot_region.top,
-          as_is_subscreenshot_region.width,
-          as_is_subscreenshot_region.height
-        )
-      )
-
-      result = self.class.new(sub_screenshot_image, region_provider: region_provider).tap do |s|
-        s.top_left_location = top_left_location.dup.offset(region.location)
-      end
-      logger.info 'Done!'
-      result
-    end
-
-    def top_left_location
-      @top_left_location ||= Applitools::Location::TOP_LEFT
+module Applitools
+  module Selenium
+    # Empty placeholder class to maintain backward compatibility
+    class FullpageScreenshot < Applitools::Selenium::EyesScreenshot
     end
   end
-end
+end

data/lib/applitools/selenium/selenium_eyes.rb

@@ -29,12 +29,13 @@ module Applitools::Selenium
         if driver.respond_to? :driver_for_eyes
           driver.driver_for_eyes eyes
         else
-          unless driver.is_a?(Applitools::Selenium::Driver)
+          if !driver.is_a?(Applitools::Selenium::Driver)
             Applitools::EyesLogger.warn("Unrecognized driver type: (#{driver.class.name})!")
             is_mobile_device = driver.respond_to?(:capabilities) && driver.capabilities['platformName']
             Applitools::Selenium::Driver.new(eyes, driver: driver, is_mobile_device: is_mobile_device)
+          else
+            driver
           end
-          raise Applitools::EyesError.new "Unknown driver #{driver}!"
         end
       end
 
@@ -158,46 +159,15 @@ module Applitools::Selenium
     #   (i.e., the visible part of the document's body) or +nil+ to use the current window's viewport.
     # @option options :session_type The type of the test (e.g., standard test / visual performance test).
     #   Default value is 'SEQUENTAL'
-    # @return [Applitools::Selenium::Driver] A wrapped web driver which enables Eyes
-    #   trigger recording and frame handling
+    # @return [Selenium::WebDriver::Driver] The original driver without wrapping
     def open(options = {})
-      # runner.add_batch(batch.id) { runner.close_batch(batch.id) } if runner
+      original_driver = options[:driver]
+      
+      # Real implementation using universal SDK
       universal_open(options)
-      # original_driver = options.delete(:driver)
-      # options[:viewport_size] = Applitools::RectangleSize.from_any_argument options[:viewport_size] if
-      #     options[:viewport_size]
-      # Applitools::ArgumentGuard.not_nil original_driver, 'options[:driver]'
-      # # Applitools::ArgumentGuard.hash options, 'open(options)', [:app_name, :test_name]
-      #
-      # if disabled?
-      #   logger.info('Ignored')
-      #   return driver
-      # end
-      #
-      # @driver = self.class.eyes_driver(original_driver, self)
-      # perform_driver_specific_settings(original_driver)
-      #
-      # self.device_pixel_ratio = UNKNOWN_DEVICE_PIXEL_RATIO
-      # self.position_provider = self.class.position_provider(
-      #   stitch_mode, driver, disable_horizontal_scrolling, disable_vertical_scrolling, explicit_entire_size
-      # )
-      #
-      # self.eyes_screenshot_factory = lambda do |image|
-      #   Applitools::Selenium::ViewportScreenshot.new(
-      #     image, driver: @driver, force_offset: position_provider.force_offset
-      #   )
-      # end
-      #
-      # open_base(options) do
-      #   self.viewport_size = get_viewport_size if force_driver_resolution_as_viewport_size
-      #   ensure_running_session
-      # end
-      # if runner
-      #   runner.add_batch(batch.id) do
-      #     server_connector.close_batch(batch.id)
-      #   end
-      # end
-      # @driver
+
+      # Return the original driver without wrapping it
+      original_driver
     end
 
     def perform_driver_specific_settings(original_driver)
@@ -248,6 +218,7 @@ module Applitools::Selenium
         target = first_arg[:target]
         name = first_arg[:name] || first_arg[:tag]
       end
+
       logger.info "check(#{name}) is called"
       self.tag_for_debug = name
       Applitools::ArgumentGuard.is_a? target, 'target', Applitools::Selenium::Target
@@ -414,6 +385,10 @@ module Applitools::Selenium
     def send_dom?(target)
       target.options[:send_dom].nil? ? send_dom : target.options[:send_dom]
     end
+
+    # These methods are private by default
+    # They will be made public for testing at the end of the file if needed
+    # Note: check method is part of the public API and should not be private
     private :send_dom?
 
     def close_async

data/lib/applitools/selenium/target.rb

@@ -30,11 +30,20 @@ module Applitools
         self.frames = []
         self.options = {
           ignore_mismatch: false,
+          ignore_caret: nil,
           script_hooks: { beforeCaptureScreenshot: '' },
           visual_grid_options: {}
         }
         self.regions = {}
+        self.accessibility_regions = []
+        self.dynamic_regions = []
+        self.ignored_regions = []
+        self.floating_regions = []
+        self.layout_regions = []
+        self.content_regions = []
+        self.strict_regions = []
         self.convert_coordinates_block = nil
+        self.frame_or_element = nil
         reset_for_fullscreen
       end
 
@@ -89,7 +98,7 @@ module Applitools
         region = { region: value }
         region.merge!(bounds) if bounds != {}
         region.merge!(padding: requested_padding) if requested_padding != {}
-        region.merge!(regionId: options[:region_id]) if options[:region_id]
+        apply_region_id(region, value, options)
         floating_regions << region
         self
       end
@@ -113,7 +122,8 @@ module Applitools
       end
 
       def exact(*args)
-        match_level(Applitools::MatchLevel::EXACT, *args)
+        match_level(:exact, *args)
+        self
       end
 
       def visual_grid_options(value)
@@ -211,7 +221,7 @@ module Applitools
         value = { type: args[0], selector: args[1] } if value.nil?
         value = value[:selector] if value.is_a?(Hash) && (value[:type].to_s === 'id')
         self.region_to_check = value
-        self.coordinate_type = Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative]
+        self.coordinate_type = :context_relative
         options[:timeout] = nil
         reset_ignore
         reset_floating
@@ -490,7 +500,7 @@ module Applitools
         return nil if value === {selector: nil, type: nil}
         region = { region: value }
         region.merge!(padding: requested_padding) if requested_padding != {}
-        region.merge!(regionId: options[:region_id]) if options[:region_id]
+        apply_region_id(region, value, options)
         region
       end
 
@@ -510,6 +520,15 @@ module Applitools
         Applitools::Selenium::Driver::FINDERS.has_key?(finders[0].to_sym)
       end
 
+      def apply_region_id(region, value, options)
+        if options[:region_id]
+          region.merge!(regionId: options[:region_id])
+        elsif value.is_a?(Hash) && value[:selector]
+          # For selector-based regions, use the selector as regionId
+          region.merge!(regionId: value[:selector])
+        end
+      end
+
       def convert_to_universal(args)
         if is_element?(args.first)
           ref = args.first.ref
@@ -533,7 +552,8 @@ module Applitools
           end
         end
         if args.first.is_a?(String)
-          return proc { |driver| driver.find_element(name_or_id: args.first) }
+          # Return selector info instead of proc to avoid immediate element lookup
+          return { type: 'css selector', selector: args.first }
         end
         if args.first.is_a?(Hash) && args.first.has_key?('selector')
           if args.first.has_key?('shadow')
@@ -544,7 +564,6 @@ module Applitools
         end
         nil
       end
-
     end
   end
 end

data/lib/applitools/selenium/viewport_screenshot.rb

@@ -1,46 +1,14 @@
 # frozen_string_literal: true
-require_relative 'eyes_screenshot'
-module Applitools::Selenium
-  # @!visibility private
-  class ViewportScreenshot < Applitools::Selenium::EyesScreenshot
-    attr_accessor :top_left_location
 
-    def sub_screenshot(region, _coordinate_type, throw_if_clipped = false, force_nil_if_clipped = false)
-      logger.info "get_subscreenshot(#{region}, #{throw_if_clipped})"
-      Applitools::ArgumentGuard.not_nil region, 'region'
+# Empty placeholder for backward compatibility
+# This class has been removed as its functionality is now handled by the Universal SDK
 
-      as_is_subscreenshot_region = region.intersect(image_region)
+require 'applitools/selenium/eyes_screenshot'
 
-      if as_is_subscreenshot_region.empty? || (throw_if_clipped && as_is_subscreenshot_region.size != region.size)
-        return nil if force_nil_if_clipped
-        raise Applitools::OutOfBoundsException.new "Region #{region} is out" \
-          ' of screenshot bounds.'
-      end
-
-      cropped_image = Applitools::Screenshot.from_image(
-        image.crop(
-          as_is_subscreenshot_region.x,
-          as_is_subscreenshot_region.y,
-          as_is_subscreenshot_region.width,
-          as_is_subscreenshot_region.height
-        )
-      )
-
-      self.class.new(cropped_image, region_provider: region_provider).tap do |s|
-        s.top_left_location = top_left_location.dup.offset(region.location)
-      end
-    end
-
-    def screenshot_offset
-      offset = Applitools::Location::TOP_LEFT.dup
-      offset.offset region_provider.scroll_position_provider.current_position
-      frame_window = region_provider.calculate_frame_window
-      offset.offset_negative(frame_window.location)
-      offset
-    end
-
-    def top_left_location
-      @top_left_location ||= screenshot_offset
+module Applitools
+  module Selenium
+    # Empty placeholder class to maintain backward compatibility
+    class ViewportScreenshot < Applitools::Selenium::EyesScreenshot
     end
   end
-end
+end

data/lib/eyes_selenium.rb

@@ -18,6 +18,25 @@ module Applitools
         require f
       end
     end
+
+    def self.universal_driver_config(driver)
+      if driver.respond_to?(:driver)
+        # appium
+        bridge = driver.send(:driver).send(:bridge)
+        capabilities = bridge.capabilities
+      else
+        # selenium
+        bridge = driver.send(:bridge)
+        capabilities = driver.capabilities
+      end
+
+      hidden_server_url = bridge.http.send(:server_url).to_s
+      {
+        serverUrl: hidden_server_url,
+        sessionId: bridge.session_id,
+        capabilities: capabilities.as_json
+      }
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 6.9.0
+  version: 6.9.2
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-17 00:00:00.000000000 Z
+date: 2025-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eyes_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.7.0
+        version: 6.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.7.0
+        version: 6.7.2
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE
+- README.md
 - Rakefile
 - eyes_selenium.gemspec
 - lib/applitools/eyes_selenium/version.rb
@@ -167,7 +169,7 @@ files:
 - lib/eyes_selenium.rb
 homepage: https://www.applitools.com
 licenses:
-- Applitools
+- Proprietary
 metadata: {}
 post_install_message: 
 rdoc_options: []