capybara 3.33.0 → 3.34.0

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

@@ -271,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/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

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
@@ -135,4 +142,10 @@ Capybara::SpecHelper.spec '#has_no_current_path?' do
       expect(@session).not_to have_current_path('/with_js', ignore_query: true)
     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_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/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

@@ -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
@@ -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"]')

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

@@ -25,6 +25,7 @@ Capybara::SpecHelper.spec '#refresh' do
     @session.visit('/form')
     @session.select('Sweden', from: 'form_region')
     @session.click_button('awesome')
+    sleep 2
     expect do
       @session.refresh
       sleep 2

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

@@ -31,7 +31,7 @@ Capybara::SpecHelper.spec '#save_page' do
   it 'can store files in a specified directory' do
     Capybara.save_path = alternative_path
     @session.save_page
-    path = Dir.glob(alternative_path + '/capybara-*.html').first
+    path = Dir.glob("#{alternative_path}/capybara-*.html").first
     expect(File.read(path)).to include('Another World')
   end
 
@@ -43,14 +43,14 @@ Capybara::SpecHelper.spec '#save_page' do
   it 'can store files in a specified directory with a given filename' do
     Capybara.save_path = alternative_path
     @session.save_page('capybara-001133.html')
-    path = alternative_path + '/capybara-001133.html'
+    path = "#{alternative_path}/capybara-001133.html"
     expect(File.read(path)).to include('Another World')
   end
 
   it 'can store files in a specified directory with a given relative filename' do
     Capybara.save_path = alternative_path
     @session.save_page('tmp/capybara-001144.html')
-    path = alternative_path + '/tmp/capybara-001144.html'
+    path = "#{alternative_path}/tmp/capybara-001144.html"
     expect(File.read(path)).to include('Another World')
   end
 
@@ -63,7 +63,7 @@ Capybara::SpecHelper.spec '#save_page' do
   it 'returns an absolute path in given directory' do
     Capybara.save_path = alternative_path
     result = @session.save_page
-    path = File.expand_path(Dir.glob(alternative_path + '/capybara-*.html').first, alternative_path)
+    path = File.expand_path(Dir.glob("#{alternative_path}/capybara-*.html").first, alternative_path)
     expect(result).to eq(path)
   end
 

data/lib/capybara/spec/spec_helper.rb

@@ -58,7 +58,7 @@ module Capybara
 
       def run_specs(session, name, **options, &filter_block)
         specs = @specs
-        RSpec.describe Capybara::Session, name, options do # rubocop:disable RSpec/EmptyExampleGroup
+        RSpec.describe Capybara::Session, name, options do
           include Capybara::SpecHelper
           include Capybara::RSpecMatchers
 
@@ -72,11 +72,11 @@ module Capybara
           end
 
           before :each, psc: true do
-            SpecHelper.reset_threadsafe(true, session)
+            SpecHelper.reset_threadsafe(bool: true, session: session)
           end
 
           after psc: true do
-            SpecHelper.reset_threadsafe(false, session)
+            SpecHelper.reset_threadsafe(session: session)
           end
 
           before :each, :exact_false do
@@ -84,15 +84,16 @@ module Capybara
           end
 
           specs.each do |spec_name, spec_options, block|
-            describe spec_name, *spec_options do # rubocop:disable RSpec/EmptyExampleGroup
+            describe spec_name, *spec_options do
               class_eval(&block)
             end
           end
         end
       end
 
-      def reset_threadsafe(bool = false, session = nil)
-        Capybara::Session.class_variable_set(:@@instance_created, false) # Work around limit on when threadsafe can be changed
+      def reset_threadsafe(bool: false, session: nil)
+        # Work around limit on when threadsafe can be changed
+        Capybara::Session.class_variable_set(:@@instance_created, false) # rubocop:disable Style/ClassVars
         Capybara.threadsafe = bool
         session = session.current_session if session.respond_to?(:current_session)
         session&.instance_variable_set(:@config, nil)
@@ -108,11 +109,9 @@ module Capybara
       stream.reopen(old_stream)
     end
 
