capybara 2.18.0 → 3.0.0.rc1

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,26 @@
 # 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 = if expected_text.is_a?(Regexp)
+          expected_text
+        else
+          Capybara::Helpers.normalize_whitespace(expected_text)
+        end
+        @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 +46,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?

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 : Capybara::Helpers.normalize_whitespace(expected_title)
         @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, 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

data/lib/capybara/rack_test/form.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Capybara::RackTest::Form < Capybara::RackTest::Node
   # This only needs to inherit from Rack::Test::UploadedFile because Rack::Test checks for
   # the class specifically when determining whether to construct the request as multipart.
@@ -20,53 +21,21 @@ class Capybara::RackTest::Form < Capybara::RackTest::Node
   def params(button)
     params = make_params
 
-    form_element_types=[:input, :select, :textarea]
-    form_elements_xpath=XPath.generate do |x|
-      xpath=x.descendant(*form_element_types).where(~x.attr(:form))
-      xpath=xpath.union(x.anywhere(*form_element_types).where(x.attr(:form) == native[:id])) if native[:id]
-      xpath.where(~x.attr(:disabled))
+    form_element_types = %i[input select textarea]
+    form_elements_xpath = XPath.generate do |x|
+      xpath = x.descendant(*form_element_types).where(!x.attr(:form))
+      xpath += x.anywhere(*form_element_types).where(x.attr(:form) == native[:id]) if native[:id]
+      xpath.where(!x.attr(:disabled))
     end.to_s
 
     native.xpath(form_elements_xpath).map do |field|
       case field.name
       when 'input'
-        if %w(radio checkbox).include? field['type']
-          if field['checked']
-            node=Capybara::RackTest::Node.new(self.driver, field)
-            merge_param!(params, field['name'].to_s, node.value.to_s)
-          end
-        elsif %w(submit image).include? field['type']
-          # TO DO identify the click button here (in document order, rather
-          # than leaving until the end of the params)
-        elsif field['type'] =='file'
-          if multipart?
-            file = \
-              if (value = field['value']).to_s.empty?
-                NilUploadedFile.new
-              else
-                mime_info = MiniMime.lookup_by_filename(value)
-                Rack::Test::UploadedFile.new(value, (mime_info && mime_info.content_type).to_s)
-              end
-            merge_param!(params, field['name'].to_s, file)
-          else
-            merge_param!(params, field['name'].to_s, File.basename(field['value'].to_s))
-          end
-        else
-          merge_param!(params, field['name'].to_s, field['value'].to_s)
-        end
+        add_input_param(field, params)
       when 'select'
-        if field['multiple'] == 'multiple'
-          options = field.xpath(".//option[@selected]")
-          options.each do |option|
-            merge_param!(params, field['name'].to_s, (option['value'] || option.text).to_s)
-          end
-        else
-          option = field.xpath(".//option[@selected]").first
-          option ||= field.xpath('.//option').first
-          merge_param!(params, field['name'].to_s, (option['value'] || option.text).to_s) if option
-        end
+        add_select_param(field, params)
       when 'textarea'
-        merge_param!(params, field['name'].to_s, field['_capybara_raw_value'].to_s.gsub(/\n/, "\r\n"))
+        add_textarea_param(field, params)
       end
     end
     merge_param!(params, button[:name], button[:value] || "") if button[:name]
@@ -111,4 +80,45 @@ private
       ParamsHash.new
     end
   end
