eyes_core 3.14.3 → 3.14.4

data/lib/applitools/core/helpers.rb

@@ -1,5 +1,13 @@
+# frozen_string_literal: true
+
 module Applitools
   module Helpers
+    @environment_variables = {}
+
+    def self.environment_variables
+      @environment_variables
+    end
+
     def abstract_attr_accessor(*names)
       names.each do |method_name|
         instance_variable_set "@#{method_name}", nil
@@ -14,5 +22,21 @@ module Applitools
       end
       private method_name if is_private
     end
+
+    def environment_attribute(attribute_name, environment_variable)
+      class_eval do
+        Applitools::Helpers.environment_variables[environment_variable.to_sym] = ENV[environment_variable.to_s] if
+            ENV[environment_variable.to_s]
+        attr_accessor attribute_name
+        define_method(attribute_name) do
+          current_value = instance_variable_get "@#{attribute_name}".to_sym
+          return current_value if current_value
+          instance_variable_set(
+            "@#{attribute_name}".to_sym,
+            Applitools::Helpers.environment_variables[environment_variable.to_sym]
+          )
+        end
+      end
+    end
   end
 end

data/lib/applitools/core/location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'applitools/core/region'
 module Applitools
   class Location
@@ -44,7 +46,7 @@ module Applitools
       @y = y
     end
 
-    TOP_LEFT = Location.new(0, 0)
+    TOP_LEFT = Location.new(0, 0).freeze
 
     def to_s
       "#{x} x #{y}"
@@ -55,12 +57,28 @@ module Applitools
       @x == other.x && @y == other.y
     end
 
+    def !=(other)
+      !(self == other)
+    end
+
     alias eql? ==
 
     def hash
       @x.hash & @y.hash
     end
 
+    def negative_part
+      new_x = @x < 0 ? @x : 0
+      new_y = @y < 0 ? @y : 0
+      self.class.new(new_x.round, new_y.round)
+    end
+
+    def positive_part
+      new_x = @x < 0 ? 0 : @x
+      new_y = @y < 0 ? 0 : @y
+      self.class.new(new_x.round, new_y.round)
+    end
+
     def to_hash(options = {})
       options[:region] ? { left: left, top: top } : { x: x, y: y }
     end

data/lib/applitools/core/match_level_setter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::MatchLevelSetter
   def match_level_with_exact(value, exact_options = {})
     raise Applitools::EyesError unless Applitools::MATCH_LEVEL.keys.include? value

data/lib/applitools/core/match_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class MatchResult
     attr_reader :response_hash

data/lib/applitools/core/match_results.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class MatchResults
     attr_accessor :screenshot, :window_id, :as_expected

data/lib/applitools/core/match_single_check_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'match_window_data'
 module Applitools
   class MatchSingleCheckData < MatchWindowData

data/lib/applitools/core/match_single_task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 require_relative 'match_window_task'
 module Applitools

data/lib/applitools/core/match_window_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class MatchWindowData
     class << self
@@ -48,7 +50,11 @@ module Applitools
             'ScreenshotUrl' => nil,
             'Title' => nil,
             'IsPrimary' => false,
-            'Elapsed' => 0
+            'Elapsed' => 0,
+            'Location' => {
+              'X' => 0,
+              'Y' => 0
+            }
           },
           'Tag' => nil
         }
@@ -111,9 +117,15 @@ module Applitools
     def app_output=(value)
       Applitools::ArgumentGuard.is_a? value, 'value', Applitools::AppOutputWithScreenshot
       @app_output = value
-      hash_value = value.to_hash
-      %w(Screenshot64 ScreenshotUrl Title IsPrimary Elapsed).each do |key|
-        current_data['AppOutput'][key] = hash_value[key] unless hash_value[key].nil?
+      hash_value = Applitools::Utils.capitalize_hash_keys(value.to_hash)
+      [:Screenshot64, :ScreenshotUrl, :Title, :IsPrimary, :Elapsed, :Location, :DomUrl].each do |key|
+        next if hash_value[key].nil?
+        current_data['AppOutput'][key.to_s] = case hash_value[key]
+                                              when Hash
+                                                Hash[hash_value[key].map { |k, v| [k.to_s, v] }]
+                                              else
+                                                hash_value[key]
+                                              end
       end
     end
 
@@ -231,6 +243,16 @@ module Applitools
           Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
         )
         updated_region.to_hash
+        Applitools::FloatingRegion.new(
+          updated_region.left,
+          updated_region.top,
+          r.width,
+          r.height,
+          r.max_left_offset,
+          r.max_top_offset,
+          r.max_right_offset,
+          r.max_bottom_offset
+        ).padding(r.current_padding)
       end
       @need_convert_floating_regions_coordinates = false
     end

