capybara 2.18.0 → 3.0.0

data/lib/capybara/queries/selector_query.rb

@@ -1,36 +1,24 @@
 # frozen_string_literal: true
+
 module Capybara
   module Queries
     class SelectorQuery < Queries::BaseQuery
       attr_accessor :selector, :locator, :options, :expression, :find, :negative
 
-      VALID_KEYS = COUNT_KEYS + [:text, :id, :class, :visible, :exact, :exact_text, :match, :wait, :filter_set]
-      VALID_MATCH = [:first, :smart, :prefer_exact, :one]
+      VALID_KEYS = COUNT_KEYS + %i[text id class visible exact exact_text match wait filter_set]
+      VALID_MATCH = %i[first smart prefer_exact one].freeze
 
-      def initialize(*args, &filter_block)
+      def initialize(*args, session_options:, **options, &filter_block)
         @resolved_node = nil
-        @options = if args.last.is_a?(Hash) then args.pop.dup else {} end
+        @options = options.dup
         super(@options)
+        self.session_options = session_options
 
+        @selector = find_selector(args[0].is_a?(Symbol) ? args.shift : args[0])
+        @locator = args.shift
         @filter_block = filter_block
 
-        if args[0].is_a?(Symbol)
-          @selector = Selector.all.fetch(args.shift) do |selector_type|
-            raise ArgumentError, "Unknown selector type (:#{selector_type})"
-          end
-          @locator = args.shift
-        else
-          @selector = Selector.all.values.find { |s| s.match?(args[0]) }
-          @locator = args.shift
-        end
-        @selector ||= Selector.all[session_options.default_selector]
-
-        warn "Unused parameters passed to #{self.class.name} : #{args}" unless args.empty?
-
-        # for compatibility with Capybara 2.0
-        if session_options.exact_options and @selector == Selector.all[:option]
-          @options[:exact] = true
-        end
+        raise ArgumentError, "Unused parameters passed to #{self.class.name} : #{args}" unless args.empty?
 
         @expression = @selector.call(@locator, @options.merge(enable_aria_label: session_options.enable_aria_label))
 
@@ -40,10 +28,10 @@ module Capybara
       end
 
       def name; selector.name; end
-      def label; selector.label or selector.name; end
+      def label; selector.label || selector.name; end
 
       def description
-        @description = String.new()
+        @description = "".dup
         @description << "visible " if visible == :visible
         @description << "non-visible " if visible == :hidden
         @description << "#{label} #{locator.inspect}"
@@ -58,80 +46,39 @@ module Capybara
       end
 
       def matches_filters?(node)
-        if options[:text]
-          regexp = if options[:text].is_a?(Regexp)
-            options[:text]
-          else
-            if exact_text == true
-              /\A#{Regexp.escape(options[:text].to_s)}\z/
-            else
-              Regexp.escape(options[:text].to_s)
-            end
-          end
-          text_visible = visible
-          text_visible = :all if text_visible == :hidden
-          return false if not node.text(text_visible).match(regexp)
-        end
-
-        if exact_text.is_a?(String)
-          regexp = /\A#{Regexp.escape(options[:exact_text])}\z/
-          text_visible = visible
-          text_visible = :all if text_visible == :hidden
-          return false if not node.text(text_visible).match(regexp)
-        end
+        return false if options[:text] && !matches_text_filter(node, options[:text])
+        return false if exact_text.is_a?(String) && !matches_exact_text_filter(node, exact_text)
 
         case visible
-          when :visible then return false unless node.visible?
-          when :hidden then return false if node.visible?
+        when :visible then return false unless node.visible?
+        when :hidden then return false if node.visible?
         end
 
