eyes_selenium 3.16.15 → 3.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c004659a8d902282438c1dcdc55291471dde4d6fb2530297a68562345eadddd7
-  data.tar.gz: c0384765b06476413b5e5da60109a0455315fdffb24ff0576a3a53073956ec18
+  metadata.gz: a287486a3c2db8fe596472fc9913fe78e986f808e85d7aff75a864af7d2eb882
+  data.tar.gz: 9dc948821e7024ecd298fbd79e139a3b18ec49cf0abd18b508379f78010257cb
 SHA512:
-  metadata.gz: 1846ad7b21531f165af57902fa5efd6bfd6808ae42e2aa424a03c74f66153f65a9a4ca409c18c6fb3832422be84bc2d81c68ab835ff536b4dd8aa620a35e7eed
-  data.tar.gz: b33e3bf45775188f848256ff2d5a5136b58ffd077cd373f04dd7dbfb8c83e7c6642b0e65ca44ddc0c2fc136316d9b5c1aaadd551d05af8ee26603a8be73da523
+  metadata.gz: e6985305123510272024b48190c15254d026835251fd7d5fcead42988a32e6f09b3c4155870729a8ded879aef9aa2523fbc40951d4e6364bbfc12c7e960e0a04
+  data.tar.gz: e1c697f8a30a19d97ad28d2cc488b4d22da34fdc78b62cbe46f44028be0e93f4a9bfed34706116dd2c516afc6349bfff4dd4a5da5bfe4c3c066fc81ed211ffd7

data/lib/applitools/selenium/browser_types.rb

@@ -1,5 +1,16 @@
 # frozen_string_literal: true
 module BrowserTypes
+  extend self
+  def const_missing(name)
+    puts 'Please, prefer using BrowserType instead of BrowserTypes(plural).'
+    BrowserType.const_get(name)
+  end
+
+  def enum_values
+    BrowserType.enum_values
+  end
+end
+module BrowserType
   extend self
   CHROME = :'chrome-0'
   CHROME_ONE_VERSION_BACK = :'chrome-1'
@@ -12,6 +23,7 @@ module BrowserTypes
   SAFARI = :'safari-0'
   SAFARI_ONE_VERSION_BACK = :'safari-1'
   SAFARI_TWO_VERSIONS_BACK = :'safari-2'
+  IOS_SAFARI = :safari
 
   EDGE_CHROMIUM = :'edgechromium'
   EDGE_CHROMIUM_ONE_VERSION_BACK = :'edgechromium-1'
@@ -52,7 +64,8 @@ module BrowserTypes
       EDGE_LEGACY,
       IE_10,
       EDGE_CHROMIUM,
-      EDGE_CHROMIUM_ONE_VERSION_BACK
+      EDGE_CHROMIUM_ONE_VERSION_BACK,
+      IOS_SAFARI
     ]
   end
 end

data/lib/applitools/selenium/browsers_info.rb

@@ -4,7 +4,7 @@ module Applitools
   module Selenium
     class BrowsersInfo < Set
       def add(obj)
-        return super if obj.is_a? Applitools::Selenium::RenderBrowserInfo
+        return super if obj.is_a? Applitools::Selenium::IRenderBrowserInfo
         raise(
           Applitools::EyesIllegalArgument,
           'It is expected the value to be an Applitools::Selenium::RenderBrowserInfo instance,' \
@@ -15,7 +15,7 @@ module Applitools
       def each(viewport_size = nil)
         return super() unless empty?
         return unless viewport_size
-        default = Applitools::Selenium::RenderBrowserInfo.new.tap do |bi|
+        default = Applitools::Selenium::DesktopBrowserInfo.new.tap do |bi|
           bi.viewport_size = viewport_size
           bi.browser_type = BrowserTypes::CHROME
         end

data/lib/applitools/selenium/configuration.rb

@@ -14,7 +14,6 @@ module Applitools
           hide_scrollbars: true,
           hide_caret: false,
           browsers_info: Applitools::Selenium::BrowsersInfo.new,
-          accessibility_validation: Applitools::AccessibilityLevel::NONE,
           rendering_grid_force_put: (ENV['APPLITOOLS_RENDERING_GRID_FORCE_PUT'] || 'false').casecmp('true') == 0
         }
       end
@@ -33,21 +32,21 @@ module Applitools
 
       object_field :browsers_info, Applitools::Selenium::BrowsersInfo
       int_field :concurrent_sessions
