eyes_selenium 2.16.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47b395b9cd5931cd1cdf51770296824d4123540e
-  data.tar.gz: ed4cfaadc2824b1140d64abee6322e08a5a99e94
+  metadata.gz: 250fb34d1762517235653022b1912a310f725030
+  data.tar.gz: e72d68a5d5927ad9bf4deaef8375820cc5c8fe23
 SHA512:
-  metadata.gz: a7f9f968f8be5d0108c768084e00213a575b946abdad64de5b389008439f8ffcc2ab24892ddf68f43229ba4d51202bb9ec509b478e87f94640ce7d108f7a09f6
-  data.tar.gz: 5fa006f0a50e22a1e9e2e31a17b31d25c47f11f90e98f1ecb70c051473fb998561bb1ec2b0031cdb859fc651077de559c086d2e4374d12d08df540f49cc9d325
+  metadata.gz: 9e86ee6df164195fd10b9b66032ca7132fd53deadca423ce904672e553b76e92f55c8f99f195d90bcf5217ebecf695a01aa86c5d62afa4cd6f9559e7cfa7b436
+  data.tar.gz: 41c97cde1b72b9dee573fec079fc80f6a3823c1ea00e41e45778a48743c10fe7292222d2a4a77a761f5dbe9dcdcc659dcc3de3fedc857496a4f47bdfc0d7d6ce

data/.rubocop.yml

@@ -0,0 +1,54 @@
+# Custom config for RuboCop static code analysis
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 4
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/HashSyntax:
+  UseHashRocketsWithSymbolValues: true
+
+Style/AlignHash:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false

data/.travis.yml

@@ -14,3 +14,5 @@ sudo: false
 before_install:
   - "export DISPLAY=:99.0"
   - "sh -e /etc/init.d/xvfb start"
+script:
+  - bundle exec rake rubocop

data/Rakefile

@@ -1,8 +1,11 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
 Bundler::GemHelper.install_tasks
 
 task :default => :spec
+
+RuboCop::RakeTask.new

data/eyes_selenium.gemspec

@@ -13,13 +13,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://www.applitools.com'
   spec.license       = 'Apache License, Version 2.0'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($RS)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_dependency 'selenium-webdriver', '>= 2.45.0'
-  spec.add_dependency 'oily_png'
+  spec.add_dependency 'oily_png', '>= 1.2'
   spec.add_dependency 'faraday'
   spec.add_dependency 'oj'
 
@@ -28,6 +28,7 @@ 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'
 
   # Exclude debugging support on Travis CI, due to its incompatibility with jruby and older rubies.
   unless ENV['TRAVIS']

data/lib/applitools/base/image_position.rb

@@ -0,0 +1,10 @@
+module Applitools::Base
+  class ImagePosition
+    attr_accessor :image, :position
+
+    def initialize(image, position)
+      @image = image
+      @position = position
+    end
+  end
+end

data/lib/applitools/base/mouse_trigger.rb

@@ -7,7 +7,7 @@ module Applitools::Base
       move: 'Move',
       down: 'Down',
       up: 'Up'
-     }.freeze
+    }.freeze
 
     attr_reader :mouse_action, :control, :location
 

data/lib/applitools/base/point.rb

@@ -2,16 +2,29 @@ module Applitools::Base
   class Point
     attr_accessor :x, :y
 
+    alias_attribute :left, :x
+    alias_attribute :top, :y
+
     def initialize(x, y)
       @x = x
       @y = y
     end
 
-    def to_hash
-      {
-        x: x,
-        y: y
-      }
+    TOP_LEFT = Point.new(0, 0)
+
+    def ==(other)
+      return super.==(other) unless other.is_a?(Point)
+      @x == other.x && @y == other.y
+    end
+
+    def hash
+      @x.hash & @y.hash
+    end
+
+    alias_method :eql?, :==
+
+    def to_hash(options = {})
+      options[:region] ? { left: left, top: top } : { x: x, y: y }
     end
 
     def values

data/lib/applitools/base/region.rb

@@ -9,7 +9,7 @@ module Applitools::Base
       @height = height.round
     end
 
-    EMPTY = Applitools::Base::Region.new(0, 0, 0, 0)
+    EMPTY = Region.new(0, 0, 0, 0)
 
     def make_empty
       @left = EMPTY.left
@@ -19,7 +19,7 @@ module Applitools::Base
     end
 
     def empty?
-       @left == EMPTY.left && @top == EMPTY.top && @width == EMPTY.width && @height == EMPTY.height
+      @left == EMPTY.left && @top == EMPTY.top && @width == EMPTY.width && @height == EMPTY.height
     end
 
     def right
@@ -31,14 +31,17 @@ module Applitools::Base
     end
 
     def intersecting?(other)
