capybara 3.32.0 → 3.35.0

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/matchers.rb

@@ -13,14 +13,14 @@ module Capybara
     #     @param string [String]           The string that the current 'path' should equal
     #   @overload $0(regexp, **options)
     #     @param regexp [Regexp]           The regexp that the current 'path' should match to
-    #   @option options [Boolean] :url (true if `string` ia a full url, otherwise false) Whether the compare should be done against the full current url or just the path
+    #   @option options [Boolean] :url (true if `string` is a full url, otherwise false) Whether the comparison should be done against the full current url or just the path
     #   @option options [Boolean] :ignore_query (false)  Whether the query portion of the current url/path should be ignored
     #   @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for the current url/path to eq/match given string/regexp argument
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_current_path(path, **options)
-      _verify_current_path(path, **options) do |query|
+    def assert_current_path(path, **options, &optional_filter_block)
+      _verify_current_path(path, optional_filter_block, **options) do |query|
         raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
       end
     end
@@ -35,8 +35,8 @@ module Capybara
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_no_current_path(path, **options)
-      _verify_current_path(path, **options) do |query|
+    def assert_no_current_path(path, **options, &optional_filter_block)
+      _verify_current_path(path, optional_filter_block, **options) do |query|
         raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self)
       end
     end
@@ -50,8 +50,8 @@ module Capybara
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_current_path?(path, **options)
-      make_predicate(options) { assert_current_path(path, **options) }
+    def has_current_path?(path, **options, &optional_filter_block)
+      make_predicate(options) { assert_current_path(path, **options, &optional_filter_block) }
     end
 
     ##
@@ -63,14 +63,14 @@ module Capybara
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_no_current_path?(path, **options)
-      make_predicate(options) { assert_no_current_path(path, **options) }
+    def has_no_current_path?(path, **options, &optional_filter_block)
+      make_predicate(options) { assert_no_current_path(path, **options, &optional_filter_block) }
     end
 
   private
 
-    def _verify_current_path(path, **options)
-      query = Capybara::Queries::CurrentPathQuery.new(path, **options)
+    def _verify_current_path(path, filter_block, **options)
+      query = Capybara::Queries::CurrentPathQuery.new(path, **options, &filter_block)
       document.synchronize(query.wait) do
         yield(query)
       end

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() {
@@ -264,5 +271,10 @@ $(function() {
   });
   $('#multiple-file, #hidden_file').change(function(e){
     $('body').append($('<p class="file_change">File input changed</p>'));
-  })
+  });
+
+  var shadow = document.querySelector('#shadow').attachShadow({mode: 'open'});
+  var span = document.createElement('span');
+  span.textContent = 'The things we do in the shadows';
+  shadow.appendChild(span);
 });

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

@@ -53,7 +53,7 @@ Capybara::SpecHelper.spec '#accept_alert', requires: [:modals] do
       @session.click_link('Alert page change')
       sleep 1 # ensure page change occurs before the accept_alert block exits
     end
-    expect(@session).to have_current_path('/with_html')
+    expect(@session).to have_current_path('/with_html', wait: 5)
   end
 
   context 'with an asynchronous alert' do

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

@@ -229,6 +229,12 @@ Capybara::SpecHelper.spec '#check' do
           @session.click_button('awesome')
           expect(extract_results(@session)['cars']).to include('bugatti')
         end
+
+        it 'should check via label if multiple labels' do
+          expect(@session).to have_field('multi_label_checkbox', checked: false, visible: :hidden)
+          @session.check('Label to click', allow_label_click: true)
+          expect(@session).to have_field('multi_label_checkbox', checked: true, visible: :hidden)
+        end
       end
     end
   end

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/current_url_spec.rb

@@ -22,7 +22,7 @@ Capybara::SpecHelper.spec '#current_url, #current_path, #current_host' do
 
     expect(@session.current_url.chomp('?')).to eq("#{scheme}://#{s.host}:#{s.port}#{path}")
     expect(@session.current_host).to eq("#{scheme}://#{s.host}") # no port
