watir 7.1.0 → 7.2.0

data/lib/watir/aliases.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   module Container
     alias field_set fieldset

data/lib/watir/attribute_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   #
   # @private
@@ -29,9 +31,9 @@ module Watir
 
     def attribute_list
       @attribute_list ||= (typed_attributes.values.flatten +
-                           ancestors[1..].map { |e|
+                           ancestors[1..].filter_map { |e|
                              e.attribute_list if e.respond_to?(:attribute_list)
-                           }.compact.flatten
+                           }.flatten
                           ).uniq
     end
 

data/lib/watir/browser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   #
   # The main class through which you control the browser.
@@ -40,15 +42,8 @@ module Watir
     #
 
     def initialize(browser = :chrome, *args)
-      case browser
-      when ::Symbol, String
-        @capabilities = Capabilities.new(browser, *args)
-        @driver = Selenium::WebDriver.for(*@capabilities.to_args)
-      when Selenium::WebDriver::Driver
-        @driver = browser
-      else
-        raise ArgumentError, "expected Symbol or Selenium::WebDriver::Driver, got #{browser.class}"
-      end
+      @capabilities = browser.is_a?(Capabilities) ? browser : Capabilities.new(browser, *args)
+      @driver = browser.is_a?(Selenium::WebDriver::Driver) ? browser : Selenium::WebDriver.for(*@capabilities.to_args)
 
       @after_hooks = AfterHooks.new(self)
       @closed = false
@@ -56,17 +51,18 @@ module Watir
     end
 
     # rubocop:disable Metrics/AbcSize
-    # TODO: w3c default behavior does not like checking if alert exists
     def inspect
       if alert.exists?
-        format('#<%s:0x%x alert=true>', self.class, hash * 2)
+        format('#<%<class>s:0x%<hash>x alert=true>', class: self.class, hash: hash * 2)
       else
-        format('#<%s:0x%x url=%s title=%s>', self.class, hash * 2, url.inspect, title.inspect)
+        format('#<%<class>s:0x%<hash>x url=%<url>s title=%<title>s>',
+               class: self.class, hash: hash * 2, url: url.inspect, title: title.inspect)
       end
     rescue Selenium::WebDriver::Error::NoSuchWindowError
-      format('#<%s:0x%x closed=%s>', self.class, hash * 2, closed?)
+      format('#<%<class>s:0x%<hash>x closed=%<closed>s>',
+             class: self.class, hash: hash * 2, closed: closed?)
     rescue Errno::ECONNREFUSED
-      format('#<%s:0x%x closed=true>', self.class, hash * 2)
+      format('#<%<class>s:0x%<hash>x closed=true>', class: self.class, hash: hash * 2)
     end
     alias selector_string inspect
     # rubocop:enable Metrics/AbcSize

data/lib/watir/capabilities.rb

@@ -1,28 +1,35 @@
+# frozen_string_literal: true
+
 module Watir
   class Capabilities
-    attr_reader :options
+    attr_reader :options, :selenium_browser, :selenium_args
 
     def initialize(browser = nil, options = {})
-      if browser.is_a?(Hash)
-        options = browser
-        browser = nil
-      end
-
-      @options = options.dup
-      Watir.logger.info "Creating Browser instance of #{browser} with user provided options: #{@options.inspect}"
-
-      if @options.key?(:capabilities) && @options.key?(:options)
-        raise(ArgumentError, ':capabilities and :options are not both allowed')
-      end
-      raise(ArgumentError, ':url and :service are not both allowed') if @options.key?(:service) && @options.key?(:url)
-
-      @browser = browser.nil? && infer_browser || browser
+      @options, @browser = case browser
+                           when Selenium::WebDriver::Driver
+                             return
+                           when ::Symbol, String
+                             [options.dup, browser&.to_sym]
+                           when Hash
+                             [browser.dup, infer_browser(browser)]
+                           when nil
+                             [{}, infer_browser]
+                           else
+                             raise ArgumentError,
+                                   "expected Driver, String, Symbol or Hash, but received: #{browser.class}"
+                           end
+      validate_options
 
       @selenium_browser = @options.key?(:url) ? :remote : @browser
     end
 
     def to_args
-      [@selenium_browser, process_arguments]
+      Watir.logger.info "Creating Browser instance of #{@browser} with user provided options: #{@options.inspect}"
+      @selenium_args = process_arguments
+      raise ArgumentError, "#{@options} are unrecognized arguments for Browser constructor" unless @options.empty?
+
+      Watir.logger.info "Selenium options generated by Watir: #{@selenium_args.inspect}"
+      [@selenium_browser, @selenium_args]
     end
 
     private
