eyes_selenium 3.17.2 → 3.17.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bbe944af9ea20d3d0afde5ae4e96b6b33d42e4e171e4bfb1d4dc0a4866e1056
-  data.tar.gz: 1cfc9ec471f9f02944189c0e442c59530e8ea37e8a586e04128191ef401316ed
+  metadata.gz: d1e1cc6d5f14b8764c463018f3f808431682bb3cb7feedacc1c4d078c8bf2856
+  data.tar.gz: 695298fd561d6c9a9736f16358135a3805417e18190daf6d9e349d47cc18a9db
 SHA512:
-  metadata.gz: d6e40409125ded5b69be42f291a23a7dc61b61c54420eaaa5ca397b279e8d4b33931b446ffdd2f03c20a28ebd73dfc2d9d9c21dd6fd8e65e81707f649d574c50
-  data.tar.gz: abd633ddeaef17adf5f937c00a149956b4b5587356bc2ec5467e88e4374f99716b47f7e964f35a1553776a5ac0e36267e51df947f7c8c05c365b874c31f496e1
+  metadata.gz: ac8f4829d35af73da8fbd52bf3fec733d8231575d8c8721c9fffc9ae23a22fcc3af3ddce45f90c0ec024dfb2202ac3bcb59201bcc54bcde3c60894e1618080bc
+  data.tar.gz: 02ba588e928af04592b2bdffa57be76adc4c19d235d63649e82f3fc46e707fa4afa8fff65665e2aee77c8e49a3da2c8c3a88972be0edea01b77d154f3fad1693

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'

data/lib/applitools/selenium/orientations.rb

@@ -1,5 +1,16 @@
 # 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'

data/lib/applitools/selenium/target.rb

@@ -21,7 +21,7 @@ module Applitools
 
       attr_accessor :element, :frames, :region_to_check, :coordinate_type, :options, :ignored_regions,
         :floating_regions, :frame_or_element, :regions, :layout_regions, :content_regions,
-        :strict_regions, :accessibility_regions
+        :strict_regions, :accessibility_regions, :convert_coordinates_block
 
       private :frame_or_element, :frame_or_element=
 
@@ -33,6 +33,7 @@ module Applitools
           script_hooks: { beforeCaptureScreenshot: '' }
         }
         self.regions = {}
+        self.convert_coordinates_block = nil
         reset_for_fullscreen
       end
 
@@ -374,6 +375,10 @@ module Applitools
         nil
       end
 
+      def convert_coordinates(&block)
+        self.convert_coordinates_block = block
+      end
+
       private
 
       def reset_for_fullscreen

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

@@ -7,7 +7,7 @@ module Applitools
       DEFAULT_CONFIG = proc do
         {
             platform: 'linux',
-            browser_type: BrowserTypes::CHROME,
+            browser_type: BrowserType::CHROME,
             # size_mode: 'full-page',
             viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
         }
@@ -18,22 +18,40 @@ module Applitools
         end
       end
 
+      object_field :emulation_info, Applitools::Selenium::EmulationBaseInfo
+
+      # def device_name
+      #   emulation_info.device_name
+      # end
+      #
       def initialize(*args)
-        super()
+        options = Applitools::Utils.extract_options!(args.dup)
+        super(options)
         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
+            ei.screen_orientation = args[1] || Orientation::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
+            ei.screen_orientation = args[0][:screen_orientation] || Orientation::PORTRAIT
           end
+        else
+          raise Applitools::EyesIllegalArgument, 'You should pass :device_name and :screen_orientation'
         end
       end
 
+      def to_s
+        "#{emulation_info.device_name} - #{emulation_info.screen_orientation}"
+      end
+
+      def device_name
+        emulation_info.device_name + ' (chrome emulation)'
+      end
+
+
       private
 
       class EmulationInfo < Applitools::Selenium::EmulationBaseInfo

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

@@ -7,7 +7,7 @@ module Applitools
       DEFAULT_CONFIG = proc do
         {
             platform: 'linux',
-            browser_type: BrowserTypes::CHROME,
+            browser_type: BrowserType::CHROME,
             # size_mode: 'full-page',
             viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
         }
@@ -20,7 +20,7 @@ module Applitools
       end
 
       def initialize(options = {})
-        super()
+        super
         if options[:width] && options[:height]
           self.viewport_size = Applitools::RectangleSize.from_any_argument(width: options[:width], height: options[:height])
         end
@@ -29,15 +29,17 @@ module Applitools
 
       def platform
         case browser_type
