eyes_selenium 3.10.1 → 3.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f06722619f30d8f8161191c90e260f3942796534
-  data.tar.gz: 6cdf3ed4f48197d05086001b133ee60097cd7fcf
+  metadata.gz: 15870d2d4f82382cfb5e1a66f0b250203bcf55a4
+  data.tar.gz: 1d65c7e9e6ea324b9f31c456836c8e9588db587d
 SHA512:
-  metadata.gz: 2cb6db07bd67a7d263f2e5e43ecc040eba9a5754832e7535b54ebdf76ef2711ffa7731dc4e4cac0bc71aa96df8a07dd2de57b6b22fcb382a3f178c6d1929f6d8
-  data.tar.gz: e860a3b924cbb7f90824ab0b323638a2c00440dc2cca4303bba39a1fafdace7cf43b9bbd86e7579252211385495ee27112b76fceab119a5bf93421a18d407568
+  metadata.gz: 880a3ee29beb57e4dd1694d817d44934f1bcccd0576163da8ecf03b262fa43dc907e1033bb93c53eb371ac36848b55fcd2f457cd65fde811ab12ad85d32b135e
+  data.tar.gz: '094d8aca9b731dca647045c665a45221326621d2194030ef4f496f67063787e658506093ffc96a14a2940e049c4c24d5096b4054e8fbccfae50bca8aa1895f8d'

data/lib/applitools/selenium/driver.rb

@@ -28,7 +28,6 @@ module Applitools::Selenium
     }.freeze
 
     attr_reader :browser
-    attr_accessor :wait_before_screenshots
     attr_accessor :rotation
 
     def_delegators :@eyes, :add_mouse_trigger, :add_text_trigger
@@ -45,7 +44,6 @@ module Applitools::Selenium
     def initialize(eyes, options)
       super(options[:driver])
       @is_mobile_device = options.fetch(:is_mobile_device, false)
-      @wait_before_screenshots = 0
       @eyes = eyes
       @frame_chain = Applitools::Selenium::FrameChain.new
       @browser = Applitools::Selenium::Browser.new(self, @eyes)
@@ -122,8 +120,8 @@ module Applitools::Selenium
       screenshot.to_blob
     end
 
-    # Finds an element, specified by +what+ parameter interpreting it in the way, specified in +how+ parameter
-    # @param [Symbol] how Defines the way that +what+ parameter will be interpreted (The type of selector). Can be one
+    # Finds an element in a window.
+    # @param [Symbol] how Defines the way that +what+ parameter will be interpreted (finder). Can be one
     #   of: +:class+, +:class_name+, +:css+, +:id+, +:link+, +:link_text+, +:name+, +:partial_link_text+, +:tag_name+,
     #   +:xpath+
     # @param [String] what The selector to find an element
@@ -137,11 +135,6 @@ module Applitools::Selenium
     # @return [Applitools::Selenium::Element]
     # @!parse def find_element(how, what); end
 
-    # Finds an element in a window.
-    #
-    # @param [Array] *args The arguments for finding the element (at most contains 2 params).
-    # @option args [Symbol] :by By what means to search for the element (e.g. :css, :id).
-    # @option args [String] Name of element.
     def find_element(*args)
       how, what = extract_args(args)
 
@@ -151,8 +144,8 @@ module Applitools::Selenium
       Applitools::Selenium::Element.new(self, driver.find_element(how, what))
     end
 
-    # Finds elements, specified by +what+ parameter interpreting it in the way, specified in +how+ parameter
-    # @param [Symbol] how Defines the way that +what+ parameter will be interpreted (The type of selector). Can be one
+    # Finds elements in a window.
+    # @param [Symbol] how Defines the way that +what+ parameter will be interpreted (finder). Can be one
     #   of: +:class+, +:class_name+, +:css+, +:id+, +:link+, +:link_text+, +:name+, +:partial_link_text+, +:tag_name+,
     #   +:xpath+
     # @param [String] what The selector to find an element
@@ -166,11 +159,6 @@ module Applitools::Selenium
     # @return [ [Applitools::Selenium::Element] ]
     # @!parse def find_elements(how, what); end
 
