eyes_selenium 3.6.8 → 3.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0ba303b56fbfe37317a95906df6aa448d0fc03e
-  data.tar.gz: 6a6c2742e1636c2dc374b41641e9d3c4444c737a
+  metadata.gz: ec128f5f784cf650ef0813cbe6f3f8723f928ec0
+  data.tar.gz: 96fef4717ef49d6ba7a8d73ee4b3b7e15c82fae0
 SHA512:
-  metadata.gz: 1694ee6dd79bad5c22eb191fb8ac20b3131bafcbe7f39fb97ce67698879005e0bdca906ffe2ef2197c61dc11c7f3e7e17f8380319dd2c11323459e9b784f4a58
-  data.tar.gz: adbe9e6af50014fdaa19d53d40812cf5e6eea1da6e799c855e3d66f9ebacec8d79b9bc517af5f58a07aaa30fed15c8c2bac96b3251e3d3cf83281c8a235e2eb6
+  metadata.gz: dbd2ea8b825228f633ad96e340bfa4dc8759634dfe617c6c665a1c957157110277f56554efe18d70ee70c77420d39b10e0f8c8f9c403d6655483a5e61ed5325b
+  data.tar.gz: 5d48ebf42e9e285390f9d6f54da5654891d53e9a9d39b78b4743f4617059fa9c22d72667c0a6dbd1caf9006d8ddc4bf9181bc5371f0737c786f4a10d2dd29f51

data/lib/applitools/selenium/border_aware_element_content_location_provider.rb

@@ -7,6 +7,9 @@ module Applitools::Selenium
 
     attr_accessor :element, :location, :size
 
+    # Initialize class instance.
+    #
+    # @param [Applitools::Selenium::Element] element The target element.
     def initialize(element)
       raise Applitools::EyesIllegalArgument.new 'Passed element is not Applitools::Selenium::Element instance!' unless
           element.is_a? Applitools::Selenium::Element

data/lib/applitools/selenium/browser.rb

@@ -59,6 +59,10 @@ module Applitools::Selenium
     MAX_SCROLLBAR_SIZE = 50
     OVERFLOW_HIDDEN = 'hidden'.freeze
 
+    # Initialize class instance.
+    #
+    # @param [Applitools::Selenium::Driver] driver The wrapped Selenium driver.
+    # @param [Applitools::Selenium::Eyes] eyes The eyes instance.
     def initialize(driver, eyes)
       @driver = driver
       @eyes = eyes
@@ -80,6 +84,10 @@ module Applitools::Selenium
       end
     end
 
+    # Gets the normalization factor.
+    #
+    # @param [ChunkyPNG::Canvas] image The image to normalize.
+    # @return [Integer] The image normalization factor.
     def image_normalization_factor(image)
       # If the user manually set the scale ratio, we use that.
       return @eyes.scale_ratio unless @eyes.scale_ratio.nil?
@@ -92,6 +100,9 @@ module Applitools::Selenium
       1.to_f / device_pixel_ratio
     end
 
+    # The dimensions of the entire page.
+    #
+    # @return [Applitools::Base::Dimension] The dimensions of the entire page.
     def entire_page_size
       max_document_element_height = [page_metrics[:client_height], page_metrics[:scroll_height]].max
       max_body_height = [page_metrics[:body_client_height], page_metrics[:body_scroll_height]].max
@@ -102,6 +113,9 @@ module Applitools::Selenium
       Applitools::Base::Dimension.new(total_width, total_height)
     end
 
+    # Returns the current scroll position.
+    #
+    # @return [Applitools::Base::Point] The coordinates of the scroll position.
     def current_scroll_position
       position = Applitools::Utils.underscore_hash_keys(execute_script(JS_GET_CURRENT_SCROLL_POSITION))
       Applitools::Base::Point.new(position[:left], position[:top])
@@ -135,6 +149,9 @@ module Applitools::Selenium
       set_transform("translate(-#{point.left}px, -#{point.top}px)")
     end
 
+    # Takes a full page screenshot.
+    #
+    # @return [ChunkyPNG::Canvas] image The result of the screenshot.
     def fullpage_screenshot
       # Scroll to the top/left corner of the screen.
       original_scroll_position = current_scroll_position

data/lib/applitools/selenium/context_based_scale_provider.rb

@@ -7,6 +7,12 @@ module Applitools::Selenium
 
     attr_reader :top_level_context_entire_size, :viewport_size, :device_pixel_ratio, :scale_ratio
 
