capybara 3.10.1 → 3.11.0

data/lib/capybara/selenium/driver.rb

@@ -225,7 +225,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       ::Selenium::WebDriver::Error::StaleElementReferenceError,
       ::Selenium::WebDriver::Error::UnhandledError,
       ::Selenium::WebDriver::Error::ElementNotVisibleError,
-      ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around a race condition that can occur with chromedriver and #go_back/#go_forward
+      ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around a chromedriver go_back/go_forward race condition
       ::Selenium::WebDriver::Error::ElementNotInteractableError,
       ::Selenium::WebDriver::Error::ElementClickInterceptedError,
       ::Selenium::WebDriver::Error::InvalidElementStateError,
@@ -352,11 +352,15 @@ private
     when :chrome
       extend ChromeDriver
     when :firefox
-      require 'capybara/selenium/patches/pause_duration_fix' if sel_driver.capabilities['moz:geckodriverVersion']&.start_with?('0.22.')
+      require 'capybara/selenium/patches/pause_duration_fix' if pause_broken?(sel_driver)
       extend MarionetteDriver if sel_driver.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
     end
   end
 
+  def pause_broken?(driver)
+    driver.capabilities['moz:geckodriverVersion']&.start_with?('0.22.')
+  end
+
   def setup_exit_handler
     main = Process.pid
     at_exit do

data/lib/capybara/selenium/node.rb

@@ -170,22 +170,9 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
       selector = node[:tagName]
       if node[:namespaceURI] != default_ns
         selector = XPath.child.where((XPath.local_name == selector) & (XPath.namespace_uri == node[:namespaceURI])).to_s
-        selector
       end
 
-      if parent
-        siblings = parent.find_xpath(selector)
-        selector += case siblings.size
-        when 0
-          '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)
-        when 1
-          '' # index not necessary when only one matching element
-        else
-          idx = siblings.index(node)
-          # Element may not be found in the siblings if it has gone away
-          idx.nil? ? '[ERROR]' : "[#{idx + 1}]"
-        end
-      end
+      selector += sibling_index(parent, node, selector) if parent
       result.push selector
     end
 
@@ -203,6 +190,20 @@ protected
 
 private
 
+  def sibling_index(parent, node, selector)
+    siblings = parent.find_xpath(selector)
+    case siblings.size
+    when 0
+      '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)
+    when 1
+      '' # index not necessary when only one matching element
+    else
+      idx = siblings.index(node)
+      # Element may not be found in the siblings if it has gone away
+      idx.nil? ? '[ERROR]' : "[#{idx + 1}]"
+    end
+  end
+
   def boolean_attr(val)
     val && (val != 'false')
   end

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

@@ -9,8 +9,9 @@ class Capybara::Selenium::MarionetteNode < Capybara::Selenium::Node
     super
   rescue ::Selenium::WebDriver::Error::ElementNotInteractableError
     if tag_name == 'tr'
-      warn 'You are attempting to click a table row which has issues in geckodriver/marionette - see https://github.com/mozilla/geckodriver/issues/1228. ' \
-           'Your test should probably be clicking on a table cell like a user would. Clicking the first cell in the row instead.'
+      warn 'You are attempting to click a table row which has issues in geckodriver/marionette - '\
+           'see https://github.com/mozilla/geckodriver/issues/1228. Your test should probably be '\
+           'clicking on a table cell like a user would. Clicking the first cell in the row instead.'
       return find_css('th:first-child,td:first-child')[0].click(keys, options)
     end
     raise
@@ -26,7 +27,7 @@ class Capybara::Selenium::MarionetteNode < Capybara::Selenium::Node
     if %w[option optgroup].include? tag_name
       find_xpath('parent::*[self::optgroup or self::select]')[0].disabled?
     else
-      !find_xpath('parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]').empty?
+      !find_xpath(DISABLED_BY_FIELDSET_XPATH).empty?
     end
   end
 
@@ -99,14 +100,27 @@ private
     return nil unless local_file
     raise ArgumentError, "You may only upload files: #{local_file.inspect}" unless File.file?(local_file)
 
