capybara 3.32.0 → 3.33.0

data/lib/capybara/selenium/nodes/firefox_node.rb

@@ -42,7 +42,7 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
 
   def send_keys(*args)
     # https://github.com/mozilla/geckodriver/issues/846
-    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none? { |arg| arg.is_a? Array }
+    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none?(Array)
 
     native.click
     _send_keys(args).perform

data/lib/capybara/selenium/patches/action_pauser.rb

@@ -20,4 +20,7 @@ module ActionPauser
   private_constant :Pauser
 end
 
-::Selenium::WebDriver::ActionBuilder.prepend ActionPauser if defined? ::Selenium::WebDriver::ActionBuilder
+if defined?(::Selenium::WebDriver::VERSION) && (::Selenium::WebDriver::VERSION.to_f < 4) &&
+   defined?(::Selenium::WebDriver::ActionBuilder)
+  ::Selenium::WebDriver::ActionBuilder.prepend(ActionPauser)
+end

data/lib/capybara/selenium/patches/logs.rb

@@ -33,11 +33,9 @@ module Capybara
                end
 
         Array(data).map do |l|
-          begin
-            ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
-          rescue KeyError
-            next
-          end
+          ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+        rescue KeyError
+          next
         end
       rescue ::Selenium::WebDriver::Error::UnknownCommandError
         raise NotImplementedError, LOG_MSG

data/lib/capybara/session/config.rb

@@ -8,7 +8,7 @@ module Capybara
                  automatic_reload match exact exact_text raise_server_errors visible_text_only
                  automatic_label_click enable_aria_label save_path asset_host default_host app_host
                  server_host server_port server_errors default_set_options disable_animation test_id
-                 predicates_wait default_normalize_ws w3c_click_offset].freeze
+                 predicates_wait default_normalize_ws w3c_click_offset enable_aria_role].freeze
 
     attr_accessor(*OPTIONS)
 
@@ -37,6 +37,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method enable_aria_label
     #   See {Capybara.configure}
+    # @!method enable_aria_role
+    #   See {Capybara.configure}
     # @!method save_path
     #   See {Capybara.configure}
     # @!method asset_host

data/lib/capybara/session.rb

@@ -97,8 +97,8 @@ module Capybara
 
     def driver
       @driver ||= begin
-        unless Capybara.drivers.key?(mode)
-          other_drivers = Capybara.drivers.keys.map(&:inspect)
+        unless Capybara.drivers[mode]
+          other_drivers = Capybara.drivers.names.map(&:inspect)
           raise Capybara::DriverNotFoundError, "no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}"
         end
         driver = Capybara.drivers[mode].call(app)
@@ -192,7 +192,7 @@ module Capybara
     # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).
     #
     def html
-      driver.html
+      driver.html || ''
     end
     alias_method :body, :html
     alias_method :source, :html

data/lib/capybara/spec/public/test.js

@@ -108,6 +108,13 @@ $(function() {
     }, 4000);
     return false;
   });