-        res = node_filters.all? do |name, filter|
-          if options.has_key?(name)
-            filter.matches?(node, options[name])
-          elsif filter.default?
-            filter.matches?(node, filter.default)
-          else
-            true
-          end
-        end
-
-        res &&= if node.respond_to?(:session)
-          node.session.using_wait_time(0){ @filter_block.call(node) }
-        else
-          @filter_block.call(node)
-        end unless @filter_block.nil?
-
-        res
-
+        matches_node_filters?(node) && matches_filter_block?(node)
       rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])
         return false
       end
 
       def visible
-        case (vis = options.fetch(:visible){ @selector.default_visibility(session_options.ignore_hidden_elements) })
-          when true then :visible
-          when false then :all
-          else vis
+        case (vis = options.fetch(:visible) { @selector.default_visibility(session_options.ignore_hidden_elements) })
+        when true then :visible
+        when false then :all
+        else vis
         end
       end
 
       def exact?
-        return false if !supports_exact?
-        options.fetch(:exact, session_options.exact)
+        supports_exact? ? options.fetch(:exact, session_options.exact) : false
       end
 
       def match
         options.fetch(:match, session_options.match)
       end
 
-      def xpath(exact=nil)
-        exact = self.exact? if exact.nil?
+      def xpath(exact = nil)
+        exact = exact? if exact.nil?
         expr = apply_expression_filters(@expression)
-        expr = if expr.respond_to?(:to_xpath) and exact
-          expr.to_xpath(:exact)
-        else
-          expr.to_s
-        end
+        expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)
         filtered_xpath(expr)
       end
 
@@ -144,9 +91,9 @@ module Capybara
         @resolved_node = node
         node.synchronize do
           children = if selector.format == :css
-            node.find_css(self.css)
+            node.find_css(css)
           else
-            node.find_xpath(self.xpath(exact))
+            node.find_xpath(xpath(exact))
           end.map do |child|
             if node.is_a?(Capybara::Node::Base)
               Capybara::Node::Element.new(node.session, child, node, self)
@@ -163,14 +110,45 @@ module Capybara
         @expression.respond_to? :to_xpath
       end
 
-      private
+    private
+
+      def find_selector(locator)
+        selector = if locator.is_a?(Symbol)
+          Selector.all.fetch(locator) { |sel_type| raise ArgumentError, "Unknown selector type (:#{sel_type})" }
+        else
+          Selector.all.values.find { |s| s.match?(locator) }
+        end
+        selector || Selector.all[session_options.default_selector]
+      end
 
       def valid_keys
         VALID_KEYS + custom_keys
       end
 
+      def matches_node_filters?(node)
+        node_filters.all? do |name, filter|
+          if options.key?(name)
+            filter.matches?(node, options[name])
+          elsif filter.default?
+            filter.matches?(node, filter.default)
+          else
+            true
+          end
+        end
+      end
+
+      def matches_filter_block?(node)
+        return true unless @filter_block
+
+        if node.respond_to?(:session)
+          node.session.using_wait_time(0) { @filter_block.call(node) }
+        else
+          @filter_block.call(node)
+        end
+      end
+
       def node_filters
-        if options.has_key?(:filter_set)
+        if options.key?(:filter_set)
           ::Capybara::Selector::FilterSet.all[options[:filter_set]].node_filters
         else
           @selector.node_filters
@@ -179,7 +157,7 @@ module Capybara
 
       def expression_filters
         filters = @selector.expression_filters
-        filters.merge ::Capybara::Selector::FilterSet.all[options[:filter_set]].expression_filters if options.has_key?(:filter_set)
+        filters.merge ::Capybara::Selector::FilterSet.all[options[:filter_set]].expression_filters if options.key?(:filter_set)
         filters
       end
 
@@ -195,13 +173,13 @@ module Capybara
       end
 
       def filtered_xpath(expr)
-        if options.has_key?(:id) || options.has_key?(:class)
+        if options.key?(:id) || options.key?(:class)
           expr = "(#{expr})"
