eyes_selenium 3.15.39 → 3.15.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aab8529dcb077f8221beb47146b533b99972fed1bb8564526ce3e3080ccadab4
-  data.tar.gz: c019144e8b13f7c3f7217dac08d96fbc91e935e028502406c0e76f1518e8facc
+  metadata.gz: dbee900cd3702aacc958add560a4ac3ecd307021f08926babf1b6269d0b5bacf
+  data.tar.gz: 9faadc80999564bfddae87dbb445239e9f8db6c9297f7eefc8e232e149aa00ba
 SHA512:
-  metadata.gz: 99b0b16d5160a1ccbff7915afedaf15b62965ca8a58980e73e198f3e1aa5986d4277dcf423cfaf14da1c61329e831f768af2e15c79fb202a47771da4b4169ad1
-  data.tar.gz: baf60a724aaf8819182a61b726cfbef865e49fe745fbb3c58a9ec589148f95d04aacb6e87b8534bcfcfe84be50a15eed8e8c1c4893b79811b88427b2f33c9255
+  metadata.gz: 89996f378e3540d53126e2392d18158eff4deec019a9a18d3030e65abb67b9265a29d220057ac15f56589bd88c903a8bc6685bccd73909a04ac6d1db190c16d6
+  data.tar.gz: 2513697371bdd3f4ee2dac36933b64cd7ae01730b28d1e7032f5a3c0e97a566279c01d731ce1891f82901685c6aa7a2dbfc269fa1a2345a205d6cf1fcec8a197

data/lib/applitools/selenium/browser_types.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module BrowserTypes
   extend self
   CHROME = :chrome

data/lib/applitools/selenium/browsers_info.rb

@@ -1,25 +1,26 @@
- module Applitools
-   module Selenium
-     class BrowsersInfo < Set
+# frozen_string_literal: true
 
-       def add(obj)
-         return super if obj.is_a? Applitools::Selenium::RenderBrowserInfo
-         raise(
-           Applitools::EyesIllegalArgument,
-           "It is expected the value to be an Applitools::Selenium::RenderBrowserInfo instance," \
-           " but got #{obj.class} instead"
-         )
-       end
+module Applitools
+  module Selenium
+    class BrowsersInfo < Set
+      def add(obj)
+        return super if obj.is_a? Applitools::Selenium::RenderBrowserInfo
+        raise(
+          Applitools::EyesIllegalArgument,
+          'It is expected the value to be an Applitools::Selenium::RenderBrowserInfo instance,' \
+          " but got #{obj.class} instead"
+        )
+      end
 
-       def each(viewport_size = nil)
-         return super() unless empty?
-         return unless viewport_size
-         default = Applitools::Selenium::RenderBrowserInfo.new.tap do |bi|
-           bi.viewport_size = viewport_size
-           bi.browser_type = BrowserTypes::CHROME
-         end
-         yield(default)
-       end
-     end
-   end
- end
+      def each(viewport_size = nil)
+        return super() unless empty?
+        return unless viewport_size
+        default = Applitools::Selenium::RenderBrowserInfo.new.tap do |bi|
+          bi.viewport_size = viewport_size
+          bi.browser_type = BrowserTypes::CHROME
+        end
+        yield(default)
+      end
+    end
+  end
+end

