eyes_appium 3.16.15 → 3.16.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0970f43b3ff2defd33a4e30b28256dd661f29fa701cbe69390f8bf501ed527ea'
-  data.tar.gz: c2306285a527ae1e56d939b200ae16f8ea52d8db7bdbf3b183d49f7e3b08f48c
+  metadata.gz: a72a3916818c3f7df9bb9539c5ae5e425ab21a4eceae8709654833719074110c
+  data.tar.gz: 6ad28f38fc32a47807ab1255504fd37301a7a964100185ff5aeb31a95b65d6bd
 SHA512:
-  metadata.gz: 61cd0579986df5f0453ba062ffe8ac351554ff1d5f2111ea4d87d5dac457eeae1fffb8a044d4aed0ecc4a94c5af56dc7588f9028eb1d0e8d011e2151a8a9540e
-  data.tar.gz: 29956067a8bfbe493460107331507a805f547fe4457bf6d783965a9734f64b47f566309efe70c1f817b4d46b9f8051d332479c28150e7b70ffeb11bc9b958fb4
+  metadata.gz: b11c47d661f8815724ef8eb9ade6ce176103f7446d5556b46cf1fd2b3be879c1f9762f68cece87e79572aaf90003b458ca2151831bd1109d097a61845b91c794
+  data.tar.gz: ea86ba7eb7a9b8947bf674c5c261749ec5d8aff1e627d9069440b7268207c108d488049e723c82e875dc8583189cad1a82ba986c24199148fbcaf6ba3343a193

data/lib/applitools/appium/android_screenshot.rb

@@ -0,0 +1,21 @@
+require_relative './screenshot.rb'
+module Applitools
+  module Appium
+    class AndroidScreenshot < Applitools::Appium::Screenshot
+      def convert_region_location(region, from, to)
+        # converted_size = region.size.dup.scale_it!(1 / device_pixel_ratio)
+        # converted_location = region.location.dup.offset_negative(Applitools::Location.new(0, status_bar_height)).scale_it!(1 / device_pixel_ratio)
+        # Applitools::Region.from_location_size(converted_location, converted_size)
+        Applitools::Region.from_location_size(
+          convert_location(region.location, nil, nil),
+          region.size
+        ).scale_it!(1.to_f / device_pixel_ratio)
+      end
+
+      def convert_location(location, _from, _to)
+        location.offset_negative(Applitools::Location.new(0, status_bar_height))
+      end
+
+    end
+  end
+end

data/lib/applitools/appium/driver.rb

@@ -2,10 +2,11 @@
 
 module Applitools::Appium
   class Driver < Applitools::Selenium::Driver
-    attr_accessor :appium_driver
     def initialize(eyes, options)
-      self.appium_driver = options.delete(:appium_driver)
       super(eyes, options)
     end
+    module AppiumLib
+      extend self
+    end
   end
 end

data/lib/applitools/appium/eyes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: false
 
 class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
+  attr_accessor :status_bar_height
   def perform_driver_settings_for_appium_driver
     self.region_visibility_strategy = Applitools::Selenium::NopRegionVisibilityStrategy.new
     self.force_driver_resolution_as_viewport_size = true
@@ -11,6 +12,7 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
     self.dont_get_title = true
     self.runner = Applitools::ClassicRunner.new
     self.base_agent_id = "eyes.appium.ruby/#{Applitools::VERSION}".freeze
+    self.status_bar_height = 0
   end
 
   private :perform_driver_settings_for_appium_driver
@@ -76,7 +78,7 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
     result = super do |screenshot|
       if scale_provider
         scaled_image = scale_provider.scale_image(screenshot.image)