-    # Finds elements in a window.
-    #
-    # @param [Array] *args The arguments for finding the element (at most contains 2 params).
-    # @option args [Symbol] :by By what means to search for the element (e.g. :css, :id).
-    # @option args [String] Name of elements.
     def find_elements(*args)
       how, what = extract_args(args)
 

data/lib/applitools/selenium/element.rb

@@ -67,9 +67,8 @@ module Applitools::Selenium
     alias eql? ==
 
     # Types content into text box.
-    #
-    # @param [Array] *args The arguments.
-    # @option *args [String] The content to type.
+    # @param [Array, String] keys The content to type.
+    # @!parse def send_keys(keys); end;
     def send_keys(*args)
       Selenium::WebDriver::Keys.encode(args).each do |key|
         @driver.add_text_trigger(self, key.to_s)

data/lib/applitools/selenium/eyes.rb

@@ -11,12 +11,6 @@ module Applitools::Selenium
 
     USE_DEFAULT_MATCH_TIMEOUT = -1
 
-    # @!visibility private
-    STICH_MODE = {
-      :scroll => :SCROLL,
-      :css => :CSS
-    }.freeze
-
     extend Forwardable
     # @!visibility public
 
@@ -24,7 +18,7 @@ module Applitools::Selenium
       def eyes_driver(driver, eyes = nil)
         if driver.respond_to? :driver_for_eyes
           driver.driver_for_eyes eyes
-        elsif driver.is_a? Capybara::Poltergeist::Driver
+        elsif defined?(::Capybara::Poltergeist) && (driver.is_a? ::Capybara::Poltergeist::Driver)
           Applitools::Poltergeist::Driver.new(eyes, driver: driver)
         else
           unless driver.is_a?(Applitools::Selenium::Driver)
@@ -99,7 +93,7 @@ module Applitools::Selenium
       self.dont_get_title = false
       self.hide_scrollbars = false
       self.device_pixel_ratio = UNKNOWN_DEVICE_PIXEL_RATIO
-      self.stitch_mode = STICH_MODE[:scroll]
+      self.stitch_mode = Applitools::STITCH_MODE[:scroll]
       self.wait_before_screenshots = DEFAULT_WAIT_BEFORE_SCREENSHOTS
       self.region_visibility_strategy = MoveToRegionVisibilityStrategy.new
       self.debug_screenshot = false
@@ -134,21 +128,7 @@ module Applitools::Selenium
       end
 
       @driver = self.class.eyes_driver(driver, self)
-
-      # if driver.respond_to? :driver_for_eyes
-      #   @driver = driver.driver_for_eyes self
-      # elsif driver.is_a? Capybara::Poltergeist::Driver
-      #   @driver = Applitools::Poltergeist::Driver.new(self, driver: driver)
-      # else
-      #   unless driver.is_a?(Applitools::Selenium::Driver)
-      #     logger.warn("Unrecognized driver type: (#{driver.class.name})!")
-      #     is_mobile_device = driver.respond_to?(:capabilities) && driver.capabilities['platformName']
-      #     @driver = Applitools::Selenium::Driver.new(self, driver: driver, is_mobile_device: is_mobile_device)
-      #   end
-      # end
-
       self.device_pixel_ratio = UNKNOWN_DEVICE_PIXEL_RATIO
-
       self.position_provider = self.class.position_provider(
         stitch_mode, driver, disable_horizontal_scrolling, disable_vertical_scrolling, explicit_entire_size
       )
@@ -170,13 +150,17 @@ module Applitools::Selenium
     # @option value [Symbol] :scroll Scroll to perform stitching.
     # @return [Symbol] The type of stitching.
     def stitch_mode=(value)
-      @stitch_mode = value.to_s.upcase == STICH_MODE[:css].to_s ? STICH_MODE[:css] : STICH_MODE[:scroll]
+      @stitch_mode = if value.to_s.upcase == Applitools::STITCH_MODE[:css].to_s
+                       Applitools::STITCH_MODE[:css]
+                     else
+                       Applitools::STITCH_MODE[:scroll]
+                     end
       unless driver.nil?
         self.position_provider = self.class.position_provider(
           stitch_mode, driver, disable_horizontal_scrolling, disable_vertical_scrolling, explicit_entire_size
         )
       end
-      if stitch_mode == STICH_MODE[:css]
+      if stitch_mode == Applitools::STITCH_MODE[:css]
         @css_transition_original_hide_scrollbars = hide_scrollbars
         self.hide_scrollbars = true
       else