+    # Initialize a class instance.
+    #
+    # @param [Applitools::RectangleSize] top_level_context_entire_size The entire
+    # size of the context.
+    # @param [Hash] viewport_size The required browser's viewport size.
+    # @param [Fixnum] device_pixel_ratio The device's pixel ratio.
     def initialize(top_level_context_entire_size, viewport_size, device_pixel_ratio)
       @top_level_context_entire_size = top_level_context_entire_size
       @viewport_size = viewport_size
@@ -14,6 +20,9 @@ module Applitools::Selenium
       @scale_ratio = UNKNOWN_SCALE_RATIO
     end
 
+    # Scales the image.
+    #
+    # @param [Screenshot::Datastream] image The image to scale.
     def scale_image(image)
       if @scale_ratio == UNKNOWN_SCALE_RATIO
         @scale_ratio = if ((image.width >= viewport_size.width - ALLOWED_VS_DEVIATION) &&
@@ -28,6 +37,9 @@ module Applitools::Selenium
       Applitools::Utils::ImageUtils.scale!(image, scale_ratio)
     end
 
+    # Gets the scale ratio.
+    #
+    # @return [Fixnum] The scale ratio.
     def scale_ratio
       raise Applitools::EyesError.new 'Scale ratio is not defined yet!' if @scale_ratio == UNKNOWN_SCALE_RATIO
       @scale_ratio

data/lib/applitools/selenium/css_translate_position_provider.rb

@@ -6,6 +6,13 @@ module Applitools::Selenium
 
     attr_accessor :last_state_position
 
+    # Initialize a class instance.
+    #
+    # @param [Applitools::Selenium::Driver] executor The driver instance.
+    # @param [Boolean] disable_horizontal Whether to disable horizontal movement or not.
+    # @param [Boolean] disable_vertical Whether to disable vertical movement or not.
+    # @param [Integer] max_width The max width.
+    # @param [Integer] max_height The max height.
     def initialize(executor, disable_horizontal = false, disable_vertical = false, max_width: nil, max_height: nil)
       self.executor = executor
       self.disable_horizontal = disable_horizontal
@@ -22,6 +29,9 @@ module Applitools::Selenium
       Applitools::Utils::EyesSeleniumUtils.current_transforms(executor)
     end
 
+    # Restore last state position.
+    #
+    # @param [Applitools::Location] value The location.
     def restore_state(value)
       transforms = value.values.select { |el| !el.empty? }
       Applitools::Utils::EyesSeleniumUtils.set_transforms(executor, value)
@@ -48,6 +58,9 @@ module Applitools::Selenium
 
     alias scroll_to position=
 
+    # Gets the entire size of the frame.
+    #
+    # @return [Applitools::RectangleSize] The entire size of the frame.
     def entire_size
       viewport_size = Applitools::Utils::EyesSeleniumUtils.extract_viewport_size(executor)
       result = Applitools::Utils::EyesSeleniumUtils.current_frame_content_entire_size(executor)

data/lib/applitools/selenium/driver.rb

@@ -35,7 +35,13 @@ module Applitools::Selenium
     def_delegators :@browser, :user_agent
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
 
+    # Initializes a class instance.
+    #
     # If driver is not provided, Applitools::Selenium::Driver will raise an EyesError exception.
+    # @param eyes [Applitools::Selenium::Eyes] The eyes instance.
+    # @param options [Hash] The options.
+    # @option options [Selenium::WebDriver::Driver] :driver The Selenium webdriver instance.
+    # @option options [Boolean] :is_mobile_device Whether is a mobile device or not.
     def initialize(eyes, options)
       super(options[:driver])
       @is_mobile_device = options.fetch(:is_mobile_device, false)
@@ -46,17 +52,22 @@ module Applitools::Selenium
       Applitools::EyesLogger.warn '"screenshot_as" method not found!' unless driver.respond_to? :screenshot_as
     end
 
-    # Executes javascript in browser context
+    # Executes javascript in browser context.
+    #
     # @raise [Applitools::EyesDriverOperationException]
     def execute_script(*args)
       raises_error { __getobj__.execute_script(*args) }
     end
 
+    # Returns the platform name.
+    #
     # @return [String] The platform name or +nil+ if it is undefined.
     def platform_name
       capabilities['platformName']
     end
 
+    # Returns the platform version.
+    #
     # @return [String] The platform version or +nil+ if it is undefined.
     def platform_version
       version = capabilities['platformVersion']
@@ -88,6 +99,7 @@ module Applitools::Selenium
     end
 
     # Returns native driver
+    #
     # @return Selenium::WebDriver
     def remote_web_driver
       driver
@@ -95,7 +107,8 @@ module Applitools::Selenium
 
     alias set_overflow overflow=
 
-    # Takes a screenshot
+    # Takes a screenshot.
+    #
     # @param [:Symbol] format A format to store screenshot (one of +:base64+ or +:png+)
     # @return [String] A byte string, representing the screenshot
     def screenshot_as(format)
@@ -123,6 +136,11 @@ 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)
 