data/lib/applitools/core/match_window_task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 module Applitools
   class MatchWindowTask

data/lib/applitools/core/mouse_trigger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'applitools/core/trigger'
 module Applitools
   class MouseTrigger < Trigger

data/lib/applitools/core/padding_bounds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class PaddingBounds
     attr_accessor :padding_left, :padding_top, :padding_right, :padding_bottom

data/lib/applitools/core/rectangle_size.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require_relative 'hash_extension'
 module Applitools
+  # rubocop:disable Metrics/BlockLength
   RectangleSize = Struct.new(:width, :height) do
     include Applitools::HashExtension
     class << self
@@ -54,8 +57,21 @@ module Applitools
       self
     end
 
+    def square
+      width * height
+    end
+
+    def >(other)
+      square > other.square
+    end
+
+    def<(other)
+      square < other.square
+    end
+
     def to_hash
       to_h
     end
   end
+  # rubocop:enable Metrics/BlockLength
 end

data/lib/applitools/core/region.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'padding_bounds'
 module Applitools
   class Region
     extend Forwardable
-    attr_accessor :left, :top, :width, :height
+    attr_accessor :left, :top, :width, :height, :padding
 
     def_delegators :@padding, :padding_left, :padding_top, :padding_right, :padding_bottom
 
@@ -65,8 +67,7 @@ module Applitools
     def intersect(other)
       unless intersecting?(other)
         make_empty
-
-        return
+        return self
       end
 
       i_left = left >= other.left ? left : other.left
@@ -121,6 +122,16 @@ module Applitools
       width == region.width && height == region.height
     end
 
+    def ==(other)
+      return false unless other.is_a? self.class
+      size_location_match = left == other.left && top == other.top && width == other.width && height == other.height
+      padding_match = padding_left == other.padding_left &&
+        padding_top == other.padding_top &&
+        padding_right == other.padding_right &&
+        padding_bottom == other.padding_bottom
+      size_location_match && padding_match
+    end
+
     # Sets padding for a current region. If called without any argument, all paddings will be set to 0
     # @param padding[Applitools::PaddingBounds] represents paddings to be set for a region
     # @return [Applitools::Region]
@@ -131,6 +142,10 @@ module Applitools
       self
     end
 