@@ -190,39 +174,10 @@ module Applitools::Selenium
     # @param [String] tag An optional tag to be assosiated with the snapshot.
     # @param [Fixnum] match_timeout The amount of time to retry matching (seconds)
     def check_window(tag = nil, match_timeout = USE_DEFAULT_MATCH_TIMEOUT)
-      self.tag_for_debug = tag
-      self.screenshot_name_enumerator = nil
-      if disabled?
-        logger.info "check_window(#{tag}, #{match_timeout}): Ignored"
-        return
-      end
-
-      logger.info "check_window(match_timeout: #{match_timeout}, tag: #{tag}): Ignored" if disabled?
-      logger.info "check_window(match_timeout: #{match_timeout}, tag: #{tag})"
-
-      region_provider = Object.new
-      region_provider.instance_eval do
-        define_singleton_method :region do
-          Applitools::Region::EMPTY
-        end
-        define_singleton_method :coordinate_type do
-          nil
-        end
-      end
-
-      self.eyes_screenshot_factory = lambda do |image|
-        Applitools::Selenium::EyesWebDriverScreenshot.new(
-          image, driver: driver, force_offset: position_provider.force_offset
-        )
-      end
-
-      match_data = Applitools::MatchWindowData.new.tap do |d|
-        d.tag = tag
-        d.ignore_mismatch = false
-        d.match_level = default_match_settings[:match_level]
+      target = Applitools::Selenium::Target.window.tap do |t|
+        t.timeout(match_timeout)
       end
-
-      check_window_base region_provider, match_timeout, match_data
+      check(tag, target)
     end
 
     # @!visibility private
@@ -246,11 +201,14 @@ module Applitools::Selenium
     # @param [Applitools::Selenium::Target] target which area of the window to check.
     # @return [Applitools::MatchResult] The match results.
     def check(name, target)
+      logger.info "check(#{name}) is called"
+      self.tag_for_debug = name
       Applitools::ArgumentGuard.is_a? target, 'target', Applitools::Selenium::Target
       original_overflow = nil
       original_position_provider = position_provider
 
       eyes_element = nil