-    expect(@session.current_path).to eq(path)
+    expect(@session.current_path).to eq(path.split('#')[0])
     # Server should agree with us
     expect(@session).to have_content("Current host is #{scheme}://#{s.host}:#{s.port}") if path == '/host'
   end
@@ -84,6 +84,16 @@ Capybara::SpecHelper.spec '#current_url, #current_path, #current_host' do
     should_be_on 0, '/landed'
   end
 
+  it 'maintains fragment' do
+    @session.visit("#{bases[0]}/redirect#fragment")
+    should_be_on 0, '/landed#fragment'
+  end
+
+  it 'redirects to a fragment' do
+    @session.visit("#{bases[0]}/redirect_with_fragment")
+    should_be_on 0, '/landed#with_fragment'
+  end
+
   it 'is affected by pushState', requires: [:js] do
     @session.visit('/with_js')
     @session.execute_script("window.history.pushState({}, '', '/pushed')")

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

@@ -9,6 +9,8 @@ Capybara::SpecHelper.spec '#has_button?' do
     expect(@session).to have_button('med')
     expect(@session).to have_button('crap321')
     expect(@session).to have_button(:crap321)
+    expect(@session).to have_button('button with label element')
+    expect(@session).to have_button('button within label element')
   end
 
   it 'should be true for disabled buttons if disabled: true' do