-      ((left <= other.left && other.left <= right) || (other.left <= left && left <= other.right)) \
-      && ((top <= other.top && other.top <= bottom) || (other.top <= top && top <=other.bottom))
+      ((left <= other.left && other.left <= right) || (other.left <= left && left <= other.right)) &&
+        ((top <= other.top && other.top <= bottom) || (other.top <= top && top <= other.bottom))
     end
 
     def intersect(other)
-      if !intersecting?(other)
-        make_empty and return
+      unless intersecting?(other)
+        make_empty
+
+        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
@@ -51,14 +54,46 @@ module Applitools::Base
     end
 
     def contains?(other_left, other_top)
-      other_left >= left && other_left <= right && \
-      other_top >= top && other_top <= bottom
+      other_left >= left && other_left <= right && other_top >= top && other_top <= bottom
     end
 
     def middle_offset
       mid_x = width / 2
       mid_y = height / 2
-      Applitools::Base::Point.new(mid_x.round, mid_y.round)
+      Point.new(mid_x.round, mid_y.round)
+    end
+
+    def subregions(subregion_size)
+      [].tap do |subregions|
+        current_top = @top
+        bottom = @top + @height
+        right = @left + @width
+        subregion_width = [@width, subregion_size.width].min
+        subregion_height = [@height, subregion_size.height].min
+
+        while current_top < bottom
+          current_bottom = current_top + subregion_height
+          if current_bottom > bottom
+            current_bottom = bottom
+            current_top = current_bottom - subregion_height
+          end
+
+          current_left = @left
+          while current_left < right
+            current_right = current_left + subregion_width
+            if current_right > right
+              current_right = right
+              current_left = current_right - subregion_width
+            end
+
+            subregions << Region.new(current_left, current_top, subregion_width, subregion_height)
+
+            current_left += subregion_width
+          end
+
+          current_top += subregion_height
+        end
+      end
     end
 
     def to_hash

data/lib/applitools/base/server_connector.rb

@@ -1,7 +1,7 @@
 require 'faraday'
 
 require 'oj'
-Oj.default_options = {:mode => :compat }
+Oj.default_options = { :mode => :compat }
 
 require 'uri'
 
@@ -44,7 +44,8 @@ module Applitools::Base::ServerConnector
   end
 
   def start_session(session_start_info)
-    res = post(endpoint_url, body: Oj.dump(startInfo: Applitools::Utils.camelcase_hash_keys(session_start_info.to_hash)))
+    res = post(endpoint_url, body: Oj.dump(startInfo:
+      Applitools::Utils.camelcase_hash_keys(session_start_info.to_hash)))
     raise Applitools::EyesError.new("Request failed: #{res.status}") unless res.success?
 
     response = Oj.load(res.body)
@@ -52,7 +53,7 @@ module Applitools::Base::ServerConnector
   end
 
   def stop_session(session, aborted = nil, save = false)
-    res = long_delete(URI.join(endpoint_url, session.id.to_s), query: {aborted: aborted, updateBaseline: save})
+    res = long_delete(URI.join(endpoint_url, session.id.to_s), query: { aborted: aborted, updateBaseline: save })
     raise Applitools::EyesError.new("Request failed: #{res.status}") unless res.success?
 
     response = Oj.load(res.body)
@@ -82,11 +83,11 @@ module Applitools::Base::ServerConnector
   end
 
   def request(url, method, options = {})
-    Faraday::Connection.new(url, ssl: {ca_file: SSL_CERT}).send(method) do |req|
+    Faraday::Connection.new(url, ssl: { ca_file: SSL_CERT }).send(method) do |req|
       req.options.timeout  = DEFAULT_TIMEOUT
       req.headers = DEFAULT_HEADERS.merge(options[:headers] || {})
       req.headers['Content-Type'] = options[:content_type] if options.key?(:content_type)
-      req.params = {apiKey: api_key}.merge(options[:query] || {})
+      req.params = { apiKey: api_key }.merge(options[:query] || {})
       req.body = options[:body]
     end
   end
@@ -95,7 +96,7 @@ module Applitools::Base::ServerConnector
     delay = LONG_REQUEST_DELAY
     (options[:headers] ||= {})['Eyes-Expect'] = '202-accepted'
 
-    while true
+    loop do
       # Date should be in RFC 1123 format.
       options[:headers]['Eyes-Date'] = Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')
 

data/lib/applitools/base/test_results.rb

@@ -2,7 +2,7 @@ module Applitools::Base
   class TestResults
     attr_accessor :is_new, :url
     attr_reader :steps, :matches, :mismatches, :missing, :exact_matches, :strict_matches, :content_matches,