data/lib/applitools/selenium/concerns/selenium_eyes.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Applitools
+  module Selenium
+    module Concerns
+      module SeleniumEyes
+        USE_DEFAULT_MATCH_TIMEOUT = -1
+
+        # 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)
+          Applitools::ArgumentGuard.is_a? options, 'options', Hash
+
+          frames = options.delete :target_frames
+
+          Applitools::ArgumentGuard.is_a? frames, 'target_frames: []', Array
+
+          return yield if block_given? && frames.empty?
+
+          original_frame_chain = driver.frame_chain
+
+          logger.info 'Switching to target frame according to frames path...'
+          driver.switch_to.frames(frames_path: frames)
+          frame_chain_to_reset = driver.frame_chain
+          logger.info 'Done!'
+
+          ensure_frame_visible
+
+          yield if block_given?
+
+          reset_frames_scroll_position(frame_chain_to_reset)
+
+          logger.info 'Switching back into top level frame...'
+          driver.switch_to.default_content
+          return unless original_frame_chain
+          logger.info 'Switching back into original frame...'
+          driver.switch_to.frames frame_chain: original_frame_chain
+        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)
+        def check_window(*args)
+          tag = args.select { |a| a.is_a?(String) || a.is_a?(Symbol) }.first
+          match_timeout = args.select { |a| a.is_a?(Integer) }.first
+          fully = args.select { |a| a.is_a?(TrueClass) || a.is_a?(FalseClass) }.first
+          target = Applitools::Selenium::Target.window.tap do |t|
+            t.timeout(match_timeout || USE_DEFAULT_MATCH_TIMEOUT)
+            if is_a?(Applitools::Selenium::VisualGridEyes)
+              t.fully(true)
+            else
+              t.fully(force_full_page_screenshot)
+            end
+            t.fully(fully) unless fully.nil?
+          end
+          check(tag, target)
+        end
+
+        # 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.
+        # @param [String] what The value will be passed to a specified finder. If finder is :css it must be a css selector.
+        # @param [Hash] options
+        # @option options [String] :tag An optional tag to be associated with the snapshot.
+        # @option options [Fixnum] :match_timeout The amount of time to retry matching. (Seconds)
+        # @option options [Boolean] :stitch_content If set to true, will try to get full content of the element
+        #   (including hidden content due overflow settings) by scrolling the element,
+        #   taking and stitching partial screenshots.
+        # @example Check region by element
+        #   check_region(element, tag: 'Check a region by element', match_timeout: 3, stitch_content: false)
+        # @example Check region by css selector
+        #   check_region(:css, '.form-row .input#e_mail', tag: 'Check a region by element', match_timeout: 3,
+        #   stitch_content: false)
+        # @!parse def check_region(element, how=nil, what=nil, options = {}); end
+        def check_region(*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]
+          check(options[:tag], target)
+        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 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)
+          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 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)
+        # @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]'
+          Applitools::ArgumentGuard.is_a? options[:by], 'options[:by]', Array
+
+          how_what = options.delete(:by)
+          frame = options[:frame] || options[:frame_element] || options[:name_or_id]
+
+          target = Applitools::Selenium::Target.new.timeout(options[:timeout])
+          target.frame(frame) if frame
+          target.fully if options[:stitch_content]
+          target.region(*how_what)
+
+          check(options[:tag], target)
+        end
+
+        # Use this method to perform seamless testing with selenium through eyes driver.
+        # It yields a block and passes to it an Applitools::Selenium::Driver instance, which wraps standard driver.
+        # Using Selenium methods inside the 'test' block will send the messages to Selenium
+        # after creating the Eyes triggers for them. Options are similar to {open}
+        # @yieldparam driver [Applitools::Selenium::Driver] Gives a driver to a block, which translates calls to a native
+        #   Selemium::Driver instance
+        # @example
+        #   eyes.test(app_name: 'my app', test_name: 'my test') do |driver|
+        #      driver.get "http://www.google.com"
+        #      driver.check_window("initial")
+        #   end
+        def test(options = {}, &_block)
+          open(options)
+          yield(driver)
+          close
+        ensure
+          abort_if_not_closed
+        end
+      end
+    end
+  end
+end

data/lib/applitools/selenium/configuration.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'applitools/selenium/stitch_modes'
 require 'applitools/selenium/browsers_info'
 
 module Applitools
   module Selenium
     class Configuration < Applitools::EyesBaseConfiguration
