watir 6.16.5 → 6.17.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)
 

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
@@ -196,15 +204,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 +275,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 +386,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 +490,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 +513,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 +561,7 @@ module Watir
     #
 
     def to_subtype
-      tag = tag_name()
+      tag = tag_name
       klass = if tag == 'input'
                 case attribute_value(:type)
                 when 'checkbox'
@@ -595,7 +609,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
 
@@ -720,7 +734,9 @@ 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.located? && @query_scope.stale?
+        @query_scope.locate
+      end
       @query_scope.switch_to! if @query_scope.is_a?(IFrame)
     end
 
@@ -770,26 +786,25 @@ 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:
     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
         unless custom_attributes.empty?
@@ -799,24 +814,22 @@ module Watir
       rescue Selenium::WebDriver::Error::StaleElementReferenceError
         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/PerceivedComplexity
+
     # rubocop:enable Metrics/CyclomaticComplexity:
 
     def check_condition(condition, 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/iframe.rb

@@ -134,8 +134,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

@@ -170,8 +170,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

data/lib/watir/generator/base/spec_extractor.rb

@@ -109,8 +109,8 @@ module Watir
             begin
               intf = fetch_interface(implementor_name).first
               intf.implements << fetch_interface(implementee_name).first
-            rescue InterfaceNotFound => ex
-              puts ex.message
+            rescue InterfaceNotFound => e
+              puts e.message
             end
           end
         end
@@ -123,8 +123,8 @@ module Watir
             begin
               intf = fetch_interface(includer_name).first
               intf.includes << fetch_interface(includee_name).first
-            rescue InterfaceNotFound => ex
-              puts ex.message
+            rescue InterfaceNotFound => e
+              puts e.message
             end
           end
         end

data/lib/watir/js_execution.rb

@@ -54,7 +54,7 @@ module Watir
         long: {flashes: 5, delay: 0.5},
         rainbow: {flashes: 5, color: %w[red orange yellow green blue indigo violet]}
       }
-      return flash(presets[preset]) unless presets[preset].nil?
+      return flash(**presets[preset]) unless presets[preset].nil?
 
       background_color = original_color = style('background-color')
       background_color = 'white' if background_color.empty?

data/lib/watir/legacy_wait.rb

@@ -10,7 +10,7 @@ module Watir
     end
 
     def respond_to_missing?(*args)
-      @element.respond_to?(*args)
+      @element.respond_to?(*args) || super
     end
 
     def method_missing(method, *args, &block)

data/lib/watir/locators/element/selector_builder.rb

@@ -6,11 +6,10 @@ module Watir
         attr_reader :custom_attributes, :built
 
         WILDCARD_ATTRIBUTE = /^(aria|data)_(.+)$/.freeze