-        self.screenshot = Applitools::Appium::Screenshot.new(
+        self.screenshot = screenshot_class.new(
           Applitools::Screenshot.from_image(
             case scaled_image
             when ChunkyPNG::Image
@@ -86,7 +88,9 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
             else
               raise Applitools::EyesError.new('Unknown image format after scale!')
             end
-          )
+          ),
+          status_bar_height: Applitools::Utils::EyesSeleniumUtils.status_bar_height(driver),
+          device_pixel_ratio: Applitools::Utils::EyesSeleniumUtils.device_pixel_ratio(driver)
         )
       end
     end
@@ -115,17 +119,22 @@ class Applitools::Appium::Eyes < Applitools::Selenium::SeleniumEyes
 
   def viewport_screenshot
     logger.info 'Viewport screenshot requested...'
-    self.screenshot = Applitools::Appium::Screenshot.new(
+
+    self.screenshot = screenshot_class.new(
       Applitools::Screenshot.from_datastream(driver.screenshot_as(:png))
     )
   end
 
   def element_screenshot
     logger.info 'Element screenshot requested...'
-    self.screenshot = Applitools::Appium::Screenshot.new(
-      Applitools::Screenshot.from_datastream(
-        driver.element_screenshot_as(eyes_element_to_check, :png)
-      )
+    self.screenshot = screenshot_class.new(
+      Applitools::Screenshot.from_datastream(driver.element_screenshot_as(eyes_element_to_check, :png))
     )
   end
+
+  def screenshot_class
+    return Applitools::Appium::IosScreenshot if Applitools::Utils::EyesSeleniumUtils.ios?(Applitools::Appium::Driver::AppiumLib)
+    return Applitools::Appium::AndroidScreenshot if Applitools::Utils::EyesSeleniumUtils.android?(Applitools::Appium::Driver::AppiumLib)
+    raise Applitools::EyesError, 'Unknown device type'
+  end
 end

data/lib/applitools/appium/ios_screenshot.rb

@@ -0,0 +1,10 @@
+require_relative './screenshot.rb'
+module Applitools
+  module Appium
+    class IosScreenshot < Applitools::Appium::Screenshot
+      def convert_location(location, _from, _to)
+        location.offset_negative(Applitools::Location.new(0, status_bar_height))
+      end
+    end
+  end
+end

data/lib/applitools/appium/screenshot.rb

@@ -3,6 +3,16 @@
 module Applitools
   module Appium
     class Screenshot < Applitools::EyesScreenshot
+
+      attr_reader :status_bar_height, :device_pixel_ratio
+
+      def initialize(*args)
+        options = Applitools::Utils.extract_options!(args)
+        @status_bar_height = options[:status_bar_height] || 0
+        @device_pixel_ratio = options[:device_pixel_ratio] || 1
+        super
+      end
+
       def sub_screenshot(region, _coordinate_type, _throw_if_clipped = false, _force_nil_if_clipped = false)
         self.class.new(
           Applitools::Screenshot.from_image(
@@ -10,6 +20,11 @@ module Applitools
           )
         )
       end
+
+      def convert_location(location, _from, _to)
+        raise 'Applitools::Appium::Screenshot is an abstract class.' \
+          ' You should implement :convert_location method in a descendant class.'
+      end
     end
   end
 end

data/lib/applitools/appium/target.rb

@@ -4,8 +4,7 @@ module Applitools
   module Appium
     class Target
       include Applitools::FluentInterface
-
-      attr_accessor :region_to_check, :options
+      attr_accessor :region_to_check, :options, :ignored_regions, :floating_regions, :layout_regions, :content_regions, :strict_regions, :accessibility_regions
 
       class << self
         def window
@@ -19,6 +18,12 @@ module Applitools
 
       def initialize
         self.region_to_check = proc { Applitools::Region::EMPTY }
+        self.ignored_regions = []
+        self.floating_regions = []
+        self.layout_regions = []
+        self.content_regions = []
+        self.strict_regions = []
+        self.accessibility_regions = []
         self.options = {}
       end
 
@@ -34,9 +39,170 @@ module Applitools
         self
       end
 
+      def ignore(*args)
+        requested_padding = if args.last.is_a? Applitools::PaddingBounds
+                              args.pop
+                            else
+                              Applitools::PaddingBounds::ZERO_PADDING
+                            end
+        ignored_regions <<  case (first_argument = args.first)
+                            when ::Selenium::WebDriver::Element
+                              proc do
+                                Applitools::Region
+                                  .from_location_size(first_argument.location, first_argument.size)
+                                  .padding(requested_padding)
+                              end
+                            when Applitools::Region
+                              result = first_argument.padding(requested_padding)
+                              if Applitools::Utils::EyesSeleniumUtils.ios?(Applitools::Appium::Driver::AppiumLib)
+                                def result.converted?
+                                  true
+                                end
+                              end
+                              result
+                            else
+                              proc do |driver|
+                                element = driver.find_element(*args)
+                                Applitools::Region
+                                  .from_location_size(element.location, element.size)
+                                  .padding(requested_padding)
+                              end
+                            end
+        self
+      end
+
+      def floating(*args)
+        value = case args.first
+                when Applitools::FloatingRegion
+                  args.first
+                when Applitools::Region
+                  result = Applitools::FloatingRegion.any(*args)
+                  if Applitools::Utils::EyesSeleniumUtils.ios?(Applitools::Appium::Driver::AppiumLib)
+                    def result.converted?
+                      true
+                    end
+                  end
+                  result
+                when ::Selenium::WebDriver::Element
+                  args_dup = args.dup
+                  Applitools::FloatingRegion.any(*args_dup)
+                else
+                  proc do |driver|
+                    args_dup = args.dup
+                    region = driver.find_element(args_dup.shift, args_dup.shift)
+                    Applitools::FloatingRegion.any(
+                        region, *args_dup
+                    )
+                  end
+                end
+        floating_regions << value
+        self
+      end
+
+      def layout
+        return match_level(Applitools::MatchLevel::LAYOUT) if args.empty?
+        region = process_region(*args)
+        layout_regions << region
+      self
+
+      end
+
+      def content(*args)
+        return match_level(Applitools::MatchLevel::CONTENT) if args.empty?
+        region = process_region(*args)
+        content_regions << region
+        self
+      end
+
+      def strict(*args)
+        return match_level(Applitools::MatchLevel::STRICT) if args.empty?
+        region = process_region(*args)
+        strict_regions << region
+        self
+      end
+
+      def exact(*args)
+        match_level(Applitools::MatchLevel::EXACT, *args)
+      end
+
+      def accessibility(*args)
+        options = Applitools::Utils.extract_options! args
+        unless options[:type]
+          raise Applitools::EyesError,
+                'You should call Target.accessibility(region, type: type). The region_type option is required'
+        end
+        unless Applitools::AccessibilityRegionType.enum_values.include?(options[:type])
+          raise Applitools::EyesIllegalArgument,
+                "The region type should be one of [#{Applitools::AccessibilityRegionType.enum_values.join(', ')}]"
+        end
+
+        accessibility_regions << case args.first
+                                 when ::Selenium::WebDriver::Element
+                                   element = args.first
+                                   Applitools::AccessibilityRegion.new(
+                                     element,
+                                     options[:type]
+                                   )
+                                 when Applitools::Region
+                                   result = Applitools::AccessibilityRegion.new(
+                                       args.first, options[:type]
+                                   )
+                                   if Applitools::Utils::EyesSeleniumUtils.ios?(Applitools::Appium::Driver::AppiumLib)
+                                     def result.converted?
+                                       true
+                                     end
+                                   end
+                                   result
+                                 when String
+                                   proc do |driver|
+                                     element = driver.find_element(name_or_id: args.first)
+                                     Applitools::AccessibilityRegion.new(
+                                       element,
+                                       options[:type]
+                                     )
+                                   end
+                                 else
+                                   proc do |driver|
+                                     elements = driver.find_elements(*args)
+                                     elements.map do |e|
+                                       Applitools::AccessibilityRegion.new(
+                                         e,
+                                         options[:type]
+                                       )
+                                     end
+                                   end
+                                 end
+        self
+      end
+
       def finalize
         self
       end
+
+      private
+
+      def process_region(*args)
+        r = args.first
+        case r
+        when ::Selenium::WebDriver::Element
+          proc do |driver|
+            Applitools::Region.from_location_size(r.location, r.size)
+          end
+        when Applitools::Region
+          if Applitools::Utils::EyesSeleniumUtils.ios?(Applitools::Appium::Driver::AppiumLib)
+            def r.converted?
+              true
+            end
+          end
+          r
+        else
+          proc do |driver|
+            element = driver.find_element(*args)
+            Applitools::Region.from_location_size(element.location, element.size)
+          end
+        end
+      end
+
     end
   end
 end

data/lib/applitools/appium/utils.rb

@@ -4,7 +4,9 @@ module Applitools::Appium
   module Utils
     # true if test is running on mobile device
     def mobile_device?(driver)
-      defined?(Appium::Driver) && driver.respond_to?(:appium_driver) && driver.appium_driver
+      defined?(Appium::Driver) &&
+          defined?(Applitools::Appium::Driver::AppiumLib) &&
+          Applitools::Appium::Driver::AppiumLib
     end
 
     # true if test is running on Android device
@@ -19,18 +21,26 @@ module Applitools::Appium
 
     # @param [Applitools::Selenium::Driver] driver
     def platform_version(driver)
-      driver.respond_to?(:caps) && driver.caps[:platformVersion]
+      driver.respond_to?(:platform_version) && driver.platform_version
     end
 
     # @param [Applitools::Selenium::Driver] executor
     def device_pixel_ratio(executor)
-      if executor.respond_to? :session_capabilities
-        session_info = executor.session_capabilities
-        return session_info['pixelRatio'].to_f if session_info['pixelRatio']
-      end
+      session_info = session_capabilities(executor)
+      return session_info['pixelRatio'].to_f if session_info['pixelRatio']
       Applitools::Selenium::Eyes::UNKNOWN_DEVICE_PIXEL_RATIO
     end
 
+    def status_bar_height(executor)
+      session_info = session_capabilities(executor)
+      return session_info['statBarHeight'].to_i if session_info['statBarHeight']
+      0
+    end
+
+    def session_capabilities(executor)
+       executor.session_capabilities if executor.respond_to? :session_capabilities
+    end
+
     def current_scroll_position(driver)
       super
     rescue

data/lib/applitools/version.rb

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

data/lib/eyes_appium.rb

@@ -22,9 +22,13 @@ else
 end
 
 if defined? Appium::Driver
-  Appium::Driver.class_eval do
+  Appium::Core::Base::Driver.class_eval do
     def driver_for_eyes(eyes)
-      Applitools::Appium::Driver.new(eyes, driver: driver || start_driver, is_mobile_device: true, appium_driver: self)
+      if defined? Appium
+        Appium.promote_appium_methods Applitools::Appium::Driver::AppiumLib
+      end
+      Applitools::Appium::Driver.new(eyes, driver: self, is_mobile_device: true)
     end
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_appium
 version: !ruby/object:Gem::Version
-  version: 3.16.15
+  version: 3.16.16
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eyes_selenium
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.16.15
+        version: 3.16.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.16.15
+        version: 3.16.16
 - !ruby/object:Gem::Dependency
   name: appium_lib
   requirement: !ruby/object:Gem::Requirement
@@ -45,10 +45,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/applitools/appium/android_screenshot.rb
 - lib/applitools/appium/driver.rb
 - lib/applitools/appium/eyes.rb
 - lib/applitools/appium/initialize_1.9.rb
 - lib/applitools/appium/initialize_2.0.rb
+- lib/applitools/appium/ios_screenshot.rb
 - lib/applitools/appium/region_provider.rb
 - lib/applitools/appium/screenshot.rb
 - lib/applitools/appium/target.rb