watir 6.16.3 → 6.19.0

data/lib/watir/cookies.rb

@@ -61,7 +61,7 @@ module Watir
       cookie[:path] = opts[:path] if opts.key?(:path)
       expires = opts[:expires]
       if expires
-        cookie[:expires] = ::Time.parse(expires) if expires.is_a?(String) else expires
+        cookie[:expires] = expires.is_a?(String) ? ::Time.parse(expires) : expires
       end
       cookie[:domain] = opts[:domain] if opts.key?(:domain)
 
@@ -105,6 +105,8 @@ module Watir
       IO.write(file, to_a.to_yaml)
     end
 
+    #
+    # TODO: Use :permitted_classes keyword when minimum supported Ruby is 2.6
     #
     # Load cookies from file
     #

data/lib/watir/element_collection.rb

@@ -7,17 +7,19 @@ module Watir
     include Enumerable
     include Exception
     include JSSnippets
+    include Waitable
     include Locators::ClassHelpers
 
     def initialize(query_scope, selector)
       @query_scope = query_scope
       @selector = selector
+      @to_a = nil
 
       build unless @selector.key?(:element)
     end
 
     #
-    # Yields each element in collection.
+    # Relocates elements then yields each element in resulting collection.
     #
     # @example
     #   divs = browser.divs(class: 'kls')
@@ -29,6 +31,7 @@ module Watir
     #
 
     def each(&blk)
+      reset!
       to_a.each(&blk)
     end
 
@@ -37,6 +40,9 @@ module Watir
 
     alias empty? none?
 
+    alias exist? any?
+    alias exists? any?
+
     def build
       selector_builder.build(@selector.dup)
     end
@@ -145,14 +151,19 @@ module Watir
     alias eql? ==
 
     #
-    # Creates a Collection containing elements of two collections.
+    # Removes cache of previously located elements in the collection.
     #
     # @example
     #   options = browser.select_list(name: "new_user_languages").options
-    #   (options + browser.select_list(id: "new_user_role").options).size
-    #   #=> 8
+    #   options.reset!
+    #   options[0]
+    #   #=> nil
     #
 
+    def reset!
+      @to_a = nil
+    end
+
     private
 
     def elements
@@ -182,7 +193,11 @@ module Watir
     end
 
     def ensure_context
-      @query_scope.locate if @query_scope.is_a?(Browser) || @query_scope.located? && @query_scope.stale?
+      if @query_scope.is_a?(Browser) || !@query_scope.located? && @query_scope.is_a?(IFrame)
+        @query_scope.browser.locate
+      elsif @query_scope.located? && @query_scope.stale?
+        @query_scope.locate
+      end
       @query_scope.switch_to! if @query_scope.is_a?(IFrame)
     end
 
@@ -191,7 +206,7 @@ module Watir
     end
 
     def element_class
-      Kernel.const_get(self.class.name.sub(/Collection$/, ''))
+      Watir.const_get(self.class.name.sub(/Collection$/, ''))
     end
 
     def construct_subtype(element, hash, tag_name)

data/lib/watir/elements/element.rb

@@ -18,6 +18,17 @@ module Watir
     attr_accessor :keyword
     attr_reader :selector
 
+    # https://www.w3.org/TR/html52/single-page.html#casesensitivity
+    CASE_INSENSITIVE_ATTRIBUTES = %i[accept accept_charset align alink axis
+                                     bgcolor charset checked clear codetype
+                                     color compact declare defer dir direction
+                                     disabled enctype face frame hreflang
+                                     http_equiv lang language link media
+                                     method multiple nohref noresize noshade
+                                     nowrap readonly rel rev rules scope
+                                     scrolling selected shape target text
+                                     type valign valuetype vlink].freeze
+
     #
     # temporarily add :id and :class_name manually since they're no longer specified in the HTML spec.
     #
@@ -54,12 +65,9 @@ module Watir
 
     def exists?
       if located? && stale?
-        Watir.logger.deprecate 'Checking `#exists? == false` to determine a stale element',
-                               '`#stale? == true`',
-                               reference: 'http://watir.com/staleness-changes',
-                               ids: [:stale_exists]
-        # TODO: Change this to `reset!` after removing deprecation
-        return false
+        reset!
+      elsif located?
+        return true
       end
 
       assert_exists