-        INTEGER_CLASS = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4') ? Fixnum : Integer
         VALID_WHATS = Hash.new([String, Regexp, TrueClass, FalseClass]).merge(adjacent: [::Symbol],
                                                                               xpath: [String],
                                                                               css: [String],
-                                                                              index: [INTEGER_CLASS],
+                                                                              index: [Integer],
                                                                               visible: [TrueClass, FalseClass],
                                                                               tag_name: [String, Regexp, ::Symbol],
                                                                               visible_text: [String, Regexp],
@@ -53,11 +52,7 @@ module Watir
           if @selector.key?(:class) || @selector.key?(:class_name)
             classes = ([@selector[:class]].flatten + [@selector.delete(:class_name)].flatten).compact
 
-            classes.each do |class_name|
-              next unless class_name.is_a?(String) && class_name.strip.include?(' ')
-
-              deprecate_class_array(class_name)
-            end
+            deprecate_class_array(classes)
 
             @selector[:class] = classes
           end
@@ -83,11 +78,15 @@ module Watir
           scope_invalid_locators.empty?
         end
 
-        def deprecate_class_array(class_name)
-          dep = "Using the :class locator to locate multiple classes with a String value (i.e. \"#{class_name}\")"
-          Watir.logger.deprecate dep,
-                                 "Array (e.g. #{class_name.split})",
-                                 ids: [:class_array]
+        def deprecate_class_array(class_array)
+          class_array.each do |class_name|
+            next unless class_name.is_a?(String) && class_name.strip.include?(' ')
+
+            dep = "Using the :class locator to locate multiple classes with a String value (i.e. \"#{class_name}\")"
+            Watir.logger.deprecate dep,
+                                   "Array (e.g. #{class_name.split})",
+                                   ids: [:class_array]
+          end
         end
 
         def check_type(how, what)

data/lib/watir/locators/element/selector_builder/xpath.rb

@@ -12,6 +12,7 @@ module Watir
 
           def build(selector)
             @selector = selector
+            @valid_attributes = build_valid_attributes
 
             @built = (@selector.keys & CAN_NOT_BUILD).each_with_object({}) do |key, hash|
               hash[key] = @selector.delete(key)
@@ -45,9 +46,10 @@ module Watir
           end
 
           def predicate_expression(key, val)
-            if val.eql? true
+            case val
+            when true
               attribute_presence(key)
-            elsif val.eql? false
+            when false
               attribute_absence(key)
             else
               equal_pair(key, val)
@@ -55,11 +57,9 @@ module Watir
           end
 
           def predicate_conversion(key, regexp)
-            # type attributes can be upper case - downcase them
-            # https://github.com/watir/watir/issues/72
-            downcase = key == :type || regexp.casefold?
+            downcase = case_insensitive_attribute?(key) || regexp.casefold?
 
-            lhs = lhs_for(key, downcase)
+            lhs = lhs_for(key, downcase: downcase)
 
             results = RegexpDisassembler.new(regexp).substrings
 
@@ -72,8 +72,10 @@ module Watir
 
             add_to_matching(key, regexp, results)
 
-            results.map { |substring|
-              "contains(#{lhs}, '#{substring}')"
+            results.map { |rhs|
+              rhs = "'#{rhs}'"
+              rhs = XpathSupport.downcase(rhs) if downcase
+              "contains(#{lhs}, #{rhs})"
             }.flatten.compact.join(' and ')
           end
 
@@ -200,7 +202,7 @@ module Watir
             regexp.casefold? ? !results.first.casecmp(regexp.source).zero? : results.first != regexp.source
           end
 
-          def lhs_for(key, downcase = false)
+          def lhs_for(key, downcase: false)
             case key
             when String
               "@#{key}"
@@ -211,7 +213,7 @@ module Watir
             when :text
               'normalize-space()'
             when :contains_text
-              'text()'
+              'normalize-space()'
             when ::Symbol
               lhs = "@#{key.to_s.tr('_', '-')}"
               downcase ? XpathSupport.downcase(lhs) : lhs
@@ -221,11 +223,11 @@ module Watir
           end
 
           def attribute_presence(attribute)
-            lhs_for(attribute, false)
+            lhs_for(attribute)
           end
 
           def attribute_absence(attribute)
-            lhs = lhs_for(attribute, false)
+            lhs = lhs_for(attribute)
             "not(#{lhs})"
           end
 
@@ -236,9 +238,34 @@ module Watir
 
               negate_xpath ? "not(#{expression})" : expression
             else
-              "#{lhs_for(key, key == :type)}=#{XpathSupport.escape value}"
+              downcase = case_insensitive_attribute?(key)
+
+              lhs = lhs_for(key, downcase: downcase)
+              rhs = XpathSupport.escape(value)
+              rhs = XpathSupport.downcase(rhs) if downcase
+
+              "#{lhs}=#{rhs}"
+            end
+          end
+
+          def build_valid_attributes
+            tag_name = @selector[:tag_name]
+            if tag_name.is_a?(String) && Watir.tag_to_class[tag_name.to_sym]
+              Watir.tag_to_class[tag_name.to_sym].attribute_list
+            else
+              Watir::HTMLElement.attribute_list
             end
           end
+
+          def case_insensitive_attribute?(attribute)
+            # type attributes can be upper case - downcase them
+            # https://github.com/watir/watir/issues/72
+            return true if attribute == :type
+            return true if Watir::Element::CASE_INSENSITIVE_ATTRIBUTES.include?(attribute) &&
+                           @valid_attributes.include?(attribute)
+
+            false
+          end
         end
       end
     end