@@ -39,9 +46,15 @@ module Watir
       end
 
       selenium_opts[:http_client] = process_http_client
-      selenium_opts[:capabilities] = @options.delete(:capabilities) || process_browser_options
+      if @options.key?(:capabilities)
+        Watir.logger.deprecate(':capabilities argument in Browser constructor',
+                               ':options argument with Selenium Options instance or Hash',
+                               id: :capabilities)
+        selenium_opts[:capabilities] = @options.delete(:capabilities)
+      else
+        selenium_opts[:options] = process_browser_options
+      end
 
-      Watir.logger.info "Creating Browser instance with Watir processed options: #{selenium_opts.inspect}"
       selenium_opts
     end
 
@@ -64,7 +77,6 @@ module Watir
 
     def process_browser_options
       browser_options = @options.delete(:options).dup || {}
-      vendor_caps = process_vendor_capabilities(browser_options)
 
       options = if browser_options.is_a? Selenium::WebDriver::Options
                   browser_options
@@ -76,9 +88,11 @@ module Watir
       options.unhandled_prompt_behavior ||= :ignore
       process_proxy_options(options)
       browser_specific_options(options)
-      raise ArgumentError, "#{@options} are unrecognized arguments for Browser constructor" unless @options.empty?
 
-      vendor_caps << options
+      vendor_opts = process_vendor_options(browser_options)
+      vendor_opts.each { |opts| options.add_option(opts) }
+
+      options
     end
 
     def process_proxy_options(options)
@@ -94,7 +108,7 @@ module Watir
       options.proxy = proxy
     end
 
-    def process_vendor_capabilities(opts)
+    def process_vendor_options(opts)
       return [] unless opts.is_a? Hash
 
       vendor = opts.select { |key, _val| key.to_s.include?(':') && opts.delete(key) }
@@ -103,12 +117,12 @@ module Watir
 
     def convert_timeouts(browser_options)
       browser_options[:timeouts] ||= {}
-      browser_options[:timeouts].keys.each do |key|
+      browser_options[:timeouts].each_key do |key|
         raise(ArgumentError, 'do not set implicit wait, Watir handles waiting automatically') if key.to_s == 'implicit'
 
         Watir.logger.deprecate('using timeouts directly in options',
                                ":#{key}_timeout",
-                               id: 'timeouts')
+                               id: :timeouts)
       end
       if browser_options.key?(:page_load_timeout)
         browser_options[:timeouts][:page_load] = browser_options.delete(:page_load_timeout) * 1000
@@ -151,16 +165,25 @@ module Watir
       end
     end
 
-    def infer_browser
-      if @options.key?(:browser)
-        @options.delete(:browser)
-      elsif @options.key?(:capabilities)
-        @options[:capabilities].browser_name.tr(' ', '_').downcase.to_sym
-      elsif @options.key?(:options)
-        @options[:options].class.to_s.split('::')[-2].downcase.to_sym
-      else
-        :chrome
+    def infer_browser(options = nil)
+      options ||= {}
+      inferred = if options.key?(:capabilities)
+                   options[:capabilities].browser_name.tr(' ', '_').downcase.to_sym
+                 elsif options[:options].is_a?(Selenium::WebDriver::Options)
+                   options[:options].class.to_s.split('::')[-2].downcase.to_sym
+                 elsif options.key?(:options)
+                   options.dig(:options, :browser_name).downcase.to_sym
+                 else
+                   :chrome
+                 end
+      %i[msedge microsoftedge].include?(inferred) ? :edge : inferred
+    end
+
+    def validate_options
+      if @options.key?(:capabilities) && @options.key?(:options)
+        raise(ArgumentError, ':capabilities and :options are not both allowed')
       end
+      raise(ArgumentError, ':url and :service are not both allowed') if @options.key?(:service) && @options.key?(:url)
     end
   end
 end

data/lib/watir/cell_container.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   module CellContainer
     #

data/lib/watir/container.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   module Container
     include JSSnippets

data/lib/watir/cookies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Watir
@@ -18,7 +20,7 @@ module Watir
 
     def to_a
       @control.all_cookies.map do |e|
