capybara 2.18.0 → 3.0.0

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,11 +1,23 @@
 # frozen_string_literal: true
+
 class Capybara::RackTest::Node < Capybara::Driver::Node
+  BLOCK_ELEMENTS = %w[p h1 h2 h3 h4 h5 h6 ol ul pre address blockquote dl div fieldset form hr noscript table].freeze
+
   def all_text
-    Capybara::Helpers.normalize_whitespace(native.text)
+    native.text
+          .gsub(/[\u200b\u200e\u200f]/, '')
+          .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
+          .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
+          .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+          .tr("\u00a0", ' ')
   end
 
   def visible_text
-    Capybara::Helpers.normalize_whitespace(unnormalized_text)
+    displayed_text.gsub(/\ +/, ' ')
+                  .gsub(/[\ \n]*\n[\ \n]*/, "\n")
+                  .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
+                  .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+                  .tr("\u00a0", ' ')
   end
 
   def [](name)
@@ -16,64 +28,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?
 
-    if (Array === value) && !multiple?
-      raise TypeError.new "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
+    warn "Options passed to Node#set but the RackTest driver doesn't support any - ignoring" unless options.empty?
+
+    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 +87,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
 
@@ -119,15 +114,20 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
 
 protected
 
-  def unnormalized_text(check_ancestor_visibility = true)
-    if !string_node.visible?(check_ancestor_visibility)
+  # @api private
+  def displayed_text(check_ancestor: true)
+    if !string_node.visible?(check_ancestor)
       ''
     elsif native.text?
       native.text
+            .gsub(/[\u200b\u200e\u200f]/, '')
+            .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
     elsif native.element?
-      native.children.map do |child|
-        Capybara::RackTest::Node.new(driver, child).unnormalized_text(false)
-      end.join
+      text = native.children.map do |child|
+        Capybara::RackTest::Node.new(driver, child).displayed_text(check_ancestor: false)
+      end.join || ''
+      text = "\n#{text}\n" if BLOCK_ELEMENTS.include?(tag_name)
+      text
     else
       ''
     end
@@ -135,6 +135,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 +154,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 +174,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 +189,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 +197,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?

data/lib/capybara/rails.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
+
 require 'capybara/dsl'
 
 Capybara.app = Rack::Builder.new do
   map "/" do
-    if Gem::Version.new(Rails.version) >= Gem::Version.new("3.0")
-      run Rails.application
-    else # Rails 2
-      use Rails::Rack::Static
-      run ActionController::Dispatcher.new
-    end
+    run Rails.application
   end
 end.to_app
 

data/lib/capybara/result.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 require 'forwardable'
 
 module Capybara
-
   ##
   # A {Capybara::Result} represents a collection of {Capybara::Node::Element} on the page. It is possible to interact with this
   # collection similar to an Array because it implements Enumerable and offers the following Array methods through delegation:
@@ -41,7 +41,7 @@ module Capybara
       loop do
         next_result = @results_enum.next
         @result_cache << next_result
-        block.call(next_result)
+        yield next_result
       end
       self
     end
@@ -62,7 +62,7 @@ module Capybara
       !any?
     end
 
-    def matches_count?
+    def compare_count
       # Only check filters for as many elements as necessary to determine result
       if @query.options[:count]
         count_opt = Integer(@query.options[:count])
@@ -70,7 +70,7 @@ module Capybara
           break if @result_cache.size > count_opt
           @result_cache << @results_enum.next
         end
-        return @result_cache.size == count_opt
+        return @result_cache.size <=> count_opt
       end
 
       if @query.options[:minimum]
@@ -78,7 +78,7 @@ module Capybara
         begin
           @result_cache << @results_enum.next while @result_cache.size < min_opt
         rescue StopIteration
-          return false
+          return -1
         end
       end
 
@@ -86,32 +86,38 @@ module Capybara
         max_opt = Integer(@query.options[:maximum])
         begin
           @result_cache << @results_enum.next while @result_cache.size <= max_opt
-          return false
+          return 1
         rescue StopIteration
         end
       end
 
       if @query.options[:between]
-        max =  Integer(@query.options[:between].max)
+        min, max = @query.options[:between].minmax
         loop do
           break if @result_cache.size > max
           @result_cache << @results_enum.next
         end
-        return false unless (@query.options[:between] === @result_cache.size)
+        return 0 if @query.options[:between].include?(@result_cache.size)
+        return -1 if @result_cache.size < min
+        return 1
       end
 
-      return true
+      return 0
+    end
+
+    def matches_count?
+      compare_count.zero?
     end
 
     def failure_message
       message = @query.failure_message
-      if count > 0
-        message << ", found #{count} #{Capybara::Helpers.declension("match", "matches", count)}: " << full_results.map(&:text).map(&:inspect).join(", ")
-      else
+      if count.zero?
         message << " but there were no matches"
+      else
+        message << ", found #{count} #{Capybara::Helpers.declension("match", "matches", count)}: " << full_results.map(&:text).map(&:inspect).join(", ")
       end
       unless rest.empty?
-        elements = rest.map(&:text).map(&:inspect).join(", ")
+        elements = rest.map { |el| el.text rescue "<<ERROR>>" }.map(&:inspect).join(", ")
         message << ". Also found " << elements << ", which matched the selector but not all filters."
       end
       message