-      :layout_matches, :none_matches, :is_passed
+      :layout_matches, :none_matches
 
     def initialize(steps = 0, matches = 0, mismatches = 0, missing = 0, exact_matches = 0, strict_matches = 0,
       content_matches = 0, layout_matches = 0, none_matches = 0)
@@ -19,15 +19,14 @@ module Applitools::Base
       @url = nil
     end
 
-    def is_passed
+    def passed?
       !is_new && mismatches == 0 && missing == 0
     end
+    alias_method :is_passed, :passed?
 
     def to_s
       is_new_str = ''
-      unless is_new.nil?
-        is_new_str = is_new ? 'New test' : 'Existing test'
-      end
+      is_new_str = is_new ? 'New test' : 'Existing test' unless is_new.nil?
 
       "#{is_new_str} [ steps: #{steps}, matches: #{matches}, mismatches: #{mismatches}, missing: #{missing} ], "\
         "URL: #{url}"

data/lib/applitools/extensions.rb

@@ -0,0 +1,17 @@
+class Module
+  def alias_attribute(new_name, old_name)
+    module_eval <<-STR, __FILE__, __LINE__ + 1
+      def #{new_name}
+        self.#{old_name}
+      end
+
+      def #{new_name}?
+        self.#{old_name}?
+      end
+
+      def #{new_name}=(v)
+        self.#{old_name}
+      end
+    STR
+  end
+end

data/lib/applitools/eyes.rb

@@ -23,7 +23,9 @@ class Applitools::Eyes
   DEFAULT_MATCH_TIMEOUT = 2.0.freeze # Seconds
   BASE_AGENT_ID = ('eyes.selenium.ruby/' + Applitools::VERSION).freeze
 
-  #
+  ANDROID = 'Android'.freeze
+  IOS = 'iOS'.freeze
+
   # Attributes:
   #
   # +app_name+:: +String+ The application name which was provided as an argument to +open+.
@@ -31,7 +33,8 @@ class Applitools::Eyes
   # +is_open+:: +boolean+ Is there an open session.
   # +viewport_size+:: +Hash+ The viewport size which was provided as an argument to +open+. Should include +width+
   #   and +height+.
-  # +driver+:: +Applitools::Selenium::Driver+ The driver instance wrapping the driver which was provided as an argument to +open+.
+  # +driver+:: +Applitools::Selenium::Driver+ The driver instance wrapping the driver which was provided as an argument
+  #   to +open+.
   # +api_key+:: +String+ The user's API key.
   # +match_timeout+:: +Float+ The default timeout for check_XXXX operations. (Seconds)
   # +batch+:: +BatchInfo+ The current tests grouping, if any.
@@ -41,8 +44,8 @@ class Applitools::Eyes
   #   you wish to override Eyes' automatic inference.
   # +branch_name+:: +String+ If set, names the branch in which the test should run.
   # +parent_branch_name+:: +String+ If set, names the parent branch of the branch in which the test should run.
-  # +user_inputs+:: +Applitools::Base::MouseTrigger+/+Applitools::Selenium::KeyboardTrigger+ Mouse/Keyboard events which happened after
-  #   the last visual validation.
+  # +user_inputs+:: +Applitools::Base::MouseTrigger+/+Applitools::Selenium::KeyboardTrigger+ Mouse/Keyboard events which
+  #   happened after the last visual validation.
   # +save_new_tests+:: +boolean+ Whether or not new tests should be automatically accepted as baseline.
   # +save_failed_tests+:: +boolean+ Whether or not failed tests should be automatically accepted as baseline.
   # +match_level+:: +String+ The default match level for the entire session. See +Applitools::Eyes::MATCH_LEVEL+.
@@ -58,10 +61,14 @@ class Applitools::Eyes
   # +rotation+:: +Integer+|+nil+ The degrees by which to rotate the screenshots received from the driver. Set this to
   #   override Eyes' automatic rotation inference. Positive values = clockwise rotation, negative
   #   values = counter-clockwise, 0 = force no rotation, +nil+ = use Eyes' automatic rotation inference.
+  # +force_fullpage_screenshot+:: +boolean+ Whether or not to force fullpage screenshot taking, if the browser doesn't
+  #   support it explicitly.
+  # +hide_scrollbars+:: +boolean+ Whether or not hide scrollbars.
+  # +use_css_transition+:: +boolean+ Whether or not to perform CSS transition.
   attr_reader :app_name, :test_name, :is_open, :viewport_size, :driver
   attr_accessor :match_timeout, :batch, :host_os, :host_app, :branch_name, :parent_branch_name, :user_inputs,
     :save_new_tests, :save_failed_tests, :is_disabled, :server_url, :agent_id, :failure_reports, :match_level,
