capybara 3.31.0 → 3.34.0

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

@@ -27,17 +27,15 @@ module Capybara
 
       def log(type)
         data = begin
-                 execute :get_log, {}, type: type.to_s
-               rescue ::Selenium::WebDriver::Error::UnknownCommandError
-                 execute :get_log_legacy, {}, type: type.to_s
-               end
+          execute :get_log, {}, type: type.to_s
+        rescue ::Selenium::WebDriver::Error::UnknownCommandError
+          execute :get_log_legacy, {}, type: type.to_s
+        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/server/animation_disabler.rb

@@ -40,16 +40,17 @@ module Capybara
       end
 
       def insert_disable(html)
-        html.sub(%r{(</head>)}, disable_markup + '\\1')
+        html.sub(%r{(</head>)}, "#{disable_markup}\\1")
       end
 
       DISABLE_MARKUP_TEMPLATE = <<~HTML
         <script defer>(typeof jQuery !== 'undefined') && (jQuery.fx.off = true);</script>
         <style>
-           %<selector>s, %<selector>s::before, %<selector>s::after {
+          %<selector>s, %<selector>s::before, %<selector>s::after {
              transition: none !important;
              animation-duration: 0s !important;
              animation-delay: 0s !important;
+             scroll-behavior: auto !important;
           }
         </style>
       HTML

data/lib/capybara/server/middleware.rb

@@ -53,14 +53,16 @@ module Capybara
         if env['PATH_INFO'] == '/__identify__'
           [200, {}, [@app.object_id.to_s]]
         else
-          @counter.increment(env['REQUEST_URI'])
+          request_uri = env['REQUEST_URI']
+          @counter.increment(request_uri)
+
           begin
             @extended_app.call(env)
           rescue *@server_errors => e
             @error ||= e
             raise e
           ensure
-            @counter.decrement(env['REQUEST_URI'])
+            @counter.decrement(request_uri)
           end
         end
       end

data/lib/capybara/session.rb

@@ -58,7 +58,7 @@ module Capybara
     ].freeze
     SESSION_METHODS = %i[
       body html source current_url current_host current_path
-      execute_script evaluate_script visit refresh go_back go_forward
+      execute_script evaluate_script visit refresh go_back go_forward send_keys
       within within_element within_fieldset within_table within_frame switch_to_frame
       current_window windows open_new_window switch_to_window within_window window_opened_by
       save_page save_and_open_page save_screenshot
@@ -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
@@ -303,6 +303,14 @@ module Capybara
       driver.go_forward
     end
 
+    ##
+    # @!method send_keys
+    #   @see Capybara::Node::Element#send_keys
+    #
+    def send_keys(*args, **kw_args)
+      driver.send_keys(*args, **kw_args)
+    end
+
     ##
     #
     # Executes the given block within the context of a node. {#within} takes the
@@ -355,8 +363,8 @@ module Capybara
     #
     # @param [String] locator    Id or legend of the fieldset
     #
-    def within_fieldset(locator)
-      within(:fieldset, locator) { yield }
+    def within_fieldset(locator, &block)
+      within(:fieldset, locator, &block)
     end
 
     ##
@@ -365,8 +373,8 @@ module Capybara
     #
     # @param [String] locator    Id or caption of the table
     #
-    def within_table(locator)
-      within(:table, locator) { yield }
+    def within_table(locator, &block)
+      within(:table, locator, &block)
     end
 
     ##
@@ -398,8 +406,9 @@ module Capybara
         driver.switch_to_frame(:parent)
       when :top
         idx = scopes.index(:frame)
+        top_level_scopes = [:frame, nil]
         if idx
-          if scopes.slice(idx..-1).any? { |scope| ![:frame, nil].include?(scope) }
+          if scopes.slice(idx..-1).any? { |scope| !top_level_scopes.include?(scope) }
             raise Capybara::ScopeError, "`switch_to_frame(:top)` cannot be called from inside a descendant frame's "\
                                         '`within` block.'
           end
@@ -488,8 +497,8 @@ module Capybara
     # @raise [ArgumentError]               if both or neither arguments were provided
     #
     def switch_to_window(window = nil, **options, &window_locator)
-      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && block_given?
-      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !block_given?
+      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator
+      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator
 
       unless scopes.last.nil?
         raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from '\
@@ -738,7 +747,7 @@ module Capybara
     # @param [Hash] options   a customizable set of options
     #
     def save_and_open_screenshot(path = nil, **options)
-      save_screenshot(path, **options).tap { |s_path| open_file(s_path) } # rubocop:disable Lint/Debugger
+      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }
     end
 
     def document
