watir 7.0.0.beta1 → 7.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 994057876b1f2ad97972dfe3a43f139cf761aefabcacbc7ab1d2bc659693e70e
-  data.tar.gz: d0bcac18f0cfe6d9d2a0258bb57a8e2e9f0804feda5eeaf8e5d840fd859de3c4
+  metadata.gz: af4906be1ae9d2713b91037006f964eddcac08ccb7a3cc341752132dea109b0f
+  data.tar.gz: 52ece209164c1ff75eeaec71efe8c70f03dd27f4fb1c791761e77c9ac600b333
 SHA512:
-  metadata.gz: b652878ab0a6b4365e3226a664945a86c96f8f94c6b0cd4744c0809a66d8fb49ff37951726699df217856d413d4104778164218ca365a1481ec6ab1212c2f12e
-  data.tar.gz: f6f5f093a6072f1456055853d2b93ce994b978897668eb3348ee6fe70fa872eea681c97481d254830f5d028cce0029bb9e45a5dd25d50d785a6e144592d429a2
+  metadata.gz: 5623e2ac22fd67b0c7f147333ed0c0e8ce3b87cf66ecb8d40a3f85672ce647d480bfe0114986a83d1a0bdc59510ad2d164c046769eea5c44a12252b3578a4d23
+  data.tar.gz: 9e95f5db40c379040dabb329c64dc4032c9c290193c3804e401cbfaabecec9550fa524c50e6483a9b597240a99f542549c1b823d91c99128dbab16b44f1c4d39

data/.github/workflows/tests.yml

@@ -61,13 +61,17 @@ jobs:
         task: [ chrome, firefox, edge ]
         include:
           - os: 'macos-latest'
-            task: 'safari'
             ruby: 2.6
+            task: 'safari'
           - os: 'macos-latest'
+            ruby: 3.0
             task: 'safari'
+          - os: 'windows-latest'
+            ruby: 2.6
+            task: 'ie'
+          - os: 'windows-latest'
             ruby: 3.0
-#          - os: 'windows-latest'
-#            task: 'ie'
+            task: 'ie'
         exclude:
           - os: 'ubuntu-latest'
             task: 'edge'

data/.rubocop.yml

@@ -19,17 +19,12 @@ Lint/UnifiedInteger:
 
 # Default: 17
 Metrics/AbcSize:
-  Max: 20
+  Max: 22
   Exclude:
-    - 'lib/watir/capabilities.rb'
     - 'lib/watir/locators/element/selector_builder.rb'
-    - 'lib/watir/locators/element/selector_builder/regexp_disassembler.rb'
-    - 'lib/watir/locators/element/selector_builder/xpath.rb'
-    - 'lib/watir/locators/element/locator.rb'
+    - 'lib/watir/locators/element/selector_builder/*.rb'
     - 'lib/watir/generator/base/generator.rb'
-    - 'lib/watir/generator/base/visitor.rb'
     - 'spec/locator_spec_helper.rb'
-    - 'spec/watirspec_helper.rb'
 
 Metrics/BlockLength:
   Exclude:

data/CHANGES.md

