capybara 3.16.1 → 3.33.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].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
@@ -59,6 +61,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method default_normalize_ws
     #   See {Capybara.configure}
+    # @!method w3c_click_offset
+    #   See {Capybara.configure}
 
     remove_method :server_host
 
@@ -77,24 +81,22 @@ module Capybara
 
     remove_method :app_host=
     def app_host=(url)
-      raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." if url && url !~ URI::DEFAULT_PARSER.make_regexp
+      unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+        raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}."
+      end
 
       @app_host = url
     end
 
     remove_method :default_host=
     def default_host=(url)
-      raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." if url && url !~ URI::DEFAULT_PARSER.make_regexp
+      unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+        raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}."
+      end
 
       @default_host = url
     end
 
-    remove_method :disable_animation=
-    def disable_animation=(bool_or_allowlist)
-      warn 'Capybara.disable_animation is a beta feature - it may change/disappear in a future point version' if bool_or_allowlist
-      @disable_animation = bool_or_allowlist
-    end
-
     remove_method :test_id=
     ##
     #
@@ -102,7 +104,7 @@ module Capybara
     # This attribute will be checked by builtin selector types whenever id would normally be checked.
     # If `nil` then it will be ignored.
     #
-    #  @params [String, Symbol, nil] id Name of the attribute to use as the test id
+    # @param [String, Symbol, nil] id Name of the attribute to use as the test id
     #
     def test_id=(id)
       @test_id = id&.to_sym

data/lib/capybara/session/matchers.rb

@@ -20,7 +20,7 @@ module Capybara
     # @return [true]
     #
     def assert_current_path(path, **options)
-      _verify_current_path(path, options) do |query|
+      _verify_current_path(path, **options) do |query|
         raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
       end
     end
@@ -36,7 +36,7 @@ module Capybara
     # @return [true]
     #
     def assert_no_current_path(path, **options)
-      _verify_current_path(path, options) do |query|
+      _verify_current_path(path, **options) do |query|
         raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self)
       end
     end
@@ -51,7 +51,7 @@ module Capybara
     # @return [Boolean]
     #
     def has_current_path?(path, **options)
-      make_predicate(options) { assert_current_path(path, options) }
+      make_predicate(options) { assert_current_path(path, **options) }
     end
 
     ##
@@ -64,13 +64,13 @@ module Capybara
     # @return [Boolean]
     #
     def has_no_current_path?(path, **options)
-      make_predicate(options) { assert_no_current_path(path, options) }
+      make_predicate(options) { assert_no_current_path(path, **options) }
     end
 
   private
 
-    def _verify_current_path(path, options)
-      query = Capybara::Queries::CurrentPathQuery.new(path, options)
+    def _verify_current_path(path, **options)
+      query = Capybara::Queries::CurrentPathQuery.new(path, **options)
       document.synchronize(query.wait) do
         yield(query)
       end

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

@@ -0,0 +1,6 @@
+$(function() {
+  $(document).on('click dblclick contextmenu', function(e){
+    e.preventDefault();
+    $(document.body).append('<div id="has-been-clicked">Has been clicked at ' + e.clientX + ',' + e.clientY + '</div>');
+  })
+})

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

