eyes_selenium 3.14.3 → 3.14.4

data/lib/applitools/selenium/keyboard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::Selenium
   # @!visibility private
   class Keyboard

data/lib/applitools/selenium/mouse.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::Selenium
   # @!visibility private
   class Mouse

data/lib/applitools/selenium/move_to_region_visibility_strategy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::Selenium
   class MoveToRegionVisibilityStrategy
     extend Forwardable

data/lib/applitools/selenium/nop_region_visibility_strategy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::Selenium
   # @!visibility private
   class NopRegionVisibilityStrategy

data/lib/applitools/selenium/region_provider.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Applitools
+  module Selenium
+    class RegionProvider
+      FF_OLD_VERSION = '45.0'
+
+      attr_accessor :driver, :eye_region, :scroll_position_provider
+
+      def initialize(driver, eye_region)
+        self.driver = driver
+        self.eye_region = eye_region
+        self.scroll_position_provider = Applitools::Selenium::ScrollPositionProvider.new driver
+      end
+
+      def region(include_borders = true)
+        region = if include_borders
+                   location = eye_region.location.offset_negative(
+                     Applitools::Location.new(eye_region.padding_left, eye_region.padding_top)
+                   )
+                   size = eye_region.size.tap do |s|
+                     s.width += eye_region.padding_left + eye_region.padding_right
+                     s.height += eye_region.padding_top + eye_region.padding_bottom
+                   end
+                   Applitools::Region.from_location_size(location, size)
+                 else
+                   Applitools::Region.from_location_size(eye_region.location, eye_region.size)
+                 end
+        if inside_a_frame?
+          frame_window = calculate_frame_window
+          return frame_window if eye_region.is_a?(Applitools::Region) && eye_region.empty?
+          region.location = region.location.offset(frame_window.location)
+          region.intersect(frame_window) unless frame_window.empty?
+          # exception if empty
+        else
+          region.location = region.location.offset_negative scroll_position_provider.current_position
+        end
+        return eye_region if eye_region.is_a?(Applitools::Region) && eye_region.empty?
+        region
+      end
+
+      def coordinate_type
+        nil
+      end
+
+      def calculate_frame_window
+        return Applitools::Region::EMPTY unless inside_a_frame?
+        frame_window_calculator.frame_window(driver.frame_chain)
+      end
+
+      private
+
+      def inside_a_frame?
+        !driver.frame_chain.empty?
+      end
+
+      def frame_window_calculator
+        return FirefoxFrameWindowCalculator if
+            driver.browser.running_browser_name == :firefox &&
+                (Gem::Version.new(driver.capabilities.version) <=> Gem::Version.new(FF_OLD_VERSION)) > 0
+        FrameWindowCalculator
+      end
+
+      module FrameWindowCalculator
+        extend self
+        def frame_window(frame_chain)
+          chain = Applitools::Selenium::FrameChain.new other: frame_chain
+          window = nil
+          frames_offset = Applitools::Location.new(0, 0)
+          chain.map(&:dup).each do |frame|
+            frames_offset = frame.location.offset(frames_offset).offset_negative(frame.parent_scroll_position)
+            if window.nil?
+              window = Applitools::Region.from_location_size(frame.location, frame.size)
+            else
+              window.intersect(Applitools::Region.from_location_size(frame.location, frame.size))
+            end
+            # exception if empty window
+          end
+          window
+        end
+      end
+
+      module FirefoxFrameWindowCalculator
+        extend self
+        def frame_window(_frame_chain)
+          Applitools::Region::EMPTY
+        end
+      end
+    end
+  end
+end

data/lib/applitools/selenium/sauce/driver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 if defined? Sauce::Selenium2
   if defined? Capybara
     Sauce::Capybara::Driver.class_eval do

data/lib/applitools/selenium/scroll_position_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::Selenium
   # @!visibility private
   class ScrollPositionProvider
@@ -49,7 +51,7 @@ module Applitools::Selenium
     # Returns the entire size of the viewport.
     #
     # @return [Applitools::RectangleSize] The viewport size.
-    def entire_size
+    def entire_size(image_width, image_height)
       viewport_size = Applitools::Utils::EyesSeleniumUtils.extract_viewport_size(executor)
       result = Applitools::Utils::EyesSeleniumUtils.entire_page_size(executor)
       logger.info "Entire size: #{result}"
@@ -60,7 +62,16 @@ module Applitools::Selenium
       result.width = [viewport_size.width, result.width].min if disable_horizontal
       result.height = [viewport_size.height, result.height].min if disable_vertical
       logger.info "Actual size to scroll: #{result}"
