capybara 2.18.0 → 3.0.0

data/lib/capybara/node/matchers.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 module Capybara
   module Node
     module Matchers
-
       ##
       #
       # Checks if a given selector is on the page or a descendant of the current node.
@@ -39,7 +39,7 @@ module Capybara
       def has_selector?(*args, &optional_filter_block)
         assert_selector(*args, &optional_filter_block)
       rescue Capybara::ExpectationNotMet
-        return false
+        false
       end
 
       ##
@@ -53,7 +53,7 @@ module Capybara
       def has_no_selector?(*args, &optional_filter_block)
         assert_no_selector(*args, &optional_filter_block)
       rescue Capybara::ExpectationNotMet
-        return false
+        false
       end
 
       ##
@@ -91,7 +91,7 @@ module Capybara
       #
       def assert_selector(*args, &optional_filter_block)
         _verify_selector_result(args, optional_filter_block) do |result, query|
-          unless result.matches_count? && ((!result.empty?) || query.expects_none?)
+          unless result.matches_count? && (!result.empty? || query.expects_none?)
             raise Capybara::ExpectationNotMet, result.failure_message
           end
         end
@@ -112,10 +112,9 @@ module Capybara
       #
       # @overload assert_all_of_selectors([kind = Capybara.default_selector], *locators, options = {})
       #
-      def assert_all_of_selectors(*args, &optional_filter_block)
-        options = if args.last.is_a?(Hash) then args.pop.dup else {} end
-        selector = if args.first.is_a?(Symbol) then args.shift else session_options.default_selector end
-        wait = options.fetch(:wait, session_options.default_max_wait_time)
+      def assert_all_of_selectors(*args, wait: nil, **options, &optional_filter_block)
+        wait = session_options.default_max_wait_time if wait.nil?
+        selector = args.first.is_a?(Symbol) ? args.shift : session_options.default_selector
         synchronize(wait) do
           args.each do |locator|
             assert_selector(selector, locator, options, &optional_filter_block)
@@ -138,10 +137,9 @@ module Capybara
       #
       # @overload assert_none_of_selectors([kind = Capybara.default_selector], *locators, options = {})
       #
-      def assert_none_of_selectors(*args, &optional_filter_block)
-        options = if args.last.is_a?(Hash) then args.pop.dup else {} end
-        selector = if args.first.is_a?(Symbol) then args.shift else session_options.default_selector end
-        wait = options.fetch(:wait, session_options.default_max_wait_time)
+      def assert_none_of_selectors(*args, wait: nil, **options, &optional_filter_block)
+        wait = session_options.default_max_wait_time if wait.nil?
+        selector = args.first.is_a?(Symbol) ? args.shift : session_options.default_selector
         synchronize(wait) do
           args.each do |locator|
             assert_no_selector(selector, locator, options, &optional_filter_block)
@@ -167,7 +165,7 @@ module Capybara
       #
       def assert_no_selector(*args, &optional_filter_block)
         _verify_selector_result(args, optional_filter_block) do |result, query|
-          if result.matches_count? && ((!result.empty?) || query.expects_none?)
+          if result.matches_count? && (!result.empty? || query.expects_none?)
             raise Capybara::ExpectationNotMet, result.negative_failure_message
           end
         end
@@ -203,7 +201,7 @@ module Capybara
       # @option options [Integer] :count (nil)    Number of times the expression should occur
       # @return [Boolean]                         If the expression exists
       #
-      def has_xpath?(path, options={}, &optional_filter_block)
+      def has_xpath?(path, **options, &optional_filter_block)
         has_selector?(:xpath, path, options, &optional_filter_block)
       end
 
@@ -215,7 +213,7 @@ module Capybara
       # @param (see Capybara::Node::Finders#has_xpath?)
       # @return [Boolean]
       #
-      def has_no_xpath?(path, options={}, &optional_filter_block)
+      def has_no_xpath?(path, **options, &optional_filter_block)
         has_no_selector?(:xpath, path, options, &optional_filter_block)
       end
 