@@ -788,7 +797,7 @@ module Capybara
     #
     # Yield a block using a specific maximum wait time.
     #
-    def using_wait_time(seconds)
+    def using_wait_time(seconds, &block)
       if Capybara.threadsafe
         begin
           previous_wait_time = config.default_max_wait_time
@@ -798,7 +807,7 @@ module Capybara
           config.default_max_wait_time = previous_wait_time
         end
       else
-        Capybara.using_wait_time(seconds) { yield }
+        Capybara.using_wait_time(seconds, &block)
       end
     end
 

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() {
@@ -153,6 +160,7 @@ $(function() {
   });
   $('#click-test').on({
     click: function(e) {
+      window.click_delay = ((new Date().getTime()) - window.mouse_down_time)/1000.0;
       var desc = "";
       if (e.altKey) desc += 'alt ';
       if (e.ctrlKey) desc += 'control ';
@@ -179,6 +187,16 @@ $(function() {
       if (e.shiftKey) desc += 'shift ';
       var pos = this.getBoundingClientRect();
       $(this).after('<a id="has-been-right-clicked" href="#">Has been ' + desc + 'right clicked at ' + (e.clientX - pos.left) + ',' + (e.clientY - pos.top) + '</a>');
+    },
+    mousedown: function(e) {
+      window.click_delay = undefined;
+      window.right_click_delay = undefined;
+      window.mouse_down_time = new Date().getTime();
+    },
+    mouseup: function(e) {
+      if (e.button == 2){
+        window.right_click_delay = ((new Date().getTime()) - window.mouse_down_time)/1000.0;
+      }
     }
   });
   $('#open-alert').click(function() {
@@ -253,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/fill_in_spec.rb

@@ -47,6 +47,15 @@ Capybara::SpecHelper.spec '#fill_in' do
     expect(extract_results(@session)['description']).to eq('Texty text')
   end
 
+  it 'should fill in a textarea in a reasonable time by default' do
+    textarea = @session.find(:fillable_field, 'form[description]')
+    value = 'a' * 4000
+    start = Time.now
+    textarea.fill_in(with: value)
+    expect(Time.now.to_f).to be_within(0.25).of start.to_f
+    expect(textarea.value).to eq value
+  end
+
   it 'should fill in a password field by id' do
     @session.fill_in('form_password', with: 'supasikrit')
     @session.click_button('awesome')

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

@@ -451,32 +451,35 @@ Capybara::SpecHelper.spec '#find' do
   context 'with spatial filters', requires: [:spatial] do
     before do
       @session.visit('/spatial')
-      @center = @session.find(:css, 'div.center')
+    end
+
+    let :center do
+      @session.find(:css, 'div.center')
     end
 
     it 'should find an element above another element' do
-      expect(@session.find(:css, 'div:not(.corner)', above: @center).text).to eq('2')
+      expect(@session.find(:css, 'div:not(.corner)', above: center).text).to eq('2')
     end
 
     it 'should find an element below another element' do
-      expect(@session.find(:css, 'div:not(.corner):not(.footer)', below: @center).text).to eq('8')
+      expect(@session.find(:css, 'div:not(.corner):not(.footer)', below: center).text).to eq('8')
     end
 
     it 'should find an element left of another element' do
-      expect(@session.find(:css, 'div:not(.corner)', left_of: @center).text).to eq('4')
+      expect(@session.find(:css, 'div:not(.corner)', left_of: center).text).to eq('4')
     end
 
     it 'should find an element right of another element' do
-      expect(@session.find(:css, 'div:not(.corner)', right_of: @center).text).to eq('6')
+      expect(@session.find(:css, 'div:not(.corner)', right_of: center).text).to eq('6')
     end
 
     it 'should combine spatial filters' do
-      expect(@session.find(:css, 'div', left_of: @center, above: @center).text).to eq('1')
-      expect(@session.find(:css, 'div', right_of: @center, below: @center).text).to eq('9')
+      expect(@session.find(:css, 'div', left_of: center, above: center).text).to eq('1')
+      expect(@session.find(:css, 'div', right_of: center, below: center).text).to eq('9')
     end
 
     it 'should find an element "near" another element' do
-      expect(@session.find(:css, 'div.distance', near: @center).text).to eq('2')
+      expect(@session.find(:css, 'div.distance', near: center).text).to eq('2')
     end
   end
 

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,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 +76,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