@@ -147,6 +165,11 @@ 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)
 
@@ -166,7 +189,9 @@ module Applitools::Selenium
     end
 
     # Returns a copy of current frame chain. Frame chain stores information about all parent frames,
-    #   including scroll offset an frame coordinates
+    #   including scroll offset an frame coordinates.
+    #
+    # @return [Applitools::Selenium::FrameChain] The frame chain.
     def frame_chain
       Applitools::Selenium::FrameChain.new other: @frame_chain
     end
@@ -177,10 +202,11 @@ module Applitools::Selenium
       @frame_chain
     end
 
-    # Gets +default_content_viewport_size+
+    # Gets +default_content_viewport_size+.
+    #
     # @param [Boolean] force_query if set to true, forces querying of viewport size from the browser,
-    #   otherwise returns cached value
-    # @return [Applitools::RectangleSize]
+    #   otherwise returns cached value.
+    # @return [Applitools::RectangleSize] The default content viewport size.
     def default_content_viewport_size(force_query = false)
       logger.info('default_content_viewport_size()')
       if cached_default_content_viewport_size && !force_query

data/lib/applitools/selenium/element.rb

@@ -30,6 +30,10 @@ module Applitools::Selenium
 
     # def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
 
+    # Initialize class instance.
+    #
+    # @param [Applitools::Selenium::Driver] driver The wrapped Selenium driver instance.
+    # @param [Applitools::Selenium::Element] element The wrapped Selenium element instance.
     def initialize(driver, element)
       super(element)
 
@@ -62,6 +66,10 @@ module Applitools::Selenium
 
     alias eql? ==
 
+    # Types content into text box.
+    #
+    # @param [Array] *args The arguments.
+    # @option *args [String] The content to type.
     def send_keys(*args)
       Selenium::WebDriver::Keys.encode(args).each do |key|
         @driver.add_text_trigger(self, key.to_s)
@@ -70,6 +78,9 @@ module Applitools::Selenium
     end
     alias send_key send_keys
 
+    # Gets the bounds of the element.
+    #
+    # @return [Applitools::Base::Region] An instance of the region.
     def bounds
       point = location
       left = point.x

data/lib/applitools/selenium/element_position_provider.rb

@@ -4,6 +4,10 @@ module Applitools::Selenium
     extend Forwardable
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
 
+    # Initialize a class instance.
+    #
+    # @param [Applitools::Selenium::Driver] executor The wrapped Selenium driver instance.
+    # @param [Applitools::Selenium::Element] passed_element The wrapped Selenium element instance.
     def initialize(executor, passed_element)
       Applitools::ArgumentGuard.not_nil 'executor', executor
       Applitools::ArgumentGuard.not_nil 'passed_element', passed_element
@@ -13,6 +17,9 @@ module Applitools::Selenium
           element.is_a? Applitools::Selenium::Element
     end
 
+    # Gets the current position.
+    #
+    # @return [Applitools::Location] The location.
     def current_position
       logger.info 'current_position() has called.'
       result = Applitools::Location.for element.scroll_left, element.scroll_top
@@ -20,6 +27,9 @@ module Applitools::Selenium
       result
     end
 
+    # Gets the enitire size of the element.
+    #
+    # @return [Applitools::RectangleSize] The size of the element.
     def entire_size
       logger.info 'entire_size()'
       result = Applitools::RectangleSize.new(element.scroll_width, element.scroll_height)

data/lib/applitools/selenium/eyes.rb

@@ -36,6 +36,10 @@ module Applitools::Selenium
         end
       end
 
+      # Set the viewport size.
+      #
+      # @param [Applitools::Selenium::Driver] driver The driver instance.
+      # @param [Hash] viewport_size The required browser's viewport size.
       def set_viewport_size(driver, viewport_size)
         Applitools::ArgumentGuard.not_nil(driver, 'Driver')
         Applitools::ArgumentGuard.not_nil(viewport_size, 'viewport_size')
@@ -84,7 +88,8 @@ module Applitools::Selenium
 
     # Creates a new (possibly disabled) Eyes instance that interacts with the
     # Eyes Server at the specified url.
-    # @param server_url The Eyes Server URL
+    #
+    # @param server_url The Eyes Server URL.
     def initialize(server_url = nil)
       super
       self.base_agent_id = "eyes.selenium.ruby/#{Applitools::VERSION}".freeze
@@ -104,6 +109,7 @@ module Applitools::Selenium
     end
 
     # Starts a test