@@ -242,7 +240,7 @@ module Capybara
       # @option options [Integer] :count (nil)    Number of times the selector should occur
       # @return [Boolean]                         If the selector exists
       #
-      def has_css?(path, options={}, &optional_filter_block)
+      def has_css?(path, **options, &optional_filter_block)
         has_selector?(:css, path, options, &optional_filter_block)
       end
 
@@ -254,7 +252,7 @@ module Capybara
       # @param (see Capybara::Node::Finders#has_css?)
       # @return [Boolean]
       #
-      def has_no_css?(path, options={}, &optional_filter_block)
+      def has_no_css?(path, **options, &optional_filter_block)
         has_no_selector?(:css, path, options, &optional_filter_block)
       end
 
@@ -268,8 +266,7 @@ module Capybara
       # @option options [String, Regexp] :href    The value the href attribute must be
       # @return [Boolean]                 Whether it exists
       #
-      def has_link?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_link?(locator = nil, **options, &optional_filter_block)
         has_selector?(:link, locator, options, &optional_filter_block)
       end
 
@@ -281,8 +278,7 @@ module Capybara
       # @param (see Capybara::Node::Finders#has_link?)
       # @return [Boolean]            Whether it doesn't exist
       #
-      def has_no_link?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_no_link?(locator = nil, **options, &optional_filter_block)
         has_no_selector?(:link, locator, options, &optional_filter_block)
       end
 
@@ -294,8 +290,7 @@ module Capybara
       # @param [String] locator      The text, value or id of a button to check for
       # @return [Boolean]            Whether it exists
       #
-      def has_button?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_button?(locator = nil, **options, &optional_filter_block)
         has_selector?(:button, locator, options, &optional_filter_block)
       end
 
@@ -307,8 +302,7 @@ module Capybara
       # @param [String] locator      The text, value or id of a button to check for
       # @return [Boolean]            Whether it doesn't exist
       #
-      def has_no_button?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_no_button?(locator = nil, **options, &optional_filter_block)
         has_no_selector?(:button, locator, options, &optional_filter_block)
       end
 
@@ -334,8 +328,7 @@ module Capybara
       # @option options [String] :type           The type attribute of the field
       # @return [Boolean]                        Whether it exists
       #
-      def has_field?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_field?(locator = nil, **options, &optional_filter_block)
         has_selector?(:field, locator, options, &optional_filter_block)
       end
 
@@ -349,8 +342,7 @@ module Capybara
       # @option options [String] :type           The type attribute of the field
       # @return [Boolean]                        Whether it doesn't exist
       #
-      def has_no_field?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_no_field?(locator = nil, **options, &optional_filter_block)
         has_no_selector?(:field, locator, options, &optional_filter_block)
       end
 
@@ -363,8 +355,7 @@ module Capybara
       # @param [String] locator           The label, name or id of a checked field
       # @return [Boolean]                 Whether it exists
       #
-      def has_checked_field?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_checked_field?(locator = nil, **options, &optional_filter_block)
         has_selector?(:field, locator, options.merge(checked: true), &optional_filter_block)
       end
 
@@ -377,8 +368,7 @@ module Capybara
       # @param [String] locator           The label, name or id of a checked field
       # @return [Boolean]                 Whether it doesn't exist
       #
-      def has_no_checked_field?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_no_checked_field?(locator = nil, **options, &optional_filter_block)
         has_no_selector?(:field, locator, options.merge(checked: true), &optional_filter_block)
       end
 
@@ -391,8 +381,7 @@ module Capybara
       # @param [String] locator           The label, name or id of an unchecked field
       # @return [Boolean]                 Whether it exists
       #
-      def has_unchecked_field?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_unchecked_field?(locator = nil, **options, &optional_filter_block)
         has_selector?(:field, locator, options.merge(unchecked: true), &optional_filter_block)
       end
 