-          expr = "#{expr}[#{XPath.attr(:id) == options[:id]}]" if options.has_key?(:id) && !custom_keys.include?(:id)
-          if options.has_key?(:class) && !custom_keys.include?(:class)
+          expr = "#{expr}[#{XPath.attr(:id) == options[:id]}]" if options.key?(:id) && !custom_keys.include?(:id)
+          if options.key?(:class) && !custom_keys.include?(:class)
             class_xpath = Array(options[:class]).map do |klass|
-              "contains(concat(' ',normalize-space(@class),' '),' #{klass} ')"
-            end.join(" and ")
+              XPath.attr(:class).contains_word(klass)
+            end.reduce(:&)
             expr = "#{expr}[#{class_xpath}]"
           end
         end
@@ -209,12 +187,12 @@ module Capybara
       end
 
       def filtered_css(expr)
-        if options.has_key?(:id) || options.has_key?(:class)
+        if options.key?(:id) || options.key?(:class)
           css_selectors = expr.split(',').map(&:rstrip)
           expr = css_selectors.map do |sel|
-           sel += "##{Capybara::Selector::CSS.escape(options[:id])}" if options.has_key?(:id) && !custom_keys.include?(:id)
-           sel += Array(options[:class]).map { |k| ".#{Capybara::Selector::CSS.escape(k)}"}.join if options.has_key?(:class) && !custom_keys.include?(:class)
-           sel
+            sel += "##{Capybara::Selector::CSS.escape(options[:id])}" if options.key?(:id) && !custom_keys.include?(:id)
+            sel += Array(options[:class]).map { |k| ".#{Capybara::Selector::CSS.escape(k)}" }.join if options.key?(:class) && !custom_keys.include?(:class)
+            sel
           end.join(", ")
         end
         expr
@@ -222,7 +200,7 @@ module Capybara
 
       def apply_expression_filters(expr)
         expression_filters.inject(expr) do |memo, (name, ef)|
-          if options.has_key?(name)
+          if options.key?(name)
             ef.apply_filter(memo, options[name])
           elsif ef.default?
             ef.apply_filter(memo, ef.default)
@@ -233,9 +211,8 @@ module Capybara
       end
 
       def warn_exact_usage
-        if options.has_key?(:exact) && !supports_exact?
-          warn "The :exact option only has an effect on queries using the XPath#is method. Using it with the query \"#{expression}\" has no effect."
-        end
+        return unless options.key?(:exact) && !supports_exact?
+        warn "The :exact option only has an effect on queries using the XPath#is method. Using it with the query \"#{expression}\" has no effect."
       end
 
       def exact_text
@@ -246,6 +223,26 @@ module Capybara
         @resolved_node && !(@resolved_node.is_a?(::Capybara::Node::Document) ||
                             (@resolved_node.is_a?(::Capybara::Node::Simple) && @resolved_node.path == '/'))
       end
+
+      def matches_text_filter(node, text_option)
+        regexp = if text_option.is_a?(Regexp)
+          text_option
+        elsif exact_text == true
+          /\A#{Regexp.escape(text_option.to_s)}\z/
+        else
+          Regexp.escape(text_option.to_s)
+        end
+        text_visible = visible
+        text_visible = :all if text_visible == :hidden
+        node.text(text_visible).match(regexp)
+      end
+
+      def matches_exact_text_filter(node, exact_text_option)
+        regexp = /\A#{Regexp.escape(exact_text_option)}\z/
+        text_visible = visible
+        text_visible = :all if text_visible == :hidden
+        node.text(text_visible).match(regexp)
+      end
     end
   end
 end

data/lib/capybara/queries/sibling_query.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Capybara
   module Queries
     class SiblingQuery < MatchQuery
@@ -7,7 +8,7 @@ module Capybara
         @sibling_node = node
         node.synchronize do
           match_results = super(node.session.current_scope, exact)
-          node.all(:xpath, XPath.preceding_sibling.union(XPath.following_sibling)) do |el|
+          node.all(:xpath, XPath.preceding_sibling + XPath.following_sibling) do |el|
             match_results.include?(el)
           end
         end