+    #
     # @param options [Hash] options
     # @option options :driver The driver that controls the browser hosting the application
     #   under the test. (*Required* option)
@@ -157,6 +163,12 @@ module Applitools::Selenium
       @driver
     end
 
+    # Sets the stitch mode.
+    #
+    # @param [Hash] value The desired type of stitching (:SCROLL is default).
+    # @option value [Symbol] :css use Css to perform stitching.
+    # @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]
       unless driver.nil?
@@ -174,6 +186,7 @@ module Applitools::Selenium
     end
 
     # Takes a snapshot of the application under test and matches it with the expected output.
+    #
     # @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)
@@ -227,6 +240,11 @@ module Applitools::Selenium
       Applitools::Utils::EyesSeleniumUtils.extract_viewport_size(driver)
     end
 
+    # Takes a snapshot and matches it with the expected output.
+    #
+    # @param [String] name The name of the tag.
+    # @param [Applitools::Selenium::Target] target which area of the window to check.
+    # @return [Applitools::MatchResult] The match results.
     def check(name, target)
       Applitools::ArgumentGuard.is_a? target, 'target', Applitools::Selenium::Target
       original_overflow = nil
@@ -301,6 +319,10 @@ module Applitools::Selenium
       end
     end
 
+    # Validates the contents of an iframe and matches it with the expected output.
+    #
+    # @param [Hash] options The specific parameters of the desired screenshot.
+    # @option options [Array] :target_frames The frames to check.
     def check_in_frame(options)
       frames = options.delete :target_frames
 
@@ -323,6 +345,10 @@ module Applitools::Selenium
       driver.switch_to.frames frame_chain: original_frame_chain
     end
 
+    # Creates a region instance.
+    #
+    # @param [Applitools::Element] element The element.
+    # @return [Applitools::Region] The relevant region.
     def region_for_element(element)
       return element if element.is_a? Applitools::Region
 
@@ -342,6 +368,9 @@ module Applitools::Selenium
       )
     end
 
+    # Returns the region of a given iframe.
+    #
+    # @return [Applitools::Region] The region of the iframe.
     def region_provider_for_frame
       Object.new.tap do |provider|
         current_frame_size = lambda do
@@ -375,6 +404,7 @@ module Applitools::Selenium
 
     # Takes a snapshot of the application under test and matches a region of
     # a specific element with the expected region output.
+    #
     # @param [Applitools::Selenium::Element] element Represents a region to check.
     # @param [Symbol] how a finder, such :css or :id. Selects a finder will be used to find an element
     #   See Selenium::Webdriver::Element#find_element documentation for full list of possible finders.
@@ -401,6 +431,14 @@ module Applitools::Selenium
       end
     end
 
+    # Validates the contents of an iframe and matches it with the expected output.
+    #
+    # @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.
+    # @return [Applitools::MatchResult] The match results.
     def check_frame(options = {})
       options = { timeout: USE_DEFAULT_MATCH_TIMEOUT, tag: nil }.merge!(options)
 
@@ -417,8 +455,15 @@ module Applitools::Selenium
       end
     end
 
-    # @param [hash] options
-    # @option options []
+    # 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] :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)
+    # @option options [Boolean] :stitch_content Whether to stitch the content or not.
+    # @return [Applitools::MatchResult] The match results.
     def check_region_in_frame(options = {})
       options = { timeout: USE_DEFAULT_MATCH_TIMEOUT, tag: nil, stitch_content: false }.merge!(options)
       Applitools::ArgumentGuard.not_nil options[:by], 'options[:by]'
@@ -472,14 +517,17 @@ module Applitools::Selenium
       end
     end
 
-    # @param [Hash] options
-    # @option [Fixnum] :index
-    # @option [String] :name_or_id
-    # @option [Applitools::Selenium::Element] :frame_element
+    # 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
-    # @option [String] :tag
+    # @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)
 
@@ -919,6 +967,7 @@ module Applitools::Selenium
     end
 
     # check a region, specified by element_or_selector parameter
+    #
     # @param [Array] element_or_selector Array, which contains Applitools::Selenium::Element or [:finder, :value]
     #    pair should be used in find_element
     # @param [Hash] options
@@ -980,6 +1029,7 @@ module Applitools::Selenium
     end
 
     # Checks an element, specified by +element_or_selector+ parameter
+    #
     # @param [Array] element_or_selector Array, which contains Applitools::Selenium::Element or [:finder, :value]
     #    pair should be used in find_element
     # @param [Hash] options
@@ -1096,6 +1146,7 @@ module Applitools::Selenium
     end
 
     # Resets screenshot_names sequence to initial state.