@@ -121,7 +127,7 @@ module Capybara
       failure_message.sub(/(to find)/, 'not \1')
     end
 
-    private
+  private
 
     def full_results
       loop { @result_cache << @results_enum.next }
@@ -137,15 +143,9 @@ module Capybara
       # causes a concurrency issue with network requests here
       # https://github.com/jruby/jruby/issues/4212
       if RUBY_PLATFORM == 'java'
-        @elements.select(&block).to_enum  # non-lazy evaluation
-      elsif @elements.respond_to? :lazy  #Ruby 2.0+
-        @elements.lazy.select(&block)
+        @elements.select(&block).to_enum # non-lazy evaluation
       else
-        Enumerator.new do |yielder|
-          @elements.each do |val|
-            yielder.yield(val) if block.call(val)
-          end
-        end
+        @elements.lazy.select(&block)
       end
     end
   end

data/lib/capybara/rspec/compound.rb

@@ -4,7 +4,7 @@ module Capybara
       include ::RSpec::Matchers::Composable
 
       def and(matcher)
-        Capybara::RSpecMatchers::Compound::And.new(self,matcher)
+        Capybara::RSpecMatchers::Compound::And.new(self, matcher)
       end
 
       def and_then(matcher)
@@ -15,12 +15,9 @@ module Capybara
         Capybara::RSpecMatchers::Compound::Or.new(self, matcher)
       end
 
-
       class CapybaraEvaluator
-        def initialize(actual, matcher_1, matcher_2)
-          @actual        = actual
-          @matcher_1     = matcher_1
-          @matcher_2     = matcher_2
+        def initialize(actual)
+          @actual = actual
           @match_results = Hash.new { |h, matcher| h[matcher] = matcher.matches?(@actual) }
         end
 
@@ -34,11 +31,10 @@ module Capybara
       end
 
       class And < ::RSpec::Matchers::BuiltIn::Compound::And
-
       private
 
         def match(_expected, actual)
-          @evaluator = CapybaraEvaluator.new(actual, matcher_1, matcher_2)
+          @evaluator = CapybaraEvaluator.new(actual)
           syncer = sync_element(actual)
           begin
             syncer.synchronize do
@@ -63,11 +59,10 @@ module Capybara
       end
 
       class Or < ::RSpec::Matchers::BuiltIn::Compound::Or
-
       private
 
         def match(_expected, actual)
-          @evaluator = CapybaraEvaluator.new(actual, matcher_1, matcher_2)
+          @evaluator = CapybaraEvaluator.new(actual)
           syncer = sync_element(actual)
           begin
             syncer.synchronize do

data/lib/capybara/rspec/features.rb

@@ -1,56 +1,25 @@
 # frozen_string_literal: true
-if RSpec::Core::Version::STRING.to_f >= 3.0
-  RSpec.shared_context "Capybara Features", capybara_feature: true do
-    instance_eval do
-      alias background before
-      alias given let
-      alias given! let!
-    end
-  end
 
-  # ensure shared_context is included if default shared_context_metadata_behavior is changed
-  if RSpec::Core::Version::STRING.to_f >= 3.5
-    RSpec.configure do |config|
-      config.include_context "Capybara Features", capybara_feature: true
-    end
+RSpec.shared_context "Capybara Features", capybara_feature: true do
+  instance_eval do
+    alias background before
+    alias given let
+    alias given! let!
   end
+end
 
+# ensure shared_context is included if default shared_context_metadata_behavior is changed
+if RSpec::Core::Version::STRING.to_f >= 3.5
   RSpec.configure do |config|
-    config.alias_example_group_to :feature, capybara_feature: true, type: :feature
-    config.alias_example_group_to :xfeature, capybara_feature: true, type: :feature, skip: "Temporarily disabled with xfeature"
-    config.alias_example_group_to :ffeature, capybara_feature: true, type: :feature, focus: true
-    config.alias_example_to :scenario
-    config.alias_example_to :xscenario, skip: "Temporarily disabled with xscenario"
-    config.alias_example_to :fscenario, focus: true
-  end
-else
-  module Capybara
-    module Features
-      def self.included(base)
-        base.instance_eval do
-          alias :background :before
-          alias :scenario :it
-          alias :xscenario :xit
-          alias :given :let
-          alias :given! :let!
-          alias :feature :describe
-        end
-      end
-    end
-  end
-
-  def self.feature(*args, &block)
-    options = if args.last.is_a?(Hash) then args.pop else {} end
-    options[:capybara_feature] = true
-    options[:type] = :feature
-    options[:caller] ||= caller
-    args.push(options)
-
-    #call describe on RSpec in case user has expose_dsl_globally set to false
-    RSpec.describe(*args, &block)
+    config.include_context "Capybara Features", capybara_feature: true
   end
+end
 
-  RSpec.configure do |config|
-    config.include(Capybara::Features, capybara_feature: true)
-  end
+RSpec.configure do |config|
+  config.alias_example_group_to :feature, capybara_feature: true, type: :feature
+  config.alias_example_group_to :xfeature, capybara_feature: true, type: :feature, skip: "Temporarily disabled with xfeature"
+  config.alias_example_group_to :ffeature, capybara_feature: true, type: :feature, focus: true
+  config.alias_example_to :scenario
+  config.alias_example_to :xscenario, skip: "Temporarily disabled with xscenario"
+  config.alias_example_to :fscenario, focus: true
 end