+    def current_padding
+      @padding
+    end
+
     def with_padding
       Applitools::Region.from_location_size(
         Applitools::Location.new(left - padding_left, top - padding_top),
@@ -139,6 +154,7 @@ module Applitools
     end
 
     class << self
+      DEFAULT_SUBREGIONS_INTERSECTION = 4
       def sub_regions_with_fixed_size(container_region, sub_region)
         Applitools::ArgumentGuard.not_nil container_region, 'container_region'
         Applitools::ArgumentGuard.not_nil sub_region, 'sub_region'
@@ -155,7 +171,7 @@ module Applitools
 
         if sub_region_width == container_region.width && sub_region_height == container_region.height
           return Enumerator(1) do |y|
-            y << sub_region
+            y << [sub_region, EMPTY]
           end
         end
 
@@ -168,7 +184,7 @@ module Applitools
             current_left = container_region.left
             while current_left <= right
               current_left = (rught - sub_region_width) + 1 if current_left + sub_region_width > right
-              y << new(current_left, current_top, sub_region_width, sub_region_height)
+              y << [new(current_left, current_top, sub_region_width, sub_region_height), EMPTY]
               current_left += sub_region_width
             end
             current_top += sub_region_height
@@ -176,7 +192,7 @@ module Applitools
         end
       end
 
-      def sub_regions_with_varying_size(container_region, sub_region)
+      def sub_regions_with_varying_size(container_region, sub_region, intersection = DEFAULT_SUBREGIONS_INTERSECTION)
         Applitools::ArgumentGuard.not_nil container_region, 'container_region'
         Applitools::ArgumentGuard.not_nil sub_region, 'sub_region'
 
@@ -186,12 +202,14 @@ module Applitools
         current_top = container_region.top
         bottom = container_region.top + container_region.height
         right = container_region.left + container_region.width
+        top_intersect = 0
 
         Enumerator.new do |y|
           while current_top < bottom
             current_bottom = current_top + sub_region.height
             current_bottom = bottom if current_bottom > bottom
             current_left = container_region.left
+            left_intersect = 0
             while current_left < right
               current_right = current_left + sub_region.width
               current_right = right if current_right > right
@@ -199,11 +217,16 @@ module Applitools
               current_height = current_bottom - current_top
               current_width = current_right - current_left
 
-              y << new(current_left, current_top, current_width, current_height)
+              y << [
+                new(current_left, current_top, current_width, current_height),
+                new(left_intersect, top_intersect, left_intersect, top_intersect)
+              ]
 
-              current_left += sub_region.width
+              current_left += sub_region.width - intersection * 2
+              left_intersect = intersection if left_intersect.zero?
             end
-            current_top += sub_region.height
+            current_top += sub_region.height - intersection * 2
+            top_intersect = intersection if top_intersect.zero?
           end
         end
       end

data/lib/applitools/core/region_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class RegionProvider
     # Do we need it under Selenium module?

data/lib/applitools/core/screenshot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class Screenshot < Delegator
     class << self
@@ -41,6 +43,10 @@ module Applitools
       super
     end
 
+    def square
+      width * height
+    end
+
     class Datastream < self
       extend Forwardable
       def_delegators :header, :width, :height

data/lib/applitools/core/session.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class Session
     attr_reader :id, :url

data/lib/applitools/core/session_start_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class SessionStartInfo
     attr_accessor :app_id_or_name, :scenario_id_or_name

data/lib/applitools/core/test_results.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Applitools

data/lib/applitools/core/text_trigger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'applitools/core/trigger'
 module Applitools
   class TextTrigger < Trigger

data/lib/applitools/core/trigger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   class Trigger
     TRIGGER_TYPE = :unknown

data/lib/applitools/extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!visibility private
 class Module
   def alias_attribute(new_name, old_name)

data/lib/applitools/eyes_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module Applitools::EyesLogger
@@ -19,8 +21,8 @@ module Applitools::EyesLogger
     end
   end
 
-  MANDATORY_METHODS = [:debug, :info, :close].freeze
-  OPTIONAL_METHODS = [:warn, :error, :fatal].freeze
+  MANDATORY_METHODS = [:debug, :info, :warn, :error, :fatal, :close].freeze
+  OPTIONAL_METHODS = [].freeze
 
   def_delegators :@log_handler, *MANDATORY_METHODS
 

data/lib/applitools/method_tracer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!visibility private
 module Applitools::MethodTracer
   def self.included(base)

data/lib/applitools/rspec/target_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
 
 RSpec::Matchers.define :match_baseline do |expected, tag|

data/lib/applitools/sauce.rb

@@ -1,2 +1,3 @@
-require_relative 'capybara' if defined? Capybara
+# frozen_string_literal: true
+
 Applitools::Selenium.require_dir 'selenium/sauce'

data/lib/applitools/utils/eyes_selenium_utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 module Applitools::Utils
   module EyesSeleniumUtils
     extend self
@@ -77,6 +79,36 @@ module Applitools::Utils
       window.scrollTo(%{left}, %{top});
     JS
 
+    # IMPORTANT: Notice there's a major difference between scrollWidth
+    # and scrollHeight. While scrollWidth is the maximum between an
+    # element's width and its content width, scrollHeight might be
+    # smaller (!) than the clientHeight, which is why we take the
+    # maximum between them.
+
+    # @!visibility private
+    JS_COMPUTE_CONTENT_ENTIRE_SIZE = <<-JS.freeze
+      var scrollWidth = document.documentElement.scrollWidth;
+      var bodyScrollWidth = document.body.scrollWidth;
+      var totalWidth = Math.max(scrollWidth, bodyScrollWidth);
+      var clientHeight = document.documentElement.clientHeight;
+      var bodyClientHeight = document.body.clientHeight;
+      var scrollHeight = document.documentElement.scrollHeight;
+      var bodyScrollHeight = document.body.scrollHeight;
+      var maxDocElementHeight = Math.max(clientHeight, scrollHeight);
+      var maxBodyHeight = Math.max(bodyClientHeight, bodyScrollHeight);
+      var totalHeight = Math.max(maxDocElementHeight, maxBodyHeight);
+    JS
+
+    # @!visibility private
+    JS_RETURN_CONTENT_ENTIRE_SIZE = <<-JS.freeze
+      #{JS_COMPUTE_CONTENT_ENTIRE_SIZE}; return [totalWidth, totalHeight];
+    JS
+
+    # @!visibility private
+    JS_SCROLL_TO_BOTTOM_RIGHT = <<-JS.freeze
+      #{JS_COMPUTE_CONTENT_ENTIRE_SIZE}; window.scrollTo(totalWidth, totalHeight);
+    JS
+
     # @!visibility private
     JS_GET_CURRENT_TRANSFORM = <<-JS.freeze
       return document.body.style.transform;
@@ -100,12 +132,20 @@ module Applitools::Utils
       }());
     JS
 
+    # JS_GET_TRANSFORM_VALUE = <<-JS.freeze
+    #   document.documentElement.style['%{key}']
+    # JS
+    #
+    # JS_SET_TRANSFORM_VALUE = <<-JS.freeze
+    #   document.documentElement.style['%{key}'] = '%{value}'
+    # JS
+
     JS_GET_TRANSFORM_VALUE = <<-JS.freeze