+  $('#aria-button').click(function() {
+    var span = $(this);
+    setTimeout(function() {
+      $(span).after('<span role="button">ARIA button has been clicked</span>')
+    }, 1000);
+    return false;
+  });
   $('#waiter').change(function() {
     activeRequests = 1;
     setTimeout(function() {

data/lib/capybara/spec/session/click_button_spec.rb

@@ -193,6 +193,17 @@ Capybara::SpecHelper.spec '#click_button' do
     end
   end
 
+  context 'when Capybara.enable_aria_role = true' do
+    it 'should click on a button role', requires: [:js] do
+      Capybara.enable_aria_role = true
+      @session.using_wait_time(1.5) do
+        @session.visit('/with_js')
+        @session.click_button('ARIA button')
+        expect(@session).to have_button('ARIA button has been clicked')
+      end
+    end
+  end
+
   context 'with fields associated with the form using the form attribute', requires: [:form_attribute] do
     let(:results) { extract_results(@session) }
 

data/lib/capybara/spec/session/has_button_spec.rb

@@ -39,6 +39,14 @@ Capybara::SpecHelper.spec '#has_button?' do
     expect(@session).to have_button('awe123', type: 'submit')
     expect(@session).not_to have_button('awe123', type: 'reset')
   end
+
+  it 'should be true for role=button when enable_aria_role: true' do
+    expect(@session).to have_button('ARIA button', enable_aria_role: true)
+  end
+
+  it 'should be false for role=button when enable_aria_role: false' do
+    expect(@session).not_to have_button('ARIA button', enable_aria_role: false)
+  end
 end
 
 Capybara::SpecHelper.spec '#has_no_button?' do
@@ -66,4 +74,12 @@ Capybara::SpecHelper.spec '#has_no_button?' do
   it 'should be false for disabled buttons if disabled: false' do
     expect(@session).to have_no_button('Disabled button', disabled: false)
   end
+
+  it 'should be true for role=button when enable_aria_role: false' do
+    expect(@session).to have_no_button('ARIA button', enable_aria_role: false)
+  end
+
+  it 'should be false for role=button when enable_aria_role: true' do
+    expect(@session).not_to have_no_button('ARIA button', enable_aria_role: true)
+  end
 end

data/lib/capybara/spec/session/has_current_path_spec.rb

@@ -128,11 +128,11 @@ Capybara::SpecHelper.spec '#has_no_current_path?' do
     # Without ignore_query option
     expect do
       expect(@session).not_to have_current_path('/with_js')
-    end. not_to raise_exception
+    end.not_to raise_exception
 
     # With ignore_query option
     expect do
       expect(@session).not_to have_current_path('/with_js', ignore_query: true)
-    end. not_to raise_exception
+    end.not_to raise_exception
   end
 end

data/lib/capybara/spec/session/has_field_spec.rb

@@ -60,6 +60,22 @@ Capybara::SpecHelper.spec '#has_field' do
     end
   end
 
+  context 'with validation message', requires: [:html_validation] do
+    it 'should accept a regexp' do
+      @session.fill_in('form_zipcode', with: '1234')
+      expect(@session).to have_field('form_zipcode', validation_message: /match the requested format/)
+      expect(@session).not_to have_field('form_zipcode', validation_message: /random/)
+    end
+
+    it 'should accept a string' do
+      @session.fill_in('form_zipcode', with: '1234')
+      expect(@session).to have_field('form_zipcode', validation_message: 'Please match the requested format.')
+      expect(@session).not_to have_field('form_zipcode', validation_message: 'match the requested format.')
+      @session.fill_in('form_zipcode', with: '12345')
+      expect(@session).to have_field('form_zipcode', validation_message: '')
+    end
+  end
+
   context 'with type' do
     it 'should be true if a field with the given type is on the page' do
       expect(@session).to have_field('First Name', type: 'text')

data/lib/capybara/spec/session/has_select_spec.rb

@@ -63,7 +63,7 @@ Capybara::SpecHelper.spec '#has_select?' do
     end
 
     it "should be true even when the selected option invisible, regardless of the select's visibility" do
-      expect(@session).to have_select('Icecream', visible: false, selected: 'Chocolate')
+      expect(@session).to have_select('Icecream', visible: :hidden, selected: 'Chocolate')
       expect(@session).to have_select('Sorbet', selected: 'Vanilla')
     end
   end
@@ -88,7 +88,7 @@ Capybara::SpecHelper.spec '#has_select?' do
     end
 
     it "should be true even when the selected values are invisible, regardless of the select's visibility" do
-      expect(@session).to have_select('Dessert', visible: false, with_options: %w[Pudding Tiramisu])
+      expect(@session).to have_select('Dessert', visible: :hidden, with_options: %w[Pudding Tiramisu])
       expect(@session).to have_select('Cake', with_selected: ['Chocolate Cake', 'Sponge Cake'])
     end
 
@@ -113,7 +113,7 @@ Capybara::SpecHelper.spec '#has_select?' do
     end
 
     it 'should be true even when the options are invisible, if the select itself is invisible' do
-      expect(@session).to have_select('Icecream', visible: false, options: %w[Chocolate Vanilla Strawberry])
+      expect(@session).to have_select('Icecream', visible: :hidden, options: %w[Chocolate Vanilla Strawberry])
     end
   end
 
@@ -158,7 +158,7 @@ Capybara::SpecHelper.spec '#has_select?' do
     end
 
     it 'should be true even when the options are invisible, if the select itself is invisible' do
-      expect(@session).to have_select('Icecream', visible: false, with_options: %w[Vanilla Strawberry])
+      expect(@session).to have_select('Icecream', visible: :hidden, with_options: %w[Vanilla Strawberry])
     end
   end
 

data/lib/capybara/spec/session/has_selector_spec.rb

@@ -61,12 +61,12 @@ Capybara::SpecHelper.spec '#has_selector?' do
     end
 
     it 'should respect visibility setting' do
-      expect(@session).to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: false)
-      expect(@session).not_to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: true)
+      expect(@session).to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: :all)
+      expect(@session).not_to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: :visible)
       Capybara.ignore_hidden_elements = false