@@ -405,8 +394,7 @@ module Capybara
       # @param [String] locator           The label, name or id of an unchecked field
       # @return [Boolean]                 Whether it doesn't exist
       #
-      def has_no_unchecked_field?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_no_unchecked_field?(locator = nil, **options, &optional_filter_block)
         has_no_selector?(:field, locator, options.merge(unchecked: true), &optional_filter_block)
       end
 
@@ -439,8 +427,7 @@ module Capybara
       # @option options [String, Array] :with_selected  Partial set of options which should minimally be selected
       # @return [Boolean]                               Whether it exists
       #
-      def has_select?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_select?(locator = nil, **options, &optional_filter_block)
         has_selector?(:select, locator, options, &optional_filter_block)
       end
 
@@ -452,8 +439,7 @@ module Capybara
       # @param (see Capybara::Node::Matchers#has_select?)
       # @return [Boolean]     Whether it doesn't exist
       #
-      def has_no_select?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_no_select?(locator = nil, **options, &optional_filter_block)
         has_no_selector?(:select, locator, options, &optional_filter_block)
       end
 
@@ -467,8 +453,7 @@ module Capybara
       # @param [String] locator                        The id or caption of a table
       # @return [Boolean]                              Whether it exist
       #
-      def has_table?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_table?(locator = nil, **options, &optional_filter_block)
         has_selector?(:table, locator, options, &optional_filter_block)
       end
 
@@ -480,8 +465,7 @@ module Capybara
       # @param (see Capybara::Node::Matchers#has_table?)
       # @return [Boolean]       Whether it doesn't exist
       #
-      def has_no_table?(locator=nil, options={}, &optional_filter_block)
-        locator, options = nil, locator if locator.is_a? Hash
+      def has_no_table?(locator = nil, **options, &optional_filter_block)
         has_no_selector?(:table, locator, options, &optional_filter_block)
       end
 
@@ -534,7 +518,7 @@ module Capybara
       # @param [String, XPath::Expression] xpath The XPath expression to match against the current code
       # @return [Boolean]
       #
-      def matches_xpath?(xpath, options={}, &optional_filter_block)
+      def matches_xpath?(xpath, **options, &optional_filter_block)
         matches_selector?(:xpath, xpath, options, &optional_filter_block)
       end
 
@@ -545,7 +529,7 @@ module Capybara
       # @param [String] css The CSS selector to match against the current code
       # @return [Boolean]
       #
-      def matches_css?(css, options={}, &optional_filter_block)
+      def matches_css?(css, **options, &optional_filter_block)
         matches_selector?(:css, css, options, &optional_filter_block)
       end
 
@@ -570,7 +554,7 @@ module Capybara
       # @param [String, XPath::Expression] xpath The XPath expression to match against the current code
       # @return [Boolean]
       #
-      def not_matches_xpath?(xpath, options={}, &optional_filter_block)
+      def not_matches_xpath?(xpath, **options, &optional_filter_block)
         not_matches_selector?(:xpath, xpath, options, &optional_filter_block)
       end
 
@@ -581,11 +565,10 @@ module Capybara
       # @param [String] css The CSS selector to match against the current code
       # @return [Boolean]
       #
-      def not_matches_css?(css, options={}, &optional_filter_block)
+      def not_matches_css?(css, **options, &optional_filter_block)
         not_matches_selector?(:css, css, options, &optional_filter_block)
       end
 
-
       ##
       # Asserts that the page or current node has the given text content,
       # ignoring any HTML tags.
@@ -656,7 +639,7 @@ module Capybara
       def has_text?(*args)
         assert_text(*args)
       rescue Capybara::ExpectationNotMet
-        return false
+        false
       end
       alias_method :has_content?, :has_text?
 
@@ -670,53 +653,49 @@ module Capybara
       def has_no_text?(*args)
         assert_no_text(*args)
       rescue Capybara::ExpectationNotMet