-    result = bridge.http.call(:post, "session/#{bridge.session_id}/file", file: Selenium::WebDriver::Zipper.zip_file(local_file))
-    result['value']
+    file = ::Selenium::WebDriver::Zipper.zip_file(local_file)
+    bridge.http.call(:post, "session/#{bridge.session_id}/file", file: file)['value']
   end
 
   def browser_version
     driver.browser.capabilities[:browser_version].to_f
   end
 
+  DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|
+    x.parent(:fieldset)[
+      x.attr(:disabled)
+    ] + x.ancestor[
+      ~x.self(:legned) |
+      x.preceding_sibling(:legend)
+    ][
+      x.parent(:fieldset)[
+        x.attr(:disabled)
+      ]
+    ]
+  end.to_s.freeze
+
   class ModifierKeysStack
     def initialize
       @stack = []

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

@@ -6,6 +6,4 @@ module PauseDurationFix
   end
 end
 
-if defined?(::Selenium::WebDriver::Interactions::Pause)
-  ::Selenium::WebDriver::Interactions::Pause.prepend PauseDurationFix
-end
+::Selenium::WebDriver::Interactions::Pause.prepend PauseDurationFix

data/lib/capybara/server.rb

@@ -18,7 +18,12 @@ module Capybara
 
     attr_reader :app, :port, :host
 
-    def initialize(app, *deprecated_options, port: Capybara.server_port, host: Capybara.server_host, reportable_errors: Capybara.server_errors, extra_middleware: [])
+    def initialize(app,
+                   *deprecated_options,
+                   port: Capybara.server_port,
+                   host: Capybara.server_host,
+                   reportable_errors: Capybara.server_errors,
+                   extra_middleware: [])
       warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments' unless deprecated_options.empty?
       @app = app
       @extra_middleware = extra_middleware

data/lib/capybara/server/animation_disabler.rb

@@ -16,7 +16,7 @@ module Capybara
 
       def initialize(app)
         @app = app
-        @disable_markup = format(DISABLE_MARKUP_TEMPLATE, selector: AnimationDisabler.selector_for(Capybara.disable_animation))
+        @disable_markup = format(DISABLE_MARKUP_TEMPLATE, selector: self.class.selector_for(Capybara.disable_animation))
       end
 
       def call(env)

data/lib/capybara/session.rb

@@ -43,7 +43,7 @@ module Capybara
       click_link_or_button click_button click_link
       fill_in find find_all find_button find_by_id find_field find_link
       has_content? has_text? has_css? has_no_content? has_no_text?
-      has_no_css? has_no_xpath? resolve has_xpath? select uncheck
+      has_no_css? has_no_xpath? has_xpath? select uncheck
       has_link? has_no_link? has_button? has_no_button? has_field?
       has_no_field? has_checked_field? has_unchecked_field?
       has_no_table? has_table? unselect has_select? has_no_select?
@@ -819,7 +819,9 @@ module Capybara
     end
 
     def prepare_path(path, extension)
-      File.expand_path(path || default_fn(extension), config.save_path).tap { |p_path| FileUtils.mkdir_p(File.dirname(p_path)) }
+      File.expand_path(path || default_fn(extension), config.save_path).tap do |p_path|
+        FileUtils.mkdir_p(File.dirname(p_path))
+      end
     end
 
     def default_fn(extension)

data/lib/capybara/session/matchers.rb

@@ -6,7 +6,7 @@ module Capybara
     # Asserts that the page has the given path.
     # By default, if passed a full url this will compare against the full url,
     # if passed a path only the path+query portion will be compared, if passed a regexp
-    # the comparison will depend on the :url option
+    # the comparison will depend on the :url option (path+query by default)
     #
     # @!macro current_path_query_params
     #   @overload $0(string, **options)
@@ -20,7 +20,9 @@ module Capybara
     # @return [true]
     #
     def assert_current_path(path, **options)