+    #
     # @param [Boolean] value should be false or nil to reset the sequence. Takes no effect if +true+ passed
     def screenshot_name_enumerator=(value)
       @name_enumerator = nil unless value

data/lib/applitools/selenium/eyes_target_locator.rb

@@ -6,6 +6,11 @@ module Applitools::Selenium
 
     attr_reader :driver, :on_will_switch, :scroll_position_provider
 
+    # Initialize a class instance.
+    #
+    # @param [Applitools::Selenium::Driver] driver The wrapped Selenium driver instance.
+    # @param [Applitools::Selenium::EyesTargetLocator] original_target_locator The  target locator.
+    # @param [FrameChangeEventListener] on_will_switch
     def initialize(driver, original_target_locator, on_will_switch)
       super(original_target_locator)
       @driver = driver
@@ -13,11 +18,12 @@ module Applitools::Selenium
       @scroll_position_provider = Applitools::Selenium::ScrollPositionProvider.new(driver)
     end
 
-    # @param [Hash] options
-    # @option options [Fixnum] :index
-    # @option options [String] :name_or_id
-    # @option options [WebElement] :frameElement
-    # @return [Applitools::Selenium::Driver]
+    # Set a certain iframe.
+    #
+    # @param [Hash] options The possible options.
+    # @option options [Fixnum] :index The index of the frame.
+    # @option options [String] :name_or_id The name of the frame.
+    # @option options [WebElement] :frameElement The element with the frame.
     def frame(options = {})
       raise Applitools::EyesIllegalArgument.new 'You must pass :index or :name_or_id or :frame_element option' unless
           options[:index] || options[:name_or_id] || options[:frame_element]
@@ -29,6 +35,9 @@ module Applitools::Selenium
       end
     end
 
+    # Switches to parent frame.
+    #
+    # @return [Applitools::Selenium::Driver] The wrapped Selenium driver instance.
     def parent_frame
       logger.info 'EyesTargetLocator.parent_frame()'
       unless driver.frame_chain.empty?
@@ -40,10 +49,11 @@ module Applitools::Selenium
       driver
     end
 
-    # @param [hash] options
-    # @option options [Applitools::Selenium::FrameChain] :frame_chain
-    # @option options [String] :frames_path
-    # @return Applitools::Selenium::Driver
+    # Sets several frames.
+    #
+    # @param [hash] options The options for the frames.
+    # @option options [Applitools::Selenium::FrameChain] :frame_chain The frame chain.
+    # @option options [String] :frames_path The frames paths.
     def frames(options = {})
       raise Applitools::EyesIllegalArgument.new 'You must pass :frame_chain or :frames_path' if
           options[:frame_chain].nil? & options[:frames_path].nil?
@@ -56,7 +66,9 @@ module Applitools::Selenium
       end
     end
 
-    # A wrapper for the native method +default_content+
+    # A wrapper for the native method +default_content+.
+    #
+    # @return [Applitools::Selenium::Driver] The wrapped Selenium driver instance.
     def default_content
       logger.info 'EyesTargetLocator.default_content()'
       unless driver.frame_chain.empty?
@@ -69,7 +81,9 @@ module Applitools::Selenium
       driver
     end
 
-    # A wrapper for the native method +window+
+    # A wrapper for the native method +window+.
+    #
+    # @return [Applitools::Selenium::Driver] The wrapped Selenium driver instance.
     def window(name_or_handle)
       logger.info 'EyesTargetLocator.window()'
       logger.info 'Making preparaions...'
@@ -80,7 +94,9 @@ module Applitools::Selenium
       driver
     end
 
-    # A wrapper for the native method +active_element+
+    # A wrapper for the native method +active_element+.
+    #
+    # @return [Applitools::Selenium::Element] The wrapped Selenium element instance.
     def active_element
       logger.info 'EyesTargetLocator.active_element()'
       logger.info 'Switching to element...'
@@ -98,7 +114,9 @@ module Applitools::Selenium
       result
     end
 
-    # A wrapper for a native method +alert+
+    # A wrapper for a native method +alert+.
+    #
+    # @return [Applitools::Selenium::EyesTargetLocator] The result .
     def alert
       logger.info 'EyesTargetLocator.alert()'
       logger.info 'Switching to alert...'

data/lib/applitools/selenium/eyes_web_driver_screenshot.rb

@@ -22,6 +22,10 @@ module Applitools::Selenium
     class << self
       alias _new new
 
+      # Creates new image.
+      #
+      # @param [Array] *args The arguments.
+      # @return [Applitools::Screenshot] The image.
       def new(*args)
         image = args.shift
         raise Applitools::EyesIllegalArgument.new 'image is expected to be Applitools::Screenshot!' unless