-      expect(@session).to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: false)
+      expect(@session).to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: :all)
       Capybara.visible_text_only = true
-      expect(@session).not_to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: true)
+      expect(@session).not_to have_selector(:id, 'hidden-text', text: 'Some of this text is hidden!', visible: :visible)
     end
 
     it 'should discard all matches where the given regexp is not matched' do

data/lib/capybara/spec/session/node_spec.rb

@@ -271,12 +271,12 @@ Capybara::SpecHelper.spec 'node' do
 
     it 'works when details is toggled open and closed' do
       @session.find(:css, '#closed_details > summary').click
-      expect(@session).to have_css('#closed_details *', visible: true, count: 5)
+      expect(@session).to have_css('#closed_details *', visible: :visible, count: 5)
         .and(have_no_css('#closed_details *', visible: :hidden))
 
       @session.find(:css, '#closed_details > summary').click
       descendants_css = '#closed_details > *:not(summary), #closed_details > *:not(summary) *'
-      expect(@session).to have_no_css(descendants_css, visible: true)
+      expect(@session).to have_no_css(descendants_css, visible: :visible)
         .and(have_css(descendants_css, visible: :hidden, count: 3))
     end
   end
@@ -446,7 +446,7 @@ Capybara::SpecHelper.spec 'node' do
 
     it 'should work with Dragula' do
       @session.visit('/with_dragula')
-      @session.within(:css, '#sortable') do
+      @session.within(:css, '#sortable.ready') do
         src = @session.find('div', text: 'Item 1')
         target = @session.find('div', text: 'Item 3')
         src.drag_to target
@@ -758,7 +758,7 @@ Capybara::SpecHelper.spec 'node' do
       @session.visit('with_js')
       @session.find(:css, '#click-test').click(x: 5, y: 5)
       link = @session.find(:link, 'has-been-clicked')
-      locations = link.text.match(/^Has been clicked at (?<x>[\d\.-]+),(?<y>[\d\.-]+)$/)
+      locations = link.text.match(/^Has been clicked at (?<x>[\d.-]+),(?<y>[\d.-]+)$/)
       # Resulting click location should be very close to 0, 0 relative to top left corner of the element, but may not be exact due to
       # integer/float conversions and rounding.
       expect(locations[:x].to_f).to be_within(1).of(5)
@@ -884,7 +884,7 @@ Capybara::SpecHelper.spec 'node' do
       @session.visit('with_js')
       @session.find(:css, '#click-test').double_click(x: 10, y: 5)
       link = @session.find(:link, 'has-been-double-clicked')
