eyes_selenium 2.33.0 → 2.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0761083944ac62eddd2754e25e1a99df2f552d42
-  data.tar.gz: 618d2ce2130371f1215290c33adf565b76435b4e
+  metadata.gz: 9cbf531403111ae72e83570622b2f33dbe3c5a1a
+  data.tar.gz: 08932a393797ce48ea59a403f2c351e6abebc1ae
 SHA512:
-  metadata.gz: e307d5656b5e228b5497b505f44ec611d9b58e6adb767b6142e8aafa8b302ac8432fc3decca3f219d235534a4056200ca49beb4f7ae152b8e3aeb7eb9a3ce3df
-  data.tar.gz: 9ce50824573c8e1508e3f9a1af24343730db7a6f0f96ed53238bc364a93c0aaba96d77df2b71be9a755d36782befca19aa5ece72dcd44e4b479618be405158e6
+  metadata.gz: 83313b5b82299099476d65a5dc975fe2b5797965e2be4cd99055c38ba6cc86b14a7bc6acbca1a223c4dcefdff46a891d0a50267bd572b17fda34436ef7f8d477
+  data.tar.gz: 6419913c448acb3f4b2cb92b9fd1313ad46a0719335c594abd68f62f49127dab20ba09355ad99f4256fc142df82cba22589e0c44961ad31f6ddd339adf0fe7a8

data/eyes_selenium.gemspec

@@ -3,6 +3,30 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'applitools/version'
 
+CURRENT_RYBY_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_2_2 = Gem::Version.new '2.2.2'
+
+RUBY_KEY = [RUBY_1_9_3, RUBY_2_0_0, RUBY_2_2_2].select { |v| v <= CURRENT_RYBY_VERSION }.last
+
+EYES_GEM_SPECS = {
+  RUBY_1_9_3 => proc do |spec|
+    spec.add_development_dependency 'mime-types', ['~> 2.99.0']
+    spec.add_development_dependency 'rack', ['~> 1.6.0']
+    spec.add_development_dependency 'tomlrb', ['<= 1.2.2']
+    spec.add_development_dependency 'rubocop', ['~> 0.41.1']
+  end,
+  RUBY_2_0_0 => proc do |spec|
+    spec.add_development_dependency 'rack', ['~> 1.6.0']
+    spec.add_development_dependency 'rubocop'
+  end,
+  RUBY_2_2_2 => proc do |spec|
+    spec.add_development_dependency 'rubocop'
+  end
+}.freeze
+
 Gem::Specification.new do |spec|
   spec.name          = 'eyes_selenium'
   spec.version       = Applitools::VERSION
@@ -29,12 +53,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '>= 3'
   spec.add_development_dependency 'watir-webdriver'
   spec.add_development_dependency 'appium_lib'
-  spec.add_development_dependency 'rubocop'
+  EYES_GEM_SPECS[RUBY_KEY].call spec
 
   # Exclude debugging support on Travis CI, due to its incompatibility with jruby and older rubies.
-  unless ENV['TRAVIS']
+  unless ENV['TRAVIS'] || CURRENT_RYBY_VERSION < Gem::Version.new('2.0.0')
     spec.add_development_dependency 'pry'
     spec.add_development_dependency 'pry-byebug'
+    spec.add_development_dependency 'byebug'
     spec.add_development_dependency 'pry-doc'
     spec.add_development_dependency 'pry-stack_explorer'
   end

data/lib/applitools/appium_driver.rb

@@ -0,0 +1,7 @@
+if defined? Appium::Driver
+  Appium::Driver.class_eval do
+    def driver_for_eyes(eyes)
+      Applitools::Selenium::Driver.new(eyes, driver: driver, is_mobile_device: true)
+    end
+  end
+end

data/lib/applitools/base/batch_info.rb

@@ -2,6 +2,8 @@ require 'securerandom'
 
 module Applitools::Base
   class BatchInfo
+    attr_accessor :name, :started_at, :id
+
     def initialize(name = nil, started_at = Time.now)
       @name = name
       @started_at = started_at

data/lib/applitools/base/region.rb

@@ -42,10 +42,10 @@ module Applitools::Base
         return
       end
 