-    :baseline_name, :rotation
+    :baseline_name, :rotation, :force_fullpage_screenshot, :hide_scrollbars, :use_css_transition
 
   def_delegators 'Applitools::EyesLogger', :log_handler, :log_handler=
   def_delegators 'Applitools::Base::ServerConnector', :api_key, :api_key=, :server_url, :server_url=
@@ -98,6 +105,9 @@ class Applitools::Eyes
     @save_new_tests = true
     @save_failed_tests = false
     @dont_get_title = false
+    @force_fullpage_screenshot = false
+    @hide_scrollbars = false
+    @use_css_transition = false
   end
 
   def open(options = {})
@@ -105,7 +115,7 @@ class Applitools::Eyes
     return driver if disabled?
 
     if api_key.nil?
-      raise Applitools::EyesError.new("API key not set! Log in to https://applitools.com to obtain your API Key and "\
+      raise Applitools::EyesError.new('API key not set! Log in to https://applitools.com to obtain your API Key and '\
         "use 'api_key' to set it.")
     end
 
@@ -180,7 +190,7 @@ class Applitools::Eyes
     check_region_(Applitools::Base::Region::EMPTY, tag, specific_timeout)
   end
 
-  def close(raise_ex=true)
+  def close(raise_ex = true)
     return if disabled?
     @is_open = false
 
@@ -217,7 +227,7 @@ class Applitools::Eyes
       return results
     end
 
-    unless results.is_passed
+    unless results.passed?
       # Test failed
       Applitools::EyesLogger.info "--- Failed test ended. See details at #{session_results_url}"
 
@@ -246,15 +256,13 @@ class Applitools::Eyes
   #      get "http://www.google.com"
   #      check_window("initial")
   #    end
-  #noinspection RubyUnusedLocalVariable
-  def test(options = {}, &block)
-    begin
-      open(options)
-      yield(driver)
-      close
-    ensure
-      abort_if_not_closed
-    end
+  # noinspection RubyUnusedLocalVariable
+  def test(options = {}, &_block)
+    open(options)
+    yield(driver)
+    close
+  ensure
+    abort_if_not_closed
   end
 
   def abort_if_not_closed
@@ -266,7 +274,7 @@ class Applitools::Eyes
 
     begin
       Applitools::Base::ServerConnector.stop_session(@session, true, false)
-    rescue Exception, Applitools::EyesError => e
+    rescue => e
       Applitools::EyesLogger.error "Failed to abort server session: #{e.message}!"
     ensure
       @session = nil
@@ -280,8 +288,8 @@ class Applitools::Eyes
   end
 
   def get_driver(options)
-    # TODO remove the "browser" related block when possible. It's for backward compatibility.
-    if options.has_key?(:browser)
+    # TODO: remove the "browser" related block when possible. It's for backward compatibility.
+    if options.key?(:browser)
       Applitools::EyesLogger.warn('"browser" key is deprecated, please use "driver" instead.')
 
       return options[:browser]
@@ -308,10 +316,10 @@ class Applitools::Eyes
         Applitools::EyesLogger.info 'Mobile device detected! Checking device type..'
         if driver.android?
           Applitools::EyesLogger.info 'Android detected.'
-          platform_name = 'Android'
+          platform_name = ANDROID
         elsif driver.ios?
           Applitools::EyesLogger.info 'iOS detected.'
-          platform_name = 'iOS'
+          platform_name = IOS
         else
           Applitools::EyesLogger.warn 'Unknown device type.'
         end
@@ -379,15 +387,15 @@ class Applitools::Eyes
     as_expected = @match_window_task.match_window(region, specific_timeout, tag, rotation,
       @should_match_window_run_once_on_timeout)
     Applitools::EyesLogger.debug 'Match window done!'
-    unless as_expected
-      @should_match_window_run_once_on_timeout = true
-      unless @session.new_session?
-        Applitools::EyesLogger.info %( mismatch #{ tag ? '' : "(#{tag})" } )
-        if failure_reports.to_i == Applitools::Eyes::FAILURE_REPORTS[:immediate]
-          raise Applitools::TestFailedError.new("Mismatch found in '#{@session_start_info.scenario_id_or_name}' "\
-            "of '#{@session_start_info.app_id_or_name}'")
-        end
-      end
-    end
+    return if as_expected
+
+    @should_match_window_run_once_on_timeout = true
+    return if @session.new_session?
+
+    Applitools::EyesLogger.info %( mismatch #{ tag ? '' : "(#{tag})" } )
+    return unless failure_reports.to_i == Applitools::Eyes::FAILURE_REPORTS[:immediate]
+
+    raise Applitools::TestFailedError.new("Mismatch found in '#{@session_start_info.scenario_id_or_name}' "\
+      "of '#{@session_start_info.app_id_or_name}'")
   end
 end