@@ -1,3 +1,35 @@
+### 7.0.0.beta5 (2021-08-02)
+
+* Add support for passing in Proxy and proxy Hash to Capabilities (#933)
+* Trigger change event when setting values on date and date-time fields (#938)
+* Allow user to obtain Capabilities instance from Browser instance
+
+### 7.0.0.beta4 (2021-05-29)
+
+* Fix Bug in using negative class names within a collection (#934)
+
+### 7.0.0.beta3 (2021-05-05)
+
+* Fix Bug preventing proper use of vendor extension capabilities
+* Changed how timeouts are supported in Watir Capabilities (#932)
+* Changed the default Alert Behavior not to automatically get dismissed when an exception happens (#931)
+
+### 7.0.0.beta2 (2021-03-28)
+
+* Replace Watir Logger implementation with Selenium Logger subclass
+* Change Watir Guards to use Selenium's new Guards. Tests run as pending when guarded.
+* Implement `#set` as standard interface for each Input Element (#405)
+* Implement `Element#set` to take correct `#set` behavior based on evaluated element (#664)
+* Optimize Performance for Select Lists (#846)
+* Allow user to set values on Select List exclusively by `:label`, `:text`, or `:value` (#846)
+* Allow user to check if option selected in Select List by `:label`, `:text`, or `:value` (#929)
+* Implement `Window#restore!` to return to original Window and close all others (#923)
+* Minor performance improvement for iterating over windows (#923)
+* Implement `Browser#closed?`; same as `Browser#exists?` without the Windows checks (#923)
+* Update methods that use Selenium's Actions class to scroll element into view before acting (#847)
+* Fix bug for `:text` locator with `Regexp` value based on whitespace (#924)
+* Remove executing after hooks when changing frames (#888)
+
 ### 7.0.0.beta1 (2021-03-18)
 
 * Requires Selenium 4

data/lib/watir/browser.rb

@@ -12,7 +12,7 @@ module Watir
     include Scrolling
 
     attr_writer :default_context, :original_window, :locator_namespace, :timer
-    attr_reader :driver, :after_hooks
+    attr_reader :driver, :after_hooks, :capabilities
     alias wd driver # ensures duck typing with Watir::Element
 
     class << self
@@ -42,8 +42,8 @@ module Watir
     def initialize(browser = :chrome, *args)
       case browser
       when ::Symbol, String
-        selenium_args = Capabilities.new(browser, *args).to_args
-        @driver = Selenium::WebDriver.for(*selenium_args)
+        @capabilities = Capabilities.new(browser, *args)
+        @driver = Selenium::WebDriver.for(*@capabilities.to_args)
       when Selenium::WebDriver::Driver
         @driver = browser
       else
@@ -55,16 +55,21 @@ module Watir
       @default_context = true
     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)
       else
         format('#<%s:0x%x url=%s title=%s>', self.class, hash * 2, url.inspect, title.inspect)
       end
+    rescue Selenium::WebDriver::Error::NoSuchWindowError
+      format('#<%s:0x%x closed=%s>', self.class, hash * 2, closed?)
     rescue Errno::ECONNREFUSED
       format('#<%s:0x%x closed=true>', self.class, hash * 2)
     end
     alias selector_string inspect
+    # rubocop:enable Metrics/AbcSize
 
     #
     # Returns URL of current page.
@@ -101,13 +106,23 @@ module Watir
     #
 
     def close
-      return if @closed
+      return if closed?
 
       @driver.quit
       @closed = true
     end
     alias quit close
 
+    #
+    # Returns true if browser is closed and false otherwise.
+    #
+    # @return [Boolean]
+    #
+
+    def closed?
+      @closed
+    end
+
     #
     # Handles cookies.
     #
@@ -252,12 +267,12 @@ module Watir
     #
 
     def exist?
-      !@closed && window.present?
+      !closed? && window.present?
     end
     alias exists? exist?
 
     def locate
-      raise Error, 'browser was closed' if @closed
+      raise Error, 'browser was closed' if closed?
 
       ensure_context
     end
@@ -267,7 +282,6 @@ module Watir
 
       driver.switch_to.default_content
       @default_context = true
-      after_hooks.run
     end
 
     def browser

data/lib/watir/capabilities.rb

@@ -55,7 +55,7 @@ module Watir
         http_client
       when Selenium::WebDriver::Remote::Http::Common
         Watir.logger.warn 'Check out the new Watir::HttpClient and let us know if there are missing features you need',
-                          ids: [:watir_client]
+                          id: [:watir_client]
         http_client
       else
         raise TypeError, ':http_client must be a Hash or a Selenium HTTP Client instance'
@@ -63,15 +63,60 @@ module Watir
     end
 
     def process_browser_options
-      browser_options = @options.delete(:options) || {}
-
-      options = browser_options if browser_options.is_a? Selenium::WebDriver::Options
-      options ||= Selenium::WebDriver::Options.send(@browser, **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
+                else
+                  convert_timeouts(browser_options)
+                  Selenium::WebDriver::Options.send(@browser, **browser_options)
+                end
+
+      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?
 
-      options
+      vendor_caps << options
+    end
+
+    def process_proxy_options(options)
+      proxy = @options.delete(:proxy)
+      return if proxy.nil?
+
+      proxy &&= Selenium::WebDriver::Proxy.new(proxy) if proxy.is_a?(Hash)
+
+      unless proxy.is_a?(Selenium::WebDriver::Proxy)
+        raise TypeError, "#{proxy} needs to be Selenium Proxy or Hash instance"
+      end
+
+      options.proxy = proxy
+    end
+
+    def process_vendor_capabilities(opts)
+      return [] unless opts.is_a? Hash
+
+      vendor = opts.select { |key, _val| key.to_s.include?(':') && opts.delete(key) }
+      vendor.map { |k, v| Selenium::WebDriver::Remote::Capabilities.new(k => v) }
+    end
+
+    def convert_timeouts(browser_options)
+      browser_options[:timeouts] ||= {}
+      browser_options[:timeouts].keys.each 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')
+      end
+      if browser_options.key?(:page_load_timeout)
+        browser_options[:timeouts][:page_load] = browser_options.delete(:page_load_timeout) * 1000
+      end
+
+      return unless browser_options.key?(:script_timeout)
+
+      browser_options[:timeouts][:script] = browser_options.delete(:script_timeout) * 1000
     end
 
     def browser_specific_options(options)

data/lib/watir/elements/date_field.rb

@@ -11,7 +11,10 @@ module Watir
       raise ArgumentError, message unless [Date, ::Time].include?(date.class)
 
       date_string = date.strftime('%Y-%m-%d')
-      element_call(:wait_for_writable) { execute_js(:setValue, @element, date_string) }
+      element_call(:wait_for_writable) do
+        execute_js(:setValue, @element, date_string)
+        execute_js(:fireEvent, @element, :change)
+      end
     end
     alias set set!
     alias value= set

data/lib/watir/elements/date_time_field.rb

@@ -11,7 +11,10 @@ module Watir
       raise ArgumentError, message unless [DateTime, ::Time].include?(date.class)
 
       date_time_string = date.strftime('%Y-%m-%dT%H:%M')
-      element_call(:wait_for_writable) { execute_js(:setValue, @element, date_time_string) }
+      element_call(:wait_for_writable) do
+        execute_js(:setValue, @element, date_time_string)
+        execute_js(:fireEvent, @element, :change)
+      end
     end
     alias set set!
     alias value= set

data/lib/watir/elements/element.rb

@@ -163,6 +163,26 @@ module Watir
       browser.after_hooks.run
     end
 
+    #
+    # Determines the correct action based on subtype and takes it.
+    # Default is to click element
+    #
+
+    def set(*args)
+      subtype = to_subtype
+      if subtype.is_a?(Radio) && [String, Regexp].include?(args.first.class)
+        RadioSet.new(@query_scope, selector).set(*args)
+      elsif subtype.class.included_modules.include?(UserEditable) || subtype.public_methods(false).include?(:set)
+        subtype.set(*args)
+      elsif @content_editable || content_editable?
+        @content_editable = true
+        extend UserEditable
+        set(*args)
+      elsif args.empty? || args.first
+        click(*args)
+      end
+    end
+
     #
     # Simulates JavaScript click event on element.
     #
@@ -184,7 +204,10 @@ module Watir
     #
 
     def double_click
-      element_call(:wait_for_present) { driver.action.double_click(@element).perform }
+      element_call(:wait_for_present) do
+        scroll.to
+        driver.action.double_click(@element).perform
+      end
       browser.after_hooks.run
     end
 
@@ -219,6 +242,7 @@ module Watir
 
     def right_click(*modifiers)
       element_call(:wait_for_present) do
+        scroll.to
         action = driver.action
         if modifiers.any?
           modifiers.each { |mod| action.key_down mod }
@@ -242,7 +266,10 @@ module Watir
     #
 
     def hover
-      element_call(:wait_for_present) { driver.action.move_to(@element).perform }
+      element_call(:wait_for_present) do
+        scroll.to
+        driver.action.move_to(@element).perform
+      end
     end
 
     #
@@ -259,6 +286,7 @@ module Watir
       assert_is_element other
 
       value = element_call(:wait_for_present) do
+        scroll.to
         driver.action
               .drag_and_drop(@element, other.wd)
               .perform
@@ -280,6 +308,7 @@ module Watir
 
     def drag_and_drop_by(right_by, down_by)
       element_call(:wait_for_present) do
+        scroll.to
         driver.action
               .drag_and_drop_by(@element, right_by, down_by)
               .perform
@@ -672,7 +701,7 @@ module Watir
 
     def wait_for_enabled
       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

data/lib/watir/elements/font.rb

@@ -2,6 +2,7 @@ module Watir
   class Font < HTMLElement
     #
     # size of font
+    # This is in the whatwg spec was not generated: https://html.spec.whatwg.org/#htmlfontelement
     #
     # @return [Integer]
     #

data/lib/watir/elements/iframe.rb

@@ -126,7 +126,6 @@ module Watir
     def switch!
       @driver.switch_to.frame @element
       @browser.default_context = false
-      @browser.after_hooks.run
     rescue Selenium::WebDriver::Error::NoSuchFrameError => e
       raise UnknownFrameException, e.message
     end

data/lib/watir/elements/radio.rb

@@ -9,8 +9,8 @@ module Watir
     # Selects this radio button.
     #
 
-    def set
-      click unless set?
+    def set(bool = true)
+      click if bool && !set?
     end
     alias select set
 

data/lib/watir/elements/select.rb

@@ -5,7 +5,7 @@ module Watir
     #
 
     def clear
-      raise Exception::Error, 'you can only clear multi-selects' unless multiple?
+      raise Exception::Error, 'you can only clear multi-selects' unless multiple_select_list?
 
       selected_options.each(&:click)
     end
@@ -18,7 +18,7 @@ module Watir
     #
 
     def include?(str_or_rx)
-      option(text: str_or_rx).exist? || option(label: str_or_rx).exist?
+      option(text: str_or_rx).exist? || option(label: str_or_rx).exist? || option(value: str_or_rx).exist?
     end
 
     #
@@ -29,14 +29,16 @@ module Watir
     # @return [String] The text of the option selected. If multiple options match, returns the first match.
     #
 
-    def select(*str_or_rx)
-      if str_or_rx.size > 1 || str_or_rx.first.is_a?(Array)
-        str_or_rx.flatten.map { |v| select_all_by v }.first
+    def select(*str_or_rx, text: nil, value: nil, label: nil)
+      key, value = parse_select_args(str_or_rx, text, value, label)
+
+      if value.size > 1 || value.first.is_a?(Array)
+        value.flatten.map { |v| select_all_by key, v }.first
       else
-        found = find_options(:value, str_or_rx.flatten.first).first
-        select_matching([found])
+        select_matching([find_option(key, value.flatten.first)])
       end
     end
+    alias set select
 
     #
     # Uses JavaScript to select the option whose text matches the given string.
@@ -45,11 +47,13 @@ module Watir
     # @raise [Watir::Exception::NoValueFoundException] if the value does not exist.
     #
 
-    def select!(*str_or_rx)
-      if str_or_rx.size > 1 || str_or_rx.first.is_a?(Array)
-        str_or_rx.flatten.map { |v| select_by! v, :multiple }.first
+    def select!(*str_or_rx, text: nil, value: nil, label: nil)
+      key, value = parse_select_args(str_or_rx, text, value, label)
+
+      if value.size > 1 || value.first.is_a?(Array)
+        value.flatten.map { |v| select_by! key, v, :multiple }.first
       else
-        str_or_rx.flatten.map { |v| select_by! v, :single }.first
+        value.flatten.map { |v| select_by! key, v, :single }.first
       end
     end
 
@@ -61,16 +65,10 @@ module Watir
     # @return [Boolean]
     #
 
-    def selected?(str_or_rx)
-      by_text = options(text: str_or_rx)
-      return true if by_text.find(&:selected?)
-
-      by_label = options(label: str_or_rx)
-      return true if by_label.find(&:selected?)
+    def selected?(*str_or_rx, text: nil, value: nil, label: nil)
+      key, value = parse_select_args(str_or_rx, text, value, label)
 
-      return false unless (by_text.size + by_label.size).zero?
-
-      raise(UnknownObjectException, "Unable to locate option matching #{str_or_rx.inspect}")
+      find_option(key, value.first).selected?
     end
 
     #
@@ -81,8 +79,7 @@ module Watir
     #
 
     def value
-      option = selected_options.first
-      option&.value
+      selected_options.first&.value
     end
 
     #
@@ -92,9 +89,9 @@ module Watir
     # @return [String, nil]
     #
 
+    # TODO: What is default behavior without #first ?
     def text
-      option = selected_options.first
-      option&.text
+      selected_options.first&.text
     end
 
     # Returns an array of currently selected options.
@@ -108,10 +105,29 @@ module Watir
 
     private
 
-    def select_by!(str_or_rx, number)
+    def multiple_select_list?
+      @multiple_select = @multiple_select.nil? ? multiple? : @multiple_select
+    end
+
+    def parse_select_args(str_or_rx, text, value, label)
+      selectors = {}
+      selectors[:any] = str_or_rx unless str_or_rx.empty?
+      selectors[:text] = Array[text] if text
+      selectors[:value] = Array[value] if value
+      selectors[:label] = Array[label] if label
+
+      raise ArgumentError, "too many arguments used for Select#select: #{selectors}" if selectors.size > 1
+
+      selectors.first
+    end
+
+    def select_by!(key, str_or_rx, number)
+      str_or_rx = type_check(str_or_rx)
+
       js_rx = process_str_or_rx(str_or_rx)
+      approaches = key == :any ? %w[Text Label Value] : [key.to_s.capitalize]
 
-      %w[Text Label Value].each do |approach|
+      approaches.each do |approach|
         element_call { execute_js("selectOptions#{approach}", self, js_rx, number.to_s) }
         return selected_options.first.text if matching_option?(approach.downcase, str_or_rx)
       end
@@ -147,34 +163,41 @@ module Watir
       false
     end
 
-    def select_all_by(str_or_rx)
-      raise Error, 'you can only use #select_all on multi-selects' unless multiple?
+    def select_all_by(key, str_or_rx)
+      raise Error, 'you can only use #select_all on multi-selects' unless multiple_select_list?
 
-      select_matching(find_options(:text, str_or_rx))
+      select_matching(find_options(key, str_or_rx))
     end
 
-    def find_options(how, str_or_rx)
-      msg = "expected String, Numeric or Regexp, got #{str_or_rx.inspect}:#{str_or_rx.class}"
-      raise TypeError, msg unless [String, Numeric, Regexp].any? { |k| str_or_rx.is_a?(k) }
+    def find_option(key, str_or_rx)
+      val = type_check(str_or_rx)
 
-      wait_while do
-        @found = how == :value ? options(value: str_or_rx) : []
-        @found = options(text: str_or_rx) if @found.empty?
-        @found = options(label: str_or_rx) if @found.empty?
-        @found.empty?
-      end
-      @found
+      option(key => val).wait_until(&:exists?)
+    rescue Wait::TimeoutError
+      raise_no_value_found(str_or_rx)
+    end
+
+    def find_options(key, str_or_rx)
+      val = type_check(str_or_rx)
+
+      options(key => val).wait_until(&:exists?)
     rescue Wait::TimeoutError
       raise_no_value_found(str_or_rx)
     end
 
+    def type_check(str_or_rx)
+      str_or_rx = str_or_rx.to_s if str_or_rx.is_a?(Numeric)
+      return str_or_rx if [String, Regexp].any? { |k| str_or_rx.is_a?(k) }
+
+      raise TypeError, "expected String, Numeric or Regexp, got #{str_or_rx.inspect}:#{str_or_rx.class}"
+    end
+
     # TODO: Consider locating the Select List before throwing the exception
     def raise_no_value_found(str_or_rx)
       raise NoValueFoundException, "#{str_or_rx.inspect} not found in #{inspect}"
     end
 
     def select_matching(elements)
-      elements = [elements.first] unless multiple?
       elements.each { |e| e.click unless e.selected? }
       elements.first.exists? ? elements.first.text : ''
     end