+
+  def add_input_param(field, params)
+    if %w[radio checkbox].include? field['type']
+      if field['checked']
+        node = Capybara::RackTest::Node.new(driver, field)
+        merge_param!(params, field['name'].to_s, node.value.to_s)
+      end
+    elsif %w[submit image].include? field['type']
+      # TODO: identify the click button here (in document order, rather
+      # than leaving until the end of the params)
+    elsif field['type'] == 'file'
+      if multipart?
+        file = if (value = field['value']).to_s.empty?
+          NilUploadedFile.new
+        else
+          mime_info = MiniMime.lookup_by_filename(value)
+          Rack::Test::UploadedFile.new(value, (mime_info && mime_info.content_type).to_s)
+        end
+        merge_param!(params, field['name'].to_s, file)
+      else
+        merge_param!(params, field['name'].to_s, File.basename(field['value'].to_s))
+      end
+    else
+      merge_param!(params, field['name'].to_s, field['value'].to_s)
+    end
+  end
+
+  def add_select_param(field, params)
+    if field['multiple'] == 'multiple'
+      field.xpath(".//option[@selected]").each do |option|
+        merge_param!(params, field['name'].to_s, (option['value'] || option.text).to_s)
+      end
+    else
+      option = field.xpath('.//option[@selected]').first || field.xpath('.//option').first
+      merge_param!(params, field['name'].to_s, (option['value'] || option.text).to_s) if option
+    end
+  end
+
+  def add_textarea_param(field, params)
+    merge_param!(params, field['name'].to_s, field['_capybara_raw_value'].to_s.gsub(/\n/, "\r\n"))
+  end
 end

data/lib/capybara/rack_test/node.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Capybara::RackTest::Node < Capybara::Driver::Node
   def all_text
     Capybara::Helpers.normalize_whitespace(native.text)
@@ -16,64 +17,45 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     string_node.value
   end
 
-  def set(value)
-    return if disabled?
-    if readonly?
-      warn "Attempt to set readonly element with value: #{value} \n * This will raise an exception in a future version of Capybara"
-      return
-    end
+  def set(value, **options)
+    return if disabled? || readonly?
+
+    warn "Options passed to Node#set but the RackTest driver doesn't support any - ignoring" unless options.empty?
 
-    if (Array === value) && !multiple?
-      raise TypeError.new "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
+    if value.is_a?(Array) && !multiple?
+      raise TypeError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
     end
 
-    if radio?
-      set_radio(value)
-    elsif checkbox?
-      set_checkbox(value)
-    elsif input_field?
-      set_input(value)
-    elsif textarea?
-      native['_capybara_raw_value'] = value.to_s
+    if radio? then set_radio(value)
+    elsif checkbox? then set_checkbox(value)
+    elsif input_field? then set_input(value)
+    elsif textarea? then native['_capybara_raw_value'] = value.to_s
     end
   end
 
   def select_option
     return if disabled?
-    if select_node['multiple'] != 'multiple'
-      select_node.find_xpath(".//option[@selected]").each { |node| node.native.remove_attribute("selected") }
-    end
+    deselect_options unless select_node.multiple?
     native["selected"] = 'selected'
   end
 
   def unselect_option
-    if select_node['multiple'] != 'multiple'
-      raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box."
-    end
+    raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box." unless select_node.multiple?
     native.remove_attribute('selected')
   end
 
-  def click
-    if tag_name == 'a' && !self[:href].nil?
-      method = self["data-method"] if driver.options[:respect_data_method]
-      method ||= :get
-      driver.follow(method, self[:href].to_s)
-    elsif (tag_name == 'input' and %w(submit image).include?(type)) or
-        ((tag_name == 'button') and type.nil? or type == "submit")
+  def click(keys = [], offset = {})
+    raise ArgumentError, "The RackTest driver does not support click options" unless keys.empty? && offset.empty?
+
+    if link?
+      follow_link
+    elsif submits?
       associated_form = form
       Capybara::RackTest::Form.new(driver, associated_form).submit(self) if associated_form
-    elsif (tag_name == 'input' and %w(checkbox radio).include?(type))
+    elsif checkable?
       set(!checked?)
-    elsif (tag_name == 'label')
-      labelled_control = if native[:for]
-        find_xpath("//input[@id='#{native[:for]}']").first
-      else
-        find_xpath(".//input").first
-      end
-
-      if labelled_control && (labelled_control.checkbox? || labelled_control.radio?)
-        labelled_control.set(!labelled_control.checked?)
-      end
+    elsif tag_name == 'label'
+      click_label
     end
   end
 
