watir 6.15.1 → 6.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c5ac0f3aeeeec1422ef300b30ffc292113a053e
-  data.tar.gz: a12b41e42257e86152ffb7e8b3c4e5777e657acf
+  metadata.gz: 63d608d81ce067739aacf522e62047450f0c0599
+  data.tar.gz: 135b27602f2a190dd6aa15401d93ecb0fbbd68a9
 SHA512:
-  metadata.gz: 057b9175188bef9121cb6bd5970db44ef90119e57e0c910c4fcec06762f66b9a8f8eebccc627826da31ba40bba0cf999fcf4110d07273b120879f3e93a3f7112
-  data.tar.gz: c7e93f0e181b4c11d3b20d7bd91e5a9f3fb4bb0fe8c0a98ad49a8daee676cf8fa35cb41c5d622714c6ee4c5dfc991b6dfbf010bd885b132e55d25d4d7df8c276
+  metadata.gz: b294891e79600c34327a05b06f01929f136a18400695b7ff03428ed264c8f66c4fae06e48e7879d691eac491029af5913ba275515eb319596c410f1cc98ba6c9
+  data.tar.gz: f258febcb8fbe41ff1ceacb3c96ada0ef27a8d19787e51bc45dd2d8f1901a64f5b76047a94446f427ce8338e4e4e5b4a85de12c9e83fe90283824cc40aeca402

data/.rubocop.yml

@@ -64,10 +64,10 @@ Metrics/MethodLength:
 
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 95
+  Max: 93
   Exclude:
     - 'lib/watir/capabilities.rb'
-    - 'lib/watir/locators/element/locator.rb'
+    - 'lib/watir/locators/element/matcher.rb'
     - 'lib/watir/locators/element/selector_builder.rb'
     - 'lib/watir/locators/element/selector_builder/xpath.rb'
     - 'lib/watir/browser.rb'
@@ -93,6 +93,7 @@ Metrics/AbcSize:
     - 'lib/watir/locators/element/locator.rb'
     - 'lib/watir/generator/base/generator.rb'
     - 'lib/watir/generator/base/visitor.rb'
+    - 'spec/locator_spec_helper.rb'
 
 # TODO: fix with Watir 7
 # Configuration parameters: CountKeywordArgs.

data/.travis.yml

@@ -71,6 +71,8 @@ matrix:
       - env: RAKE_TASK=spec:chrome HEADLESS=true
         <<: *five
         <<: *chrome
+      - env: RAKE_TASK=spec:unit
+        <<: *five
       - env: RAKE_TASK=spec:stats
         <<: *five
         <<: *chrome

data/CHANGES.md