-      result
+      return result unless executor.frame_chain.empty?
+      original_scroll_position = current_position
+      scroll_to_bottom_right
+      bottom_right_position = current_position
+      restore_state(original_scroll_position)
+      Applitools::RectangleSize.new(bottom_right_position.x + image_width, bottom_right_position.y + image_height)
+    end
+
+    def scroll_to_bottom_right
+      Applitools::Utils::EyesSeleniumUtils.scroll_to_bottom_right(executor)
     end
 
     def force_offset

data/lib/applitools/selenium/takes_screenshot_image_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools::Selenium
   # @!visibility private
   class TakesScreenshotImageProvider
@@ -10,11 +12,11 @@ module Applitools::Selenium
     #
     # @param [Applitools::Selenium::Driver] driver
     # @param [Hash] options The options for taking a screenshot.
-    # @option options [Boolean] :debug_screenshot
+    # @option options [Boolean] :debug_screenshots
     # @option options [Enumerator] :name_enumerator The name enumerator.
     def initialize(driver, options = {})
       self.driver = driver
-      options = { debug_screenshot: false }.merge! options
+      options = { debug_screenshots: false }.merge! options
       self.debug_screenshot_provider = options[:debug_screenshot_provider]
     end
 
@@ -32,7 +34,7 @@ module Applitools::Selenium
 
     private
 
-    attr_accessor :debug_screenshot
+    attr_accessor :debug_screenshots
 
     def save_debug_screenshot(screenshot, suffix)
       debug_screenshot_provider.save(screenshot, suffix || '')

data/lib/applitools/selenium/target.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   module Selenium
     class Target
@@ -11,19 +13,23 @@ module Applitools
           new
         end
 
-        def region(element)
-          new.region(element)
+        def region(*args)
+          new.region(*args)
         end
       end
 
-      attr_accessor :element, :frames, :region_to_check, :coordinate_type, :options, :ignored_regions, :floating_regions
+      attr_accessor :element, :frames, :region_to_check, :coordinate_type, :options, :ignored_regions,
+        :floating_regions, :frame_or_element
+
+      private :frame_or_element, :frame_or_element=
 
       # Initialize a Applitools::Selenium::Target instance.
       def initialize
         self.frames = []
         self.options = {
-          ignore_caret: false,
-          ignore_mismatch: false
+          ignore_caret: true,
+          ignore_mismatch: false,
+          send_dom: nil
         }
         reset_for_fullscreen
       end
@@ -114,11 +120,13 @@ module Applitools
 
       def fully
         options[:stitch_content] = true
+        handle_frames
         self
       end
 
       def frame(element)
-        frames << element
+        frames << frame_or_element if frame_or_element
+        self.frame_or_element = element
         reset_for_fullscreen
         self
       end
@@ -135,9 +143,14 @@ module Applitools
       # @!parse def region(element, how, what); end;
 
       def region(*args)
+        handle_frames
         self.region_to_check = case args.first
                                when Applitools::Selenium::Element, Applitools::Region, ::Selenium::WebDriver::Element
                                  proc { args.first }
+                               when String
+                                 proc do |driver|
+                                   driver.find_element(name_or_id: args.first)
+                                 end
                                else
                                  proc do |driver|
                                    driver.find_element(*args)
@@ -150,6 +163,13 @@ module Applitools
         self
       end
 
+      def finalize
+        return self unless frame_or_element
+        region = frame_or_element
+        self.frame_or_element = nil
+        dup.region(region)
+      end
+
       private
 
       def reset_for_fullscreen
@@ -169,6 +189,12 @@ module Applitools
       def reset_floating
         self.floating_regions = []
       end
+
+      def handle_frames
+        return unless frame_or_element
+        frames << frame_or_element
+        self.frame_or_element = nil
+      end
     end
   end
 end

data/lib/applitools/selenium/viewport_screenshot.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require_relative 'eyes_screenshot'
+module Applitools::Selenium
+  # @!visibility private
+  class ViewportScreenshot < Applitools::Selenium::EyesScreenshot
+    attr_accessor :top_left_location
+
+    def sub_screenshot(region, _coordinate_type, throw_if_clipped = false, force_nil_if_clipped = false)
+      logger.info "get_subscreenshot(#{region}, #{throw_if_clipped})"
+      Applitools::ArgumentGuard.not_nil region, 'region'
+
+      as_is_subscreenshot_region = region.intersect(image_region)
+
+      if as_is_subscreenshot_region.empty? || (throw_if_clipped && as_is_subscreenshot_region.size != region.size)
+        return nil if force_nil_if_clipped
+        raise Applitools::OutOfBoundsException.new "Region #{region} is out" \
+          ' of screenshot bounds.'
+      end
+
+      cropped_image = Applitools::Screenshot.from_image(
+        image.crop(
+          as_is_subscreenshot_region.x,
+          as_is_subscreenshot_region.y,
+          as_is_subscreenshot_region.width,
+          as_is_subscreenshot_region.height
+        )
+      )
+
+      self.class.new(cropped_image, region_provider: region_provider).tap do |s|
+        s.top_left_location = top_left_location.dup.offset(region.location)
+      end
+    end
+
+    def screenshot_offset
+      offset = Applitools::Location::TOP_LEFT.dup
+      offset.offset region_provider.scroll_position_provider.current_position
+      frame_window = region_provider.calculate_frame_window
+      offset.offset_negative(frame_window.location)
+      offset
+    end
+
+    def top_left_location
+      @top_left_location ||= screenshot_offset
+    end
+  end
+end