@@ -15,9 +16,8 @@ module Capybara
 
       def description
         desc = super
-        if @sibling_node && (sibling_query = @sibling_node.instance_variable_get(:@query))
-          desc += " that is a sibling of #{sibling_query.description}"
-        end
+        sibling_query = @sibling_node && @sibling_node.instance_variable_get(:@query)
+        desc += " that is a sibling of #{sibling_query.description}" if sibling_query
         desc
       end
     end

data/lib/capybara/queries/text_query.rb

@@ -1,22 +1,23 @@
 # frozen_string_literal: true
+
 module Capybara
   # @api private
   module Queries
     class TextQuery < BaseQuery
-      def initialize(*args)
-        @type = (args.first.is_a?(Symbol) || args.first.nil?) ? args.shift : nil
-        # @type = (Capybara.ignore_hidden_elements or Capybara.visible_text_only) ? :visible : :all if @type.nil?
-        @options = if args.last.is_a?(Hash) then args.pop.dup else {} end
+      def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments
+        @type = if type.nil?
+          Capybara.ignore_hidden_elements || Capybara.visible_text_only ? :visible : :all
+        else
+          type
+        end
+
+        @expected_text = expected_text.is_a?(Regexp) ? expected_text : expected_text.to_s
+        @options = options
         super(@options)
+        self.session_options = session_options
 
-        @type = (session_options.ignore_hidden_elements or session_options.visible_text_only) ? :visible : :all if @type.nil?
+        @search_regexp = Capybara::Helpers.to_regexp(@expected_text, exact: exact?)
 
-        @expected_text = args.shift
-        unless @expected_text.is_a?(Regexp)
-          @expected_text = Capybara::Helpers.normalize_whitespace(@expected_text)
-        end
-        @search_regexp = Capybara::Helpers.to_regexp(@expected_text, nil, exact?)
-        warn "Unused parameters passed to #{self.class.name} : #{args}" unless args.empty?
         assert_valid_keys
       end
 
@@ -42,48 +43,47 @@ module Capybara
         end
       end
 
-      private
+    private
 
       def exact?
         options.fetch(:exact, session_options.exact_text)
       end
 
       def build_message(report_on_invisible)
-        message = String.new()
+        message = "".dup
         unless (COUNT_KEYS & @options.keys).empty?
           message << " but found #{@count} #{Capybara::Helpers.declension('time', 'times', @count)}"
         end
         message << " in #{@actual_text.inspect}"
 
         details_message = []
+        details_message << case_insensitive_message if @node and !@expected_text.is_a? Regexp
+        details_message << invisible_message if @node and check_visible_text? and report_on_invisible
+        details_message.compact!
 
-        if @node and !@expected_text.is_a? Regexp
-          insensitive_regexp = Capybara::Helpers.to_regexp(@expected_text, Regexp::IGNORECASE)
-          insensitive_count = @actual_text.scan(insensitive_regexp).size
-          if insensitive_count != @count
-            details_message << "it was found #{insensitive_count} #{Capybara::Helpers.declension("time", "times", insensitive_count)} using a case insensitive search"
-          end
-        end
+        message << ". (However, #{details_message.join(' and ')}.)" unless details_message.empty?
+        message
+      end
 
-        if @node and check_visible_text? and report_on_invisible
-          begin
-            invisible_text = text(@node, :all)
-            invisible_count = invisible_text.scan(@search_regexp).size
-            if invisible_count != @count
-              details_message << "it was found #{invisible_count} #{Capybara::Helpers.declension("time", "times", invisible_count)} including non-visible text"
-            end
-          rescue
-            # An error getting the non-visible text (if element goes out of scope) should not affect the response
-          end
+      def case_insensitive_message
+        insensitive_regexp = Capybara::Helpers.to_regexp(@expected_text, options: Regexp::IGNORECASE)
+        insensitive_count = @actual_text.scan(insensitive_regexp).size
+        if insensitive_count != @count
+          "it was found #{insensitive_count} #{Capybara::Helpers.declension("time", "times", insensitive_count)} using a case insensitive search"
         end