-      enum_field :accessibility_validation, Applitools::AccessibilityLevel.enum_values
       boolean_field :rendering_grid_force_put
 
-      def custom_setter_for_accessibility_validation(value)
-        # self.default_match_settings = self.parent.class.default_config[:default_match_settings] unless default_match_settings
-        default_match_settings.accessibility_level = value
-      end
-
       def add_browser(*args)
         case args.size
-        when 0, 1
+        when 0
+          browser = Applitools::Selenium::DesktopBrowserInfo.new
+        when 1
           b = args[0]
-          browser = b || Applitools::Selenium::RenderBrowserInfo.new
+          raise(
+            Applitools::EyesIllegalArgument,
+            'Expected :browser to be an IRenderBrowserInfo instance!'
+          ) unless b.is_a? IRenderBrowserInfo
+          browser = b
         when 3
-          browser = Applitools::Selenium::RenderBrowserInfo.new.tap do |bi|
+          browser = Applitools::Selenium::DesktopBrowserInfo.new.tap do |bi|
             bi.viewport_size = Applitools::RectangleSize.new(args[0], args[1])
             bi.browser_type = args[2]
           end
@@ -58,11 +57,18 @@ module Applitools
         self
       end
 
+      def add_browsers(browsers)
+        browsers.each do |browser|
+          add_browser(browser)
+        end
+        self
+      end
+
       def add_device_emulation(device_name, orientation = Orientations::PORTRAIT)
         Applitools::ArgumentGuard.not_nil device_name, 'device_name'
         raise Applitools::EyesIllegalArgument, 'Wrong device name!' unless Devices.enum_values.include? device_name
         emu = Applitools::Selenium::ChromeEmulationInfo.new(device_name, orientation)
-        add_browser { |b| b.emulation_info(emu) }
+        add_browser emu
       end
 
       def viewport_size
@@ -73,6 +79,7 @@ module Applitools
         return from_browsers_info.viewport_size if from_browsers_info
         nil
       end
+
     end
   end
 end

data/lib/applitools/selenium/eyes_target_locator.rb

@@ -210,7 +210,7 @@ module Applitools::Selenium
         when String
           frame(name_or_id: frame_name_or_id)
         when Applitools::Selenium::Element
-          frame(frame_element: frame_name_or_id.reference)
+          frame(frame_element: frame_name_or_id)
         else
           Applitools::ArgumentGuard.raise_argument_error Applitools::EyesNoSuchFrame.new frame_name_or_id
         end

data/lib/applitools/selenium/orientations.rb

@@ -1,5 +1,21 @@
 # frozen_string_literal: true
 module Orientations
+  extend self
+  def const_missing(name)
+    puts 'Please prefer using the Orientation instead of Orientations(plural).'
+    Orientation.const_get(name)
+  end
+  def enum_values
+    Orientation.enum_values
+  end
+end
+
+module Orientation
+  extend self
   PORTRAIT = 'portrait'
   LANDSCAPE = 'landscape'
+
+  def enum_values
+    [PORTRAIT, LANDSCAPE]
+  end
 end

data/lib/applitools/selenium/selenium_eyes.rb

@@ -674,10 +674,13 @@ module Applitools::Selenium
 
         if platform_name && !platform_name.empty?
           os = platform_name
-          platform_version = Applitools::Utils::EyesSeleniumUtils.platform_version(underlying_driver).to_s
-          unless platform_version.empty?
+          platform_version = Applitools::Utils::EyesSeleniumUtils.platform_version(underlying_driver)
+          case platform_version
+          when String
             major_version = platform_version.split(/\./).first
             os << " #{major_version}"
+          when Array
+            os << " #{platform_version.first}"
           end
           logger.info "Setting OS: #{os}"
           app_env.os = os

data/lib/applitools/selenium/target.rb

@@ -312,7 +312,7 @@ module Applitools
         options = Applitools::Utils.extract_options! args
         unless options[:type]
           raise Applitools::EyesError,
-            'You should call Target.accessibility(region, region_type: type). The region_type option is required'
+            'You should call Target.accessibility(region, type: type). The :type option is required'
         end
         unless Applitools::AccessibilityRegionType.enum_values.include?(options[:type])
           raise Applitools::EyesIllegalArgument,

data/lib/applitools/selenium/visual_grid/chrome_emulation_info.rb

@@ -1,20 +1,55 @@
 # frozen_string_literal: true
-require 'applitools/selenium/visual_grid/emulation_base_info'
+require_relative 'emulation_base_info'
+require_relative 'i_render_browser_info'
 module Applitools
   module Selenium