-        when BrowserTypes::EDGE_LEGACY, BrowserTypes::EDGE_CHROMIUM, BrowserTypes::EDGE_CHROMIUM_ONE_VERSION_BACK
+        when BrowserType::EDGE_LEGACY, BrowserType::EDGE_CHROMIUM, BrowserType::EDGE_CHROMIUM_ONE_VERSION_BACK
           'windows'
         else
           'linux'
         end
       end
 
+      def device_name
+        'desktop'
+      end
+
     end
   end
 end
-
-Applitools::Selenium::RenderBrowserInfo = Applitools::Selenium::DesktopBrowserInfo

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
@@ -54,7 +54,6 @@ module Applitools
           logger.error "Error retrieving coordinates for region #{e.region}"
           logger.error e.message
         end
-
         check_result = check_window_base(
           dummy_region_provider, timeout, match_data
         )

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

@@ -3,16 +3,18 @@ module Applitools
     class IRenderBrowserInfo < ::Applitools::AbstractConfiguration
 
       object_field :viewport_size, Applitools::RectangleSize
-      enum_field :browser_type, BrowserTypes.enum_values
+      enum_field :browser_type, BrowserType.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 initialize(options = {})
+        super()
+        self.baseline_env_name = options[:baseline_env_name] if options[:baseline_env_name]
+      end
 
       def to_s
-        return "#{viewport_size} (#{browser_type})" unless emulation_info
-        "#{emulation_info.device_name} - #{emulation_info.screen_orientation}"
+        return "#{viewport_size} (#{browser_type})"
       end
     end
   end

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

@@ -11,26 +11,36 @@ module Applitools
             viewport_size: Applitools::RectangleSize.from_any_argument(width: 0, height: 0)
         }
       end
+
+      object_field :ios_device_info, Applitools::Selenium::EmulationBaseInfo
+
       class << self
         def default_config
           DEFAULT_CONFIG.call
         end
       end
 
-
       def initialize(options = {})
-        super()
+        super
         self.ios_device_info = EmulationInfo.new.tap do |ei|
           ei.device_name = options[:device_name]
-          ei.screen_orientation = options[:screen_orientation] || IosScreenshotOrientations::PORTRAIT
+          ei.screen_orientation = options[:screen_orientation] || options[:orientation] || IosScreenOrientation::PORTRAIT
         end
       end
 
+      def to_s
+        "#{ios_device_info.device_name} - #{ios_device_info.screen_orientation}"
+      end
+
+      def device_name
+        ios_device_info.device_name
+      end
+
       private
 
       class EmulationInfo < EmulationBaseInfo
         enum_field :device_name, IosDeviceName.enum_values