-        e.merge(expires: e[:expires] ? e[:expires].to_time : nil)
+        e.merge(expires: e[:expires]&.to_time)
       end
     end
 
@@ -102,11 +104,9 @@ module Watir
     #
 
     def save(file = '.cookies')
-      IO.write(file, to_a.to_yaml)
+      File.write(file, to_a.to_yaml)
     end
 
-    #
-    # TODO: Use :permitted_classes keyword when minimum supported Ruby is 2.6
     #
     # Load cookies from file
     #
@@ -117,7 +117,7 @@ module Watir
     #
 
     def load(file = '.cookies')
-      YAML.safe_load(IO.read(file), [::Symbol, ::Time]).each do |c|
+      YAML.safe_load(File.read(file), permitted_classes: [::Symbol, ::Time]).each do |c|
         add(c.delete(:name), c.delete(:value), c)
       end
     end

data/lib/watir/element_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   #
   # Base class for element collections.
@@ -193,7 +195,7 @@ module Watir
     end
 
     def ensure_context
-      if @query_scope.is_a?(Browser) || !@query_scope.located? && @query_scope.is_a?(IFrame)
+      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

data/lib/watir/elements/button.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   #
   # Class representing button elements.

data/lib/watir/elements/cell.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   #
   # Custom class representing table cell (th or td).

data/lib/watir/elements/checkbox.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class CheckBox < Input
     #

data/lib/watir/elements/date_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class DateField < Input
     #

data/lib/watir/elements/date_time_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class DateTimeField < Input
     #

data/lib/watir/elements/dlist.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Watir
   class DList < HTMLElement
     def to_hash
       keys = dts.map(&:text)
       values = dds.map(&:text)
 
-      Hash[keys.zip(values)]
+      keys.zip(values).to_h
     end
   end # DList
 end # Watir

data/lib/watir/elements/element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   #
   # Base class for HTML elements.
@@ -13,6 +15,7 @@ module Watir
     include JSExecution
     include Locators::ClassHelpers
     include Scrolling
+    include SearchContext
 
     attr_accessor :keyword
     attr_reader :selector
@@ -54,38 +57,11 @@ module Watir
       build unless @element
     end
 
-    #
-    # Returns true if element exists.
-    # Checking for staleness is deprecated
-    #
-    # @return [Boolean]
-    #
-
-    def exists?
-      if located? && stale?
-        reset!
-      elsif located?
-        return true
-      end
-
-      assert_exists
-      true
-    rescue UnknownObjectException, UnknownFrameException
-      false
-    end
-    alias exist? exists?
-
     def inspect
-      string = "#<#{self.class}: "
-      string << "keyword: #{keyword} " if keyword
-      string << "located: #{located?}; "
-      string << if @selector.empty?
-                  '{element: (selenium element)}'
-                else
-                  selector_string
-                end
-      string << '>'
-      string
+      keyword_string = keyword ? "keyword: #{keyword} " : ''
+      located = "located: #{located?}; "
+      element_string = @selector.empty? ? '{element: (selenium element)}' : selector_string
+      "#<#{self.class}: #{keyword_string}#{located}#{element_string}>"
     end
 
     #
@@ -372,7 +348,7 @@ module Watir
     def attribute_values
       result = element_call { execute_js(:attributeValues, @element) }
       result.keys.each do |key|
-        next unless key == key[/[a-zA-Z\-]*/]
+        next unless key == key[/[a-zA-Z-]*/]
 
         result[key.tr('-', '_').to_sym] = result.delete(key)
       end
@@ -505,6 +481,17 @@ module Watir
       assert_exists
       @element
     end
+    alias we wd
+
+    #
+    # Returns shadow root of element
+    #
+    # @return [Watir::ShadowRoot]
+    #
+
+    def shadow_root
+      ShadowRoot.new(self)
+    end
 
     #
     # Returns true if this element is present and enabled on the page.
@@ -700,18 +687,6 @@ module Watir
 
     protected
 
-    def wait_for_exists
-      return if located? # Performance shortcut
-
-      begin
-        @query_scope.wait_for_exists unless @query_scope.is_a? Browser
-        wait_until(element_reset: true, &:exists?)
-      rescue Wait::TimeoutError
-        msg = "timed out after #{Watir.default_timeout} seconds, waiting for #{inspect} to be located"
-        raise unknown_exception, msg
-      end
-    end
-
     def wait_for_present
       return true if present?
 
@@ -758,7 +733,7 @@ module Watir
     end
 
     def ensure_context