+      end
 
-        message << ". (However, #{details_message.join(' and ')}.)" unless details_message.empty?
-
-        message
+      def invisible_message
+        invisible_text = text(@node, :all)
+        invisible_count = invisible_text.scan(@search_regexp).size
+        if invisible_count != @count
+          "it was found #{invisible_count} #{Capybara::Helpers.declension("time", "times", invisible_count)} including non-visible text"
+        end
+      rescue # An error getting the non-visible text (if element goes out of scope) should not affect the response
       end
 
       def valid_keys
-        COUNT_KEYS + [:wait, :exact]
+        COUNT_KEYS + %i[wait exact]
       end
 
       def check_visible_text?
@@ -91,7 +91,7 @@ module Capybara
       end
 
       def text(node, query_type)
-        Capybara::Helpers.normalize_whitespace(node.text(query_type))
+        node.text(query_type)
       end
     end
   end

data/lib/capybara/queries/title_query.rb

@@ -1,22 +1,19 @@
 # frozen_string_literal: true
+
 module Capybara
   # @api private
   module Queries
     class TitleQuery < BaseQuery
-      def initialize(expected_title, options = {})
-        @expected_title = expected_title
+      def initialize(expected_title, **options)
+        @expected_title = expected_title.is_a?(Regexp) ? expected_title : expected_title.to_s
         @options = options
         super(@options)
-        unless @expected_title.is_a?(Regexp)
-          @expected_title = Capybara::Helpers.normalize_whitespace(@expected_title)
-        end
-        @search_regexp = Capybara::Helpers.to_regexp(@expected_title, nil, options.fetch(:exact, false))
+        @search_regexp = Capybara::Helpers.to_regexp(@expected_title, all_whitespace: true, exact: options.fetch(:exact, false))
         assert_valid_keys
       end
 
       def resolves_for?(node)
-        @actual_title = node.title
-        @actual_title.match(@search_regexp)
+        (@actual_title = node.title).match(@search_regexp)
       end
 
       def failure_message
@@ -27,15 +24,15 @@ module Capybara
         failure_message_helper(' not')
       end
 
-      private
+    private
 
       def failure_message_helper(negated = '')
-        verb = (@expected_title.is_a?(Regexp))? 'match' : 'include'
+        verb = @expected_title.is_a?(Regexp) ? 'match' : 'include'
         "expected #{@actual_title.inspect}#{negated} to #{verb} #{@expected_title.inspect}"
       end
 
       def valid_keys
-        [:wait, :exact]
+        %i[wait exact]
       end
     end
   end

data/lib/capybara/rack_test/browser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Capybara::RackTest::Browser
   include ::Rack::Test::Methods
 
@@ -17,7 +18,7 @@ class Capybara::RackTest::Browser
     driver.options
   end
 
-  def visit(path, attributes = {})
+  def visit(path, **attributes)
     reset_host!
     process_and_follow_redirects(:get, path, attributes)
   end
@@ -28,23 +29,24 @@ class Capybara::RackTest::Browser
   end
 
   def submit(method, path, attributes)
-    path = request_path if not path or path.empty?
-    process_and_follow_redirects(method, path, attributes, {'HTTP_REFERER' => current_url})
+    path = request_path if path.nil? || path.empty?
+    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => current_url)
   end
 
-  def follow(method, path, attributes = {})
+  def follow(method, path, **attributes)
     return if path.gsub(/^#{Regexp.escape(request_path)}/, '').start_with?('#') || path.downcase.start_with?('javascript:')
-    process_and_follow_redirects(method, path, attributes, {'HTTP_REFERER' => current_url})
+    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => current_url)
   end
 
   def process_and_follow_redirects(method, path, attributes = {}, env = {})
     process(method, path, attributes, env)