-      locations = link.text.match(/^Has been double clicked at (?<x>[\d\.-]+),(?<y>[\d\.-]+)$/)
+      locations = link.text.match(/^Has been double clicked at (?<x>[\d.-]+),(?<y>[\d.-]+)$/)
       # Resulting click location should be very close to 10, 5 relative to top left corner of the element, but may not be exact due
       # to integer/float conversions and rounding.
       expect(locations[:x].to_f).to be_within(1).of(10)
@@ -970,7 +970,7 @@ Capybara::SpecHelper.spec 'node' do
       @session.visit('with_js')
       @session.find(:css, '#click-test').right_click(x: 10, y: 10)
       link = @session.find(:link, 'has-been-right-clicked')
-      locations = link.text.match(/^Has been right clicked at (?<x>[\d\.-]+),(?<y>[\d\.-]+)$/)
+      locations = link.text.match(/^Has been right clicked at (?<x>[\d.-]+),(?<y>[\d.-]+)$/)
       # Resulting click location should be very close to 10, 10 relative to top left corner of the element, but may not be exact due
       # to integer/float conversions and rounding
       expect(locations[:x].to_f).to be_within(1).of(10)

data/lib/capybara/spec/spec_helper.rb

@@ -30,6 +30,7 @@ module Capybara
         Capybara.visible_text_only = false
         Capybara.match = :smart
         Capybara.enable_aria_label = false
+        Capybara.enable_aria_role = false
         Capybara.default_set_options = {}
         Capybara.disable_animation = false
         Capybara.test_id = nil

data/lib/capybara/spec/test_app.rb

@@ -188,28 +188,24 @@ class TestApp < Sinatra::Base
   end
 
   post '/upload' do
-    begin
-      buffer = []
-      buffer << "Content-type: #{params.dig(:form, :document, :type)}"
-      buffer << "File content: #{params.dig(:form, :document, :tempfile).read}"
-      buffer.join(' | ')
-    rescue StandardError
-      'No file uploaded'
-    end
+    buffer = []
+    buffer << "Content-type: #{params.dig(:form, :document, :type)}"
+    buffer << "File content: #{params.dig(:form, :document, :tempfile).read}"
+    buffer.join(' | ')
+  rescue StandardError
+    'No file uploaded'
   end
 
   post '/upload_multiple' do
-    begin
-      docs = params.dig(:form, :multiple_documents)
-      buffer = [docs.size.to_s]
-      docs.each do |doc|
-        buffer << "Content-type: #{doc[:type]}"
-        buffer << "File content: #{doc[:tempfile].read}"
-      end
-      buffer.join(' | ')
-    rescue StandardError
-      'No files uploaded'
+    docs = params.dig(:form, :multiple_documents)
+    buffer = [docs.size.to_s]
+    docs.each do |doc|
+      buffer << "Content-type: #{doc[:type]}"
+      buffer << "File content: #{doc[:tempfile].read}"
     end
+    buffer.join(' | ')
+  rescue StandardError
+    'No files uploaded'
   end
 
   get '/apple-touch-icon-precomposed.png' do

data/lib/capybara/spec/views/form.erb

@@ -140,7 +140,11 @@
 
   <p>
     <label for="form_zipcode">Zipcode</label>
-    <input type="text" maxlength="5" name="form[zipcode]" id="form_zipcode" />
+    <input type="text" maxlength="5" name="form[zipcode]" id="form_zipcode" pattern="[0-9]{5,9}" />
+  </p>
+
+  <p>
+    <input maxlength="35" id="long_length" />
   </p>
 
   <p>
@@ -453,6 +457,7 @@ New line after and before textarea tag
     <button id="no_type">No Type!</button>
     <button><img alt="A horse eating hay"/></button>
     <input type="button" disabled="disabled" value="Disabled button"/>
+    <span role="button">ARIA button</span>
   </p>
 
   <p>

data/lib/capybara/spec/views/with_dragula.erb

@@ -15,7 +15,9 @@
     </div>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/dragula/3.7.2/dragula.js" type="text/javascript"></script>
     <script>
-      dragula([document.getElementById("sortable")]);
+      let container = document.getElementById("sortable");
+      dragula([container]);
+      container.className = "ready"
     </script>
   </body>
 </html>