@@ -141,7 +149,6 @@ module Watir
     #
 
     def click(*modifiers)
-      # TODO: Should wait_for_enabled be default, or `Button` specific behavior?
       element_call(:wait_for_enabled) do
         if modifiers.any?
           action = driver.action
@@ -196,15 +203,35 @@ module Watir
     end
 
     #
-    # Right clicks the element.
-    # Note that browser support may vary.
+    # Right clicks the element, optionally while pressing the given modifier keys.
+    # Note that support for holding a modifier key is currently experimental,
+    # and may not work at all. Also, the browser support may vary.
     #
     # @example
     #   browser.element(name: "new_user_button").right_click
     #
+    # @example Right click an element with shift key pressed
+    #   browser.element(name: "new_user_button").right_click(:shift)
+    #
+    # @example Click an element with several modifier keys pressed
+    #   browser.element(name: "new_user_button").right_click(:shift, :alt)
+    #
+    # @param [:shift, :alt, :control, :command, :meta] modifiers to press while right clicking.
+    #
+
+    def right_click(*modifiers)
+      element_call(:wait_for_present) do
+        action = driver.action
+        if modifiers.any?
+          modifiers.each { |mod| action.key_down mod }
+          action.context_click(@element)
+          modifiers.each { |mod| action.key_up mod }
+          action.perform
+        else
+          action.context_click(@element).perform
+        end
+      end
 
-    def right_click
-      element_call(:wait_for_present) { driver.action.context_click(@element).perform }
       browser.after_hooks.run
     end
 
@@ -247,7 +274,7 @@ module Watir
     # Note that browser support may vary.
     #
     # @example
-    #   browser.div(id: "draggable").drag_and_drop_by 100, -200
+    #   browser.div(id: "draggable").drag_and_drop_by 100, 25
     #
     # @param [Integer] right_by
     # @param [Integer] down_by
@@ -358,6 +385,8 @@ module Watir
     #
 
     def scroll_into_view
+      Watir.logger.deprecate 'Element#scroll_into_view', 'Element#scroll methods', ids: [:scroll_into_view]
+
       element_call { @element.location_once_scrolled_into_view }
     end
 
@@ -460,16 +489,7 @@ module Watir
       msg = '#visible? behavior will be changing slightly, consider switching to #present? ' \
             '(more details: http://watir.com/element-existentialism/)'
       Watir.logger.warn msg, ids: [:visible_element]
-      displayed = display_check
-      if displayed.nil? && display_check
-        Watir.logger.deprecate 'Checking `#visible? == false` to determine a stale element',
-                               '`#stale? == true`',
-                               reference: 'http://watir.com/staleness-changes',
-                               ids: [:stale_visible]
-      end
-      raise unknown_exception if displayed.nil?
-
-      displayed
+      display_check
     end
 
     #
@@ -492,14 +512,7 @@ module Watir
     #
 
     def present?
-      displayed = display_check
-      if displayed.nil? && display_check
-        Watir.logger.deprecate 'Checking `#present? == false` to determine a stale element',
-                               '`#stale? == true`',
-                               reference: 'http://watir.com/staleness-changes',
-                               ids: [:stale_present]
-      end
-      displayed
+      display_check
     rescue UnknownObjectException, UnknownFrameException
       false
     end
@@ -547,7 +560,7 @@ module Watir
     #
 
     def to_subtype
-      tag = tag_name()
+      tag = tag_name
       klass = if tag == 'input'
                 case attribute_value(:type)
                 when 'checkbox'
@@ -595,7 +608,7 @@ module Watir
     def stale_in_context?
       @element.css_value('staleness_check') # any wire call will check for staleness
       false
-    rescue Selenium::WebDriver::Error::ObsoleteElementError
+    rescue Selenium::WebDriver::Error::StaleElementReferenceError
       true
     end
 
@@ -686,7 +699,7 @@ module Watir
       return assert_enabled unless Watir.relaxed_locate?
 
       wait_for_exists
-      return unless [Input, Button, Select, Option].any? { |c| is_a? c } || @content_editable
+      return unless [Input, Button, Select, Option].any? { |c| is_a? c } || content_editable
       return if enabled?
 
       begin
@@ -698,9 +711,7 @@ module Watir
 
     def wait_for_writable
       wait_for_enabled