-        enum_field :screen_orientation, IosScreenshotOrientations.enum_values
+        enum_field :screen_orientation, IosScreenOrientation.enum_values
 
         def json_data
           {

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

@@ -1,4 +1,4 @@
-module IosScreenshotOrientations
+module IosScreenOrientation
   extend self
   PORTRAIT ='portrait'
   LANDSCAPE_LEFT = 'landscapeLeft'

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require 'applitools/selenium/browser_types'
+# We should not break the API
+module Applitools
+  module Selenium
+    class RenderBrowserInfo < 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
+
+      object_field :ios_device_info, Applitools::Selenium::EmulationBaseInfo
+      object_field :emulation_info, Applitools::Selenium::EmulationBaseInfo
+
+      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
+        return 'ios' if ios_device_info
+        case browser_type
+        when BrowserType::EDGE_LEGACY, BrowserType::EDGE_CHROMIUM, BrowserType::EDGE_CHROMIUM_ONE_VERSION_BACK
+          'windows'
+        else
+          'linux'
+        end
+      end
+
+      def to_s
+        if emulation_info
+          "#{emulation_info.device_name} - #{emulation_info.screen_orientation}"
+        elsif ios_device_info
+          "#{ios_device_info.device_name} - #{ios_device_info.screen_orientation}"
+        end
+        "#{viewport_size} (#{browser_type})"
+      end
+
+      def device_name
+        if ios_device_info
+          return ios_device_info.device_name
+        elsif emulation_info
+          return emulation_info.device_name + ' (chrome emulation)'
+        end
+        'desktop'
+      end
+    end
+  end
+end

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

@@ -248,8 +248,11 @@ module Applitools
             r.height = running_test.browser_info.viewport_size.height
             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
+            if running_test.browser_info.respond_to?(:emulation_info) && running_test.browser_info.emulation_info
+              r.emulation_info = running_test.browser_info.emulation_info
+            elsif running_test.browser_info.respond_to?(:ios_device_info) && running_test.browser_info.ios_device_info
+              r.ios_device_info = running_test.browser_info.ios_device_info
+            end
           end
 
           requests << Applitools::Selenium::RenderRequest.new(

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

@@ -3,6 +3,15 @@
 module Applitools
   module Selenium
     class VgMatchWindowData < Applitools::MatchWindowData
+      CONVERT_COORDINATES = proc do |region, selector_regions|
+        begin
+          offset_region = selector_regions.last
+          new_location = region.location.offset_negative(Applitools::Location.new(offset_region['x'].to_i, offset_region['y'].to_i))
+          region.location = new_location
+        rescue
+          Applitools::EyesLogger.error("Failed to convert coordinates for #{region}")
+        end
+      end
       class RegionCoordinatesError < ::Applitools::EyesError
         attr_accessor :region
         def initialize(region, message)
@@ -109,7 +118,11 @@ module Applitools
             region = selector_regions[target.regions[region]]
             raise RegionCoordinatesError.new(r, region['error']) if region['error']
             retrieved_region = Applitools::Region.new(region['x'], region['y'], region['width'], region['height'])
-            result_region = r.padding_proc.call(retrieved_region) if r.padding_proc.is_a? Proc
+            result_region = if r.padding_proc.is_a? Proc
+              r.padding_proc.call(retrieved_region)
+            else
+              retrieved_region
+            end
             result << result_region
           end
         end
@@ -118,36 +131,54 @@ module Applitools
 
       def convert_ignored_regions_coordinates
         return unless @need_convert_ignored_regions_coordinates
+        if target.convert_coordinates_block.is_a?(Proc)
+          @ignored_regions.each { |r| target.convert_coordinates_block.call(r, selector_regions)}
+        end
         self.ignored_regions = @ignored_regions.map(&:with_padding).map(&:to_hash)
         @need_convert_ignored_regions_coordinates = false
       end
 
       def convert_floating_regions_coordinates
         return unless @need_convert_floating_regions_coordinates
+        if target.convert_coordinates_block.is_a?(Proc)
+          @floating_regions.each { |r| target.convert_coordinates_block.call(r, selector_regions)}
+        end
         self.floating_regions = @floating_regions
         @need_convert_floating_regions_coordinates = false
       end
 
       def convert_layout_regions_coordinates
         return unless @need_convert_layout_regions_coordinates
+        if target.convert_coordinates_block.is_a?(Proc)
+          @layout_regions.each { |r| target.convert_coordinates_block.call(r, selector_regions)}
+        end
         self.layout_regions = @layout_regions
         @need_convert_layout_regions_coordinates = false
       end
 
       def convert_strict_regions_coordinates
         return unless @need_convert_strict_regions_coordinates
+        if target.convert_coordinates_block.is_a?(Proc)
+          @strict_regions.each { |r| target.convert_coordinates_block.call(r, selector_regions)}
+        end
         self.strict_regions = @strict_regions
         @need_convert_strict_regions_coordinates = false
       end
 
       def convert_content_regions_coordinates
         return unless @need_convert_content_regions_coordinates
+        if target.convert_coordinates_block.is_a?(Proc)
+          @content_regions.each { |r| target.convert_coordinates_block.call(r, selector_regions)}
+        end
         self.content_regions = @content_regions
         @need_convert_content_regions_coordinates = false
       end
 
       def convert_accessibility_regions_coordinates
         return unless @need_convert_accessibility_regions_coordinates
+        if target.convert_coordinates_block.is_a?(Proc)
+          @accessibility_regions.each { |r| target.convert_coordinates_block.call(r, selector_regions)}
+        end
         self.accessibility_regions = @accessibility_regions
         @need_convert_accessibility_regions_coordinates = false
       end

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

@@ -154,6 +154,7 @@ module Applitools
             mod = Digest::SHA2.hexdigest(script_thread_result[:script_result])
 
             region_x_paths = get_regions_x_paths(target_to_check)
+
             render_task = RenderTask.new(
               "Render #{config.short_description} - #{tag}",
               script_thread_result[:result]['value'],
@@ -169,6 +170,10 @@ module Applitools
             )
           end
 
+          if size_mod == 'selector'
+            target_to_check.convert_coordinates(&Applitools::Selenium::VgMatchWindowData::CONVERT_COORDINATES)
+          end
+
           title = begin
             driver.title
           rescue StandardError => e

data/lib/applitools/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.17.2
+  version: 3.17.7
 platform: ruby
 authors:
 - Applitools Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-18 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.17.2
+        version: 3.17.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.17.2
+        version: 3.17.7
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +157,7 @@ files:
 - 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_browser_info.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
@@ -177,7 +178,7 @@ homepage: https://www.applitools.com
 licenses:
 - Applitools
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Applitools Ruby Selenium SDK
 test_files: []