@@ -1,3 +1,16 @@
+### 6.16.0 (2018-12-16)
+
+* Fix bug that did not re-locate Stale elements when taking an action on them (#814)
+* Implement `Element#cache=` to assign otherwise located Selenium Element to `Element`
+* Allow `:class` and `:class_name` locators to be used at the same time
+* Allow `:class` locator with empty `Array` value to find all elements without a `class` attribute
+* Fix bug that forced nested elements to wait when calling predicate methods (#827)
+* Locator filtering behavior and Validate class moved into new `Matcher` classes
+* Selector is built on Element initialization rather than during location
+* Allow some nested elements to be located with a single XPath call
+* Merge p0deje's watir-scroll gem functionality directly into Watir
+* Fix bug with `#obscured?` for non-interactive elements (#818)
+
 ### 6.15.1 (2018-12-04)
 
 * Locator value type check error message now returns array of allowed class types

data/Rakefile

@@ -7,6 +7,7 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = %w[--color --require fuubar --format Fuubar]
   spec.pattern = 'spec/**/*_spec.rb'
+  spec.exclude_pattern = 'spec/unit/**/*_spec.rb'
 end
 
 require 'rubocop/rake_task'
@@ -155,6 +156,11 @@ namespace :spec do
     end
   end
 
+  desc 'Run the Unit tests'
+  RSpec::Core::RakeTask.new(:unit) do |spec|
+    spec.pattern = 'spec/unit/**/**_spec.rb'
+  end
+
   desc 'Run element location specs and report wire calls'
   RSpec::Core::RakeTask.new(:stats) do |spec|
     ENV['SELENIUM_STATS'] = 'true'

data/lib/watir.rb

@@ -1,6 +1,7 @@
 require 'selenium-webdriver'
 require 'time'
 
+require 'watir/scroll'
 require 'watir/legacy_wait'
 require 'watir/wait'
 require 'watir/exception'

data/lib/watir/browser.rb

@@ -9,6 +9,7 @@ module Watir
     include Waitable
     include Navigation
     include Exception
+    include Scrolling
 
     attr_writer :default_context, :original_window, :locator_namespace
     attr_reader :driver, :after_hooks
@@ -213,7 +214,9 @@ module Watir
     #
 
     def execute_script(script, *args)
-      args.map! { |e| e.is_a?(Element) ? e.wd : e }
+      args.map! do |e|
+        e.is_a?(Element) ? e.wait_until(&:exists?).wd : e
+      end
 
       wrap_elements_in(self, @driver.execute_script(script, *args))
     end

data/lib/watir/element_collection.rb

@@ -10,6 +10,8 @@ module Watir
     def initialize(query_scope, selector)
       @query_scope = query_scope
       @selector = selector
+
+      build unless @selector.key?(:element)
     end
 
     #
@@ -33,11 +35,15 @@ module Watir
 
     alias empty? none?
 
+    def build
+      selector_builder.build(@selector.dup)
+    end
+
     #
     # Get the element at the given index or range.
     #
-    # Any call to an ElementCollection including an adjacent selector
-    # can not be lazy loaded because it must store correct type
+    # Any call to an ElementCollection that includes an adjacent selector
+    # can not be lazy loaded because it must store the correct type
     #
     # Ranges can not be lazy loaded
     #
@@ -86,19 +92,14 @@ module Watir
     def to_a
       hash = {}
       @to_a ||=
-        elements.map.with_index do |e, idx|
-          selector = @selector.merge(element: e)
-          selector[:index] = idx
+        elements.map.with_index do |el, idx|
+          selector = @selector.dup
+          selector[:index] = idx unless idx.zero?
           element = element_class.new(@query_scope, selector)
           if [HTMLElement, Input].include? element.class
-            tag_name = @selector[:tag_name] || element.tag_name
-            hash[tag_name] ||= 0
-            hash[tag_name] += 1
-            selector[:index] = hash[tag_name] - 1
-            selector[:tag_name] = tag_name
-            Watir.element_class_for(tag_name).new(@query_scope, selector)
+            construct_subtype(element, hash).tap { |e| e.cache = el }
           else
-            element
+            element.tap { |e| e.cache = el }
           end
         end
     end
@@ -154,11 +155,10 @@ module Watir
 
     def elements
       ensure_context
-      if @query_scope.is_a?(Browser)
-        locate_all
-      else
-        # This gives all of the standard Watir waiting behaviors to Collections
+      if selector_builder.built.key?(:scope)
         @query_scope.send(:element_call) { locate_all }
+      else
+        locate_all
       end
     end
 
@@ -168,11 +168,21 @@ module Watir
     end
 
     def locate_all
-      build_locator.locate_all
+      locator.locate_all(selector_builder.built)
     end
 
     def element_class
       Kernel.const_get(self.class.name.sub(/Collection$/, ''))
     end
+
+    def construct_subtype(element, hash)
+      selector = element.selector
+      tag_name = selector[:tag_name] || element.tag_name
+      hash[tag_name] ||= 0
+      hash[tag_name] += 1
+      selector[:index] = hash[tag_name] - 1
+      selector[:tag_name] = tag_name
+      Watir.element_class_for(tag_name).new(@query_scope, selector)
+    end
   end # ElementCollection
 end # Watir

data/lib/watir/elements/element.rb

@@ -13,6 +13,7 @@ module Watir
     include Adjacent
     include JSExecution
     include Locators::ClassHelpers
+    include Scrolling
 
     attr_accessor :keyword
     attr_reader :selector
@@ -34,7 +35,14 @@ module Watir
       raise ArgumentError, "invalid argument: #{selector.inspect}" unless selector.is_a? Hash
 
       @element = selector.delete(:element)
+
+      if @element && !(selector.keys - %i[tag_name]).empty?
+        Watir.logger.deprecate(':element locator to initialize a relocatable Element', '#cache=', ids: [:element_cache])
+      end
+
       @selector = selector
+
+      build unless @element
     end
 
     #
@@ -133,6 +141,7 @@ 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
@@ -436,7 +445,8 @@ module Watir
     #
 
     def wd
-      element_call { @element }
+      assert_exists
+      @element
     end
 
     #
@@ -504,7 +514,7 @@ module Watir
       element_call do
         return true unless present?
 
-        scroll_into_view
+        scroll.to
         execute_js(:elementObscured, self)
       end
     end
@@ -555,7 +565,7 @@ module Watir
                 Watir.element_class_for(tag)
               end
 
-      klass.new(@query_scope, @selector.merge(element: wd))
+      klass.new(@query_scope, @selector).tap { |el| el.cache = wd }
     end
 
     #
@@ -583,7 +593,7 @@ module Watir
     end
 
     def stale_in_context?
-      @element.enabled? # any wire call will check for staleness
+      @element.css_value('staleness_check') # any wire call will check for staleness
       false
     rescue Selenium::WebDriver::Error::ObsoleteElementError
       true
@@ -603,6 +613,14 @@ module Watir
       self
     end
 
+    #
+    # @api private
+    #
+
+    def build
+      selector_builder.build(@selector.dup)
+    end
+
     #
     # @api private
     #
@@ -615,6 +633,16 @@ module Watir
       !!@element
     end
 
+    #
+    # @api private
+    #
+    # Set the cached element. For use when element can be relocated with the provided selector.
+    #
+
+    def cache=(element)
+      @element = element
+    end
+
     #
     # @api private
     #
@@ -646,7 +674,7 @@ module Watir
 
       begin
         @query_scope.wait_for_exists unless @query_scope.is_a? Browser
-        wait_until(&:exists?)
+        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
@@ -710,8 +738,7 @@ module Watir
     end
 
     def locate_in_context
-      @locator = build_locator
-      @element = @locator.locate
+      @element = locator.locate(selector_builder.built)
     end
 
     private
@@ -747,7 +774,7 @@ module Watir
     end
 
     def assert_is_element(obj)
-      raise TypeError, "execpted Watir::Element, got #{obj.inspect}:#{obj.class}" unless obj.is_a? Element
+      raise TypeError, "expected Watir::Element, got #{obj.inspect}:#{obj.class}" unless obj.is_a? Element
     end
 
     # Removes duplication in #present? & #visible? and makes setting deprecation notice easier
@@ -771,13 +798,13 @@ module Watir
 
       begin
         check_condition(precondition, caller)
-        Watir.logger.info "-> `Executing #{inspect}##{caller}`"
+        Watir.logger.debug "-> `Executing #{inspect}##{caller}`"
         yield
       rescue unknown_exception => ex
         element_call(:wait_for_exists, &block) if precondition.nil?
         msg = ex.message
         msg += '; Maybe look in an iframe?' if @query_scope.iframe.exists?
-        custom_attributes = @locator.nil? ? [] : @locator.selector_builder.custom_attributes
+        custom_attributes = @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
@@ -796,7 +823,7 @@ module Watir
       rescue Selenium::WebDriver::Error::NoSuchWindowError
         raise NoMatchingWindowFoundException, 'browser window was closed'
       ensure
-        Watir.logger.info "<- `Completed #{inspect}##{caller}`"
+        Watir.logger.debug "<- `Completed #{inspect}##{caller}`"
         Wait.timer.reset! unless already_locked
       end
     end
@@ -806,14 +833,14 @@ module Watir
     # rubocop:enable Metrics/CyclomaticComplexity:
 
     def check_condition(condition, caller)
-      Watir.logger.info "<- `Verifying precondition #{inspect}##{condition} for #{caller}`"
+      Watir.logger.debug "<- `Verifying precondition #{inspect}##{condition} for #{caller}`"
       begin
         condition.nil? ? assert_exists : send(condition)
-        Watir.logger.info "<- `Verified precondition #{inspect}##{condition || 'assert_exists'}`"
+        Watir.logger.debug "<- `Verified precondition #{inspect}##{condition || 'assert_exists'}`"
       rescue unknown_exception
         raise unless condition.nil?
 
-        Watir.logger.info "<- `Unable to satisfy precondition #{inspect}##{condition}`"
+        Watir.logger.debug "<- `Unable to satisfy precondition #{inspect}##{condition}`"
         check_condition(:wait_for_exists, caller)
       end
     end

data/lib/watir/elements/iframe.rb

@@ -45,7 +45,9 @@ module Watir
     #
 
     def execute_script(script, *args)
-      args.map! { |e| e.is_a?(Element) ? e.wd : e }
+      args.map! do |e|
+        e.is_a?(Element) ? e.wait_until(&:exists?).wd : e
+      end
       returned = driver.execute_script(script, *args)
 
       browser.wrap_elements_in(self, returned)

data/lib/watir/elements/radio.rb

@@ -1,8 +1,8 @@
 module Watir
   class Radio < Input
-    def initialize(query_scope, selector)
-      super
+    def build
       @selector[:label] = @selector.delete(:text) if @selector.key?(:text)
+      super
     end
 
     #
@@ -51,6 +51,11 @@ module Watir
   class RadioCollection < InputCollection
     private
 
+    def build
+      @selector[:label] = @selector.delete(:text) if @selector.key?(:text)
+      super
+    end
+
     def element_class
       Radio
     end

data/lib/watir/elements/select.rb

@@ -218,6 +218,7 @@ module Watir
       raise_no_value_found(str_or_rx)
     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

data/lib/watir/locators.rb

@@ -3,33 +3,35 @@ require 'watir/locators/element/selector_builder'
 require 'watir/locators/element/selector_builder/xpath_support'
 require 'watir/locators/element/selector_builder/regexp_disassembler'
 require 'watir/locators/element/selector_builder/xpath'
-require 'watir/locators/element/validator'
+require 'watir/locators/element/matcher'
 
 require 'watir/locators/anchor/selector_builder'
 
-require 'watir/locators/button/locator'
 require 'watir/locators/button/selector_builder'
 require 'watir/locators/button/selector_builder/xpath'
-require 'watir/locators/button/validator'
+require 'watir/locators/button/matcher'
 
-require 'watir/locators/cell/locator'
 require 'watir/locators/cell/selector_builder'
 require 'watir/locators/cell/selector_builder/xpath'
 
-require 'watir/locators/row/locator'
 require 'watir/locators/row/selector_builder'
 require 'watir/locators/row/selector_builder/xpath'
 
 require 'watir/locators/text_area/selector_builder'
 require 'watir/locators/text_area/selector_builder/xpath'
 
-require 'watir/locators/text_field/locator'
 require 'watir/locators/text_field/selector_builder'
 require 'watir/locators/text_field/selector_builder/xpath'
-require 'watir/locators/text_field/validator'
+require 'watir/locators/text_field/matcher'
 
 module Watir
   module Locators
+    W3C_FINDERS = %i[css
+                     link
+                     link_text
+                     partial_link_text
+                     xpath].freeze
+
     module ClassHelpers
       def locator_class
         class_from_string("#{browser.locator_namespace}::#{element_class_name}::Locator") ||
@@ -38,11 +40,11 @@ module Watir
           Locators::Element::Locator
       end
 
-      def element_validator_class
-        class_from_string("#{browser.locator_namespace}::#{element_class_name}::Validator") ||
-          class_from_string("Watir::Locators::#{element_class_name}::Validator") ||
-          class_from_string("#{browser.locator_namespace}::Element::Validator") ||
-          Locators::Element::Validator
+      def element_matcher_class
+        class_from_string("#{browser.locator_namespace}::#{element_class_name}::Matcher") ||
+          class_from_string("Watir::Locators::#{element_class_name}::Matcher") ||
+          class_from_string("#{browser.locator_namespace}::Element::Matcher") ||
+          Locators::Element::Matcher
       end
 
       def selector_builder_class
@@ -62,15 +64,13 @@ module Watir
         element_class.to_s.split('::').last
       end
 
-      def build_locator
-        selector_builder = if element_class == Watir::Row
-                             scope_tag_name = @query_scope.selector[:tag_name]
-                             selector_builder_class.new(element_class.attribute_list, scope_tag_name)
-                           else
-                             selector_builder_class.new(element_class.attribute_list)
-                           end
-        element_validator = element_validator_class.new
-        locator_class.new(@query_scope, @selector.dup, selector_builder, element_validator)
+      def selector_builder
+        @selector_builder ||= selector_builder_class.new(element_class.attribute_list, @query_scope)
+      end
+
+      def locator
+        @element_matcher ||= element_matcher_class.new(@query_scope, @selector.dup)
+        @locator ||= locator_class.new(@element_matcher)
       end
     end
   end