-    class ChromeEmulationInfo < EmulationBaseInfo
-      attr_accessor :device_name
+    class ChromeEmulationInfo < IRenderBrowserInfo
+      DEFAULT_CONFIG = proc do
+        {
+            platform: 'linux',
+            browser_type: BrowserTypes::CHROME,
+            # size_mode: 'full-page',
+            viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
+        }
+      end
+      class << self
+        def default_config
+          DEFAULT_CONFIG.call
+        end
+      end
 
-      def initialize(device_name, screen_orientation)
-        super(screen_orientation)
-        self.device_name = device_name
+      # def device_name
+      #   emulation_info.device_name
+      # end
+      #
+      def initialize(*args)
+        super()
+        case args[0]
+        when String
+          self.emulation_info = EmulationInfo.new.tap do |ei|
+            ei.device_name = args[0]
+            ei.screen_orientation = args[1] || Orientations::PORTRAIT
+          end
+        when Hash
+          self.emulation_info = EmulationInfo.new.tap do |ei|
+            ei.device_name = args[0][:device_name]
+            ei.screen_orientation = args[0][:screen_orientation] || Orientations::PORTRAIT
+          end
+        end
       end
 
-      def json_data
-        {
-          deviceName: device_name,
-          screenOrientation: screen_orientation
-        }
+      private
+
+      class EmulationInfo < Applitools::Selenium::EmulationBaseInfo
+        enum_field :device_name, Devices.enum_values
+        enum_field :screen_orientation, Orientations.enum_values
+
+        def json_data
+          {
+              :'deviceName' => device_name,
+              :'screenOrientation' => screen_orientation
+          }
+        end
       end
     end
   end

data/lib/applitools/selenium/visual_grid/desktop_browser_info.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'applitools/selenium/browser_types'
+
+module Applitools
+  module Selenium
+    class DesktopBrowserInfo < IRenderBrowserInfo
+      DEFAULT_CONFIG = proc do
+        {
+            platform: 'linux',
+            browser_type: BrowserTypes::CHROME,
+            # size_mode: 'full-page',
+            viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
+        }
+      end
+
+      class << self
+        def default_config
+          DEFAULT_CONFIG.call
+        end
+      end
+
+      def initialize(options = {})
+        super()
+        if options[:width] && options[:height]
+          self.viewport_size = Applitools::RectangleSize.from_any_argument(width: options[:width], height: options[:height])
+        end
+        self.browser_type = options[:browser_type] if options[:browser_type]
+      end
+
+      def platform
+        case browser_type
+        when BrowserTypes::EDGE_LEGACY, BrowserTypes::EDGE_CHROMIUM, BrowserTypes::EDGE_CHROMIUM_ONE_VERSION_BACK
+          'windows'
+        else
+          'linux'
+        end
+      end
+
+    end
+  end
+end
+
+Applitools::Selenium::RenderBrowserInfo = Applitools::Selenium::DesktopBrowserInfo

data/lib/applitools/selenium/visual_grid/emulation_base_info.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 module Applitools
   module Selenium
-    class EmulationBaseInfo
-      extend Applitools::Helpers
-      attr_accessor :screen_orientation
-      abstract_attr_accessor :device_name
-
-      def initialize(screen_orientation)
-        self.screen_orientation = screen_orientation
-      end
+    class EmulationBaseInfo < Applitools::AbstractConfiguration
     end
   end
 end

data/lib/applitools/selenium/visual_grid/eyes_connector.rb

@@ -30,7 +30,7 @@ module Applitools
       def open(driver, browser_info)
         self.driver = driver
         self.browser_info = browser_info
-        self.device_name = browser_info && browser_info.emulation_info && browser_info.emulation_info.device_name
+        self.device_name = browser_info.device_name
         logger.info "opening EyesConnector for #{config.short_description} with viewport size: #{browser_info}"
         config.viewport_size = browser_info.viewport_size
         title

data/lib/applitools/selenium/visual_grid/i_render_browser_info.rb

