eyes_core 3.14.5 → 3.14.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 699fdaa843ddf61783611136c23a54748dbf14fb539f8277704560aec1987d4a
-  data.tar.gz: 865d01e90e8b4167874101bf0e5888af1f2e2cd10f6a37f58d4bca8635fad1b0
+  metadata.gz: 76b1b9533c6ab0e561eb14fa9b80aedfae91846720fd7559b504f097517b37d3
+  data.tar.gz: 355309c1236932eb25b426464de828db42bd609a093271817b0ad1860d97d2d0
 SHA512:
-  metadata.gz: 7ca423cd9645a0ea4e67077600aae06a377567063e5ac6b5e580da4cf0137bbc30ff2073ace51ceee44e6ef55c7790dc020e2ba73a5e336f9ac28137159cb33d
-  data.tar.gz: eb4acf47dd5d0d6cd14172359c287d768b769121a14315c7d7135e9c2065039222a48ffc49c366db52a84007abdf2551a456cc2cb605772558b38a1d475df8f4
+  metadata.gz: af2aea48847d239d1f4c832b8168e821b1d1aa87841dd2ec9eb647f9f43e3c837a52f9a740dc11bdd765c1ff6eb342e146a55a1c4ebf16bdd71cfbf7308e7fa6
+  data.tar.gz: e90c28eef3e5b7f9cf8f5efa72eeb3dc6279675b893dd1a4858d3854f145a173e6c0bbd97f297e5b86cf4f85eee37c83c8d335ae34b62479aa1570f50b33a182

data/lib/applitools/appium/driver.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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
+  end
+end

data/lib/applitools/appium/eyes.rb

@@ -1,12 +1,115 @@
 # frozen_string_literal: false
 
-module Applitools::Appium
-  module Eyes
-    def perform_driver_settings_for_appium_driver
-      self.region_visibility_strategy = Applitools::Selenium::NopRegionVisibilityStrategy.new
-      self.force_driver_resolution_as_viewport_size = true
+class Applitools::Appium::Eyes < Applitools::Selenium::Eyes
+  def perform_driver_settings_for_appium_driver
+    self.region_visibility_strategy = Applitools::Selenium::NopRegionVisibilityStrategy.new
+    self.force_driver_resolution_as_viewport_size = true
+  end
+
+  def initialize(*args)
+    super
+    self.dont_get_title = true
+  end
+
+  private :perform_driver_settings_for_appium_driver
+
+  def check(name, target)
+    logger.info "check(#{name}) is called"
+    self.tag_for_debug = name
+    Applitools::ArgumentGuard.one_of? target, 'target', [Applitools::Selenium::Target, Applitools::Appium::Target]
+
+    return check_native(name, target) if native_app?
+    super
+  end
+
+  attr_accessor :eyes_element_to_check, :region_provider
+  private :eyes_element_to_check, :eyes_element_to_check=, :region_provider, :region_provider=
+
+  def check_native(name, target)
+    logger.info "check_native(#{name}) is called"
+    update_scaling_params
+    target_to_check = target.finalize
+    match_data = Applitools::MatchWindowData.new
+    match_data.tag = name
+    timeout = target_to_check.options[:timeout] || USE_DEFAULT_MATCH_TIMEOUT
+
+    eyes_element = target_to_check.region_to_check.call(driver)
+    self.eyes_element_to_check = eyes_element
+    region_provider = Applitools::Appium::RegionProvider.new(driver, eyes_element)
+    match_data.read_target(target_to_check, driver)
+
+    check_window_base(
+      region_provider, timeout, match_data
+    )
+  end
+
+  def native_app?
+    return true if driver.current_context == 'NATIVE_APP'
+    false
+  end
+
+  def capture_screenshot
+    logger.info 'Getting screenshot (capture_screenshot() has been invoked)'
+    case eyes_element_to_check
+    when Applitools::Region
+      viewport_screenshot
+    when Selenium::WebDriver::Element, Applitools::Selenium::Element
+      element_screenshot
     end
+  end
+
+  def get_app_output_with_screenshot(*args)
+    super do |screenshot|
+      if scale_provider
+        scaled_image = scale_provider.scale_image(screenshot.image)
+        self.screenshot = Applitools::Appium::Screenshot.new(
+          Applitools::Screenshot.from_image(
+            case scaled_image
+            when ChunkyPNG::Image
+              scaled_image
+            when Applitools::Screenshot::Datastream
+              scaled_image.image
+            else
+              raise Applitools::EyesError.new('Unknown image format after scale!')
+            end
+          )
+        )
+      end
+    end
+  end
+
+  def dom_data
+    {}
+  end
+
+  def check_window(tag = nil, match_timeout = USE_DEFAULT_MATCH_TIMEOUT)
+    target = Applitools::Appium::Target.window.tap do |t|
+      t.timeout(match_timeout)
+    end
+    check(tag, target)
+  end
+
+  def check_region(*args)
+    options = { timeout: USE_DEFAULT_MATCH_TIMEOUT, tag: nil }.merge! Applitools::Utils.extract_options!(args)
+    target = Applitools::Appium::Target.new.region(*args).timeout(options[:match_timeout])
+    check(options[:tag], target)
+  end
+
+  private
+
+  def viewport_screenshot
+    logger.info 'Viewport screenshot requested...'
+    self.screenshot = Applitools::Appium::Screenshot.new(
+      Applitools::Screenshot.from_datastream(driver.screenshot_as(:png))
+    )
+  end
 
-    private :perform_driver_settings_for_appium_driver
+  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)
+      )
+    )
   end
 end