data/lib/capybara/spec/views/with_js.erb

@@ -35,6 +35,7 @@
 
     <p><a href="#" id="clickable">Click me</a></p>
     <p><a href="#" id="slow-click">Slowly</a></p>
+    <p><span id="aria-button" role="button">ARIA button</span></p>
 
     <p>
       <select id="waiter">

data/lib/capybara/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Capybara
-  VERSION = '3.32.0'
+  VERSION = '3.33.0'
 end

data/lib/capybara.rb

@@ -5,6 +5,7 @@ require 'nokogiri'
 require 'xpath'
 require 'forwardable'
 require 'capybara/config'
+require 'capybara/registration_container'
 
 module Capybara
   class CapybaraError < StandardError; end
@@ -81,6 +82,7 @@ module Capybara
     # - **default_selector** (`:css`, `:xpath` = `:css`) - Methods which take a selector use the given type by default. See also {Capybara::Selector}.
     # - **default_set_options** (Hash = `{}`) - The default options passed to {Capybara::Node::Element#set Element#set}.
     # - **enable_aria_label** (Boolean = `false`) - Whether fields, links, and buttons will match against `aria-label` attribute.
+    # - **enable_aria_role** (Boolean = `false`) - Selectors will check for relevant aria role (currently only `button`).
     # - **exact** (Boolean = `false`) - Whether locators are matched exactly or with substrings. Only affects selector conditions
     #   written using the `XPath#is` method.
     # - **exact_text** (Boolean = `false`) - Whether the text matchers and `:text` filter match exactly or on substrings.
@@ -93,6 +95,7 @@ module Capybara
     # - **save_path** (String = `Dir.pwd`) - Where to put pages saved through {Capybara::Session#save_page save_page}, {Capybara::Session#save_screenshot save_screenshot},
     #   {Capybara::Session#save_and_open_page save_and_open_page}, or {Capybara::Session#save_and_open_screenshot save_and_open_screenshot}.
     # - **server** (Symbol = `:default` (which uses puma)) - The name of the registered server to use when running the app under test.
+    # - **server_port** (Integer) - The port Capybara will run the application server on, if not specified a random port will be used.
     # - **server_errors** (Array\<Class> = `[Exception]`) - Error classes that should be raised in the tests if they are raised in the server
     #   and {configure raise_server_errors} is `true`.
     # - **test_id** (Symbol, String, `nil` = `nil`) - Optional attribute to match locator against with built-in selectors along with id.
@@ -124,7 +127,7 @@ module Capybara
     # @yieldreturn [Capybara::Driver::Base]   A Capybara driver instance
     #
     def register_driver(name, &block)
-      drivers[name] = block
+      drivers.send(:register, name, block)
     end
 
     ##
@@ -143,7 +146,7 @@ module Capybara
     # @yieldparam host                        The host/ip to bind to
     #
     def register_server(name, &block)
-      servers[name.to_sym] = block
+      servers.send(:register, name.to_sym, block)
     end
 
     ##
@@ -197,11 +200,11 @@ module Capybara
     end
 
     def drivers
-      @drivers ||= {}
+      @drivers ||= RegistrationContainer.new
     end
 
     def servers
-      @servers ||= {}
+      @servers ||= RegistrationContainer.new
     end
 
     # Wraps the given string, which should contain an HTML document or fragment
@@ -349,7 +352,8 @@ module Capybara
     #
     # Yield a block using a specific session name or {Capybara::Session} instance.
     #