-    def quietly
-      silence_stream(STDOUT) do
-        silence_stream(STDERR) do
-          yield
-        end
+    def quietly(&block)
+      silence_stream($stdout) do
+        silence_stream($stderr, &block)
       end
     end
 
@@ -132,4 +131,4 @@ module Capybara
   end
 end
 
-Dir[File.dirname(__FILE__) + '/session/**/*.rb'].each { |file| require_relative file }
+Dir["#{File.dirname(__FILE__)}/session/**/*.rb"].each { |file| require_relative file }

data/lib/capybara/spec/test_app.rb

@@ -9,6 +9,7 @@ class TestApp < Sinatra::Base
   class TestAppError < Exception; end # rubocop:disable Lint/InheritException
   class TestAppOtherError < Exception # rubocop:disable Lint/InheritException
     def initialize(string1, msg)
+      super()
       @something = string1
       @message = msg
     end
@@ -33,6 +34,10 @@ class TestApp < Sinatra::Base
     redirect '/redirect_again'
   end
 
+  get '/redirect_with_fragment' do
+    redirect '/landed#with_fragment'
+  end
+
   get '/redirect_again' do
     redirect '/landed'
   end
@@ -85,11 +90,11 @@ class TestApp < Sinatra::Base
   end
 
   get '/form/get' do
-    '<pre id="results">' + params[:form].to_yaml + '</pre>'
+    %(<pre id="results">#{params[:form].to_yaml}</pre>)
   end
 
   post '/relative' do
-    '<pre id="results">' + params[:form].to_yaml + '</pre>'
+    %(<pre id="results">#{params[:form].to_yaml}</pre>)
   end
 
   get '/favicon.ico' do
@@ -176,7 +181,7 @@ class TestApp < Sinatra::Base
 
   post '/form' do
     self.class.form_post_count += 1
-    '<pre id="results">' + params[:form].merge('post_count' => self.class.form_post_count).to_yaml + '</pre>'
+    %(<pre id="results">#{params[:form].merge('post_count' => self.class.form_post_count).to_yaml}</pre>)
   end
 
   post '/upload_empty' do

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

@@ -456,6 +456,12 @@ New line after and before textarea tag
     <button type="submit" name="form[no_value]">No Value!</button>
     <button id="no_type">No Type!</button>
     <button><img alt="A horse eating hay"/></button>
+    <button id="button_with_label"></button>
+    <label for="button_with_label">button with label element</label>
+    <label>
+      button within label element
+      <button></button>
+    </label>
     <input type="button" disabled="disabled" value="Disabled button"/>
     <span role="button">ARIA button</span>
   </p>
@@ -684,3 +690,15 @@ New line after and before textarea tag
 <p>
   <input id="special" {custom}="abcdef" value="custom attribute"/>
 </p>
+
+
+<label for="multi_label_checkbox">
+  Label to click
+</label>
+<div>Something random that justifies the usage of a separate label</div>
+<label>
+  <div>
+    <input type="checkbox" id="multi_label_checkbox" style="display: none"/>
+    <div>Visual representation of the checkbox</div>
+  </div>
+</label>

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

@@ -18,6 +18,14 @@
       });
     </script>
     <style>
+      html {
+        scroll-behavior: smooth;
+      }
+
+      body {
+        min-height: 2000px;
+      }
+
       .transition.away {
           width: 0%;
       }

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

@@ -152,6 +152,7 @@
       <p>This is an HTML5 draggable element.</p>
     </div>
 
+    <div id="shadow"></div>
     <script type="text/javascript">
       // a javascript comment
       var aVar = 123;

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

@@ -2,7 +2,7 @@
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
     <title>with_sortable_js</title>
-    <script src="https://sortablejs.github.io/Sortable/Sortable.js" type="text/javascript"></script>
+    <script src="https://cdn.jsdelivr.net/npm/sortablejs@1.12.0/dist/sortable.umd.min.js" type="text/javascript"></script>
   </head>
 
   <body id="with_sortable_js">