capybara 2.18.0 → 3.0.0

data/lib/capybara/node/document.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Capybara
   module Node
-
     ##
     #
     # A {Capybara::Document} represents an HTML document. Any operation
@@ -20,7 +20,7 @@ module Capybara
       #
       # @return [String]    The text of the document
       #
-      def text(type=nil)
+      def text(type = nil)
         find(:xpath, '/html').text(type)
       end
 

data/lib/capybara/node/document_matchers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Capybara
   module Node
     module DocumentMatchers
@@ -15,8 +16,8 @@ module Capybara
       # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
       # @return [true]
       #
-      def assert_title(title, options = {})
-        _verify_title(title,options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
+      def assert_title(title, **options)
+        _verify_title(title, options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
       end
 
       ##
@@ -26,8 +27,8 @@ module Capybara
       # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
       # @return [true]
       #
-      def assert_no_title(title, options = {})
-        _verify_title(title,options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
+      def assert_no_title(title, **options)
+        _verify_title(title, options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
       end
 
       ##
@@ -36,7 +37,7 @@ module Capybara
       # @macro title_query_params
       # @return [Boolean]
       #
-      def has_title?(title, options = {})
+      def has_title?(title, **options)
         assert_title(title, options)
       rescue Capybara::ExpectationNotMet
         return false
@@ -48,13 +49,13 @@ module Capybara
       # @macro title_query_params
       # @return [Boolean]
       #
-      def has_no_title?(title, options = {})
+      def has_no_title?(title, **options)
         assert_no_title(title, options)
       rescue Capybara::ExpectationNotMet
         return false
       end
 
-      private
+    private
 
       def _verify_title(title, options)
         query = Capybara::Queries::TitleQuery.new(title, options)
@@ -63,7 +64,6 @@ module Capybara
         end
         return true
       end
-
     end
   end
 end

data/lib/capybara/node/element.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Capybara
   module Node
-
     ##
     #
     # A {Capybara::Node::Element} represents a single element on the page. It is possible
@@ -22,7 +22,6 @@ module Capybara
     # @see Capybara::Node
     #
     class Element < Base
-
       def initialize(session, base, query_scope, query)
         super(session, base)
         @query_scope = query_scope
@@ -54,7 +53,7 @@ module Capybara
       # @param [:all, :visible] type  Whether to return only visible or all text
       # @return [String]              The text of the element
       #
-      def text(type=nil)
+      def text(type = nil)
         type ||= :all unless session_options.ignore_hidden_elements or session_options.visible_text_only
         synchronize do
           if type == :all
@@ -94,23 +93,10 @@ module Capybara
       # @param [Hash{}] options  Driver specific options for how to set the value
       #
       # @return [Capybara::Node::Element]  The element
-      def set(value, options={})
-        options ||= {}
-
-        driver_supports_options = (base.method(:set).arity != 1)
-
-        unless options.empty? || driver_supports_options
-          warn "Options passed to Capybara::Node#set but the driver doesn't support them"
-        end
-
-        synchronize do
-          if driver_supports_options
-            base.set(value, options)
-          else
-            base.set(value)
-          end
-        end
-        return self
+      def set(value, **options)
+        raise Capybara::ReadOnlyElementError, "Attempt to set readonly element with value: #{value}" if readonly?
+        synchronize { base.set(value, options) }
+        self
       end
 
       ##
@@ -121,7 +107,7 @@ module Capybara
       def select_option
         warn "Attempt to select disabled option: #{value || text}" if disabled?
         synchronize { base.select_option }
-        return self
+        self
       end
 
       ##
@@ -131,37 +117,43 @@ module Capybara
       # @return [Capybara::Node::Element]  The element
       def unselect_option
         synchronize { base.unselect_option }
-        return self
+        self
       end
 
       ##
       #
       # Click the Element
       #
+      # @!macro click_modifiers
+      #   @overload $0(*key_modifiers=[], offset={x: nil, y: nil})
+      #     @param [Array<:alt, :control, :meta, :shift>] *key_modifiers  Keys to be held down when clicking
+      #     @param [Hash] offset                          x and y coordinates to offset the click location from the top left corner of the element.  If not specified will click the middle of the element.
       # @return [Capybara::Node::Element]  The element
-      def click
-        synchronize { base.click }
-        return self
+      def click(*keys, **offset)
+        synchronize { base.click(keys, offset) }
+        self
       end
 
       ##
       #
       # Right Click the Element
       #
+      # @macro click_modifiers
       # @return [Capybara::Node::Element]  The element
-      def right_click
-        synchronize { base.right_click }
-        return self
+      def right_click(*keys, **offset)
+        synchronize { base.right_click(keys, offset) }
+        self
       end
 
       ##
       #
       # Double Click the Element
       #
+      # @macro click_modifiers
       # @return [Capybara::Node::Element]  The element
-      def double_click
-        synchronize { base.double_click }
-        return self
+      def double_click(*keys, **offset)
+        synchronize { base.double_click(keys, offset) }
+        self
       end
 
       ##
@@ -237,7 +229,7 @@ module Capybara
       # @return [Capybara::Node::Element]  The element
       def send_keys(*args)
         synchronize { base.send_keys(*args) }
-        return self
+        self
       end
 
       ##
@@ -247,7 +239,7 @@ module Capybara
       # @return [Capybara::Node::Element]  The element
       def hover
         synchronize { base.hover }
-        return self
+        self
       end
 
       ##
@@ -339,7 +331,7 @@ module Capybara
       # @return [Capybara::Node::Element]  The element
       def trigger(event)
         synchronize { base.trigger(event) }
-        return self
+        self
       end
 
       ##
@@ -355,7 +347,7 @@ module Capybara
       # @return [Capybara::Node::Element]  The element
       def drag_to(node)
         synchronize { base.drag_to(node.base) }
-        return self
+        self
       end
 
       def reload
@@ -375,11 +367,9 @@ module Capybara
       rescue NotSupportedByDriverError
         %(#<Capybara::Node::Element tag="#{base.tag_name}">)
       rescue => e
-        if session.driver.invalid_element_errors.any? { |et| e.is_a?(et)}
-          %(Obsolete #<Capybara::Node::Element>)
-        else
-          raise
-        end
+        raise unless session.driver.invalid_element_errors.any? { |et| e.is_a?(et) }
+
+        %(Obsolete #<Capybara::Node::Element>)
       end
     end
   end

data/lib/capybara/node/finders.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 module Capybara
   module Node
     module Finders
-
       ##
       #
       # Find an {Capybara::Node::Element} based on the given arguments. +find+ will raise an error if the element
@@ -28,13 +28,9 @@ module Capybara
       # @return [Capybara::Node::Element]      The found element
       # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires
       #
-      def find(*args, &optional_filter_block)
-        if args.last.is_a? Hash
-          args.last[:session_options] = session_options
-        else
-          args.push(session_options: session_options)
-        end
-        synced_resolve Capybara::Queries::SelectorQuery.new(*args, &optional_filter_block)
+      def find(*args, **options, &optional_filter_block)
+        options[:session_options] = session_options
+        synced_resolve Capybara::Queries::SelectorQuery.new(*args, options, &optional_filter_block)
       end
 
       ##
@@ -57,13 +53,9 @@ module Capybara
       # @return [Capybara::Node::Element]      The found element
       # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires
       #
-      def ancestor(*args, &optional_filter_block)
-        if args.last.is_a? Hash
-          args.last[:session_options] = session_options
-        else
-          args.push(session_options: session_options)
-        end
-        synced_resolve Capybara::Queries::AncestorQuery.new(*args, &optional_filter_block)
+      def ancestor(*args, **options, &optional_filter_block)
+        options[:session_options] = session_options
+        synced_resolve Capybara::Queries::AncestorQuery.new(*args, **options, &optional_filter_block)
       end
 
       ##
@@ -87,13 +79,9 @@ module Capybara
       # @return [Capybara::Node::Element]      The found element
       # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires
       #
-      def sibling(*args, &optional_filter_block)
-        if args.last.is_a? Hash
-          args.last[:session_options] = session_options
-        else
-          args.push(session_options: session_options)
-        end
-        synced_resolve Capybara::Queries::SiblingQuery.new(*args, &optional_filter_block)
+      def sibling(*args, **options, &optional_filter_block)
+        options[:session_options] = session_options
+        synced_resolve Capybara::Queries::SiblingQuery.new(*args, **options, &optional_filter_block)
       end
 
       ##
@@ -123,11 +111,9 @@ module Capybara
       # @return [Capybara::Node::Element]   The found element
       #
 
-      def find_field(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def find_field(locator = nil, **options, &optional_filter_block)
         find(:field, locator, options, &optional_filter_block)
       end
-      alias_method :field_labeled, :find_field
 
       ##
       #
@@ -145,8 +131,7 @@ module Capybara
       #   @option options [String, Array<String>] class    Match links that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
-      def find_link(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def find_link(locator = nil, **options, &optional_filter_block)
         find(:link, locator, options, &optional_filter_block)
       end
 
@@ -174,8 +159,7 @@ module Capybara
       #   @option options [String, Array<String>] class    Match buttons that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
-      def find_button(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def find_button(locator = nil, **options, &optional_filter_block)
         find(:button, locator, options, &optional_filter_block)
       end
 
@@ -189,7 +173,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]   The found element
       #
-      def find_by_id(id, options={}, &optional_filter_block)
+      def find_by_id(id, **options, &optional_filter_block)
         find(:id, id, options, &optional_filter_block)
       end
 
@@ -221,10 +205,11 @@ module Capybara
       #     page.all('a', text: 'Home')
       #     page.all('#menu li', visible: true)
       #
-      # By default if no elements are found, an empty array is returned;
-      # however, expectations can be set on the number of elements to be found which
-      # will trigger Capybara's waiting behavior for the expectations to match.The
-      # expectations can be set using
+      # By default Capybara's waiting behavior will wait up to `Capybara.default_max_wait_time`
+      # seconds for matching elements to be available and then return an empty result if none
+      # are available. It is possible to set expectations on the number of results located and
+      # Capybara will raise an exception if the number of elements located don't satisfy the
+      # specified conditions.  The expectations can be set using
       #
       #     page.assert_selector('p#foo', count: 4)
       #     page.assert_selector('p#foo', maximum: 10)
@@ -235,9 +220,9 @@ module Capybara
       # count matching.
       #
       # @param [Symbol] kind                       Optional selector type (:css, :xpath, :field, etc.) - Defaults to Capybara.default_selector
-      # @param [String] locator                    The selector
+      # @param [String] locator                    The locator for the specified selector
       # @option options [String, Regexp] text      Only find elements which contain this text or match this regexp
-      # @option options [String, Boolean] exact_text (Capybara.exact_text) When String the string the elements contained text must match exactly, when Boolean controls whether the :text option must match exactly
+      # @option options [String, Boolean] exact_text (Capybara.exact_text) When String the elements contained text must match exactly, when Boolean controls whether the :text option must match exactly
       # @option options [Boolean, Symbol] visible  Only find elements with the specified visibility:
       #                                              * true - only finds visible elements.
       #                                              * false - finds invisible _and_ visible elements.
@@ -249,24 +234,28 @@ module Capybara
       # @option options [Integer] minimum          Minimum number of matches that are expected to be found
       # @option options [Range]   between          Number of matches found must be within the given range
       # @option options [Boolean] exact            Control whether `is` expressions in the given XPath match exactly or partially
-      # @option options [Integer] wait (Capybara.default_max_wait_time)  The time to wait for element count expectations to become true
+      # @option options [Integer, false] wait (Capybara.default_max_wait_time)  The time to wait for matching elements to become available
       # @overload all([kind = Capybara.default_selector], locator = nil, options = {})
       # @overload all([kind = Capybara.default_selector], locator = nil, options = {}, &filter_block)
       #   @yieldparam element [Capybara::Node::Element]  The element being considered for inclusion in the results
       #   @yieldreturn [Boolean]                     Should the element be considered in the results?
       # @return [Capybara::Result]                   A collection of found elements
-      #
-      def all(*args, &optional_filter_block)
-        if args.last.is_a? Hash
-          args.last[:session_options] = session_options
-        else
-          args.push(session_options: session_options)
-        end
-        query = Capybara::Queries::SelectorQuery.new(*args, &optional_filter_block)
-        synchronize(query.wait) do
-          result = query.resolve_for(self)
-          raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?
-          result
+      # @raise [Capybara::ExpectationNotMet]         The number of elements found doesn't match the specified conditions
+      def all(*args, **options, &optional_filter_block)
+        minimum_specified = options_include_minimum?(options)
+        options = { minimum: 1 }.merge(options) unless minimum_specified
+        options[:session_options] = session_options
+        query = Capybara::Queries::SelectorQuery.new(*args.push(options), &optional_filter_block)
+        result = nil
+        begin
+          synchronize(query.wait) do
+            result = query.resolve_for(self)
+            raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?
+            result
+          end
+        rescue Capybara::ExpectationNotMet
+          raise if minimum_specified || (result.compare_count == 1)
+          Result.new([], nil)
         end
       end
       alias_method :find_all, :all
@@ -274,48 +263,51 @@ module Capybara
       ##
       #
       # Find the first element on the page matching the given selector
-      # and options, or nil if no element matches.  By default no waiting
-      # behavior occurs, however if {Capybara.wait_on_first_by_default} is set to true
-      # it will trigger Capybara's waiting behavior for a minimum of 1 matching element to be found and
-      # return the first.  Waiting behavior can also be triggered by passing in any of the count
-      # expectation options.
+      # and options. By default `first` will wait up to `Capybara.default_max_wait_time`
+      # seconds for matching elements to appear and then raise an error if no matching
+      # element is found, or `nil` if the provided count options allow for empty results.
       #
       # @overload first([kind], locator, options)
       #   @param [:css, :xpath] kind                 The type of selector
       #   @param [String] locator                    The selector
       #   @param [Hash] options                      Additional options; see {#all}
       # @return [Capybara::Node::Element]            The found element or nil
+      # @raise  [Capybara::ElementNotFound]          If element(s) matching the provided options can't be found before time expires
       #
-      def first(*args, &optional_filter_block)
-        if session_options.wait_on_first_by_default
-          options = if args.last.is_a?(Hash) then args.pop.dup else {} end
-          args.push({minimum: 1}.merge(options))
-        end
-        all(*args, &optional_filter_block).first
-      rescue Capybara::ExpectationNotMet
-        nil
+      def first(*args, **options, &optional_filter_block)
+        options = { minimum: 1 }.merge(options) unless options_include_minimum?(options)
+        all(*args, **options, &optional_filter_block).first
       end
 
-      private
+    private
 
       def synced_resolve(query)
         synchronize(query.wait) do
-          if (query.match == :smart or query.match == :prefer_exact)
+          if prefer_exact?(query)
             result = query.resolve_for(self, true)
             result = query.resolve_for(self, false) if result.empty? && query.supports_exact? && !query.exact?
           else
             result = query.resolve_for(self)
           end
 
-          if query.match == :one or query.match == :smart and result.size > 1
-            raise Capybara::Ambiguous.new("Ambiguous match, found #{result.size} elements matching #{query.description}")
-          end
-          if result.empty?
-            raise Capybara::ElementNotFound.new("Unable to find #{query.description}")
-          end
+          raise Capybara::Ambiguous, "Ambiguous match, found #{result.size} elements matching #{query.description}" if ambiguous?(query, result)
+          raise Capybara::ElementNotFound, "Unable to find #{query.description}" if result.empty?
+
           result.first
         end.tap(&:allow_reload!)
       end
+
+      def ambiguous?(query, result)
+        query.match == :one or query.match == :smart and result.size > 1
+      end
+
+      def prefer_exact?(query)
+        query.match == :smart or query.match == :prefer_exact
+      end
+
+      def options_include_minimum?(opts)
+        %i[count minimum between].any? { |k| opts.key?(k) }
+      end
     end
   end
 end