-        return false
+        false
       end
       alias_method :has_no_content?, :has_no_text?
 
       def ==(other)
-        self.eql?(other) || (other.respond_to?(:base) && base == other.base)
+        eql?(other) || (other.respond_to?(:base) && base == other.base)
       end
 
     private
 
-      def _verify_selector_result(query_args, optional_filter_block, &result_block)
-        _set_query_session_options(query_args)
+      def _verify_selector_result(query_args, optional_filter_block)
+        query_args = _set_query_session_options(*query_args)
         query = Capybara::Queries::SelectorQuery.new(*query_args, &optional_filter_block)
         synchronize(query.wait) do
           result = query.resolve_for(self)
-          result_block.call(result, query)
+          yield result, query
         end
-        return true
+        true
       end
 
-      def _verify_match_result(query_args, optional_filter_block, &result_block)
-        _set_query_session_options(query_args)
+      def _verify_match_result(query_args, optional_filter_block)
+        query_args = _set_query_session_options(*query_args)
         query = Capybara::Queries::MatchQuery.new(*query_args, &optional_filter_block)
         synchronize(query.wait) do
-          result = query.resolve_for(self.query_scope)
-          result_block.call(result)
+          result = query.resolve_for(query_scope)
+          yield result
         end
-        return true
+        true
       end
 
       def _verify_text(query_args)
-        _set_query_session_options(query_args)
+        query_args = _set_query_session_options(*query_args)
         query = Capybara::Queries::TextQuery.new(*query_args)
         synchronize(query.wait) do
           count = query.resolve_for(self)
           yield(count, query)
         end
-        return true
+        true
       end
 
-      def _set_query_session_options(query_args)
-        if query_args.last.is_a? Hash
-          query_args.last[:session_options] = session_options
-        else
-          query_args.push(session_options: session_options)
-        end
-        query_args
+      def _set_query_session_options(*query_args, **query_options)
+        query_options[:session_options] = session_options
+        query_args.push(query_options)
       end
     end
   end

data/lib/capybara/node/simple.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Capybara
   module Node
-
     ##
     #
     # A {Capybara::Node::Simple} is a simpler version of {Capybara::Node::Base} which
@@ -28,7 +28,7 @@ module Capybara
       #
       # @return [String]    The text of the element
       #
-      def text(type=nil)
+      def text(_type = nil)
         native.text
       end
 
@@ -45,7 +45,7 @@ module Capybara
         attr_name = name.to_s
         if attr_name == 'value'
           value
-        elsif 'input' == tag_name and 'checkbox' == native[:type] and 'checked' == attr_name
+        elsif tag_name == 'input' and native[:type] == 'checkbox' and attr_name == 'checked'
           native['checked'] == 'checked'
         else
           native[attr_name]
@@ -79,12 +79,12 @@ module Capybara
           native['_capybara_raw_value']
         elsif tag_name == 'select'
           if native['multiple'] == 'multiple'
-            native.xpath(".//option[@selected='selected']").map { |option| option[:value] || option.content  }
+            native.xpath(".//option[@selected='selected']").map { |option| option[:value] || option.content }
           else
             option = native.xpath(".//option[@selected='selected']").first || native.xpath(".//option").first
             option[:value] || option.content if option
           end
-        elsif tag_name == 'input' && %w(radio checkbox).include?(native[:type])
+        elsif tag_name == 'input' && %w[radio checkbox].include?(native[:type])
           native[:value] || 'on'
         else
           native[:value]
@@ -100,14 +100,13 @@ module Capybara
       # @return [Boolean]     Whether the element is visible
       #
       def visible?(check_ancestors = true)
-        return false if (tag_name == 'input') && (native[:type]=="hidden")
+        return false if (tag_name == 'input') && (native[:type] == "hidden")
 
         if check_ancestors