@@ -0,0 +1,25 @@
+module Applitools
+  module Selenium
+    class IRenderBrowserInfo < ::Applitools::AbstractConfiguration
+
+      object_field :viewport_size, Applitools::RectangleSize
+      enum_field :browser_type, BrowserTypes.enum_values
+      string_field :platform
+      string_field :size_mode
+      string_field :baseline_env_name
+      object_field :emulation_info, Applitools::Selenium::EmulationBaseInfo
+      object_field :ios_device_info, Applitools::Selenium::EmulationBaseInfo
+
+      def device_name
+        return 'desktop' unless emulation_info || ios_device_info
+        return ios_device_info.device_name if ios_device_info
+        return emulation_info.device_name + ' (chrome emulation)' if emulation_info
+      end
+
+      def to_s
+        return "#{viewport_size} (#{browser_type})" unless emulation_info
+        "#{emulation_info.device_name} - #{emulation_info.screen_orientation}"
+      end
+    end
+  end
+end

data/lib/applitools/selenium/visual_grid/ios_device_info.rb

@@ -0,0 +1,44 @@
+require_relative 'ios_device_name'
+require_relative 'ios_screen_orientation'
+module Applitools
+  module Selenium
+    class IosDeviceInfo < IRenderBrowserInfo
+      DEFAULT_CONFIG = proc do
+        {
+            platform: 'ios',
+            browser_type: BrowserTypes::IOS_SAFARI,
+            # size_mode: 'full-page',
+            viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
+        }
+      end
+      class << self
+        def default_config
+          DEFAULT_CONFIG.call
+        end
+      end
+
+      def initialize(options = {})
+        super()
+        self.ios_device_info = EmulationInfo.new.tap do |ei|
+          ei.device_name = options[:device_name]
+          ei.screen_orientation = options[:screen_orientation] || options[:orientation] || IosScreenshotOrientation::PORTRAIT
+        end
+      end
+
+      private
+
+      class EmulationInfo < EmulationBaseInfo
+        enum_field :device_name, IosDeviceName.enum_values
+        enum_field :screen_orientation, IosScreenshotOrientation.enum_values
+
+        def json_data
+          {
+              name: device_name,
+              screenOrientation: screen_orientation,
+              version: 'latest'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/applitools/selenium/visual_grid/ios_device_name.rb

@@ -0,0 +1,30 @@
+module IosDeviceName
+  extend self
+  IPhone_11_Pro = 'iPhone 11 Pro'
+  IPhone_11_Pro_Max = 'iPhone 11 Pro Max'
+  IPhone_11 = 'iPhone 11'
+  IPhone_XR = 'iPhone XR'
+  IPhone_XS =  'iPhone Xs'
+  IPhone_X = 'iPhone X'
+  IPhone_8 = 'iPhone 8'
+  IPhone_7 = 'iPhone 7'
+  IPad_Pro_3 = 'iPad Pro (12.9-inch) (3rd generation)'
+  IPad_7 = 'iPad (7th generation)'
+  IPad_Air_2 = 'iPad Air (2nd generation)'
+
+  def enum_values
+    [
+      IPhone_11_Pro,
+      IPhone_11_Pro_Max,
+      IPhone_11,
+      IPhone_XR,
+      IPhone_XS,
+      IPhone_X,
+      IPhone_8,
+      IPhone_7,
+      IPad_Pro_3,
+      IPad_7,
+      IPad_Air_2
+    ]
+  end
+end

data/lib/applitools/selenium/visual_grid/ios_screen_orientation.rb

@@ -0,0 +1,14 @@
+module IosScreenshotOrientation
+  extend self
+  PORTRAIT ='portrait'
+  LANDSCAPE_LEFT = 'landscapeLeft'
+  LANDSCAPE_RIGHT = 'landscapeRight'
+
+  def enum_values
+    [
+      PORTRAIT,
+      LANDSCAPE_LEFT,
+      LANDSCAPE_RIGHT
+    ]
+  end
+end

data/lib/applitools/selenium/visual_grid/render_info.rb

@@ -3,7 +3,7 @@ module Applitools
   module Selenium
     class RenderInfo
       include Applitools::Jsonable
-      json_fields :width, :height, :sizeMode, :emulationInfo, :region, :selector
+      json_fields :width, :height, :sizeMode, :emulationInfo, :region, :selector, :IosDeviceInfo
       # , :region, :emulationInfo
 
       def json_data
@@ -13,6 +13,7 @@ module Applitools
           sizeMode: size_mode
         }
         result['emulationInfo'] = json_value(emulation_info) if emulation_info
+        result['iosDeviceInfo'] = json_value(ios_device_info) if ios_device_info
         result['region'] = json_value(region) if size_mode == 'region'
         result['selector'] = json_value(region) if size_mode == 'selector'
         result

data/lib/applitools/selenium/visual_grid/render_request.rb