+      timeout = target.options[:timeout] || USE_DEFAULT_MATCH_TIMEOUT
 
       self.eyes_screenshot_factory = lambda do |image|
         Applitools::Selenium::EyesWebDriverScreenshot.new(
@@ -262,6 +220,7 @@ module Applitools::Selenium
         begin
           match_data = Applitools::MatchWindowData.new
           match_data.tag = name
+          update_default_settings(match_data)
           match_data.read_target(target, driver)
           eyes_element = target.region_to_check.call(driver)
           region_visibility_strategy.move_to_region original_position_provider,
@@ -270,16 +229,19 @@ module Applitools::Selenium
           check_window = false
           if !target.frames.empty? && eyes_element.is_a?(Applitools::Region)
             # check_current_frame
+            logger.info "check_region_in_frame(#{eyes_element})"
             region_provider = region_provider_for_frame
 
           elsif eyes_element.is_a? Applitools::Selenium::Element
             # check_element
+            logger.info 'check_region(' \
+              "#{Applitools::Region.from_location_size(eyes_element.location, eyes_element.size)})"
             region_provider = Applitools::RegionProvider.new(
-              region_for_element(eyes_element),
-              target.coordinate_type
+              region_for_element(eyes_element), target.coordinate_type
             )
           else
             # check_window
+            logger.info "check_window(match_timeout: #{timeout}, tag: #{match_data.tag})"
             region_provider = Applitools::RegionProvider.new(
               region_for_element(eyes_element),
               target.coordinate_type
@@ -305,7 +267,7 @@ module Applitools::Selenium
           end
 
           check_window_base(
-            region_provider, target.options[:timeout] || USE_DEFAULT_MATCH_TIMEOUT, match_data
+            region_provider, timeout, match_data
           )
         ensure
           eyes_element.overflow = original_overflow unless original_overflow.nil?
@@ -421,13 +383,11 @@ module Applitools::Selenium
     #   stitch_content: false)
     # @!parse def check_region(element, how=nil, what=nil, options = {}); end
     def check_region(*args)
-      options = Applitools::Utils.extract_options! args
+      options = { timeout: USE_DEFAULT_MATCH_TIMEOUT, tag: nil }.merge! Applitools::Utils.extract_options!(args)
+      target = Applitools::Selenium::Target.new.region(*args).timeout(options[:match_timeout])
+      target.fully if options[:stitch_content]
       self.screenshot_name_enumerator = nil
-      if options.delete(:stitch_content)
-        check_element args, options
-      else
-        check_region_ args, options
-      end
+      check(options[:tag], target)
     end
 
     # Validates the contents of an iframe and matches it with the expected output.
@@ -435,29 +395,24 @@ module Applitools::Selenium
     # @param [Hash] options The specific parameters of the desired screenshot.
     # @option options [Fixnum] :timeout The amount of time to retry matching. (Seconds)
     # @option options [String] :tag An optional tag to be associated with the snapshot.
-    # @option options [String] :frame_key The key of the relevant frame.
-    # @option options [String] :name_or_id The name or id of the screenshot.
+    # @option options [String] :frame Frame element or frame name or frame id.
+    # @option options [String] :name_or_id The name or id of the target frame (deprecated. use :frame instead).
+    # @option options [String] :frame_element The frame element (deprecated. use :frame instead).
     # @return [Applitools::MatchResult] The match results.
+
     def check_frame(options = {})
       options = { timeout: USE_DEFAULT_MATCH_TIMEOUT, tag: nil }.merge!(options)
-
-      process_in_frame options do |opts, frame_key|
-        if disabled?
-          logger.info "check_frame(#{frame_key}: #{opts[frame_key]}, timeout: #{opts[:timeout]}, " \
-            "tag: #{opts[:tag]}): Ignored"
-          return
-        end
-
-        logger.info "check_frame(#{frame_key}: #{opts[frame_key]}, timeout: #{opts[:timeout]}, " \
-          "tag: #{opts[:tag]})"
-        check_current_frame opts[:timeout], opts[:tag]
-      end
+      frame = options[:frame] || options[:frame_element] || options[:name_or_id]
+      target = Applitools::Selenium::Target.frame(frame).timeout(options[:timeout]).fully
+      check(options[:tag], target)
     end
 
     # Validates the contents of a region in an iframe and matches it with the expected output.
     #
     # @param [Hash] options The specific parameters of the desired screenshot.
-    # @option options [String] :name_or_id The name or id of the frame.
+    # @option options [String] :name_or_id The name or id of the target frame (deprecated. use :frame instead).
+    # @option options [String] :frame_element The frame element (deprecated. use :frame instead).
+    # @option options [String] :frame Frame element or frame name or frame id.
     # @option options [String] :tag An optional tag to be associated with the snapshot.
     # @option options [Symbol] :by By which identifier to find the region (e.g :css, :id).
     # @option options [Fixnum] :timeout The amount of time to retry matching. (Seconds)
@@ -469,16 +424,14 @@ module Applitools::Selenium
       Applitools::ArgumentGuard.is_a? options[:by], 'options[:by]', Array
 
       how_what = options.delete(:by)
+      frame = options[:frame] || options[:frame_element] || options[:name_or_id]
 
-      process_in_frame options do |opts, frame_key|
-        if disabled?
-          logger.info "check_region_in_frame(#{frame_key}: #{options[frame_key]}, by: #{options[:by]}, " \
-                          "timeout: #{options[:timeout]}, tag: #{options[:tag]}): Ignored)"
-          return
-        end
+      target = Applitools::Selenium::Target.new.timeout(options[:timeout])
+      target.frame(frame) if frame
+      target.fully if options[:stitch_content]
+      target.region(*how_what)
 
-        check_region(*how_what, tag: opts[:tag], timeout: opts[:timeout], stitch_content: opts[:stitch_content])
-      end
+      check(options[:tag], target)
     end
 
     # @!parse def check_region(element, how=nil, what=nil, options = {}); end
@@ -516,143 +469,12 @@ module Applitools::Selenium
       end
     end
 
-    # Validates the contents of an iframe and matches it with the expected output.
-    #
-    # @param [Hash] options The options.
-    # @option [Fixnum] :index The index of the iframe.
-    # @option [String] :name_or_id The name or id of the screenshot.
-    # @option [Applitools::Selenium::Element] :frame_element The relevant frame.
-    # @option [Array] :frames_path
-    # @option [Applitools::Selenium::FrameChain] :frame_chain
-    # @option [Fixnum] :timeout The amount of time to retry matching. (Seconds)
-    # @option [String] :tag An optional tag to be associated with the snapshot.
-    # @option [String] :frame_key The key of the relevant frame.
-    def check_frame__(options = {})
-      options = { timeout: USE_DEFAULT_MATCH_TIMEOUT, tag: nil }.merge!(options)
-
-      unless options[:index] ||
-          options[:name_or_id] ||
-          options[:frame_element] ||
-          options[:frame_chain] ||
-          options[:frames_path]
-        raise Applitools::EyesIllegalArgument.new 'You must pass :index or :name_or_id or :frame_element option' \
-          '  or :frame_chain option or :frames_path option'
-      end
-
-      if (needed_keys = (options.keys & [:index, :name_or_id, :frame_element, :frame_chain, :frames_path])).length == 1
-        frame_key = needed_keys.first
-      else
-        raise Applitools::EyesIllegalArgument.new 'You\'ve passed some extra keys!' \
-          'Only one of :index, :name_or_id or :frame_elenent or :frame_chain or :frames_path is allowed.'
-      end
-
-      if disabled?
-        logger.info "check_frame(#{frame_key}: #{options[frame_key]}, timeout: #{options[:timeout]}," \
-          " tag: #{options[:tag]}): Ignored"
-        return
-      end
-
-      frame_or_frames = options[frame_key]
-      if frame_or_frames.respond_to? :pop
-        frame_to_check = frame_or_frames.pop
-        original_frame_chain = driver.frame_chain
-        logger.info 'Switching to parent frame according to frames path...'
-        driver.switch_to.frames(frame_key => frame_or_frames)
-        logger.info 'Done!'
-        case frame_to_check
-        when String
-          frame_options = { name_or_id: frame_to_check }
-        when Applitools::Selenium::Element
-          frame_options = { frame_element: frame_to_check }
-        else
-          raise Applitools::EyesError.new "Unknown frame class: #{frame_to_check.class}"
-        end
-      else
-        frame_options = { frame_key => options[frame_key] }
-      end
-
-      logger.info "check_frame(#{frame_key}: #{options[frame_key]}, timeout: #{options[:timeout]}," /
-        " tag: #{options[:tag]})"
-      logger.info 'Switching to requested frame...'
-
-      driver.switch_to.frame frame_options
-      logger.info 'Done!'
-
-      check_current_frame options[:timeout], options[:tag]
-
-      logger.info 'Switching back to parent_frame...'
-      driver.switch_to.parent_frame
-      logger.info 'Done!'
-      return unless original_frame_chain
-
-      logger.info 'Switching back into original frame...'
-      driver.switch_to.frames frame_chain: original_frame_chain
-    end
-
     private
 
     attr_accessor :check_frame_or_element, :region_to_check, :dont_get_title,
       :device_pixel_ratio, :position_provider, :scale_provider, :tag_for_debug,
       :region_visibility_strategy, :eyes_screenshot_factory
 
-    def process_in_frame(options = {})
-      unless options[:index] ||
-          options[:name_or_id] ||
-          options[:frame_element] ||
-          options[:frame_chain] ||
-          options[:frames_path] ||
-          options[:target_frames]
-        raise Applitools::EyesIllegalArgument.new 'You must pass :index or :name_or_id or :frame_element option' /
-          'or :frame_chain option or :frames_path option'
-      end
-
-      needed_keys = (
-        options.keys & [:index, :name_or_id, :frame_element, :frame_chain, :frames_path, :target_frames]
-      )
-
-      if needed_keys.length == 1
-        frame_key = needed_keys.first
-      else
-        raise Applitools::EyesIllegalArgument.new 'You\'ve passed some extra keys!' /
-          'Only one of :index, :name_or_id or :frame_elenent or :frame_chain or :frames_path is allowed.'
-      end
-
-      frame_or_frames = options[frame_key]
-      if frame_or_frames.respond_to? :pop
-        frame_to_check = frame_or_frames.pop
-        original_frame_chain = driver.frame_chain
-        logger.info 'Switching to parent frame according to frames path...'
-        driver.switch_to.frames(frame_key => frame_or_frames)
-        logger.info 'Done!'
-        case frame_to_check
-        when String
-          frame_options = { name_or_id: frame_to_check }
-        when Applitools::Selenium::Element
-          frame_options = { frame_element: frame_to_check }
-        else
-          raise Applitools::EyesError.new "Unknown frame class: #{frame_to_check.class}"
-        end
-      else
-        frame_options = { frame_key => options[frame_key] }
-      end
-
-      logger.info 'Switching to requested frame...'
-
-      driver.switch_to.frame frame_options
-      logger.info 'Done!'
-
-      yield(options, frame_key) if block_given?
-
-      logger.info 'Switching back to parent_frame...'
-      driver.switch_to.parent_frame
-      logger.info 'Done!'
-
-      return unless original_frame_chain
-
-      logger.info 'Switching back into original frame...'
-      driver.switch_to.frames frame_chain: original_frame_chain
-    end
-
     def capture_screenshot
       image_provider = Applitools::Selenium::TakesScreenshotImageProvider.new driver,
         debug_screenshot: debug_screenshot, name_enumerator: screenshot_name_enumerator
@@ -673,7 +495,7 @@ module Applitools::Selenium
           logger.info 'Check frame/element requested'
           algo = Applitools::Selenium::FullPageCaptureAlgorithm.new
 
-          entire_frame_or_element = algo.get_stiched_region(
+          entire_frame_or_element = algo.get_stitched_region(
             image_provider: image_provider,
             region_to_check: region_to_check,
             origin_provider: position_provider,
@@ -704,7 +526,7 @@ module Applitools::Selenium
               nil
             end
           end
-          full_page_image = algo.get_stiched_region image_provider: image_provider,
+          full_page_image = algo.get_stitched_region image_provider: image_provider,
                                   region_to_check: region_provider,
                                   origin_provider: Applitools::Selenium::ScrollPositionProvider.new(driver),
                                   position_provider: position_provider,
@@ -724,6 +546,7 @@ module Applitools::Selenium
           ewd_screenshot
         else
           logger.info 'Screenshot requested...'
+          sleep wait_before_screenshots
           image = image_provider.take_screenshot
           scale_provider.scale_image(image) if scale_provider
           cut_provider.cut(image) if cut_provider
@@ -1033,7 +856,7 @@ module Applitools::Selenium
     #    pair should be used in find_element
     # @param [Hash] options
     # @option options [String] :tag
-    # @option options [Float] :tmatch_timeout
+    # @option options [Float] :match_timeout
 
     def check_element(element_or_selector, options = {})
       selector = element_or_selector if Applitools::Selenium::Driver::FINDERS.keys.include? element_or_selector.first

data/lib/applitools/selenium/eyes_web_driver_screenshot.rb

@@ -22,10 +22,21 @@ module Applitools::Selenium
     class << self
       alias _new new
 
+      # rubocop:disable LineLength
       # Creates new image.
       #
-      # @param [Array] *args The arguments.
+      # @param [Applitools::Screenshot] image
+      # @param [Hash] options
+      # @option options [Applitools::Selenium::Driver] :driver Applitools driver instance.
+      # @option options [Applitools::RectangleSize] :entire_frame_size The size of the entire frame.
+      # @option options [Applitools::Location] :frame_location_in_screenshot The location of the frame in the screenshot.
+      # @option options [String] :screenshot_type One of allowed types - 'VIEPORT' or 'ENTIRE_FRAME'
+      # @option options [Applitools::Location] :force_offset
+
       # @return [Applitools::Screenshot] The image.
+      # @!parse def initialize(image, options); end
+      # rubocop:enable LineLength
+
       def new(*args)
         image = args.shift
         raise Applitools::EyesIllegalArgument.new 'image is expected to be Applitools::Screenshot!' unless
@@ -79,7 +90,6 @@ module Applitools::Selenium
     # @param [Hash] options The options.
     # @option options [Symbol] :driver Applitools driver instance.
     # @option options [Symbol] :entire_frame_size The size of the entire frame.
-    # @option options [Symbol] :entire_frame The frame instance.
     # @option options [Symbol] :frame_location_in_screenshot The location of the frame in the screenshot.
     def initialize_for_element(options = {})
       Applitools::ArgumentGuard.not_nil options[:driver], 'options[:driver]'
@@ -169,17 +179,9 @@ module Applitools::Selenium
       logger.info 'Done!'
     end
 
-    # def scroll_position
-    #   begin
-    #     position_provider.state
-    #   rescue
-    #     Applitools::Location.new(0,0)
-    #   end
-    # end
-
     # Convert the location.
     #
-    # @param [Applitools::Location] location.
+    # @param [Applitools::Location] location Location to convert
     # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] from Source.
     # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] to Destination.
     # @return [Applitools::Location] The converted location.

data/lib/applitools/selenium/frame_chain.rb

@@ -66,6 +66,10 @@ module Applitools::Selenium
       @frames.last.size
     end
 
+    def to_s
+      @frames.map(&:to_s).join(', ')
+    end
+
     class NoFramesException < RuntimeError; end
   end
 end

data/lib/applitools/selenium/full_page_capture_algorithm.rb

@@ -19,8 +19,8 @@ module Applitools::Selenium
     # @option [Integer] :wait_before_screenshots The time to wait before taking screenshot.
     # @option [Faraday::Request::UrlEncoded] :eyes_screenshot_factory The images.
     # @return [Applitools::Image] The entire image.
-    def get_stiched_region(options = {})
-      logger.info 'get_stiched_region() has been invoked.'
+    def get_stitched_region(options = {})
+      logger.info 'get_stitched_region() has been invoked.'
       image_provider = options[:image_provider]
       region_provider = options[:region_to_check]
       origin_provider = options[:origin_provider]

data/lib/applitools/selenium/keyboard.rb

@@ -14,7 +14,7 @@ module Applitools::Selenium
 
     # Types the keys into a text box.
     #
-    # @param [Array] *keys The keys to type into the text box.
+    # @param [Array] keys The keys to type into the text box.
     def send_keys(*keys)
       active_element = Applitools::Selenium::Element.new(driver, driver.switch_to.active_element)
       current_control = active_element.region

data/lib/applitools/selenium/move_to_region_visibility_strategy.rb

@@ -1,5 +1,4 @@
 module Applitools::Selenium
-  # @!visibility private
   class MoveToRegionVisibilityStrategy
     extend Forwardable
 
@@ -8,12 +7,13 @@ module Applitools::Selenium
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
     attr_accessor :original_position
 
+    # rubocop:disable LineLength
     # Set the location of the position provider.
     #
-    # @param [Applitools::Selenium::CssTranslatePositionProvider, Applitools::Selenium::ScrollPositionProvider]
-    # position_provider The position provider type (e.g. Applitools::Selenium::CssTranslatePositionProvider,
-    # Applitools::Selenium::ScrollPositionProvider).
+    # @param [Applitools::Selenium::CssTranslatePositionProvider, Applitools::Selenium::ScrollPositionProvider] position_provider
+    #   The position provider type (e.g. Applitools::Selenium::CssTranslatePositionProvider, Applitools::Selenium::ScrollPositionProvider).
     # @param [Applitools::Location] location The location to move to.
+    # rubocop:enable LineLength
     def move_to_region(position_provider, location)
       logger.info 'Getting current position state...'
       self.original_position = position_provider.state
@@ -30,11 +30,11 @@ module Applitools::Selenium
       logger.info 'Done!'
     end
 
-    # Return the position provider to its original position.
-    #
-    # @param [Applitools::Selenium::CssTranslatePositionProvider, Applitools::Selenium::ScrollPositionProvider]
-    # position_provider The position provider type (e.g. Applitools::Selenium::CssTranslatePositionProvider,
-    # Applitools::Selenium::ScrollPositionProvider).
+    # rubocop:disable LineLength
+    # Returns the position provider to its original position.
+    # @param [Applitools::Selenium::CssTranslatePositionProvider, Applitools::Selenium::ScrollPositionProvider] position_provider
+    #   The position provider type (e.g. Applitools::Selenium::CssTranslatePositionProvider,  Applitools::Selenium::ScrollPositionProvider).
+    # rubocop:enable LineLength
     def return_to_original_position(position_provider)
       return if original_position.nil?
       logger.info 'Returning to original position...'

data/lib/applitools/selenium/target.rb

@@ -28,19 +28,21 @@ module Applitools
         reset_for_fullscreen
       end
 
+      # rubocop:disable LineLength
       # Add the wanted ignored regions.
       #
-      # @param [Array] *args The arguments to ignore.
-      # @option args [String] :name The name of the region to ignore.
-      # @option args [Integer] :id The id of the region to ignore.
+      # @param [Applitools::Selenium::Element, Applitools::Region, ::Selenium::WebDriver::Element] region_or_element the region to ignore or an element representing the region to ignore
+      # @param [Symbol, String] how A finder to be used (see Selenium::WebDriver documentation for complete list of available finders)
+      # @param [Symbol, String] what An id or selector to find
+      # @!parse def ignore(region_or_element, how, what); end;
+      # rubocop:enable LineLength
+
       def ignore(*args)
         if args.empty?
           reset_ignore
         else
           ignored_regions << case args.first
-                             when Applitools::Selenium::Element
-                               proc { args.first }
-                             when Applitools::Region
+                             when Applitools::Selenium::Element, Applitools::Region, ::Selenium::WebDriver::Element
                                proc { args.first }
                              else
                                proc do |driver|
@@ -56,8 +58,8 @@ module Applitools
         value = case args.first
                 when Applitools::FloatingRegion
                   proc { args.first }
-                when Applitools::Selenium::Element
-                  proc { Applitools::FloatingRegion.for_element args.shift, *args }
+                when ::Selenium::WebDriver::Element, Applitools::Selenium::Element
+                  proc { Applitools::FloatingRegion.any args.shift, *args }
                 when Applitools::Region
                   proc do
                     region = args.shift
@@ -65,7 +67,7 @@ module Applitools
                   end
                 else
                   proc do |driver|
-                    Applitools::FloatingRegion.for_element driver.find_element(args.shift, args.shift), *args
+                    Applitools::FloatingRegion.any driver.find_element(args.shift, args.shift), *args
                   end
                 end
         floating_regions << value
@@ -83,17 +85,23 @@ module Applitools
         self
       end
 
+      # rubocop:disable LineLength
       # Add the desired region.
       #
-      # @param [Array] *args The arguments to add.
-      # @option args [Integer] :timeout The timeout.
-      # @option args [Integer] :id The id of the region.
-      # @return [Applitools::Selenium::Target] Self instance.
+      # @param [Applitools::Selenium::Element, Applitools::Region, ::Selenium::WebDriver::Element] element the target region or an element representing the target region
+      # @param [Symbol, String] how The finder to be used (:css, :id, etc. see Selenium::WebDriver documentation for complete list of available finders)
+      # @param [Symbol, String] what Selector or id of an element
+      # @example Add region by element
+      #   target.region(an_element)
+      # @example Add target region by finder
+      #   target.region(:id, 'target_region')
+      # @return [Applitools::Selenium::Target] A Target instance.
+      # @!parse def region(element, how, what); end;
+      # rubocop:enable LineLength
+
       def region(*args)
         self.region_to_check = case args.first
-                               when Applitools::Selenium::Element
-                                 proc { args.first }
-                               when Applitools::Region
+                               when Applitools::Selenium::Element, Applitools::Region, ::Selenium::WebDriver::Element
                                  proc { args.first }
                                else
                                  proc do |driver|

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '3.10.1'.freeze
+  VERSION = '3.10.2'.freeze
 end

data/lib/eyes_selenium.rb

@@ -1,6 +1,12 @@
 require 'eyes_core'
 
 module Applitools
+  # @!visibility private
+  STITCH_MODE = {
+    :scroll => :SCROLL,
+    :css => :CSS
+  }.freeze
+
   module Selenium
     extend Applitools::RequireUtils
     def self.load_dir

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 3.10.2
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-07-10 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.10.1
+        version: 3.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.10.1
+        version: 3.10.2
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +92,6 @@ files:
 - lib/applitools/selenium/frame_chain.rb
 - lib/applitools/selenium/full_page_capture_algorithm.rb
 - lib/applitools/selenium/keyboard.rb
-- lib/applitools/selenium/match_window_task.rb
 - lib/applitools/selenium/mouse.rb
 - lib/applitools/selenium/move_to_region_visibility_strategy.rb
 - lib/applitools/selenium/nop_region_visibility_strategy.rb
@@ -123,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Applitools Ruby Images SDK