@@ -37,6 +41,12 @@ module Applitools::Selenium
         raise Applitools::EyesIllegalArgument.new "#{self.class}.initialize(): Hash is expected as an argument!"
       end
 
+      # Calculates the frame location in the screenshot.
+      #
+      # @param [Applitools::Selenium::FrameChain] frame_chain The driver's frame chain.
+      # @param [String] screenshot_type The type of the screenshot.
+      # @param [Logger] logger The logger instance.
+      # @return [Applitools::Location] The location in the screenshot.
       def calc_frame_location_in_screenshot(frame_chain, screenshot_type, logger)
         frame_chain = Applitools::Selenium::FrameChain.new other: frame_chain
         logger.info 'Getting first frame...'
@@ -64,6 +74,13 @@ module Applitools::Selenium
       end
     end
 
+    # Initialize element.
+    #
+    # @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]'
       Applitools::ArgumentGuard.not_nil options[:entire_frame_size], 'options[:entire_frame_size]'
@@ -78,6 +95,16 @@ module Applitools::Selenium
       self.frame_window = Applitools::Region.new(0, 0, entire_frame_size.width, entire_frame_size.height)
     end
 
+    # Initializes class properties.
+    #
+    # @param [Hash] options The options.
+    # @option options [Symbol] :driver Wrapped Selenium driver instance.
+    # @option options [Symbol] :position_provider The ScrollPositionProvider.
+    # @option options [Symbol] :viewport The viewport instance.
+    # @option options [Symbol] :entire_frame The entire frame instance.
+    # @option options [Symbol] :screenshot_type The screenshot type.
+    # @option options [Symbol] :frame_location_in_screenshot The frame location in the screenshot.
+    # @option options [Symbol] :force_offset Whether to force offset or not.
     def initialize_main(options = {})
       # options = {screenshot_type: SCREENSHOT_TYPES[:viewport]}.merge options
 
@@ -150,6 +177,12 @@ module Applitools::Selenium
     #   end
     # end
 
+    # Convert the location.
+    #
+    # @param [Applitools::Location] location.
+    # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] from Source.
+    # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] to Destination.
+    # @return [Applitools::Location] The converted location.
     def convert_location(location, from, to)
       Applitools::ArgumentGuard.not_nil location, 'location'
       Applitools::ArgumentGuard.not_nil from, 'from'
@@ -197,6 +230,14 @@ module Applitools::Selenium
       Applitools::Selenium::FrameChain.new other: @frame_chain
     end
 
+    # Returns the intersected region.
+    #
+    # @param [Applitools::Selenium::Region] region The relevant region.
+    # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] original_coordinate_types The type of
+    # the original coordinates.
+    # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] result_coordinate_types The type of the
+    # original coordinates.
+    # @return [Applitools::Region] The intersected region.
     def intersected_region(region, original_coordinate_types, result_coordinate_types)
       return Applitools::Region::EMPTY if region.empty?
       intersected_region = convert_region_location(
@@ -223,6 +264,11 @@ module Applitools::Selenium
       )
     end
 
+    # Returns the location in the screenshot.
+    #
+    # @param [Applitools::Location] location The location.
+    # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] coordinate_type The type of the coordinate.
+    # @return [Applitools::Location] The location instance in the screenshot.
     def location_in_screenshot(location, coordinate_type)
       location = convert_location(
         location, coordinate_type, Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is]
@@ -235,6 +281,12 @@ module Applitools::Selenium
       location
     end
 
+    # Gets a sub-screenshot of a region.
+    #
+    # @param [Applitools::Region] region The relevant region for taking screenshot.
+    # @param [Applitools::EyesScreenshot::COORDINATE_TYPES] coordinate_type The coordinate type.
+    # @param [Boolean] throw_if_clipped Whether to throw if screenshot is out of bounds.
+    # @return [Applitools::Screenshot] The sub screenshot.
     def sub_screenshot(region, coordinate_type, throw_if_clipped = false, force_nil_if_clipped = false)
       logger.info "get_subscreenshot(#{region}, #{coordinate_type}, #{throw_if_clipped})"
       Applitools::ArgumentGuard.not_nil region, 'region'

data/lib/applitools/selenium/frame_chain.rb

@@ -53,6 +53,9 @@ module Applitools::Selenium
       @frames.last
     end
 
+    # Returns the default content scroll position.
+    #
+    # @return [Applitools::Base::Point] The coordinates of the result.
     def default_content_scroll_position
       raise NoFramesException.new 'No frames!' if @frames.empty?
       result = @frames.first.parent_scroll_position