data/lib/applitools/appium/initialize_1.9.rb

@@ -13,10 +13,6 @@ module Applitools::Appium
         alias_method :super_current_scroll_position, :current_scroll_position
         include Applitools::Appium::Utils
       end
-
-      Applitools::Selenium::Eyes.class_eval do
-        include Applitools::Appium::Eyes
-      end
     end
   end
 end

data/lib/applitools/appium/initialize_2.0.rb

@@ -8,10 +8,6 @@ module Applitools::Appium
         prepend Applitools::Appium::Utils
         extend self
       end
-
-      Applitools::Selenium::Eyes.class_eval do
-        prepend Applitools::Appium::Eyes
-      end
     end
   end
 end

data/lib/applitools/appium/region_provider.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Applitools
+  module Appium
+    class RegionProvider
+      attr_accessor :driver, :eye_region, :coordinate_type
+
+      def initialize(driver, eye_region)
+        self.driver = driver
+        self.eye_region = eye_region
+      end
+
+      def region
+        return Applitools::Region::EMPTY if
+            [::Selenium::WebDriver::Element, Applitools::Selenium::Element].include? eye_region.class
+        region = driver.session_capabilities['viewportRect']
+        Applitools::Region.new(
+          region['left'],
+          region['top'],
+          region['width'],
+          region['height']
+        )
+      end
+    end
+  end
+end

data/lib/applitools/appium/screenshot.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Applitools
+  module Appium
+    class Screenshot < Applitools::EyesScreenshot
+      def sub_screenshot(region, _coordinate_type, _throw_if_clipped = false, _force_nil_if_clipped = false)
+        self.class.new(
+          Applitools::Screenshot.from_image(
+            image.crop(region.x, region.y, region.width, region.height)
+          )
+        )
+      end
+    end
+  end
+end

data/lib/applitools/appium/target.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Applitools
+  module Appium
+    class Target
+      include Applitools::FluentInterface
+
+      attr_accessor :region_to_check, :options
+
+      class << self
+        def window
+          new
+        end
+
+        def region(*args)
+          new.region(*args)
+        end
+      end
+
+      def initialize
+        self.region_to_check = proc { Applitools::Region::EMPTY }
+        self.options = {}
+      end
+
+      def region(*args)
+        self.region_to_check = case args.first
+                               when ::Selenium::WebDriver::Element
+                                 proc { args.first }
+                               else
+                                 proc do |driver|
+                                   driver.find_element(*args)
+                                 end
+                               end
+        self
+      end
+
+      def finalize
+        self
+      end
+    end
+  end
+end

data/lib/applitools/appium/utils.rb

@@ -3,19 +3,18 @@
 module Applitools::Appium
   module 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)
+    def mobile_device?(driver)
+      defined?(Appium::Driver) && driver.respond_to?(:appium_driver) && driver.appium_driver
     end
 
     # true if test is running on Android device
     def android?(driver)
-      driver.respond_to?(:appium_device) && driver.appium_device == :android
+      driver.respond_to?(:device_is_android?) && driver.device_is_android?
     end
 
     # true if test is running on iOS device
     def ios?(driver)
-      driver.respond_to?(:appium_device) && driver.appium_device == :ios
+      driver.respond_to?(:device_is_ios?) && driver.device_is_ios?
     end
 
     # @param [Applitools::Selenium::Driver] driver
@@ -23,17 +22,14 @@ module Applitools::Appium
       driver.respond_to?(:caps) && driver.caps[:platformVersion]
     end
 
-    # def current_position
-    #   result = nil
-    #   begin
-    #     logger.info 'current_position()'
-    #     result = Applitools::Utils::EyesSeleniumUtils.current_scroll_position(executor)
-    #     logger.info "Current position: #{result}"
-    #   rescue Applitools::EyesDriverOperationException
-    #     result = Applitools::Location::TOP_LEFT
-    #   end
-    #   result
-    # 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
+      Applitools::Selenium::Eyes::UNKNOWN_DEVICE_PIXEL_RATIO
+    end
 
     def current_scroll_position(driver)
       super

data/lib/applitools/core/argument_guard.rb

@@ -34,6 +34,12 @@ module Applitools
         " instance of #{klass}, but got #{param.class.name} instead"
     end
 
+    def one_of?(param, param_name, klasses)
+      return true if klasses.detect { |a| param.is_a? a }
+      raise Applitools::EyesIllegalArgument.new "Expected #{param_name} to be" \
+        " instance of one of this classes: [#{klass}], but got #{param.class.name} instead"
+    end
+
     def raise_argument_error(error)
       raise Applitools::EyesIllegalArgument.new error
     end

data/lib/applitools/utils/eyes_selenium_utils.rb

@@ -166,7 +166,7 @@ module Applitools::Utils
     MAX_DIFF = 3
 
     # true if test is running on mobile device
-    def mobile_device?
+    def mobile_device?(_driver)
       nil
     end
 

data/lib/applitools/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_core
 version: !ruby/object:Gem::Version
-  version: 3.14.5
+  version: 3.14.6
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oily_png
@@ -134,9 +134,13 @@ files:
 - ext/eyes_core/extconf.rb
 - ext/eyes_core/eyes_core.c
 - ext/eyes_core/eyes_core.h
+- 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/region_provider.rb
+- lib/applitools/appium/screenshot.rb
+- lib/applitools/appium/target.rb
 - lib/applitools/appium/utils.rb
 - lib/applitools/calabash/calabash_element.rb
 - lib/applitools/calabash/calabash_screenshot_provider.rb