@@ -8,7 +8,7 @@ module Applitools
       json_fields :renderId, :webhook, :url, :dom, :resources, :scriptHooks,
         :selectorsToFindRegionsFor, :sendDom, :agentId
 
-      json_fields :renderInfo, :browser
+      json_fields :renderInfo, :browser, :platform
 
       def initialize(*args)
         options = Applitools::Utils.extract_options! args

data/lib/applitools/selenium/visual_grid/render_task.rb

@@ -249,6 +249,7 @@ module Applitools
             r.size_mode = size_mode
             r.region = region_to_check
             r.emulation_info = running_test.browser_info.emulation_info if running_test.browser_info.emulation_info
+            r.ios_device_info = running_test.browser_info.ios_device_info if running_test.browser_info.ios_device_info
           end
 
           requests << Applitools::Selenium::RenderRequest.new(
@@ -257,7 +258,8 @@ module Applitools
             dom: dom,
             resources: request_resources,
             render_info: r_info,
-            browser: { name: running_test.browser_info.browser_type, platform: running_test.browser_info.platform },
+            browser: { name: running_test.browser_info.browser_type },
+            platform: { name: running_test.browser_info.platform },
             script_hooks: script_hooks,
             selectors_to_find_regions_for: region_selectors,
             send_dom: if running_test.eyes.configuration.send_dom.nil?

data/lib/applitools/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: false
 
 module Applitools
-  VERSION = '3.16.15'.freeze
+  VERSION = '3.17.3'.freeze
 end

data/lib/eyes_selenium.rb

@@ -20,8 +20,8 @@ end
 
 Applitools::Selenium.require_dir 'selenium/concerns'
 Applitools::Selenium.require_dir 'selenium/scripts'
-Applitools::Selenium.require_dir 'selenium/visual_grid'
 Applitools::Selenium.require_dir 'selenium'
+Applitools::Selenium.require_dir 'selenium/visual_grid'
 Applitools::Selenium.require_dir 'selenium/dom_capture'
 Applitools::Selenium.require_dir 'selenium/css_parser'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.16.15
+  version: 3.17.3
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eyes_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.16.15
+        version: 3.17.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.16.15
+        version: 3.17.3
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -150,9 +150,13 @@ files:
 - lib/applitools/selenium/viewport_screenshot.rb
 - lib/applitools/selenium/viewport_size.rb
 - lib/applitools/selenium/visual_grid/chrome_emulation_info.rb
+- lib/applitools/selenium/visual_grid/desktop_browser_info.rb
 - lib/applitools/selenium/visual_grid/emulation_base_info.rb
 - lib/applitools/selenium/visual_grid/eyes_connector.rb
-- lib/applitools/selenium/visual_grid/render_browser_info.rb
+- lib/applitools/selenium/visual_grid/i_render_browser_info.rb
+- lib/applitools/selenium/visual_grid/ios_device_info.rb
+- lib/applitools/selenium/visual_grid/ios_device_name.rb
+- lib/applitools/selenium/visual_grid/ios_screen_orientation.rb
 - lib/applitools/selenium/visual_grid/render_info.rb
 - lib/applitools/selenium/visual_grid/render_request.rb
 - lib/applitools/selenium/visual_grid/render_requests.rb

data/lib/applitools/selenium/visual_grid/render_browser_info.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-require 'applitools/selenium/browser_types'
-
-module Applitools
-  module Selenium
-    class RenderBrowserInfo < ::Applitools::AbstractConfiguration
-      DEFAULT_CONFIG = proc do
-        {
-          platform: 'linux',
-          browser_type: BrowserTypes::CHROME,
-          # size_mode: 'full-page',
-          viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
-        }
-      end
-      class << self
-        def default_config
-          DEFAULT_CONFIG.call
-        end
-      end
-
-      object_field :viewport_size, Applitools::RectangleSize
-      enum_field :browser_type, BrowserTypes.enum_values
-      string_field :platform
-      string_field :size_mode
-      string_field :baseline_env_name
-      object_field :emulation_info, Applitools::Selenium::EmulationBaseInfo
-
-      def platform
-        case browser_type
-        when BrowserTypes::EDGE_LEGACY, BrowserTypes::EDGE_CHROMIUM, BrowserTypes::EDGE_CHROMIUM_ONE_VERSION_BACK
-          'windows'
-        else
-          'linux'
-        end
-      end
-
-      def to_s
-        return "#{viewport_size} (#{browser_type})" unless emulation_info
-        "#{emulation_info.device_name} - #{emulation_info.screen_orientation}"
-      end
-    end
-  end
-end