-    if driver.follow_redirects?
-      driver.redirect_limit.times do
-        process(:get, last_response["Location"], {}, env) if last_response.redirect?
-      end
-      raise Capybara::InfiniteRedirectError, "redirected more than #{driver.redirect_limit} times, check for infinite redirects." if last_response.redirect?
+
+    return unless driver.follow_redirects?
+
+    driver.redirect_limit.times do
+      process(:get, last_response["Location"], {}, env) if last_response.redirect?
     end
+    raise Capybara::InfiniteRedirectError, "redirected more than #{driver.redirect_limit} times, check for infinite redirects." if last_response.redirect?
   end
 
   def process(method, path, attributes = {}, env = {})
@@ -55,7 +57,7 @@ class Capybara::RackTest::Browser
     else
       new_uri.path = request_path if path.start_with?("?")
       new_uri.path = "/" if new_uri.path.empty?
-      new_uri.path = request_path.sub(%r(/[^/]*$), '/') + new_uri.path unless new_uri.path.start_with?('/')
+      new_uri.path = request_path.sub(%r{/[^/]*$}, '/') + new_uri.path unless new_uri.path.start_with?('/')
     end
     new_uri.scheme ||= @current_scheme
     new_uri.host ||= @current_host
@@ -91,7 +93,7 @@ class Capybara::RackTest::Browser
   end
 
   def find(format, selector)
-    if format==:css
+    if format == :css
       dom.css(selector, Capybara::RackTest::CSSHandlers.new)
     else
       dom.xpath(selector)
@@ -105,12 +107,7 @@ class Capybara::RackTest::Browser
   end
 
   def title
-    if dom.respond_to? :title
-      dom.title
-    else
-      #old versions of nokogiri don't have #title - remove in 3.0
-      dom.xpath('/html/head/title | /html/title').first.text
-    end
+    dom.title
   end
 
 protected

data/lib/capybara/rack_test/css_handlers.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
+
 class Capybara::RackTest::CSSHandlers < BasicObject
   include ::Kernel
-  
-  def disabled list
+
+  def disabled(list)
     list.find_all { |node| node.has_attribute? 'disabled' }
-  end        
-  def enabled list
+  end
+
+  def enabled(list)
     list.find_all { |node| !node.has_attribute? 'disabled' }
   end
 end

data/lib/capybara/rack_test/driver.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rack/test'
 require 'rack/utils'
 require 'mini_mime'
@@ -10,10 +11,10 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
     respect_data_method: false,
     follow_redirects: true,
     redirect_limit: 5
-  }
+  }.freeze
   attr_reader :app, :options
 
-  def initialize(app, options={})
+  def initialize(app, **options)
     raise ArgumentError, "rack-test requires a rack application, but none was given" unless app
     @session = nil
     @app = app
@@ -40,7 +41,7 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
     browser.last_request
   end
 
-  def visit(path, attributes = {})
+  def visit(path, **attributes)
     browser.visit(path, attributes)
   end
 
@@ -52,7 +53,7 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
     browser.submit(method, path, attributes)
   end
 
-  def follow(method, path, attributes = {})
+  def follow(method, path, **attributes)
     browser.follow(method, path, attributes)
   end
 
@@ -73,7 +74,7 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
   end
 
   def find_css(selector)
-    browser.find(:css,selector)
+    browser.find(:css, selector)
   end
 
   def html
@@ -92,11 +93,6 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
     @browser = nil
   end
 
-  # @deprecated This method is being removed
-  def browser_initialized?
-    super && !@browser.nil?
-  end
-
   def get(*args, &block); browser.get(*args, &block); end
   def post(*args, &block); browser.post(*args, &block); end
   def put(*args, &block); browser.put(*args, &block); end