-      unless Watir.relaxed_locate?
-        raise_writable unless !respond_to?(:readonly?) || !readonly?
-      end
+      raise_writable unless Watir.relaxed_locate? || (!respond_to?(:readonly?) || !readonly?)
 
       return if !respond_to?(:readonly?) || !readonly?
 
@@ -720,7 +731,11 @@ module Watir
     end
 
     def ensure_context
-      @query_scope.locate if @query_scope.is_a?(Browser) || @query_scope.located? && @query_scope.stale?
+      if @query_scope.is_a?(Browser) || !@query_scope.located? && @query_scope.is_a?(IFrame)
+        @query_scope.browser.locate
+      elsif @query_scope.located? && @query_scope.stale?
+        @query_scope.locate
+      end
       @query_scope.switch_to! if @query_scope.is_a?(IFrame)
     end
 
@@ -770,54 +785,52 @@ module Watir
       @element.displayed?
     rescue Selenium::WebDriver::Error::StaleElementReferenceError
       reset!
-      nil
+      retry
     end
 
     # TODO: - this will get addressed with Watir::Executor implementation
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/PerceivedComplexity
     # rubocop:disable Metrics/CyclomaticComplexity:
+    # rubocop:disable Metrics/PerceivedComplexity::
     def element_call(precondition = nil, &block)
       caller = caller_locations(1, 1)[0].label
-      already_locked = Wait.timer.locked?
-      Wait.timer = Wait::Timer.new(timeout: Watir.default_timeout) unless already_locked
+      already_locked = browser.timer.locked?
+      browser.timer = Wait::Timer.new(timeout: Watir.default_timeout) unless already_locked
 
       begin
         check_condition(precondition, caller)
         Watir.logger.debug "-> `Executing #{inspect}##{caller}`"
         yield
-      rescue unknown_exception => ex
+      rescue unknown_exception => e
         element_call(:wait_for_exists, &block) if precondition.nil?
-        msg = ex.message
+        msg = e.message
         msg += '; Maybe look in an iframe?' if @query_scope.iframe.exists?
-        custom_attributes = @locator.nil? ? [] : selector_builder.custom_attributes
+        custom_attributes = !defined?(@locator) || @locator.nil? ? [] : selector_builder.custom_attributes
         unless custom_attributes.empty?
           msg += "; Watir treated #{custom_attributes} as a non-HTML compliant attribute, ensure that was intended"
         end
         raise unknown_exception, msg
-      rescue Selenium::WebDriver::Error::StaleElementReferenceError
+      rescue Selenium::WebDriver::Error::StaleElementReferenceError, Selenium::WebDriver::Error::NoSuchElementError
         reset!
         retry
-      rescue Selenium::WebDriver::Error::ElementNotVisibleError, Selenium::WebDriver::Error::ElementNotInteractableError
-        raise_present unless Wait.timer.remaining_time.positive?
+        # TODO: - InvalidElementStateError is deprecated, so no longer calling `raise_disabled`
+        # need a better way to handle this
+      rescue Selenium::WebDriver::Error::ElementNotInteractableError
+        raise_present unless browser.timer.remaining_time.positive?
         raise_present unless %i[wait_for_present wait_for_enabled wait_for_writable].include?(precondition)
         retry
-      rescue Selenium::WebDriver::Error::InvalidElementStateError
-        raise_disabled unless Wait.timer.remaining_time.positive?
-        raise_disabled unless %i[wait_for_present wait_for_enabled wait_for_writable].include?(precondition)
-        retry
       rescue Selenium::WebDriver::Error::NoSuchWindowError
         raise NoMatchingWindowFoundException, 'browser window was closed'
       ensure
         Watir.logger.debug "<- `Completed #{inspect}##{caller}`"
-        Wait.timer.reset! unless already_locked
+        browser.timer.reset! unless already_locked
       end
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
-    # rubocop:enable Metrics/CyclomaticComplexity:
 
     def check_condition(condition, caller)
       Watir.logger.debug "<- `Verifying precondition #{inspect}##{condition} for #{caller}`"

data/lib/watir/elements/file_field.rb

@@ -12,6 +12,7 @@ module Watir
 
       self.value = path
     end
+    alias upload set
 
     #
     # Sets the file field to the given path

data/lib/watir/elements/html_elements.rb

