eyes_appium 3.14.6 → 3.14.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4343ca9e6659a07c3983445b01ba7fb035cca25ccc468c21e248b35c949457f
-  data.tar.gz: c3956f3a199756c5567e9e1adcae4bfe5de6aeed29d11b9fbc4e0ea810ce6b90
+  metadata.gz: 8ae5c6b84c2efcceca2be48b2753654fc11daf5c10106b67a98562d40a4a7212
+  data.tar.gz: 897a8cd6f6306f87e743e692a1e5de9aae4494ff56f79344eebe99268ee71e71
 SHA512:
-  metadata.gz: 4d7ecf5d2b57bc936340deeb3b6481cf29d32749b99fdce493f6e42afdcb758f682f2615f37534687b7ccbdfb2548cfecab5a3adbcac0bff5ac74ecc4623a470
-  data.tar.gz: a14ea0ccb19d651dadb5ff056a86c6cc7814f48a33d5c6d9ba71323b527c047e13ec86937efcf3a006d91dc9694db39660fcede8807699fe85443aacaa862395
+  metadata.gz: bb45150ea47662d44b54fe290e3a093170c75c698b864236a7d5089dc5201e44ae420045408ec95b8d29cff9e76fa5c07bcf2c50aecb7083d92fac035f797acf
+  data.tar.gz: 41d71ee8e1b1c4e7253bd5133146fd5e989c36b596d4a8398ea13a9f46e836e88678d2e87af9e506c70898a015456f083f57f43a05468c7220e58ce1586bb994

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: false
+
+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
+
+  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

@@ -0,0 +1,18 @@
+# frozen_string_literal: false
+
+module Applitools::Appium
+  module Init19
+    extend self
+
+    def init
+      Applitools::Utils::EyesSeleniumUtils.module_eval do
+        alias_method :super_mobile_device?, :mobile_device?
+        alias_method :super_android?, :android?
+        alias_method :super_ios?, :ios?
+        alias_method :super_platform_version, :platform_version
+        alias_method :super_current_scroll_position, :current_scroll_position
+        include Applitools::Appium::Utils
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: false
+
+module Applitools::Appium
+  module Init20
+    extend self
+    def init
+      Applitools::Utils::EyesSeleniumUtils.module_eval do
+        prepend Applitools::Appium::Utils
+        extend self
+      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

@@ -0,0 +1,40 @@
+# frozen_string_literal: false
+
+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
+    end
+
+    # true if test is running on Android device
+    def android?(driver)
+      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?(:device_is_ios?) && driver.device_is_ios?
+    end
+
+    # @param [Applitools::Selenium::Driver] driver
+    def platform_version(driver)
+      driver.respond_to?(:caps) && driver.caps[:platformVersion]
+    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
+    rescue
+      Applitools::Location::TOP_LEFT
+    end
+  end
+end

data/lib/applitools/version.rb

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

data/lib/eyes_appium.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: false
+
+require 'eyes_selenium'
+require 'appium_lib'
+
+CURRENT_RUBY_VERSION = Gem::Version.new RUBY_VERSION
+
+RUBY_1_9_3 = Gem::Version.new '1.9.3'
+RUBY_2_0_0 = Gem::Version.new '2.0.0'
+RUBY_2_1_6 = Gem::Version.new '2.1.6'
+RUBY_2_2_2 = Gem::Version.new '2.2.2'
+RUBY_2_4_0 = Gem::Version.new '2.4.0'
+
+RUBY_KEY = [RUBY_1_9_3, RUBY_2_0_0, RUBY_2_1_6, RUBY_2_2_2, RUBY_2_4_0].select { |v| v <= CURRENT_RUBY_VERSION }.last
+
+Applitools.require_dir('appium')
+
+if RUBY_KEY >= RUBY_2_0_0
+  Applitools::Appium::Init20.init
+else
+  Applitools::Appium::Init19.init
+end
+
+if defined? Appium::Driver
+  Appium::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)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eyes_appium
 version: !ruby/object:Gem::Version
-  version: 3.14.6
+  version: 3.14.7
 platform: ruby
 authors:
 - Applitools Team
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.14.6
+        version: 3.14.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.14.6
+        version: 3.14.7
 - !ruby/object:Gem::Dependency
   name: appium_lib
   requirement: !ruby/object:Gem::Requirement
@@ -45,10 +45,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/applitools/capybara/capybara_settings.rb
-- lib/applitools/capybara/driver.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/region_provider.rb
+- lib/applitools/appium/screenshot.rb
+- lib/applitools/appium/target.rb
+- lib/applitools/appium/utils.rb
 - lib/applitools/version.rb
-- lib/eyes_capybara.rb
+- lib/eyes_appium.rb
 homepage: https://www.applitools.com
 licenses:
 - Apache-2.0

data/lib/applitools/capybara/capybara_settings.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Applitools
-  module Selenium
-    module Capybara
-      module CapybaraSettings
-        # Registers Capybara driver which will be used by eyes and sets it as default Capybara driver.
-        # The name of the driver is :eyes, and the driver is a descendant of class Capybara::Selenium::Driver.
-        # Options are eventually passed to drivers constructor
-        # @param [Hash] options
-        # @example
-        #   Applitools.register_capybara_driver :browser => :chrome
-        # @example
-        #   Applitools.register_capybara_driver :browser => :remote, :url => 'remote_url', :desired_capabilities => {}
-        def register_capybara_driver(options = {})
-          ::Capybara.register_driver :eyes do |app|
-            Applitools::Selenium::Capybara::Driver.new app, options
-          end
-          ::Capybara.default_driver = :eyes
-          ::Capybara.javascript_driver = :eyes
-        end
-      end
-    end
-  end
-end

data/lib/applitools/capybara/driver.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-if defined? Capybara::Selenium::Driver
-  module Applitools::Selenium::Capybara
-    # @!visibility private
-    class Driver < Capybara::Selenium::Driver
-      def driver_for_eyes(eyes)
-        browser eyes: eyes
-      end
-
-      def browser(options = {})
-        eyes = options.delete(:eyes)
-        @native_browser ||= super()
-        unless eyes.nil?
-          is_mobile_device = @browser.capabilities['platformName'] ? true : false
-          @browser = Applitools::Selenium::Driver.new eyes,
-            options.merge(driver: @browser,  is_mobile_device: is_mobile_device)
-        end
-        @browser
-      end
-
-      def use_native_browser
-        @browser = @native_browser
-      end
-    end
-  end
-end
-
-if defined? ::Capybara::Session
-  ::Capybara::Session.class_eval do
-    def driver_for_eyes(eyes)
-      driver.driver_for_eyes eyes
-    end
-
-    def use_native_browser
-      driver.use_native_browser if driver.respond_to? :use_native_browser
-    end
-  end
-end

data/lib/eyes_capybara.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require 'eyes_selenium'
-require 'capybara'
-
-module Applitools
-  module Selenium
-    module Capybara
-      extend Applitools::RequireUtils
-      def self.load_dir
-        File.dirname(File.expand_path(__FILE__))
-      end
-    end
-  end
-end
-
-Applitools::Selenium::Capybara.require_dir 'capybara'
-
-module Applitools
-  extend Applitools::Selenium::Capybara::CapybaraSettings
-  register_capybara_driver
-end