-      i_left = (left >= other.left) ? left : other.left
-      i_right = (right <= other.right) ? right : other.right
-      i_top = (top >= other.top) ? top : other.top
-      i_bottom = (bottom <= other.bottom) ? bottom : other.bottom
+      i_left = left >= other.left ? left : other.left
+      i_right = right <= other.right ? right : other.right
+      i_top = top >= other.top ? top : other.top
+      i_bottom = bottom <= other.bottom ? bottom : other.bottom
 
       @left = i_left
       @top = i_top

data/lib/applitools/capybara.rb

@@ -0,0 +1,8 @@
+require 'capybara'
+
+Applitools.require_dir 'capybara'
+
+module Applitools
+  extend Applitools::Capybara::CapybaraSettings
+  register_capybara_driver
+end

data/lib/applitools/capybara/capybara_settings.rb

@@ -0,0 +1,11 @@
+module Applitools::Capybara
+  module CapybaraSettings
+    def register_capybara_driver(options = {})
+      Capybara.register_driver :eyes do |app|
+        Applitools::Capybara::Driver.new app, options
+      end
+      Capybara.default_driver = :eyes
+      Capybara.javascript_driver = :eyes
+    end
+  end
+end

data/lib/applitools/capybara/driver.rb

@@ -0,0 +1,28 @@
+if defined? Capybara::Selenium::Driver
+  module Applitools::Capybara
+    class Driver < Capybara::Selenium::Driver
+      def driver_for_eyes(eyes)
+        browser eyes: eyes
+      end
+
+      def browser(options = {})
+        eyes = options.delete(:eyes)
+        super()
+        if eyes.present?
+          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
+    end
+  end
+end
+
+if defined? Capybara::Session
+  Capybara::Session.class_eval do
+    def driver_for_eyes(eyes)
+      driver.driver_for_eyes eyes
+    end
+  end
+end

data/lib/applitools/eyes.rb

@@ -132,14 +132,8 @@ class Applitools::Eyes
         "use 'api_key' to set it.")
     end
 
-    if driver.is_a?(Selenium::WebDriver::Driver)
-      is_mobile_device = driver.capabilities['platformName'] ? true : false
-      @driver = Applitools::Selenium::Driver.new(self, driver: driver, is_mobile_device: is_mobile_device)
-    elsif defined?(Appium::Driver) && driver.is_a?(Appium::Driver)
-      @driver = Applitools::Selenium::Driver.new(self, driver: driver.driver, is_mobile_device: true)
-    elsif defined?(Watir::Browser) && driver.is_a?(Watir::Browser)
-      is_mobile_device = driver.driver.capabilities['platformName'] ? true : false
-      @driver = Applitools::Selenium::Driver.new(self, driver: driver.driver, is_mobile_device: is_mobile_device)
+    if driver.respond_to? :driver_for_eyes
+      @driver = driver.driver_for_eyes self
     else
       unless driver.is_a?(Applitools::Selenium::Driver)
         Applitools::EyesLogger.warn("Unrecognized driver type: (#{driver.class.name})!")
@@ -204,6 +198,8 @@ class Applitools::Eyes
         Applitools::EyesLogger.debug 'Element given as an argument...'
         raise Applitools::EyesError.new('Element does not exist') if what.nil?
         element_to_check = what
+      elsif how == :region && what.is_a?(Applitools::Base::Region)
+        return check_region_(what, tag, specific_timeout)
       else
         Applitools::EyesLogger.debug 'Finding element...'
         element_to_check = driver.find_element(how, what)

data/lib/applitools/sauce.rb

@@ -0,0 +1,2 @@
+require_relative 'capybara'
+Applitools.require_dir 'sauce'

data/lib/applitools/sauce/driver.rb

@@ -0,0 +1,23 @@
+if defined? Sauce::Selenium2
+  Sauce::Capybara::Driver.class_eval do
+    def driver_for_eyes(eyes)
+      browser.raw_driver eyes: eyes
+    end
+  end
+
+  Sauce::Selenium2.class_eval do
+    def driver_for_eyes(eyes)
+      raw_driver eyes: eyes
+    end
+
+    def raw_driver(options = {})
+      eyes = options.delete(:eyes)
+      if eyes.present?
+        is_mobile_device = @raw_driver.capabilities['platformName'] ? true : false
+        @raw_driver = Applitools::Selenium::Driver.new eyes,
+          options.merge(driver: @raw_driver, is_mobile_device: is_mobile_device)
+      end
+      @raw_driver
+    end
+  end
+end