@@ -272,7 +272,6 @@ module Watir
     attribute(String, :form, :form)
     attribute(String, :label, :label)
     attribute("Boolean", :defaultselected?, :defaultSelected)
-    attribute("Boolean", :selected?, :selected)
     attribute(String, :value, :value)
     attribute(Integer, :index, :index)
   end

data/lib/watir/elements/iframe.rb

@@ -44,8 +44,9 @@ module Watir
     # @see Watir::Browser#execute_script
     #
 
-    def execute_script(script, *args)
+    def execute_script(script, *args, function_name: nil)
       args.map! do |e|
+        Watir.logger.info "Executing Script on Frame: #{function_name}" if function_name
         e.is_a?(Element) ? e.wait_until(&:exists?).wd : e
       end
       returned = driver.execute_script(script, *args)
@@ -134,8 +135,8 @@ module Watir
       @element
     end
 
-    def respond_to_missing?(meth, _include_private = false)
-      @driver.respond_to?(meth) || @element.respond_to?(meth) || super
+    def respond_to_missing?(meth, _include_private)
+      @driver.respond_to?(meth) || @element.respond_to?(meth) || super(meth, false)
     end
 
     def method_missing(meth, *args, &blk)

data/lib/watir/elements/link.rb

@@ -3,13 +3,4 @@ module Watir
     alias link a
     alias links as
   end # Container
-
-  class Anchor < HTMLElement
-    #
-    # @todo temporarily add href attribute
-    #
-    # @see https://www.w3.org/Bugs/Public/show_bug.cgi?id=23192
-    #
-    attribute String, :href, :href
-  end # Anchor
 end # Watir

data/lib/watir/elements/radio.rb

@@ -33,7 +33,7 @@ module Watir
     #
 
     def text
-      l = label()
+      l = label
       l.exist? ? l.text : ''
     end
   end # Radio

data/lib/watir/elements/select.rb

@@ -30,8 +30,11 @@ module Watir
     #
 
     def select(*str_or_rx)
-      results = str_or_rx.flatten.map { |v| select_by v }
-      results.first
+      if str_or_rx.size > 1 || str_or_rx.first.is_a?(Array)
+        str_or_rx.flatten.map { |v| select_all_by v }.first
+      else
+        str_or_rx.flatten.map { |v| select_by v }.first
+      end
     end
 
     #
@@ -43,6 +46,10 @@ module Watir
     #
 
     def select_all(*str_or_rx)
+      Watir.logger.deprecate('#select_all',
+                             '#select with an Array instance',
+                             ids: [:select_all])
+
       results = str_or_rx.flatten.map { |v| select_all_by v }
       results.first
     end
@@ -55,8 +62,11 @@ module Watir
     #
 
     def select!(*str_or_rx)
-      results = str_or_rx.flatten.map { |v| select_by!(v, :single) }
-      results.first
+      if str_or_rx.size > 1 || str_or_rx.first.is_a?(Array)
+        str_or_rx.flatten.map { |v| select_by! v, :multiple }.first
+      else
+        str_or_rx.flatten.map { |v| select_by! v, :single }.first
+      end
     end
 
     #
@@ -67,6 +77,10 @@ module Watir
     #
 
     def select_all!(*str_or_rx)
+      Watir.logger.deprecate('#select_all!',
+                             '#select! with an Array instance',
+                             ids: [:select_all])
+
       results = str_or_rx.flatten.map { |v| select_by!(v, :multiple) }
       results.first
     end
@@ -145,7 +159,8 @@ module Watir
       found = find_options(:value, str_or_rx)
 
       if found.size > 1
-        Watir.logger.deprecate 'Selecting Multiple Options with #select', '#select_all',
+        Watir.logger.deprecate 'Selecting multiple options with #select using a String or Regexp value',
+                               '#select with the desired values in an Array instance',
                                ids: [:select_by]
       end
       select_matching(found)
@@ -170,8 +185,8 @@ module Watir
         str_or_rx.inspect.sub('\\A', '^')
                  .sub('\\Z', '$')
                  .sub('\\z', '$')
-                 .sub(%r{^\/}, '')
-                 .sub(%r{\/[a-z]*$}, '')
+                 .sub(%r{^/}, '')
+                 .sub(%r{/[a-z]*$}, '')
                  .gsub(/\(\?#.+\)/, '')
                  .gsub(/\(\?-\w+:/, '(')
       else