-          #check size because oldest supported nokogiri doesnt support xpath boolean() function
-          native.xpath("./ancestor-or-self::*[contains(@style, 'display:none') or contains(@style, 'display: none') or @hidden or name()='script' or name()='head']").size() == 0
+          !native.xpath("boolean(./ancestor-or-self::*[contains(@style, 'display:none') or contains(@style, 'display: none') or @hidden or name()='script' or name()='head'])")
         else
-          #no need for an xpath if only checking the current element
-          !(native.has_attribute?('hidden') || (native[:style] =~ /display:\s?none/) || %w(script head).include?(tag_name))
+          # No need for an xpath if only checking the current element
+          !(native.has_attribute?('hidden') || (native[:style] =~ /display:\s?none/) || %w[script head].include?(tag_name))
         end
       end
 
@@ -140,7 +139,7 @@ module Capybara
         native.has_attribute?('selected')
       end
 
-      def synchronize(seconds=nil)
+      def synchronize(_seconds = nil)
         yield # simple nodes don't need to wait
       end
 
@@ -152,12 +151,7 @@ module Capybara
       #
       # @return [String]     The title of the document
       def title
-        if native.respond_to? :title
-          native.title
-        else
-          #old versions of nokogiri don't have #title - remove in 3.0
-          native.xpath('/html/head/title | /html/title').first.text
-        end
+        native.title
       end
 
       def inspect

data/lib/capybara/queries/ancestor_query.rb

@@ -1,25 +1,29 @@
 # frozen_string_literal: true
+
 module Capybara
   module Queries
-    class AncestorQuery < MatchQuery
+    class AncestorQuery < Capybara::Queries::SelectorQuery
       # @api private
       def resolve_for(node, exact = nil)
         @child_node = node
         node.synchronize do
           match_results = super(node.session.current_scope, exact)
-          node.all(:xpath, XPath.ancestor) do |el|
-            match_results.include?(el)
-          end
+          node.all(:xpath, XPath.ancestor) { |el| match_results.include?(el) }
         end
       end
 
       def description
+        child_query = @child_node && @child_node.instance_variable_get(:@query)
         desc = super
-        if @child_node && (child_query = @child_node.instance_variable_get(:@query))
-          desc += " that is an ancestor of #{child_query.description}"
-        end
+        desc += " that is an ancestor of #{child_query.description}" if child_query
         desc
       end
+
+    private
+
+      def valid_keys
+        super - COUNT_KEYS
+      end
     end
   end
 end

data/lib/capybara/queries/base_query.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module Capybara
   # @api private
   module Queries
     class BaseQuery
-      COUNT_KEYS = [:count, :minimum, :maximum, :between]
+      COUNT_KEYS = %i[count minimum maximum between].freeze
 
       attr_reader :options
       attr_writer :session_options
@@ -20,8 +21,11 @@ module Capybara
         self.class.wait(options, session_options.default_max_wait_time)
       end
 
-      def self.wait(options, default=Capybara.default_max_wait_time)
-        options.fetch(:wait, default) || 0
+      def self.wait(options, default = Capybara.default_max_wait_time)
+        # if no value or nil for the :wait option is passed it should default to the default
+        w = options.fetch(:wait, nil)
+        w = default if w.nil?
+        w || 0
       end
 
       ##
@@ -30,11 +34,7 @@ module Capybara
       # Returns false if query does not have any count options specified.
       #
       def expects_none?
-        if COUNT_KEYS.any? { |k| options.has_key? k }
-          matches_count?(0)
-        else
-          false
-        end
+        count_specified? ? matches_count?(0) : false
       end
 
       ##
@@ -47,11 +47,11 @@ module Capybara
       # @param [Integer] count     The actual number. Should be coercible via Integer()
       #
       def matches_count?(count)
-        return (Integer(options[:count]) == count)     if options[:count]
+        return (Integer(options[:count]) == count) if options[:count]
         return false if options[:maximum] && (Integer(options[:maximum]) < count)
         return false if options[:minimum] && (Integer(options[:minimum]) > count)