data/lib/applitools/selenium/browser.rb

@@ -175,7 +175,7 @@ module Applitools::Selenium
           page_size.height).subregions(screenshot_part_size)
         parts = sub_regions.map do |screenshot_part|
           # Skip (0,0), as we already got the screenshot.
-          if screenshot_part.left == 0 && screenshot_part.top == 0
+          if screenshot_part.left.zero? && screenshot_part.top.zero?
             next Applitools::Base::ImagePosition.new(screenshot, Applitools::Base::Point::TOP_LEFT)
           end
 

data/lib/applitools/selenium/driver.rb

@@ -35,7 +35,6 @@ module Applitools::Selenium
     # If driver is not provided, Applitools::Selenium::Driver will raise an EyesError exception.
     def initialize(eyes, options)
       super(options[:driver])
-
       @is_mobile_device = options.fetch(:is_mobile_device, false)
       @wait_before_screenshots = 0
       @eyes = eyes
@@ -138,6 +137,10 @@ module Applitools::Selenium
 
     private
 
+    def bridge
+      __getobj__.send(:bridge)
+    end
+
     def driver
       @driver ||= __getobj__
     end
@@ -174,11 +177,11 @@ module Applitools::Selenium
       # +rotation+:: +Integer+|+nil+ The degrees by which to rotate the image: positive values = clockwise rotation,
       #   negative values = counter-clockwise, 0 = force no rotation, +nil+ = rotate automatically when needed.
       def normalize_rotation(driver, image, rotation)
-        return if rotation == 0
+        return if rotation && rotation.zero?
 
         num_quadrants = 0
         if !rotation.nil?
-          if rotation % RIGHT_ANGLE != 0
+          if (rotation % RIGHT_ANGLE).nonzero?
             raise Applitools::EyesError.new('Currently only quadrant rotations are supported. Current rotation: '\
             "#{rotation}")
           end

data/lib/applitools/selenium/element.rb

@@ -67,5 +67,17 @@ module Applitools::Selenium
 
       Applitools::Base::Region.new(left, top, width, height)
     end
+
+    def find_element(*args)
+      self.class.new driver, super
+    end
+
+    def find_elements(*args)
+      super(*args).map { |e| self.class.new driver, e }
+    end
+
+    private
+
+    attr_reader :driver
   end
 end

data/lib/applitools/selenium/viewport_size.rb

@@ -130,7 +130,7 @@ module Applitools::Selenium
 
       retries_left = VERIFY_RETRIES
 
-      until retries_left == 0
+      until retries_left.zero?
         return true if browser_size == required_browser_size
         Applitools::EyesLogger.debug "Trying to set browser size to #{required_browser_size}"
         resize_browser required_browser_size

data/lib/applitools/selenium_webdriver.rb

@@ -0,0 +1,8 @@
+if defined? Selenium::WebDriver::Driver
+  Selenium::WebDriver::Driver.class_eval do
+    def driver_for_eyes(eyes)
+      is_mobile_device = capabilities['platformName'] ? true : false
+      Applitools::Selenium::Driver.new(eyes, driver: self, is_mobile_device: is_mobile_device)
+    end
+  end
+end

data/lib/applitools/utils/image_delta_compressor.rb

@@ -26,8 +26,8 @@ module Applitools::Utils
       target_pixels = target.to_rgb_stream.unpack('C*')
       source_pixels = source.to_rgb_stream.unpack('C*')
       image_size = Dimension.new(target.width, target.height)
-      block_columns_count = (target.width / block_size) + ((target.width % block_size) == 0 ? 0 : 1)
-      block_rows_count = (target.height / block_size) + ((target.height % block_size) == 0 ? 0 : 1)
+      block_columns_count = (target.width / block_size) + ((target.width % block_size).zero? ? 0 : 1)
+      block_rows_count = (target.height / block_size) + ((target.height % block_size).zero? ? 0 : 1)
 
       # IMPORTANT: The "-Zlib::MAX_WBITS" tells ZLib to create raw deflate compression, without the
       # "Zlib headers" (this isn't documented in the Zlib page, I found this in some internet forum).