-      _verify_current_path(path, options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
+      _verify_current_path(path, options) do |query|
+        raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
+      end
     end
 
     ##
@@ -34,7 +36,9 @@ module Capybara
     # @return [true]
     #
     def assert_no_current_path(path, **options)
-      _verify_current_path(path, options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
+      _verify_current_path(path, options) do |query|
+        raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self)
+      end
     end
 
     ##

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

@@ -159,25 +159,25 @@ $(function() {
         $(this).attr('confirmed', 'false');
       }
     }
-  })
+  });
   $('#delayed-page-change').click(function() {
     setTimeout(function() {
       window.location.pathname = '/with_html'
     }, 500)
-  })
+  });
   $('#with-key-events').keydown(function(e){
     $('#key-events-output').append('keydown:'+e.which+' ')
   });
   $('#disable-on-click').click(function(e){
-    var input = this
+    var input = this;
     setTimeout(function() {
       input.disabled = true;
     }, 500)
-  })
+  });
   $('#set-storage').click(function(e){
     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>'));
   })

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

@@ -56,6 +56,11 @@ Capybara::SpecHelper.spec '#all' do
       expect(@session.all(:xpath, '//h1').first.text).to eq('This is a test')
       expect(@session.all(:xpath, "//input[@id='test_field']").first.value).to eq('monkey')
     end
+
+    it 'should use alternated regex for :id' do
+      expect(@session.all(:xpath, './/h2', id: /h2/).unfiltered_size).to eq 3
+      expect(@session.all(:xpath, './/h2', id: /h2(one|two)/).unfiltered_size).to eq 2
+    end
   end
 
   context 'with css as default selector' do

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

@@ -50,17 +50,17 @@ Capybara::SpecHelper.spec '#has_css?' do
     it 'should be able to generate an error message if the scope is a sibling' do
       el = @session.find(:css, '#first')
       @session.within el.sibling(:css, '#second') do
-        expect {
+        expect do
           expect(@session).to have_css('a#not_on_page')
-        }.to raise_error /there were no matches/
+        end.to raise_error(/there were no matches/)
       end
     end
 
     it 'should be able to generate an error message if the scope is a sibling from XPath' do
       el = @session.find(:css, '#first').find(:xpath, './following-sibling::*[1]') do
-        expect {
+        expect do
           expect(el).to have_css('a#not_on_page')
-        }.to raise_error /there were no matches/
+        end.to raise_error(/there were no matches/)
       end
     end
   end

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

@@ -41,6 +41,23 @@ Capybara::SpecHelper.spec '#has_field' do
       expect(@session).not_to have_field('First Name', with: 'John')
       expect(@session).not_to have_field('First Name', with: /John|Paul|George|Ringo/)
     end