-      if @query_scope.is_a?(Browser) || !@query_scope.located? && @query_scope.is_a?(IFrame)
+      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
@@ -772,10 +747,6 @@ module Watir
 
     private
 
-    def unknown_exception
-      UnknownObjectException
-    end
-
     def raise_writable
       message = "element present and enabled, but timed out after #{Watir.default_timeout} seconds, " \
                 "waiting for #{inspect} to not be readonly"
@@ -790,7 +761,7 @@ module Watir
 
     def raise_present
       message = "element located, but timed out after #{Watir.default_timeout} seconds, " \
-                               "waiting for #{inspect} to be present"
+                "waiting for #{inspect} to be present"
       raise unknown_exception, message
     end
 
@@ -806,66 +777,19 @@ module Watir
       raise TypeError, "expected Watir::Element, got #{obj.inspect}:#{obj.class}" unless obj.is_a? Element
     end
 
-    # TODO: - this will get addressed with Watir::Executor implementation
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/CyclomaticComplexity:
-    # rubocop:disable Metrics/PerceivedComplexity::
-    def element_call(precondition = nil, &block)
-      caller = caller_locations(1, 1)[0].label
-      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 => e
-        element_call(:wait_for_exists, &block) if precondition.nil?
-        msg = e.message
-        msg += '; Maybe look in an iframe?' if @query_scope.iframe.exists?
-        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, Selenium::WebDriver::Error::NoSuchElementError
-        reset!
-        retry
-        # 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::NoSuchWindowError
-        raise NoMatchingWindowFoundException, 'browser window was closed'
-      ensure
-        Watir.logger.debug "<- `Completed #{inspect}##{caller}`"
-        browser.timer.reset! unless already_locked
-      end
-    end
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/PerceivedComplexity
-
-    def check_condition(condition, caller)
-      Watir.logger.debug "<- `Verifying precondition #{inspect}##{condition} for #{caller}`"
-      begin
-        condition.nil? ? assert_exists : send(condition)
-        Watir.logger.debug "<- `Verified precondition #{inspect}##{condition || 'assert_exists'}`"
-      rescue unknown_exception
-        raise unless condition.nil?
-
-        Watir.logger.debug "<- `Unable to satisfy precondition #{inspect}##{condition}`"
-        check_condition(:wait_for_exists, caller)
+    def custom_message
+      msg = ''
+      msg += '; Maybe look in an iframe?' if @query_scope.iframe.exists?
+      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
+      msg
     end
 
     def method_missing(meth, *args, &blk)
       method = meth.to_s
-      if method =~ Locators::Element::SelectorBuilder::WILDCARD_ATTRIBUTE
+      if Locators::Element::SelectorBuilder::WILDCARD_ATTRIBUTE.match?(method)
         attribute_value(meth, *args)
       elsif UserEditable.instance_methods(false).include?(meth) && content_editable?
         @content_editable = true

data/lib/watir/elements/file_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class FileField < Input
     #

data/lib/watir/elements/font.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Font < HTMLElement
     #

data/lib/watir/elements/form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Form < HTMLElement
     #

data/lib/watir/elements/hidden.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Hidden < Input
     def visible?

data/lib/watir/elements/iframe.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class IFrame < HTMLElement
     #

data/lib/watir/elements/image.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Image < HTMLElement
     #

data/lib/watir/elements/input.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Input < HTMLElement
     #

data/lib/watir/elements/link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   module Container
     alias link a

data/lib/watir/elements/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   module List
     include Enumerable

data/lib/watir/elements/option.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   #
   # Represents an option in a select list.

data/lib/watir/elements/radio.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Radio < Input
     def build

data/lib/watir/elements/row.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   #
   # Custom class representing table row (tr).

data/lib/watir/elements/select.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Select < HTMLElement
     #

data/lib/watir/elements/table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class Table < HTMLElement
     include RowContainer
@@ -31,7 +33,7 @@ module Watir
 
       all_rows.entries[1..].map do |row|
         cell_size_check(header_row, row)
-        Hash[headers(header_row).map(&:text).zip(row.cells.map(&:text))]
+        headers(header_row).map(&:text).zip(row.cells.map(&:text)).to_h
       end
     end
 

data/lib/watir/elements/table_cell.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class TableCell < HTMLElement
     def column_header

data/lib/watir/elements/table_row.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Watir
   class TableRow < HTMLElement
     include CellContainer