data/lib/applitools/utils/image_utils.rb

@@ -129,6 +129,10 @@ module Applitools::Utils
         end
       end
 
+      def respond_to_missing?(method_name, include_private = false)
+        super
+      end
+
       def restore
         ChunkyPNG::Image.from_datastream @datastream
       end

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '2.33.0'.freeze
+  VERSION = '2.34.0'.freeze
 end

data/lib/applitools/watir_browser.rb

@@ -0,0 +1,8 @@
+if defined? Watir::Browser
+  Watir::Browser.class_eval do
+    def driver_for_eyes(eyes)
+      is_mobile_device = driver.capabilities['platformName'] ? true : false
+      Applitools::Selenium::Driver.new(eyes, driver: driver, is_mobile_device: is_mobile_device)
+    end
+  end
+end

data/lib/eyes_selenium.rb

@@ -1,8 +1,11 @@
 module Applitools
-  ROOT_DIR = File.join(File.dirname(File.expand_path(__FILE__)), 'applitools').freeze
-
-  Dir["#{ROOT_DIR}/*.rb"].sort.each { |f| require f }
-  Dir["#{ROOT_DIR}/**/*.rb"].sort.each { |f| require f }
+  class << self
+    def require_dir(dir)
+      Dir[File.join(File.dirname(File.expand_path(__FILE__)), 'applitools', dir, '*.rb')].sort.each do |f|
+        require f
+      end
+    end
+  end
 
   class EyesError < StandardError; end
   class EyesAbort < EyesError; end
@@ -19,3 +22,16 @@ module Applitools
 
   class NewTestError < TestFailedError; end
 end
+
+require_relative 'applitools/method_tracer'
+require_relative 'applitools/extensions'
+require_relative 'applitools/version'
+
+Applitools.require_dir 'base'
+Applitools.require_dir 'utils'
+Applitools.require_dir 'selenium'
+
+require_relative 'applitools/eyes'
+require_relative 'applitools/selenium_webdriver'
+require_relative 'applitools/appium_driver'
+require_relative 'applitools/watir_browser'

data/test/capybara_example.rb

@@ -4,12 +4,7 @@ require_relative '../lib/eyes_selenium'
 require 'openssl'
 OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 
-
-Capybara.register_driver :selenium do |app|
-  Capybara::Selenium::Driver.new(app, :browser => :chrome)
-end
-
-Capybara.javascript_driver = :selenium
+Applitools.register_capybara_driver :browser => :chrome
 
 # require 'capybara/poltergeist'
 #
@@ -19,25 +14,25 @@ Capybara.javascript_driver = :selenium
 #
 # Capybara.javascript_driver = :poltergeist_app
 
-
 describe 'Capybara Example', :type => :feature, :js => true do
-  before :each do
-    @eyes = Applitools::Eyes.new
-    @eyes.api_key = ENV['APPLITOOLS_API_KEY']
-    @eyes.log_handler = Logger.new(STDOUT)
+  let(:eyes) do
+    Applitools::Eyes.new.tap do |eyes|
+      eyes.api_key = ENV['APPLITOOLS_API_KEY']
+      eyes.log_handler = Logger.new(STDOUT)
+    end
   end
 
   it 'Simple test' do
-    driver = @eyes.open(app_name: 'Ruby SDK', test_name: 'Capybara test', driver: page.driver.browser, viewport_size: {width: 800, height: 600})
+    eyes.open(app_name: 'Ruby SDK', test_name: 'Capybara test', driver: page,
+               viewport_size: { width: 800, height: 600 })
     visit 'http://github.com'
-    @eyes.check_window('homepage')
-    username = driver.find_element(:name, 'user[login]')
-    username.send_keys('user')
-    @eyes.check_window('homepage with username')
-    @eyes.close
+    eyes.check_window('homepage')
+    fill_in('user[login]', with: 'user')
+    eyes.check_window('homepage with username')
+    eyes.close
   end
 
   after :each do