data/lib/applitools/selenium/viewport_size.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 module Applitools::Selenium
   class ViewportSize
     JS_GET_VIEWPORT_SIZE = <<-JS.freeze

data/lib/applitools/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 module Applitools
-  VERSION = '3.14.3'.freeze
+  VERSION = '3.14.4'.freeze
 end

data/lib/eyes_selenium.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'eyes_core'
 
 module Applitools
@@ -9,6 +11,7 @@ module Applitools
 
   module Selenium
     extend Applitools::RequireUtils
+    class UnsupportedCoordinateType < EyesError; end
     def self.load_dir
       File.dirname(File.expand_path(__FILE__))
     end
@@ -16,7 +19,7 @@ module Applitools
 end
 
 Applitools::Selenium.require_dir 'selenium'
-Applitools::Selenium.require_dir 'poltergeist'
+Applitools::Selenium.require_dir 'selenium/dom_capture'
 
 if defined? Selenium::WebDriver::Driver
   Selenium::WebDriver::Driver.class_eval do
@@ -26,11 +29,3 @@ if defined? Selenium::WebDriver::Driver
     end
   end
 end
-
-if defined? Appium::Driver
-  Appium::Driver.class_eval do
-    def driver_for_eyes(eyes)
-      Applitools::Selenium::Driver.new(eyes, driver: driver || start_driver, is_mobile_device: true)
-    end
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.14.3
+  version: 3.14.4
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eyes_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.14.3
+        version: 3.14.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.14.3
+        version: 3.14.4
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -39,21 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: watir
+  name: css_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,33 +59,36 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/applitools/capybara.rb
-- lib/applitools/poltergeist/applitools_compatible.rb
-- lib/applitools/poltergeist/driver.rb
 - lib/applitools/selenium/border_aware_element_content_location_provider.rb
 - lib/applitools/selenium/browser.rb
-- lib/applitools/selenium/capybara/capybara_settings.rb
-- lib/applitools/selenium/capybara/driver.rb
 - lib/applitools/selenium/context_based_scale_provider.rb
+- lib/applitools/selenium/css_transform/css_transform.rb
+- lib/applitools/selenium/css_translate_element_position_provider.rb
 - lib/applitools/selenium/css_translate_position_provider.rb
+- lib/applitools/selenium/dom_capture/dom_capture.rb
+- lib/applitools/selenium/dom_capture/dom_capture_script.rb
 - lib/applitools/selenium/driver.rb
 - lib/applitools/selenium/element.rb
 - lib/applitools/selenium/element_position_provider.rb
+- lib/applitools/selenium/entire_element_screenshot.rb
 - lib/applitools/selenium/eyes.rb
-- lib/applitools/selenium/eyes_full_page_screenshot.rb
+- lib/applitools/selenium/eyes_screenshot.rb
 - lib/applitools/selenium/eyes_target_locator.rb
-- lib/applitools/selenium/eyes_web_driver_screenshot.rb
+- lib/applitools/selenium/fixed_cut_provider.rb
 - lib/applitools/selenium/frame.rb
 - lib/applitools/selenium/frame_chain.rb
 - lib/applitools/selenium/full_page_capture_algorithm.rb
+- lib/applitools/selenium/fullpage_screenshot.rb
 - lib/applitools/selenium/keyboard.rb
 - lib/applitools/selenium/mouse.rb
 - lib/applitools/selenium/move_to_region_visibility_strategy.rb
 - lib/applitools/selenium/nop_region_visibility_strategy.rb
+- lib/applitools/selenium/region_provider.rb
 - lib/applitools/selenium/sauce/driver.rb
 - lib/applitools/selenium/scroll_position_provider.rb
 - lib/applitools/selenium/takes_screenshot_image_provider.rb
 - lib/applitools/selenium/target.rb
+- lib/applitools/selenium/viewport_screenshot.rb
 - lib/applitools/selenium/viewport_size.rb
 - lib/applitools/version.rb
 - lib/eyes_selenium.rb
@@ -123,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Applitools Ruby Images SDK