@@ -94,10 +76,12 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
   end
 
   def disabled?
-    if %w(option optgroup).include? tag_name
-      string_node.disabled? || find_xpath("parent::*[self::optgroup or self::select]")[0].disabled?
+    return true if string_node.disabled?
+
+    if %w[option optgroup].include? tag_name
+      find_xpath("parent::*[self::optgroup or self::select]")[0].disabled?
     else
-      string_node.disabled? || !find_xpath("parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]").empty?
+      !find_xpath("parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]").empty?
     end
   end
 
@@ -135,6 +119,10 @@ protected
 
 private
 
+  def deselect_options
+    select_node.find_xpath(".//option[@selected]").each { |node| node.native.remove_attribute("selected") }
+  end
+
   def string_node
     @string_node ||= Capybara::Node::Simple.new(native)
   end
@@ -150,19 +138,19 @@ private
 
   def form
     if native[:form]
-      native.xpath("//form[@id='#{native[:form]}']").first
+      native.xpath("//form[@id='#{native[:form]}']")
     else
-      native.ancestors('form').first
-    end
+      native.ancestors('form')
+    end.first
   end
 
-  def set_radio(_value)
-    other_radios_xpath = XPath.generate { |x| x.anywhere(:input)[x.attr(:name).equals(self[:name])] }.to_s
+  def set_radio(_value) # rubocop:disable Naming/AccessorMethodName
+    other_radios_xpath = XPath.generate { |x| x.anywhere(:input)[x.attr(:name) == self[:name]] }.to_s
     driver.dom.xpath(other_radios_xpath).each { |node| node.remove_attribute("checked") }
     native['checked'] = 'checked'
   end
 
-  def set_checkbox(value)
+  def set_checkbox(value) # rubocop:disable Naming/AccessorMethodName
     if value && !native['checked']
       native['checked'] = 'checked'
     elsif !value && native['checked']
@@ -170,13 +158,13 @@ private
     end
   end
 
-  def set_input(value)
+  def set_input(value) # rubocop:disable Naming/AccessorMethodName
     if text_or_password? && attribute_is_not_blank?(:maxlength)
       # Browser behavior for maxlength="0" is inconsistent, so we stick with
       # Firefox, allowing no input
       value = value.to_s[0...self[:maxlength].to_i]
     end
-    if Array === value #Assert multiple attribute is present
+    if value.is_a?(Array) # Assert multiple attribute is present
       value.each do |v|
         new_native = native.clone
         new_native.remove_attribute('value')
@@ -185,11 +173,7 @@ private
       end
       native.remove
     else
-      if readonly?
-        warn "Attempt to set readonly element with value: #{value} \n *This will raise an exception in a future version of Capybara"
-      else
-        native['value'] = value.to_s
-      end
+      native['value'] = value.to_s
     end
   end
 
@@ -197,6 +181,36 @@ private
     self[attribute] && !self[attribute].empty?
   end
 
+  def follow_link
+    method = self["data-method"] if driver.options[:respect_data_method]
+    method ||= :get
+    driver.follow(method, self[:href].to_s)
+  end
+
+  def click_label
+    labelled_control = if native[:for]
+      find_xpath("//input[@id='#{native[:for]}']")
+    else
+      find_xpath(".//input")
+    end.first
+
+    if labelled_control && (labelled_control.checkbox? || labelled_control.radio?)
+      labelled_control.set(!labelled_control.checked?)
+    end
+  end
+
+  def link?
+    tag_name == 'a' && !self[:href].nil?
+  end
+
+  def submits?
+    (tag_name == 'input' and %w[submit image].include?(type)) || (tag_name == 'button' and [nil, "submit"].include?(type))
+  end
+
+  def checkable?
+    tag_name == 'input' and %w[checkbox radio].include?(type)
+  end
+
 protected
 
   def checkbox?