-    @eyes.abort_if_not_closed
+    eyes.abort_if_not_closed
   end
 end

data/test/sauce_capybara_check.rb

@@ -2,37 +2,42 @@ require 'capybara'
 require 'sauce'
 require 'sauce/capybara'
 require_relative '../lib/eyes_selenium'
+require 'applitools/sauce'
 require 'openssl'
 OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
 
 Sauce.config do |config|
   config[:browsers] = [
-      ["OS X 10.10", "chrome", "39.0"]
+    ['OS X 10.10', 'chrome', '39.0']
   ]
   config[:start_tunnel] = false
   # config[:sauce_connect_4_executable] = '/path/to/sauce-connect/bin/sc'
 end
 
-Capybara.javascript_driver = :sauce
+Capybara.configure do |c|
+  c.javascript_driver = :sauce
+  c.default_driver = :sauce
+end
 
-describe 'A Saucy Example Group', :sauce => true do
-  before :each do
-    @eyes = Applitools::Eyes.new
-    @eyes.api_key = ENV['APPLITOOLS_API_KEY']
-    @eyes.log_handler = Logger.new(STDOUT)
+describe 'A Saucy Example Group', sauce: true do
+  let!(:eyes) do
+    Applitools::Eyes.new.tap do |eyes|
+      eyes.api_key = ENV['APPLITOOLS_API_KEY']
+      eyes.log_handler = Logger.new(STDOUT)
+    end
   end
 
   it 'Simple test' do
-    driver = @eyes.open(app_name: 'Ruby SDK', test_name: 'Capybara test', driver: selenium.driver, viewport_size: {width: 800, height: 600})
-    driver.navigate.to 'http://github.com'
-    @eyes.check_window('homepage')
-    username = driver.find_element(:name, 'user[login]')
-    username.send_keys('user')
-    @eyes.check_window('homepage with username')
-    @eyes.close(false)
+    eyes.open(app_name: 'Ruby SDK', test_name: 'Capybara test', driver: page,
+      viewport_size: { width: 800, height: 600 })
+    visit 'http://github.com'
+    eyes.check_window('homepage')
+    fill_in 'user[login]', with: 'user'
+    eyes.check_window('homepage with username')
+    eyes.close(false)
   end
 
   after :each do
     @eyes.abort_if_not_closed
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 2.33.0
+  version: 2.34.0
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-doc
   requirement: !ruby/object:Gem::Requirement
@@ -237,6 +265,7 @@ files:
 - Rakefile
 - certs/cacert.pem
 - eyes_selenium.gemspec
+- lib/applitools/appium_driver.rb
 - lib/applitools/base/batch_info.rb
 - lib/applitools/base/dimension.rb
 - lib/applitools/base/environment.rb
@@ -249,10 +278,15 @@ files:
 - lib/applitools/base/start_info.rb
 - lib/applitools/base/test_results.rb
 - lib/applitools/base/text_trigger.rb
+- lib/applitools/capybara.rb
+- lib/applitools/capybara/capybara_settings.rb
+- lib/applitools/capybara/driver.rb
 - lib/applitools/extensions.rb
 - lib/applitools/eyes.rb
 - lib/applitools/eyes_logger.rb
 - lib/applitools/method_tracer.rb
+- lib/applitools/sauce.rb
+- lib/applitools/sauce/driver.rb
 - lib/applitools/selenium/browser.rb
 - lib/applitools/selenium/driver.rb
 - lib/applitools/selenium/element.rb
@@ -261,10 +295,12 @@ files:
 - lib/applitools/selenium/match_window_task.rb
 - lib/applitools/selenium/mouse.rb
 - lib/applitools/selenium/viewport_size.rb
+- lib/applitools/selenium_webdriver.rb
 - lib/applitools/utils/image_delta_compressor.rb
 - lib/applitools/utils/image_utils.rb
 - lib/applitools/utils/utils.rb
 - lib/applitools/version.rb
+- lib/applitools/watir_browser.rb
 - lib/eyes_selenium.rb
 - spec/driver_passthrough_spec.rb
 - spec/fixtures/static_test_file.html