-    def using_session(name_or_session)
+    def using_session(name_or_session, &block)
+      previous_session = current_session
       previous_session_info = {
         specified_session: specified_session,
         session_name: session_name,
@@ -362,7 +366,12 @@ module Capybara
       else
         self.session_name = name_or_session
       end
-      yield
+
+      if block.arity.zero?
+        yield
+      else
+        yield current_session, previous_session
+      end
     ensure
       self.session_name, self.specified_session = previous_session_info.values_at(:session_name, :specified_session)
       self.current_driver, self.app = previous_session_info.values_at(:current_driver, :app) if threadsafe
@@ -394,7 +403,7 @@ module Capybara
             template.inner_html = ''
           end
           document.xpath('//textarea').each do |textarea|
-            textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/, '')
+            textarea['_capybara_raw_value'] = textarea.content.delete_prefix("\n")
           end
         end
       end
@@ -501,6 +510,7 @@ Capybara.configure do |config|
   config.visible_text_only = false
   config.automatic_label_click = false
   config.enable_aria_label = false
+  config.enable_aria_role = false
   config.reuse_server = true
   config.default_set_options = {}
   config.test_id = nil

data/spec/capybara_spec.rb

@@ -32,7 +32,7 @@ RSpec.describe Capybara do
         # do nothing
       end
 
-      expect(described_class.servers).to have_key(:blob)
+      expect(described_class.servers[:blob]).to be_truthy
     end
   end
 

data/spec/dsl_spec.rb

@@ -8,7 +8,7 @@ class TestClass
 end
 
 Capybara::SpecHelper.run_specs TestClass.new, 'DSL', capybara_skip: %i[
-  js modals screenshot frames windows send_keys server hover about_scheme psc download css driver scroll spatial
+  js modals screenshot frames windows send_keys server hover about_scheme psc download css driver scroll spatial html_validation
 ] do |example|
   case example.metadata[:full_description]
   when /has_css\? should support case insensitive :class and :id options/
@@ -19,6 +19,10 @@ Capybara::SpecHelper.run_specs TestClass.new, 'DSL', capybara_skip: %i[
 end
 
 RSpec.describe Capybara::DSL do
+  before do
+    Capybara.use_default_driver
+  end
+
   after do
     Capybara.session_name = nil
     Capybara.default_driver = nil
@@ -238,6 +242,15 @@ RSpec.describe Capybara::DSL do
       end
       expect(Capybara.current_session).to eq(original_session)
     end
+
+    it 'should pass the new session if block accepts' do
+      original_session = Capybara.current_session
+      Capybara.using_session(:administrator) do |admin_session, prev_session|
+        expect(admin_session).to be(Capybara.current_session)
+        expect(prev_session).to be(original_session)
+        expect(prev_session).not_to be(admin_session)
+      end
+    end
   end
 
   describe '#session_name' do

data/spec/minitest_spec.rb

@@ -16,7 +16,7 @@ class MinitestTest < Minitest::Test
   end
 
   def test_assert_text
-    assert_text('Form')
+    assert_text('Form', normalize_ws: false)
     assert_no_text('Not on the page')
     refute_text('Also Not on the page')
   end

data/spec/rack_test_spec.rb

@@ -26,6 +26,7 @@ skipped_tests = %i[
   css
   scroll
   spatial
+  html_validation
 ]
 Capybara::SpecHelper.run_specs TestSessions::RackTest, 'RackTest', capybara_skip: skipped_tests do |example|
   case example.metadata[:full_description]

data/spec/result_spec.rb

@@ -190,23 +190,7 @@ RSpec.describe Capybara::Result do
     end
   end
 
-  context 'lazy select' do
-    it 'is compatible' do
-      # This test will let us know when JRuby fixes lazy select so we can re-enable it in Result
-      pending 'JRuby < 9.2.8.0 has an issue with lazy enumberator evaluation' if jruby_lazy_enumerator_workaround?
-      eval_count = 0
-      enum = %w[Text1 Text2 Text3].lazy.select do
-        eval_count += 1
-        true
-      end
-      expect(eval_count).to eq 0
-      enum.next
-      sleep 1
-      expect(eval_count).to eq 1
-    end
-  end
-
   def jruby_lazy_enumerator_workaround?
-    (RUBY_PLATFORM == 'java') && (Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('9.2.8.0'))
+    RUBY_PLATFORM == 'java'
   end
 end