data/lib/applitools/selenium/full_page_capture_algorithm.rb

@@ -7,6 +7,18 @@ module Applitools::Selenium
     MAX_SCROLL_BAR_SIZE = 50
     MIN_SCREENSHOT_PART_HEIGHT = 10
 
+    # Returns the stitched image.
+    #
+    # @param [Hash] options The options.
+    # @option [Applitools::Selenium::TakesScreenshotImageProvider] :image_provider
+    # @option [Applitools::Region] :region_to_check
+    # @option [Applitools::Selenium::ScrollPositionProvider] :origin_provider
+    # @option [Applitools::Selenium::ElementPositionProvider] :position_provider
+    # @option [Applitools::Selenium::ContextBasedScaleProvider] :scale_provider
+    # @option [Applitools::FixedCutProvider] :cut_provider
+    # @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.'
       image_provider = options[:image_provider]

data/lib/applitools/selenium/keyboard.rb

@@ -3,11 +3,18 @@ module Applitools::Selenium
   class Keyboard
     attr_reader :keyboard, :driver
 
+    # Creates a new Applitools::Selenium::Keyboard instance.
+    #
+    # @param [Applitools::Selenium::Driver] driver The driver instance.
+    # @param [Selenium::WebDriver::Keyboard] keyboard The keyboard instance.
     def initialize(driver, keyboard)
       @driver = driver
       @keyboard = keyboard
     end
 
+    # Types the keys into a 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
@@ -17,10 +24,16 @@ module Applitools::Selenium
       keyboard.send_keys(*keys)
     end
 
+    # Press the key.
+    #
+    # @param [String] key The key to press.
     def press(key)
       keyboard.press(key)
     end
 
+    # Release the key.
+    #
+    # @param [String] key The key to release.
     def release(key)
       keyboard.release(key)
     end

data/lib/applitools/selenium/mouse.rb

@@ -3,6 +3,10 @@ module Applitools::Selenium
   class Mouse
     attr_reader :driver, :mouse
 
+    # Creates a new Applitools::Selenium::Mouse instance.
+    #
+    # @param [Applitools::Selenium::Driver] driver The driver instance.
+    # @param [Selenium::WebDriver::Mouse] mouse The mouse instance.
     def initialize(driver, mouse)
       @driver = driver
       @mouse = mouse
@@ -28,6 +32,11 @@ module Applitools::Selenium
       extract_trigger_and_perform(:up, element)
     end
 
+    # Moves the mouse to a certain region.
+    #
+    # @param [Applitools::Selenium::Element] element The element to move the mouse to.
+    # @param [Integer] right_by The amount to move to the right.
+    # @param [Integer] down_by The amount to move down.
     def move_to(element, right_by = nil, down_by = nil)
       element = element.web_element if element.is_a?(Applitools::Selenium::Element)
       location = element.location
@@ -39,6 +48,10 @@ module Applitools::Selenium
       mouse.move_to(element, right_by, down_by)
     end
 
+    # Moves the mouse to a certain point.
+    #
+    # @param [Integer] right_by The amount to move to the right.
+    # @param [Integer] down_by The amount to move down.
     def move_by(right_by, down_by)
       right = [0, right_by].max.round
       down = [0, down_by].max.round

data/lib/applitools/selenium/move_to_region_visibility_strategy.rb

@@ -8,6 +8,12 @@ module Applitools::Selenium
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
     attr_accessor :original_position
 
+    # 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::Location] location The location to move to.
     def move_to_region(position_provider, location)
       logger.info 'Getting current position state...'
       self.original_position = position_provider.state
@@ -24,6 +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).
     def return_to_original_position(position_provider)
       return if original_position.nil?
       logger.info 'Returning to original position...'

data/lib/applitools/selenium/scroll_position_provider.rb

@@ -5,6 +5,11 @@ module Applitools::Selenium
 
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
 
+    # Creates a new Applitools::Selenium::ScrollPositionProvider instance.
+    #
+    # @param [Applitools::Selenium::Driver] executor The instance that of the driver.
+    # @param [Boolean] disable_horizontal Whether to disable horizontal movement or not.
+    # @param [Boolean] disable_vertical Whether to disable vertical movement or not.
     def initialize(executor, disable_horizontal = false, disable_vertical = false, max_width: nil, max_height: nil)
       self.executor = executor
       self.disable_horizontal = disable_horizontal
@@ -13,7 +18,9 @@ module Applitools::Selenium
       self.max_height = max_height
     end
 