-      document.documentElement.style['%{key}']
+      %{element}.style['%{key}']
     JS
 
     JS_SET_TRANSFORM_VALUE = <<-JS.freeze
-      document.documentElement.style['%{key}'] = '%{value}'
+      %{element}.style['%{key}'] = '%{value}'
     JS
 
     JS_TRANSFORM_KEYS = ['transform', '-webkit-transform'].freeze
@@ -127,23 +167,22 @@ module Applitools::Utils
 
     # true if test is running on mobile device
     def mobile_device?
-      return nil unless defined?(Appium::Driver)
-      return $driver if $driver && $driver.is_a?(Appium::Driver)
+      nil
     end
 
     # true if test is running on Android device
-    def android?(driver)
-      driver.respond_to?(:appium_device) && driver.appium_device == :android
+    def android?(_driver)
+      false
     end
 
     # true if test is running on iOS device
-    def ios?(driver)
-      driver.respond_to?(:appium_device) && driver.appium_device == :ios
+    def ios?(_driver)
+      false
     end
 
     # @param [Applitools::Selenium::Driver] driver
-    def platform_version(driver)
-      driver.respond_to?(:caps) && driver.caps[:platformVersion]
+    def platform_version(_driver)
+      nil
     end
 
     # @param [Applitools::Selenium::Driver] executor
@@ -207,8 +246,10 @@ module Applitools::Utils
     end
 
     def current_transforms(executor)
-      script =
-        "return { #{JS_TRANSFORM_KEYS.map { |tk| "'#{tk}': #{JS_GET_TRANSFORM_VALUE % { key: tk }}" }.join(', ')} };"
+      transform_script = JS_TRANSFORM_KEYS.map do |tk|
+        "'#{tk}': #{JS_GET_TRANSFORM_VALUE % { element: 'document.documentElement', key: tk }}"
+      end.join(', ')
+      script = "return { #{transform_script} };"
       executor.execute_script(script)
     end
 
@@ -219,12 +260,35 @@ module Applitools::Utils
     end
 
     def set_transforms(executor, value)
-      script = value.keys.map { |k| JS_SET_TRANSFORM_VALUE % { key: k, value: value[k] } }.join('; ')
+      script = value.keys.map do |k|
+        JS_SET_TRANSFORM_VALUE % { element: 'document.documentElement', key: k, value: value[k] }
+      end.join('; ')
       executor.execute_script(script)
     end
 
+    def set_element_transforms(executor, element, transform)
+      value = {}
+      JS_TRANSFORM_KEYS.map { |tk| value[tk] = transform }
+      script = value.keys.map do |k|
+        JS_SET_TRANSFORM_VALUE % { element: 'arguments[0]', key: k, value: value[k] }
+      end.join('; ')
+      executor.execute_script(script, element)
+    end
+
+    def current_element_transforms(executor, element)
+      transform_script = JS_TRANSFORM_KEYS.map do |tk|
+        "'#{tk}': #{JS_GET_TRANSFORM_VALUE % { element: 'arguments[0]', key: tk }}"
+      end.join(', ')
+      script = "return { #{transform_script} };"
+      executor.execute_script(script, element)
+    end
+
     def translate_to(executor, location)
-      set_current_transforms(executor, "translate(-#{location.x}px, -#{location.y}px)")
+      set_current_transforms(executor, "translate(#{-location.x}px, #{-location.y}px)")
+    end
+
+    def element_translate_to(executor, element, location)
+      set_element_transforms(executor, element, "translate(#{location.x}px, #{location.y}px)")
     end
 
     # @param [Applitools::Selenium::Driver] executor
@@ -334,12 +398,24 @@ module Applitools::Utils
     end
 
     def set_browser_size_by_viewport_size(executor, actual_viewport_size, required_size)
-      browser_size = Applitools::RectangleSize.from_any_argument(executor.manage.window.size)
+      browser_size = executor.manage.window.size
+      if browser_size.width.nil? || browser_size.height.nil?
+        raise(
+          Applitools::EyesError,
+          'driver.manage.window.size returned nil values. ' \
+          'Please ensure that you use the latest version of browser and its driver!'
+        )
+      end
+      browser_size = Applitools::RectangleSize.from_any_argument(browser_size)
       Applitools::EyesLogger.info "Current browser size: #{browser_size}"
       required_browser_size = browser_size + required_size - actual_viewport_size
       set_browser_size(executor, required_browser_size)
     end
 
+    def scroll_to_bottom_right(executor)
+      executor.execute_script(JS_SCROLL_TO_BOTTOM_RIGHT)
+    end
+
     private
 
     def with_timeout(timeout, &_block)