-
       DEFAULT_CONFIG = proc do
         {
           force_full_page_screenshot: false,
@@ -69,7 +70,7 @@ module Applitools
         new_config = self.class.new
         config_keys.each do |k|
           new_config.send(
-            "#{k}=", case value = self.send(k)
+            "#{k}=", case value = send(k)
                      when Symbol, FalseClass, TrueClass, Integer, Float
                        value
                      else
@@ -84,10 +85,10 @@ module Applitools
         user_defined_vp = super
         user_defined_vp = nil if user_defined_vp.respond_to?(:square) && user_defined_vp.square == 0
         return user_defined_vp if user_defined_vp
-        from_browsers_info = browsers_info.select {|bi| bi.viewport_size.square > 0 }.first
+        from_browsers_info = browsers_info.select { |bi| bi.viewport_size.square > 0 }.first
         return from_browsers_info.viewport_size if from_browsers_info
         nil
       end
     end
   end
-end
+end

data/lib/applitools/selenium/css_parser/find_embedded_resources.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'crass'
 
 module Applitools
@@ -35,7 +37,8 @@ module Applitools
           url = node[:tokens].select { |t| t[:node] == :function && t[:value] == 'url' }.first
           url_index = node[:tokens].index(url)
           url_string_node = url_index && node[:tokens][url_index + 1]
-          url_string_node && url_string_node[:node] == :string && !url_string_node[:value].empty? && url_string_node[:value]
+          url_string_node &&
+            url_string_node[:node] == :string && !url_string_node[:value].empty? && url_string_node[:value]
         end
 
         def fetch_urls(nodes)

data/lib/applitools/selenium/css_translate_position_provider.rb

@@ -38,7 +38,7 @@ module Applitools::Selenium
     #
     # @param [Applitools::Location] value The location.
     def restore_state(value)
-      Applitools::Utils::EyesSeleniumUtils.set_current_transforms(executor, "translate(10px, 0px)")
+      Applitools::Utils::EyesSeleniumUtils.set_current_transforms(executor, 'translate(10px, 0px)')
 
       transforms = value.values.compact.map(&:to_s).select { |el| !el.empty? }
       Applitools::Utils::EyesSeleniumUtils.set_transforms(executor, value)

data/lib/applitools/selenium/devices.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: false
 module Devices
   extend self
   IPhone4 = 'iPhone 4'.freeze

data/lib/applitools/selenium/dom_capture/dom_capture.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Applitools
   module Selenium
     module DomCapture
       extend self
-      DOM_EXTRACTION_TIMEOUT = 300 #seconds
+      DOM_EXTRACTION_TIMEOUT = 300 # seconds
       def full_window_dom(driver, server_connector, logger, position_provider = nil)
         return get_dom(driver, server_connector, logger) unless position_provider
         scroll_top_and_return_back(position_provider) do
@@ -18,7 +20,6 @@ module Applitools
           driver.switch_to.frames(frame_chain: original_frame_chain)
         end
         # CSS processing
-
         dom
       end
 
@@ -35,7 +36,7 @@ module Applitools
           raise Applitools::EyesError, "DOM extraction error: #{script_response['error']}" if script_response['error']
           sleep(0.2)
         end
-        response_lines = script_response['value'].split /\r?\n/
+        response_lines = script_response['value'].split(/\r?\n/)
         separators = Oj.load(response_lines.shift)
         missing_css_list = []
         missing_frame_list = []
@@ -52,7 +53,6 @@ module Applitools
         end
         logger.info "Missing CSS: #{missing_css_list.count}"
         logger.info "Missing frames: #{missing_frame_list.count}"
-        #fetch_css_files(missing_css_list)
 
         frame_data = recurse_frames(driver, server_connector, logger, missing_frame_list)
         result = replace(separators['iframeStartToken'], separators['iframeEndToken'], data.first, frame_data)
@@ -79,9 +79,10 @@ module Applitools
 
             css = missing_css_response.body
 
-            found_and_missing_css = Applitools::Selenium::CssParser::FindEmbeddedResources.new(css).imported_css.map do |found_url|
-              base_url(url).merge(found_url).to_s
-            end
+            found_and_missing_css =
+              Applitools::Selenium::CssParser::FindEmbeddedResources.new(css).imported_css.map do |found_url|
+                base_url(url).merge(found_url).to_s
+              end
             fetch_css_files(found_and_missing_css, server_connector).each do |_k, v|
               css += v
             end
@@ -139,7 +140,7 @@ module Applitools
 
       def base_url(url)
         uri = URI.parse(url)
-        uri.query = uri.fragment = nil;
+        uri.query = uri.fragment = nil
         uri.path = ''
         uri
       end

data/lib/applitools/selenium/dom_capture/dom_capture_script.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   module Selenium
     module DomCapture
@@ -459,4 +461,4 @@ function __captureDomAndPoll() {
 SCRIPT
     end
   end
-end
+end

data/lib/applitools/selenium/external_css_resources.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require 'css_parser'
 
 module Applitools
   module Selenium
     class ExternalCssResources
       include CssParser
-      def initialize(url, base_url = nil)
+      def initialize(url, _base_url = nil)
         @parser = CssParser::Parser.new(absolute_paths: true)
         @parser.load_uri!(url)
         @parser.compact!
@@ -20,9 +21,12 @@ module Applitools
 
       def images
         result = []
-        @parser.each_rule_set { |s| s.expand_background_shorthand!; result.push(s) unless s.get_value('background-image').empty? }
+        @parser.each_rule_set do |s|
+          s.expand_background_shorthand!
+          result.push(s) unless s.get_value('background-image').empty?
+        end
         result
       end
     end
   end
-end
+end

data/lib/applitools/selenium/eyes.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 module Applitools
   module Selenium
     class Eyes < SimpleDelegator
-
       def initialize(*args)
         options = Applitools::Utils.extract_options!(args)
         server_url = options.delete(:server_url)
@@ -13,7 +13,6 @@ module Applitools
           super Applitools::Selenium::SeleniumEyes.new(server_url, runner: runner || Applitools::ClassicRunner.new)
         end
       end
-
     end
   end
-end
+end

data/lib/applitools/selenium/full_page_capture_algorithm.rb

@@ -116,7 +116,11 @@ module Applitools::Selenium
       logger.info 'Done! Adding initial screenshot..'
       logger.info "Initial part:(0,0) [#{image.width} x #{image.height}]"
 
-      image.crop!(0,0,stitched_image.width < image.width ? stitched_image.width : image.width, stitched_image.height < image.height ? stitched_image.height : image.height)
+      image.crop!(
+        0, 0,
+        stitched_image.width < image.width ? stitched_image.width : image.width,
+        stitched_image.height < image.height ? stitched_image.height : image.height
+      )
 
       stitched_image.replace! image, 0, 0
       logger.info 'Done!'

data/lib/applitools/selenium/orientations.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Orientations
   PORTRAIT = 'portrait'
   LANDSCAPE = 'landscape'

data/lib/applitools/selenium/render_browser_info_fluent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Applitools
   module Selenium
     class RenderBrowserInfoFluent
@@ -42,4 +44,4 @@ module Applitools
       end
     end
   end
-end
+end

data/lib/applitools/selenium/render_resources.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
+
 module Applitools
   module Selenium
     class RenderResources < Hash
       class ResourceMissingInCache < EyesError; end
       def []=(key, value)
-        raise Applitools::EyesIllegalArgument, "Expected key to be an instance of URI (but got #{key.class}) - #{key}" unless
-            key.is_a? URI
-        raise Applitools::EyesIllegalArgument, "Expected value to be an instance of Applitools::Selenium::VGResource" \
-            " (but got #{value.class}) - #{key}:#{value}" unless value.is_a? Applitools::Selenium::VGResource
+        unless key.is_a? URI
+          raise Applitools::EyesIllegalArgument, "Expected key to be an instance of URI (but got #{key.class}) - #{key}"
+        end
+        unless value.is_a? Applitools::Selenium::VGResource
+          raise(
+            Applitools::EyesIllegalArgument, 'Expected value to be an instance of Applitools::Selenium::VGResource' \
+            " (but got #{value.class}) - #{key}:#{value}"
+          )
+        end
         super
       end
     end
   end
-end
+end