+
+    it 'should output filter errors if only one element matched the selector but failed the filters' do
+      @session.fill_in('First Name', with: 'Thomas')
+      expect do
+        expect(@session).to have_field('First Name', with: 'Jonas')
+      end.to raise_exception(RSpec::Expectations::ExpectationNotMetError, /Expected value to be "Jonas" but was "Thomas"/)
+
+      # native boolean node filter
+      expect do
+        expect(@session).to have_field('First Name', readonly: true)
+      end.to raise_exception(RSpec::Expectations::ExpectationNotMetError, /Expected readonly true but it wasn't/)
+
+      # inherited boolean node filter
+      expect do
+        expect(@session).to have_field('form_pets_cat', checked: true)
+      end.to raise_exception(RSpec::Expectations::ExpectationNotMetError, /Expected checked true but it wasn't/)
+    end
   end
 
   context 'with type' do

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

@@ -411,6 +411,33 @@ Capybara::SpecHelper.spec 'node' do
       tr = @session.find(:css, '#agent_table tr:first-child').click
       expect(tr).to have_css('label', text: 'Clicked')
     end
+
+    it 'should retry clicking', requires: [:js] do
+      @session.visit('/obscured')
+      obscured = @session.find(:css, '#obscured')
+      @session.execute_script <<~JS
+        setTimeout(function(){ $('#cover').hide(); }, 1000)
+      JS
+      expect { obscured.click }.not_to raise_error
+    end
+
+    it 'should allow to retry longer', requires: [:js] do
+      @session.visit('/obscured')
+      obscured = @session.find(:css, '#obscured')
+      @session.execute_script <<~JS
+        setTimeout(function(){ $('#cover').hide(); }, 3000)
+      JS
+      expect { obscured.click(wait: 4) }.not_to raise_error
+    end
+
+    it 'should not retry clicking when wait is disabled', requires: [:js] do
+      @session.visit('/obscured')
+      obscured = @session.find(:css, '#obscured')
+      @session.execute_script <<~JS
+        setTimeout(function(){ $('#cover').hide(); }, 2000)
+      JS
+      expect { obscured.click(wait: 0) }.to(raise_error { |e| expect(e).to be_an_invalid_element_error(@session) })
+    end
   end
 
   describe '#double_click', requires: [:js] do
@@ -436,6 +463,15 @@ Capybara::SpecHelper.spec 'node' do
       expect(locations[:x].to_f).to be_within(1).of(10)
       expect(locations[:y].to_f).to be_within(1).of(5)
     end
+
+    it 'should retry clicking', requires: [:js] do
+      @session.visit('/obscured')
+      obscured = @session.find(:css, '#obscured')
+      @session.execute_script <<~JS
+        setTimeout(function(){ $('#cover').hide(); }, 1000)
+      JS
+      expect { obscured.double_click }.not_to raise_error
+    end
   end
 
   describe '#right_click', requires: [:js] do
@@ -461,6 +497,15 @@ Capybara::SpecHelper.spec 'node' do
       expect(locations[:x].to_f).to be_within(1).of(10)
       expect(locations[:y].to_f).to be_within(1).of(10)
     end
+
+    it 'should retry clicking', requires: [:js] do
+      @session.visit('/obscured')
+      obscured = @session.find(:css, '#obscured')
+      @session.execute_script <<~JS
+        setTimeout(function(){ $('#cover').hide(); }, 1000)
+      JS
+      expect { obscured.right_click }.not_to raise_error
+    end
   end
 
   describe '#send_keys', requires: [:send_keys] do
@@ -670,8 +715,4 @@ Capybara::SpecHelper.spec 'node' do
       end)
     end
   end
-
-  def be_an_invalid_element_error(session)
-    satisfy { |error| session.driver.invalid_element_errors.any? { |e| error.is_a? e } }
-  end
 end

data/lib/capybara/spec/spec_helper.rb

@@ -117,7 +117,12 @@ module Capybara
 
     def extract_results(session)
       expect(session).to have_xpath("//pre[@id='results']")
-      YAML.load Nokogiri::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+      # YAML.load Nokogiri::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+      YAML.load Capybara::HTML(session.body).xpath("//pre[@id='results']").first.inner_html.lstrip
+    end
+
+    def be_an_invalid_element_error(session)
+      satisfy { |error| session.driver.invalid_element_errors.any? { |e| error.is_a? e } }
     end
   end
 end

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

@@ -4,7 +4,7 @@
         <title>This is the child frame title</title>
         <script>
         function closeWin() {
-          var iframe = window.parent.document.getElementById('childFrame')
+          var iframe = window.parent.document.getElementById('childFrame');
           iframe.parentNode.removeChild(iframe)
         }
         </script>

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

@@ -0,0 +1,44 @@
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8"/>
+    <title>with_animation</title>
+    <script src="/jquery.js" type="text/javascript" charset="utf-8"></script>
+    <style>
+      div {
+        width: 400px;
+        height: 400px;
+        position: absolute;
+      }
+      #obscured {
+        z-index: 1;
+        background-color: red;
+      }
+      #cover {
+        z-index: 2;
+        background-color: blue;
+      }
+      #offscreen {
+        top: 2000px;
+        left: 2000px;
+        background-color: green;
+      }
+      #offscreen_wrapper {
+        top: 2000px;
+        left: 2000px;
+        overflow-x: scroll;
+        background-color: yellow;
+      }
+    </style>
+  </head>
+
+  <body id="with_animation">
+    <div id="obscured">
+      <input id="obscured_input"/>
+    </div>
+    <div id="cover"></div>
+    <div id="offscreen_wrapper">
+      <div id="offscreen"></div>
+    </div>
+  </body>
+</html>
+

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

@@ -10,7 +10,7 @@
 <h2 class="no text"></h2>
 <h2 class="head" id="h2one">Header Class Test One</h2>
 <h2 class="head" id="h2two">Header Class Test Two</h2>
-<h2 class="head">Header Class Test Three</h2>
+<h2 class="head" id="h2_">Header Class Test Three</h2>
 <h2 class="head">Header Class Test Four</h2>
 <h2 class="head">Header Class Test Five</h2>