@@ -1,24 +1,95 @@
 var activeRequests = 0;
 $(function() {
   $('#change').text('I changed it');
-  $('#drag, #drag_scroll, #drag_link').draggable();
+  $('#drag, #drag_scroll, #drag_link').draggable({
+    start: function(event, ui){
+      $(document.body).append(
+        "<div class='drag_start'>Dragged!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "") +
+          "</div>"
+      );
+    }
+  });
   $('#drop, #drop_scroll').droppable({
     tolerance: 'touch',
     drop: function(event, ui) {
       ui.draggable.remove();
-      $(this).html('Dropped!');
+      $(this).html(
+        "Dropped!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "")
+      );
     }
   });
   $('#drag_html5, #drag_html5_scroll').on('dragstart', function(ev){
+    $(document.body).append(
+        "<div class='drag_start'>HTML5 Dragged!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "") +
+          "</div>"
+    );
     ev.originalEvent.dataTransfer.setData("text", ev.target.id);
   });
+  $('#drag_html5, #drag_html5_scroll').on('dragend', function(ev){
+    $(this).after('<div class="log">DragEnd with client position: ' + ev.clientX + ',' + ev.clientY)
+  });
   $('#drop_html5, #drop_html5_scroll').on('dragover', function(ev){
     $(this).after('<div class="log">DragOver with client position: ' + ev.clientX + ',' + ev.clientY)
     if ($(this).hasClass('drop')) { ev.preventDefault(); }
   });
+  $('#drop_html5, #drop_html5_scroll').on('dragleave', function(ev){
+    $(this).after('<div class="log">DragLeave with client position: ' + ev.clientX + ',' + ev.clientY)
+    if ($(this).hasClass('drop')) { ev.preventDefault(); }
+  });
+  $('#drop_html5, #drop_html5_scroll').on('drop', function(ev){
+    $(this).after('<div class="log">Drop with client position: ' + ev.clientX + ',' + ev.clientY)
+    if ($(this).hasClass('drop')) { ev.preventDefault(); }
+  });
   $('#drop_html5, #drop_html5_scroll').on('drop', function(ev){
     ev.preventDefault();
-    $(this).html('HTML5 Dropped ' + ev.originalEvent.dataTransfer.getData("text"));
+    var oev = ev.originalEvent;
+    if (oev.dataTransfer.items) {
+      for (var i = 0; i < oev.dataTransfer.items.length; i++){
+        var item = oev.dataTransfer.items[i];
+        if (item.kind === 'file'){
+          var file = item.getAsFile();
+          $(this).append('HTML5 Dropped file: ' + file.name);
+        } else {
+          var _this = this;
+          var callback = (function(type) {
+            return function(s) {
+              $(_this).append(
+                "HTML5 Dropped string: " +
+                  type +
+                  " " +
+                  s +
+                  (ev.altKey ? "-alt" : "") +
+                  (ev.ctrlKey ? "-ctrl" : "") +
+                  (ev.metaKey ? "-meta" : "") +
+                  (ev.shiftKey ? "-shift" : "")
+              );
+            };
+          })(item.type);
+          item.getAsString(callback);
+        }
+      }
+    } else {
+      $(this).html('HTML5 Dropped ' + oev.dataTransfer.getData("text"));
+      for (var i = 0; i < oev.dataTransfer.files.length; i++) {
+        $(this).append('HTML5 Dropped file: ' + oev.dataTransfer.files[i].name);
+      }
+      for (var i = 0; i < oev.dataTransfer.types.length; i++) {
+        var type = oev.dataTransfer.types[i];
+        $(this).append('HTML5 Dropped string: ' + type + ' ' + oev.dataTransfer.getData(type));
+      }
+    }
   });
   $('#clickable').click(function(e) {
     var link = $(this);
@@ -37,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() {
@@ -82,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 ';
@@ -108,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() {
@@ -180,7 +269,7 @@ $(function() {
     sessionStorage.setItem('session', 'session_value');
     localStorage.setItem('local', 'local value');
   });
-  $('#multiple-file').change(function(e){
-    $('body').append($('<p class="file_change"input_event_triggered">File input changed</p>'));
+  $('#multiple-file, #hidden_file').change(function(e){
+    $('body').append($('<p class="file_change">File input changed</p>'));
   })
 });

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

@@ -30,16 +30,56 @@ Capybara::SpecHelper.spec '#all' do
 
   it 'should accept an XPath instance', :exact_false do
     @session.visit('/form')
-    @xpath = Capybara::Selector[:fillable_field].call('Name')
+    @xpath = Capybara::Selector.new(:fillable_field, config: {}, format: :xpath).call('Name')
     expect(@xpath).to be_a(::XPath::Union)
     @result = @session.all(@xpath).map(&:value)
     expect(@result).to include('Smith', 'John', 'John Smith')
   end
 
+  it 'should allow reversing the order' do
+    @session.visit('/form')
+    fields = @session.all(:fillable_field, 'Name', exact: false).to_a
+    reverse_fields = @session.all(:fillable_field, 'Name', order: :reverse, exact: false).to_a
+    expect(fields).to eq(reverse_fields.reverse)
+  end
+
   it 'should raise an error when given invalid options' do
     expect { @session.all('//p', schmoo: 'foo') }.to raise_error(ArgumentError)
   end
 
+  it 'should not reload by default', requires: [:driver] do
+    paras = @session.all(:css, 'p', minimum: 3)
+    expect { paras[0].text }.not_to raise_error
+    @session.refresh
+    expect { paras[0].text }.to raise_error do |err|
+      expect(err).to be_an_invalid_element_error(@session)
+    end
+  end
+
+  context 'with allow_reload' do
+    it 'should reload if true' do
+      paras = @session.all(:css, 'p', allow_reload: true, minimum: 3)
+      expect { paras[0].text }.not_to raise_error
+      @session.refresh
+      sleep 1 # Ensure page has started to reload
+      expect(paras[0]).to have_text('Lorem ipsum dolor')
+      expect(paras[1]).to have_text('Duis aute irure dolor')
+    end
+
+    it 'should not reload if false', requires: [:driver] do
+      paras = @session.all(:css, 'p', allow_reload: false, minimum: 3)
+      expect { paras[0].text }.not_to raise_error
+      @session.refresh
+      sleep 1 # Ensure page has started to reload
+      expect { paras[0].text }.to raise_error do |err|
+        expect(err).to be_an_invalid_element_error(@session)
+      end
+      expect { paras[2].text }.to raise_error do |err|
+        expect(err).to be_an_invalid_element_error(@session)
+      end
+    end
+  end
+
   context 'with css selectors' do
     it 'should find all elements using the given selector' do
       expect(@session.all(:css, 'h1').first.text).to eq('This is a test')
@@ -100,11 +140,35 @@ Capybara::SpecHelper.spec '#all' do
     end
   end
 
+  context 'with obscured filter', requires: [:css] do
+    it 'should only find nodes on top in the viewport when false' do
+      expect(@session.all(:css, 'a.simple', obscured: false).size).to eq(1)
+    end
+
+    it 'should not find nodes on top outside the viewport when false' do
+      expect(@session.all(:link, 'Download Me', obscured: false).size).to eq(0)
+      @session.scroll_to(@session.find_link('Download Me'))
+      expect(@session.all(:link, 'Download Me', obscured: false).size).to eq(1)
+    end
+
+    it 'should find top nodes outside the viewport when true' do
+      expect(@session.all(:link, 'Download Me', obscured: true).size).to eq(1)
+      @session.scroll_to(@session.find_link('Download Me'))
+      expect(@session.all(:link, 'Download Me', obscured: true).size).to eq(0)
+    end
+
+    it 'should only find non-top nodes when true' do
+      # Also need visible: false so visibility is ignored
+      expect(@session.all(:css, 'a.simple', visible: false, obscured: true).size).to eq(1)
+    end
+  end
+
   context 'with element count filters' do
     context ':count' do
       it 'should succeed when the number of elements founds matches the expectation' do
         expect { @session.all(:css, 'h1, p', count: 4) }.not_to raise_error
       end
+
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
         expect { @session.all(:css, 'h1, p', count: 5) }.to raise_error(Capybara::ExpectationNotMet)
       end
@@ -114,6 +178,7 @@ Capybara::SpecHelper.spec '#all' do
       it 'should succeed when the number of elements founds matches the expectation' do
         expect { @session.all(:css, 'h1, p', minimum: 0) }.not_to raise_error
       end
+
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
         expect { @session.all(:css, 'h1, p', minimum: 5) }.to raise_error(Capybara::ExpectationNotMet)
       end
@@ -123,6 +188,7 @@ Capybara::SpecHelper.spec '#all' do
       it 'should succeed when the number of elements founds matches the expectation' do
         expect { @session.all(:css, 'h1, p', maximum: 4) }.not_to raise_error
       end
+
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
         expect { @session.all(:css, 'h1, p', maximum: 0) }.to raise_error(Capybara::ExpectationNotMet)
       end
@@ -132,6 +198,7 @@ Capybara::SpecHelper.spec '#all' do
       it 'should succeed when the number of elements founds matches the expectation' do
         expect { @session.all(:css, 'h1, p', between: 2..7) }.not_to raise_error
       end
+
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
         expect { @session.all(:css, 'h1, p', between: 0..3) }.to raise_error(Capybara::ExpectationNotMet)
       end
@@ -142,6 +209,13 @@ Capybara::SpecHelper.spec '#all' do
           expect { @session.all(:css, 'h1, p', between: 5..) }.to raise_error(Capybara::ExpectationNotMet)
         end
       TEST
+
+      eval <<~TEST, binding, __FILE__, __LINE__ + 1 if RUBY_VERSION.to_f > 2.6
+        it'treats a beginless range as maximum' do
+          expect { @session.all(:css, 'h1, p', between: ..7) }.not_to raise_error
+          expect { @session.all(:css, 'h1, p', between: ..3) }.to raise_error(Capybara::ExpectationNotMet)
+        end
+      TEST
     end
 
     context 'with multiple count filters' do
@@ -150,32 +224,36 @@ Capybara::SpecHelper.spec '#all' do
               minimum: 5,
               maximum: 0,
               between: 0..3 }
-        expect { @session.all(:css, 'h1, p', o) }.not_to raise_error
+        expect { @session.all(:css, 'h1, p', **o) }.not_to raise_error
       end
+
       context 'with no :count expectation' do
         it 'fails if :minimum is not met' do
           o = { minimum: 5,
                 maximum: 4,
                 between: 2..7 }
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
+
         it 'fails if :maximum is not met' do
           o = { minimum: 0,
                 maximum: 0,
                 between: 2..7 }
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
+
         it 'fails if :between is not met' do
           o = { minimum: 0,
                 maximum: 4,
                 between: 0..3 }
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
+
         it 'succeeds if all combineable expectations are met' do
           o = { minimum: 0,
                 maximum: 4,
                 between: 2..7 }
-          expect { @session.all(:css, 'h1, p', o) }.not_to raise_error
+          expect { @session.all(:css, 'h1, p', **o) }.not_to raise_error
         end
       end
     end

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

@@ -20,6 +20,11 @@ Capybara::SpecHelper.spec '#ancestor' do
     expect(el.ancestor('//div', text: "Ancestor\nAncestor\nAncestor")[:id]).to eq('ancestor3')
   end
 
+  it 'should find the closest ancestor' do
+    el = @session.find(:css, '#child')
+    expect(el.ancestor('.//div', order: :reverse, match: :first)[:id]).to eq('ancestor1')
+  end
+
   it 'should raise an error if there are multiple matches' do
     el = @session.find(:css, '#child')
     expect { el.ancestor('//div') }.to raise_error(Capybara::Ambiguous)

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

@@ -37,7 +37,9 @@ Capybara::SpecHelper.spec '#assert_current_path' do
   end
 
   it 'should not cause an exception when current_url is nil' do
-    allow_any_instance_of(Capybara::Session).to receive(:current_url).and_return(nil)
+    allow(@session).to receive(:current_url).and_return(nil)
+    allow(@session.page).to receive(:current_url).and_return(nil) if @session.respond_to? :page
+
     expect { @session.assert_current_path(nil) }.not_to raise_error
   end
 end
@@ -65,7 +67,8 @@ Capybara::SpecHelper.spec '#assert_no_current_path?' do
   end
 
   it 'should not cause an exception when current_url is nil' do
-    allow_any_instance_of(Capybara::Session).to receive(:current_url).and_return(nil)
+    allow(@session).to receive(:current_url).and_return(nil)
+    allow(@session.page).to receive(:current_url).and_return(nil) if @session.respond_to? :page
 
     expect { @session.assert_no_current_path('/with_html') }.not_to raise_error
   end