-    # The scroll position of the current frame
+    # The scroll position of the current frame.
+    #
+    # @return [Applitools::Location] The current position of the ScrollPositionProvider.
     def current_position
       logger.info 'current_position()'
       result = Applitools::Utils::EyesSeleniumUtils.current_scroll_position(executor)
@@ -39,6 +46,9 @@ module Applitools::Selenium
 
     alias scroll_to position=
 
+    # Returns the entire size of the viewport.
+    #
+    # @return [Applitools::RectangleSize] The viewport size.
     def entire_size
       viewport_size = Applitools::Utils::EyesSeleniumUtils.extract_viewport_size(executor)
       result = Applitools::Utils::EyesSeleniumUtils.entire_page_size(executor)

data/lib/applitools/selenium/takes_screenshot_image_provider.rb

@@ -5,6 +5,13 @@ module Applitools::Selenium
     def_delegators 'Applitools::EyesLogger', :logger, :log_handler, :log_handler=
 
     attr_accessor :driver, :name_enumerator
+
+    # Initialize an Applitools::Selenium::TakesScreenshotImageProvider.
+    #
+    # @param [Applitools::Selenium::Driver] driver
+    # @param [Hash] options The options for taking a screenshot.
+    # @option options [Boolean] :debug_screenshot
+    # @option options [Enumerator] :name_enumerator The name enumerator.
     def initialize(driver, options = {})
       self.driver = driver
       options = { debug_screenshot: false }.merge! options
@@ -12,6 +19,9 @@ module Applitools::Selenium
       self.name_enumerator = options[:name_enumerator]
     end
 
+    # Takes a screenshot.
+    #
+    # @return [Applitools::Screenshot::Datastream] The screenshot.
     def take_screenshot
       logger.info 'Getting screenshot...'
       if debug_screenshot

data/lib/applitools/selenium/target.rb

@@ -13,12 +13,18 @@ module Applitools
 
       attr_accessor :element, :frames, :region_to_check, :coordinate_type, :options, :ignored_regions
 
+      # Initialize a Applitools::Selenium::Target instance.
       def initialize
         self.frames = []
         self.options = {}
         reset_for_fullscreen
       end
 
+      # 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.
       def ignore(*args)
         if args.first
           ignored_regions << if args.first.is_a? Applitools::Selenium::Element
@@ -56,6 +62,12 @@ module Applitools
         self
       end
 
+      # 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.
       def region(*args)
         self.region_to_check = if args.first.is_a? Applitools::Selenium::Element
                                  proc do

data/lib/applitools/selenium/viewport_size.rb

@@ -25,6 +25,10 @@ module Applitools::Selenium
     VERIFY_RETRIES = 3
     BROWSER_SIZE_CALCULATION_RETRIES = 2
 
+    # Initialize a Applitools::Selenium::ViewportSize instance.
+    #
+    # @param [Applitools::Selenium::Driver] driver The driver instance.
+    # @param [Applitools::Base::Dimension] dimension The dimension of the viewport size.
     def initialize(driver, dimension = nil)
       @driver = driver
       @dimension = dimension.nil? ? nil : setup_dimension(dimension)
@@ -40,6 +44,9 @@ module Applitools::Selenium
 
     alias extract_viewport_from_browser! extract_viewport_size!
 
+    # Extract the viewport size.
+    #
+    # @return [Applitools::Base::Dimension] The dimensions of the viewport size.
     def extract_viewport_size
       width = nil
       height = nil
@@ -64,6 +71,7 @@ module Applitools::Selenium
     alias viewport_size extract_viewport_size
     alias extract_viewport_from_browser extract_viewport_size
 
+    # Set the viewport size.
     def set
       Applitools::EyesLogger.debug "Set viewport size #{@dimension}"
       # Before resizing the window, set its position to the upper left corner (otherwise, there might not be enough
@@ -124,7 +132,6 @@ module Applitools::Selenium
     # tries to resize browser, yields a block (which should check if an attempt was successful) before each iteration.
     # If the block returns true, stop trying and returns true (resize was successful)
     # Otherwise, returns false after VERIFY_RETRIES iterations
-
     def resize_attempt
       actual_viewport_size = extract_viewport_size
       Applitools::EyesLogger.debug "Actual viewport size #{actual_viewport_size}"

data/lib/applitools/version.rb

@@ -1,3 +1,3 @@
 module Applitools
-  VERSION = '3.6.8'.freeze
+  VERSION = '3.6.9'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eyes_selenium
 version: !ruby/object:Gem::Version
-  version: 3.6.8
+  version: 3.6.9
 platform: ruby
 authors:
 - Applitools Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-14 00:00:00.000000000 Z
+date: 2017-05-16 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.6.8
+        version: 3.6.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.6.8
+        version: 3.6.9
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement