watir 6.17.0 → 6.18.0

data/lib/watir/elements/element.rb

@@ -149,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
@@ -700,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
@@ -712,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?
 
@@ -734,7 +731,9 @@ module Watir
     end
 
     def ensure_context
-      if @query_scope.is_a?(Browser) || !@query_scope.located? || @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)
@@ -793,6 +792,7 @@ module Watir
     # 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?
@@ -806,12 +806,12 @@ module Watir
         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 = @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
         # TODO: - InvalidElementStateError is deprecated, so no longer calling `raise_disabled`
@@ -829,8 +829,8 @@ module Watir
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
-
-    # rubocop:enable Metrics/CyclomaticComplexity:
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def check_condition(condition, caller)
       Watir.logger.debug "<- `Verifying precondition #{inspect}##{condition} for #{caller}`"

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)

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)

data/lib/watir/generator/html/generator.rb

@@ -14,7 +14,7 @@ module Watir
       end
 
       def ignored_attributes
-        %w[cells elements hash rows span text size selected? style width height tHead tFoot link options]
+        %w[cells elements hash rows span text size selected? style width height tHead tFoot link options selected]
       end
 
       def generator_implementation

data/lib/watir/has_window.rb

@@ -10,13 +10,7 @@ module Watir
     #
 
     def windows(*args)
-      all = @driver.window_handles.map { |handle| Window.new(self, handle: handle) }
-
-      if args.empty?
-        all
-      else
-        filter_windows extract_selector(args), all
-      end
+      WindowCollection.new self, extract_selector(args)
     end
 
     #
@@ -51,16 +45,24 @@ module Watir
       @original_window ||= window
     end
 
-    private
+    #
+    # Waits for and returns second window if present
+    # See Window#use
+    #
+    # @example
+    #   browser.switch_window
+    #
+    # @return [Window]
+    #
 
-    def filter_windows(selector, windows)
-      unless selector.keys.all? { |k| %i[title url].include? k }
-        raise ArgumentError, "invalid window selector: #{selector.inspect}"
-      end
+    def switch_window
+      current_window = window
+      wins = windows
+      wait_until { (wins = windows) && wins.size > 1 } if wins.size == 1
+      raise StandardError, 'Unable to determine which window to switch to' if wins.size > 2
 
-      windows.select do |win|
-        selector.all? { |key, value| win.send(key) =~ /#{value}/ }
-      end
+      wins.find { |w| w != current_window }.use
+      window
     end
   end # HasWindow
 end # Watir

data/lib/watir/js_execution.rb

@@ -3,8 +3,8 @@ module Watir
     #
     # Delegates script execution to Browser or IFrame.
     #
-    def execute_script(script, *args)
-      @query_scope.execute_script(script, *args)
+    def execute_script(script, *args, function_name: nil)
+      @query_scope.execute_script(script, *args, function_name: function_name)
     end
 
     #

data/lib/watir/js_snippets.rb

@@ -6,11 +6,11 @@ module Watir
 
     def execute_js(function_name, *arguments)
       file = File.expand_path("../js_snippets/#{function_name}.js", __FILE__)
-      raise Exception::Error, "Can not excute script as #{function_name}.js does not exist" unless File.exist?(file)
+      raise Exception::Error, "Can not execute script as #{function_name}.js does not exist" unless File.exist?(file)
 
       js = File.read(file)
       script = "return (#{js}).apply(null, arguments)"
-      @query_scope.execute_script(script, *arguments)
+      @query_scope.execute_script(script, *arguments, function_name: function_name)
     end
   end # JSSnippets
 end # Watir

data/lib/watir/locators.rb

@@ -55,9 +55,7 @@ module Watir
       end
 
       def class_from_string(string)
-        Kernel.const_get(string)
-      rescue NameError
-        nil
+        Watir.const_get(string) if Watir.const_defined?(string)
       end
 
       def element_class_name

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

@@ -142,7 +142,7 @@ module Watir
 
         # Extensions implement this method when creating a different selector builder
         def implementation_class
-          Kernel.const_get("#{self.class.name}::XPath")
+          Watir.const_get("#{self.class.name}::XPath")
         end
 
         def build_wd_selector(selector)

data/lib/watir/logger.rb

@@ -2,7 +2,7 @@ require 'forwardable'
 require 'logger'
 
 # Code adapted from Selenium Implementation
-# https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/common/logger.rb
+# https://github.com/SeleniumHQ/selenium/blob/trunk/rb/lib/selenium/webdriver/common/logger.rb
 
 module Watir
   #
@@ -25,7 +25,7 @@ module Watir
                    :warn?,
                    :error, :error?,
                    :fatal, :fatal?,
-                   :level
+                   :level, :level=
 
     def initialize(progname = 'Watir')
       @logger = create_logger($stdout)
@@ -50,22 +50,6 @@ module Watir
       @logger.warn(msg, &block) unless (@ignored & ids).any?
     end
 
-    #
-    # For Ruby < 2.4 compatibility
-    # Based on https://github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250
-    #
-
-    def level=(severity)
-      if severity.is_a?(Integer)
-        @logger.level = severity
-      else
-        levels = %w[debug info warn error fatal unknown]
-        raise ArgumentError, "invalid log level: #{severity}" unless levels.include? severity.to_s.downcase
-
-        @logger.level = severity.to_s.upcase
-      end
-    end
-
     #
     # Returns IO object used by logger internally.
     #

data/lib/watir/radio_set.rb

@@ -4,7 +4,7 @@ module Watir
     include Exception
     include Enumerable
 
-    delegate %i[exists? present? visible? browser] => :source
+    delegate %i[exist? exists? present? visible? browser] => :source
 
     attr_reader :source, :frame
 
@@ -201,7 +201,7 @@ module Watir
     end
     alias eql? ==
 
-    # Ruby 2.4+ complains about using #delegate to do this
+    # Delegating to Private Methods
     %i[assert_exists element_call].each do |method|
       define_method(method) do |*args, &blk|
         source.send(method, *args, &blk)

data/lib/watir/user_editable.rb

@@ -21,13 +21,17 @@ module Watir
     # @param [String, Symbol] args
     #
 
+    def content_editable
+      defined?(@content_editable) && content_editable?
+    end
+
     def set!(*args)
       msg = '#set! does not support special keys, use #set instead'
       raise ArgumentError, msg if args.any? { |v| v.is_a?(::Symbol) }
 
       input_value = args.join
       set input_value[0]
-      return content_editable_set!(*args) if @content_editable
+      return content_editable_set!(*args) if content_editable
 
       element_call { execute_js(:setValue, @element, input_value[0..-2]) }
       append(input_value[-1])
@@ -43,7 +47,7 @@ module Watir
     #
 
     def append(*args)
-      raise NotImplementedError, '#append method is not supported with contenteditable element' if @content_editable
+      raise NotImplementedError, '#append method is not supported with contenteditable element' if content_editable
 
       send_keys(*args)
     end

data/lib/watir/version.rb

@@ -1,3 +1,3 @@
 module Watir
-  VERSION = '6.17.0'.freeze
+  VERSION = '6.18.0'.freeze
 end

data/lib/watir/wait.rb

@@ -229,6 +229,8 @@ module Watir
           case expected
           when Regexp
             expected =~ actual
+          when Numeric
+            expected == actual
           else
             expected.to_s == actual
           end

data/lib/watir/wait/timer.rb

@@ -2,7 +2,7 @@ module Watir
   module Wait
     class Timer
       def initialize(timeout: nil)
-        @end_time = current_time + timeout if timeout
+        @end_time = timeout ? current_time + timeout : nil
         @remaining_time = @end_time - current_time if @end_time
       end
 

data/lib/watir/window.rb

@@ -6,7 +6,7 @@ module Watir
 
     attr_reader :browser
 
-    def initialize(browser, selector)
+    def initialize(browser, selector = {})
       @browser = browser
       @driver = browser.driver
       @selector = selector
@@ -16,7 +16,7 @@ module Watir
       elsif selector.key? :handle
         @handle = selector.delete :handle
       else
-        return if selector.keys.all? { |k| %i[title url index].include? k }
+        return if selector.keys.all? { |k| %i[title url index element].include? k }
 
         raise ArgumentError, "invalid window selector: #{selector_string}"
       end
@@ -207,6 +207,9 @@ module Watir
       if @selector.empty?
         nil
       elsif @selector.key?(:index)
+        Watir.logger.deprecate 'Using :index as a selector for Window', ':title or :url or :element',
+                               reference: 'http://watir.com/guides/windows/#locating-by-index-is-no-longer-supported',
+                               ids: [:window_index]
         @driver.window_handles[Integer(@selector[:index])]
       else
         @driver.window_handles.find { |wh| matches?(wh) }
@@ -230,8 +233,9 @@ module Watir
       @driver.switch_to.window(handle) do
         matches_title = @selector[:title].nil? || @browser.title =~ /#{@selector[:title]}/
         matches_url = @selector[:url].nil? || @browser.url =~ /#{@selector[:url]}/
+        matches_element = @selector[:element].nil? || @selector[:element].exists?
 
-        matches_title && matches_url
+        matches_title && matches_url && matches_element
       end
     rescue Selenium::WebDriver::Error::NoSuchWindowError
       # the window may disappear while we're iterating.

data/lib/watir/window_collection.rb

@@ -0,0 +1,105 @@
+module Watir
+  class WindowCollection
+    include Enumerable
+    include Waitable
+
+    def initialize(browser, selector = {})
+      unless selector.keys.all? { |k| %i[title url element].include? k }
+        raise ArgumentError, "invalid window selector: #{selector.inspect}"
+      end
+
+      @browser = browser
+      @selector = selector
+    end
+
+    #
+    # Yields each window in collection.
+    #
+    # @yieldparam [Watir::Window]
+    #
+
+    def each(&blk)
+      reset!
+      to_a.each(&blk)
+    end
+
+    alias length count
+    alias size count
+    alias empty? none?
+
+    #
+    # First window of the collection
+    #
+    # @note windows in a collection are not ordered so this is not reliably
+    # @deprecated use Browser#switch_window or a better Window locator
+    # @return [Watir::Window] Returns an instance of a Watir::Window
+    #
+
+    def first
+      self[0]
+    end
+
+    #
+    # Last window of the collection
+    #
+    # @note windows in a collection are not ordered so this is not reliably
+    # @deprecated use Browser#switch_window or a better Window locator
+    # @return [Watir::Window] Returns an instance of a Watir::Window
+    #
+
+    def last
+      self[-1]
+    end
+
+    #
+    # Get the window at the given index or range.
+    #
+    # @note windows in a collection are not ordered so this is not reliably
+    # @deprecated use Browser#switch_window or a better Window locator
+    # @param [Integer, Range] value Index (0-based) or Range of desired window(s)
+    # @return [Watir::Window] Returns an instance of a Watir::Window
+    #
+
+    def [](value)
+      old = 'using indexing with windows'
+      new = 'Browser#switch_window or Browser#window with :title, :url or :element selectors'
+      reference = 'http://watir.com/window_indexes'
+      Watir.logger.deprecate old, new, reference: reference, ids: [:window_index]
+
+      to_a[value]
+    end
+
+    def ==(other)
+      to_a == other.to_a
+    end
+    alias eql? ==
+
+    def to_a
+      @to_a ||= begin
+        handles = @browser.driver.window_handles.select { |wh| matches?(wh) }
+        handles.map { |wh| Window.new(@browser, handle: wh) }
+      end
+    end
+
+    def reset!
+      @to_a = nil
+    end
+
+    private
+
+    # NOTE: This is the exact same code from `Window#matches?`
+    # TODO: Move this code into a separate WindowLocator class
+    def matches?(handle)
+      @selector.empty? || @browser.driver.switch_to.window(handle) do
+        matches_title = @selector[:title].nil? || @browser.title =~ /#{@selector[:title]}/
+        matches_url = @selector[:url].nil? || @browser.url =~ /#{@selector[:url]}/
+        matches_element = @selector[:element].nil? || @selector[:element].exists?
+
+        matches_title && matches_url && matches_element
+      end
+    rescue Selenium::WebDriver::Error::NoSuchWindowError
+      # the window may disappear while we're iterating.
+      false
+    end
+  end # Window
+end # Watir