@@ -39,6 +41,30 @@ 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 a role=button within a label when enable_aria_role: true' do
+    expect(@session).not_to have_button('role=button within label', 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
+
+  it 'should be false for a role=button within a label when enable_aria_role: false' do
+    expect(@session).not_to have_button('role=button within label', enable_aria_role: false)
+  end
+
+  it 'should not affect other selectors when enable_aria_role: true' do
+    expect(@session).to have_button('Click me!', enable_aria_role: true)
+  end
+
+  it 'should not affect other selectors when enable_aria_role: false' do
+    expect(@session).to have_button('Click me!', enable_aria_role: false)
+  end
 end
 
 Capybara::SpecHelper.spec '#has_no_button?' do
@@ -66,4 +92,29 @@ 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 true for role=button within a label when enable_aria_role: false' do
+    expect(@session).to have_no_button('role=button within label', 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
+
+  it 'should be true for a role=button within a label when enable_aria_role: true' do
+    # label element does not associate with aria button
+    expect(@session).to have_no_button('role=button within label', enable_aria_role: true)
+  end
+
+  it 'should not affect other selectors when enable_aria_role: true' do
+    expect(@session).to have_no_button('Junk button that does not exist', enable_aria_role: true)
+  end
+
+  it 'should not affect other selectors when enable_aria_role: false' do
+    expect(@session).to have_no_button('Junk button that does not exist', enable_aria_role: false)
+  end
 end

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

@@ -14,8 +14,9 @@ Capybara::SpecHelper.spec '#has_css?' do
     # This was never a specifically accepted format but it has worked for a
     # lot of versions.
     # TODO: Remove in 4.0
-    expect_any_instance_of(Kernel).to receive(:warn) # rubocop:disable RSpec/AnyInstance
+    allow(Capybara::Helpers).to receive(:warn).and_return(nil)
     expect(@session).to have_css(:p)
+    expect(Capybara::Helpers).to have_received(:warn)
   end
 
   it 'should be false if the given selector is not on the page' do

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

@@ -94,6 +94,13 @@ Capybara::SpecHelper.spec '#has_current_path?' do
       expect(@session).to have_current_path(nil, ignore_query: true)
     end.not_to raise_exception
   end
+
+  it 'should accept a filter block that receives Addressable::URL' do
+    @session.visit('/with_js?a=3&b=defgh')
+    expect(@session).to have_current_path('/with_js', ignore_query: true) { |url|
+      url.query_values.keys == %w[a b]
+    }
+  end
 end
 
 Capybara::SpecHelper.spec '#has_no_current_path?' do
@@ -128,11 +135,17 @@ 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
+
+  it 'should accept a filter block that receives Addressable::URL' do
+    expect(@session).to have_no_current_path('/with_js', ignore_query: true) { |url|
+      !url.query.nil?
+    }
   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/has_text_spec.rb

@@ -133,17 +133,6 @@ Capybara::SpecHelper.spec '#has_text?' do
         expect(@session).to have_text(:visible, with_to_hash, {})
       end
     end
-
-    it 'should fail if passed without empty options' do
-      with_to_hash = Class.new do
-        def to_s; '42' end
-        def to_hash; { blah: 'Other hash' } end
-      end.new
-      @session.visit('/with_html')
-      expect do
-        expect(@session).to have_text(:visible, with_to_hash)
-      end.to raise_error(ArgumentError)
-    end
   end
 
   context 'with exact: true option' do

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# NOTE: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
 # because of the methods being tested. In tests using Capybara this type of behavior should be implemented
 # using Capybara provided assertions with builtin waiting behavior.
 

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

@@ -28,8 +28,8 @@ Capybara::SpecHelper.spec '#matches_style?', requires: [:css] do
       output(/have_style is deprecated/).to_stderr
 
     el = @session.find(:css, '#first')
-    allow(el).to receive(:warn).and_return(nil)
+    allow(Capybara::Helpers).to receive(:warn).and_return(nil)
     el.has_style?('display' => /^bl/)
-    expect(el).to have_received(:warn)
+    expect(Capybara::Helpers).to have_received(:warn)
   end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# NOTE: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
 # because of the methods being tested. In tests using Capybara this type of behavior should be implemented
 # using Capybara provided assertions with builtin waiting behavior.
 
@@ -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
@@ -388,8 +388,8 @@ Capybara::SpecHelper.spec 'node' do
 
   describe '#==' do
     it 'preserve object identity' do
-      expect(@session.find('//h1') == @session.find('//h1')).to be true # rubocop:disable Lint/UselessComparison
-      expect(@session.find('//h1') === @session.find('//h1')).to be true # rubocop:disable Style/CaseEquality, Lint/UselessComparison
+      expect(@session.find('//h1') == @session.find('//h1')).to be true # rubocop:disable Lint/BinaryOperatorWithIdenticalOperands
+      expect(@session.find('//h1') === @session.find('//h1')).to be true # rubocop:disable Style/CaseEquality, Lint/BinaryOperatorWithIdenticalOperands
       expect(@session.find('//h1').eql?(@session.find('//h1'))).to be false
     end
 
@@ -409,6 +409,17 @@ Capybara::SpecHelper.spec 'node' do
       element = @session.find(:link, 'Second Link')
       expect(@session.find(:xpath, element.path)).to eq(element)
     end
+
+    it 'reports when element in shadow dom', requires: [:shadow_dom] do
+      @session.visit('/with_js')
+      shadow = @session.find(:css, '#shadow')
+      element = @session.evaluate_script(<<~JS, shadow)
+        (function(root){
+          return root.shadowRoot.querySelector('span');
+        })(arguments[0])
+      JS
+      expect(element.path).to eq '(: Shadow DOM element - no XPath :)'
+    end
   end
 
   describe '#trigger', requires: %i[js trigger] do
@@ -446,7 +457,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
@@ -671,6 +682,15 @@ Capybara::SpecHelper.spec 'node' do
       expect(@session).to have_xpath('//div[contains(., "HTML5 Dropped string: text/plain Some dropped text")]')
     end
 
+    it 'can drop a pathname' do
+      @session.visit('/with_js')
+      target = @session.find('//div[@id="drop_html5"]')
+      target.drop(
+        Pathname.new(with_os_path_separators(File.expand_path('../fixtures/capybara.jpg', File.dirname(__FILE__))))
+      )
+      expect(@session).to have_xpath('//div[contains(., "HTML5 Dropped file: capybara.jpg")]')
+    end
+
     it 'can drop multiple strings' do
       @session.visit('/with_js')
       target = @session.find('//div[@id="drop_html5"]')
@@ -758,7 +778,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 +904,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 +990,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)