-        return false if options[:between] && !(options[:between] === count)
-        return true
+        return false if options[:between] && !options[:between].include?(count)
+        true
       end
 
       ##
@@ -66,10 +66,14 @@ module Capybara
         String.new("expected not to find #{description}") << count_message
       end
 
-      private
+    private
+
+      def count_specified?
+        COUNT_KEYS.any? { |k| options.key? k }
+      end
 
       def count_message
-        message = String.new()
+        message = "".dup
         if options[:count]
           message << " #{options[:count]} #{Capybara::Helpers.declension('time', 'times', options[:count])}"
         elsif options[:between]
@@ -84,11 +88,11 @@ module Capybara
 
       def assert_valid_keys
         invalid_keys = @options.keys - valid_keys
-        unless invalid_keys.empty?
-          invalid_names = invalid_keys.map(&:inspect).join(", ")
-          valid_names = valid_keys.map(&:inspect).join(", ")
-          raise ArgumentError, "invalid keys #{invalid_names}, should be one of #{valid_names}"
-        end
+        return if invalid_keys.empty?
+
+        invalid_names = invalid_keys.map(&:inspect).join(", ")
+        valid_names = valid_keys.map(&:inspect).join(", ")
+        raise ArgumentError, "invalid keys #{invalid_names}, should be one of #{valid_names}"
       end
     end
   end

data/lib/capybara/queries/current_path_query.rb

@@ -1,34 +1,25 @@
 # frozen_string_literal: true
+
 require 'addressable/uri'
 
 module Capybara
   # @api private
   module Queries
     class CurrentPathQuery < BaseQuery
-      def initialize(expected_path, options = {})
+      def initialize(expected_path, **options)
         super(options)
         @expected_path = expected_path
-        warn "DEPRECATED: The :only_path option is deprecated in favor of the :ignore_query option" if options.has_key?(:only_path)
-
         @options = {
           url: !@expected_path.is_a?(Regexp) && !::Addressable::URI.parse(@expected_path || "").hostname.nil?,
-          only_path: false,
-          ignore_query: false }.merge(options)
+          ignore_query: false
+        }.merge(options)
         assert_valid_keys
       end
 
       def resolves_for?(session)
         uri = ::Addressable::URI.parse(session.current_url)
         uri.query = nil if uri && options[:ignore_query]
-        @actual_path = if options[:url]
-          uri.to_s
-        else
-          if options[:only_path]
-            uri && uri.path
-          else
-            uri && uri.request_uri
-          end
-        end
+        @actual_path = options[:url] ? uri.to_s : uri && uri.request_uri
 
         if @expected_path.is_a? Regexp
           @actual_path.to_s.match(@expected_path)
@@ -45,22 +36,15 @@ module Capybara
         failure_message_helper(' not')
       end
 
-      private
+    private
 
       def failure_message_helper(negated = '')
-        verb = (@expected_path.is_a?(Regexp))? 'match' : 'equal'
+        verb = @expected_path.is_a?(Regexp) ? 'match' : 'equal'
         "expected #{@actual_path.inspect}#{negated} to #{verb} #{@expected_path.inspect}"
       end
 
       def valid_keys
-        [:wait, :url, :only_path, :ignore_query]
-      end
-
-      def assert_valid_keys
-        super
-        if options[:url] && options[:only_path]
-          raise ArgumentError, "the :url and :only_path options cannot both be true"
-        end
+        %i[wait url ignore_query]
       end
     end
   end

data/lib/capybara/queries/match_query.rb

@@ -2,18 +2,14 @@ module Capybara
   module Queries
     class MatchQuery < Capybara::Queries::SelectorQuery
       def visible
-        if options.has_key?(:visible)
-          super
-        else
-          :all
-        end
+        options.key?(:visible) ? super : :all
       end
 
-      private
+    private
 
       def valid_keys
         super - COUNT_KEYS
       end
     end
   end
-end
+end