capybara 3.15.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 023614c44b5551f29984d882a7fb13b5ff240f589eff090cfb24c4f3a2787a47
-  data.tar.gz: c5c1cd40b59700f743325cca40efbe9fd68df776c7f16f6d351336400e86cdd4
+  metadata.gz: e077e28912ed7973882a0394db7eb44c493b0546175f81ef6f15c8ad1ee564c1
+  data.tar.gz: 6efae1078877ffe1578dc28d83f6d8df338dc01a162214c5b3aa3bd625c6a426
 SHA512:
-  metadata.gz: a76732bb72e5e5daefaf55a2bc4c895ef56d109905b9b3b2a5c96e229d97d783f1044dd6971ed21d4e63e55200a5e00a4641f50698f79346767fe498a5b894ad
-  data.tar.gz: ac8d9499807a093c26ca861ed204087702b1a3713b757c6e9d84d43f399b38db36b3b1ab28471413dfd385b442b7636abe9f16194ae4ef17395a16d5e92b7a1c
+  metadata.gz: 48d7420e5621c0dafbff830bfa56aba6ccf1d171d9efd0081f30f95f0cc538fa655d6fd5bef5525d13da573f51993f443f89b20af9b2241e4b9194b6ca3d2ae1
+  data.tar.gz: e7470806d56a47cbb6a2b12690816cc0cb569d26032ccae32ad2d832f356d59235f156651a8422ba70259021f9e47a81ad43f4d3e97612891e7e98c6eb1c857e

data/History.md

@@ -1,3 +1,42 @@
+# Version 3.17.0
+Release date: 2019-04-18
+
+### Added
+
+* Initial support for selenium-webdriver 4.0.0.alpha1
+* :button selector will now also match on `name` attribute
+
+### Fixed
+
+* Suppress warnings generated by using selenium-webdriver 3.141.5926
+* Mask Appium issue with finder visibility optimizations (non-optimal)
+
+# Version 3.16.2
+Release date: 2019-04-10
+
+### Fixed
+
+* Fix Session#quit resetting of memoized document
+
+# Version 3.16.1
+Release date: 2019-03-30
+
+### Fixed
+
+* Fix potential 'uninitialized constant' error when using the :selenium_chrome driver [jeffclemens-ab]
+
+# Version 3.16
+Release date: 2019-03-28
+
+### Changed
+
+* Ruby 2.4.0+ is now required
+* Selenium driver now defaults to using a persistent http client connection
+
+### Added
+
+* :wait option in predicates now accepts `true` to selectively override when `Capybara.predicates_wait == false`
+
 # Version 3.15
 Release date: 2019-03-19
 

data/README.md

@@ -6,7 +6,7 @@
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jnicklas/capybara?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=capybara&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=capybara&package-manager=bundler&version-scheme=semver)
 
-**Note** You are viewing the README for the 3.15.x version of Capybara.
+**Note** You are viewing the README for the 3.17.x version of Capybara.
 
 
 Capybara helps you test web applications by simulating how a real user would
@@ -76,7 +76,7 @@ GitHub): http://groups.google.com/group/ruby-capybara
 
 ## <a name="setup"></a>Setup
 
-Capybara requires Ruby 2.3.0 or later. To install, add this line to your
+Capybara requires Ruby 2.4.0 or later. To install, add this line to your
 `Gemfile` and run `bundle install`:
 
 ```ruby
@@ -419,7 +419,7 @@ teamcapybara repo once completely stable.
 
 ### <a name="capybara-webkit"></a>Capybara-webkit
 
-Note: `capybara-webkit` depends on QtWebkit which went EOL quite some time ago. There has been an attempt to revive the project but `capybara-webkit` is not yet (AFAIK) compatible with the revived version of QtWebKit (could be a good OSS project for someone) and as such is still limited to an old version of QtWebKit.  This means its support for modern JS and CSS is severely limited.
+Note: `capybara-webkit` depends on QtWebkit which went end-of-life quite some time ago. There has been an attempt to revive the project but `capybara-webkit` is not yet (as far as I know) compatible with the revived version of QtWebKit (could be a good open source project for someone) and as such is still limited to an old version of QtWebKit.  This means its support for modern JS and CSS is severely limited.
 
 The [capybara-webkit driver](https://github.com/thoughtbot/capybara-webkit) is for true headless
 testing. It uses QtWebKit to start a rendering engine process. It can execute JavaScript as well.

data/lib/capybara/config.rb

@@ -7,8 +7,7 @@ module Capybara
   class Config
     extend Forwardable
 
-    OPTIONS = %i[app reuse_server threadsafe default_wait_time server
-                 default_driver javascript_driver allow_gumbo].freeze
+    OPTIONS = %i[app reuse_server threadsafe server default_driver javascript_driver allow_gumbo].freeze
 
     attr_accessor :app
     attr_reader :reuse_server, :threadsafe

data/lib/capybara/helpers.rb

@@ -3,7 +3,7 @@
 module Capybara
   # @api private
   module Helpers
-  module_function
+  module_function # rubocop:disable Layout/IndentationWidth
 
     ##
     # @deprecated

data/lib/capybara/node/actions.rb

@@ -8,7 +8,7 @@ module Capybara
       #   and continuously retry finding the element until either the element is found or the time
       #   expires. The length of time +find+ will wait is controlled through {Capybara.default_max_wait_time}
       #
-      #   @option options [false, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
+      #   @option options [false, true, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
 
       ##
       #
@@ -45,7 +45,7 @@ module Capybara
       #
       # Finds a button on the page and clicks it.
       # This can be any \<input> element of type submit, reset, image, button or it can be a
-      # \<button> element. All buttons can be found by their id, Capybara.test_id attribute, value, or title. \<button> elements can also be found
+      # \<button> element. All buttons can be found by their id, name, Capybara.test_id attribute, value, or title. \<button> elements can also be found
       # by their text content, and image \<input> elements by their alt attribute
       #
       # @overload click_button([locator], **options)
@@ -300,7 +300,7 @@ module Capybara
         synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
           begin
             find(:select, from, options)
-          rescue Capybara::ElementNotFound => select_error
+          rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName
             raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }
 
             begin
@@ -356,14 +356,14 @@ module Capybara
           begin
             el = find(selector, locator, options)
             el.set(checked)
-          rescue StandardError => err
-            raise unless allow_label_click && catch_error?(err)
+          rescue StandardError => e
+            raise unless allow_label_click && catch_error?(e)
 
             begin
               el ||= find(selector, locator, options.merge(visible: :all))
               el.session.find(:label, for: el, visible: true).click unless el.checked? == checked
             rescue StandardError # swallow extra errors - raise original
-              raise err
+              raise e
             end
           end
         end

data/lib/capybara/node/base.rb

@@ -76,24 +76,24 @@ module Capybara
       def synchronize(seconds = nil, errors: nil)
         return yield if session.synchronized
 
-        seconds = session_options.default_max_wait_time if seconds.nil?
+        seconds = session_options.default_max_wait_time if [nil, true].include? seconds
         session.synchronized = true
         timer = Capybara::Helpers.timer(expire_in: seconds)
         begin
           yield
-        rescue StandardError => err
+        rescue StandardError => e
           session.raise_server_error!
-          raise err unless catch_error?(err, errors)
+          raise e unless catch_error?(e, errors)
 
           if driver.wait?
-            raise err if timer.expired?
+            raise e if timer.expired?
 
             sleep(0.01)
             reload if session_options.automatic_reload
           else
             old_base = @base
             reload if session_options.automatic_reload
-            raise err if old_base == @base
+            raise e if old_base == @base
           end
           retry
         ensure

data/lib/capybara/node/element.rb

@@ -87,11 +87,11 @@ module Capybara
 
         begin
           synchronize { base.style(styles) }
-        rescue NotImplementedError => err
+        rescue NotImplementedError => e
           begin
             evaluate_script(STYLE_SCRIPT, *styles)
           rescue Capybara::NotSupportedByDriverError
-            raise err
+            raise e
           end
         end
       end
@@ -113,7 +113,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element
       def set(value, **options)
-        raise Capybara::ReadOnlyElementError, "Attempt to set readonly element with value: #{value}" if readonly?
+        raise Capybara::ReadOnlyElementError, "Attempt to set readonly element with value: #{value}" if ENV['CAPYBARA_THOROUGH'] && readonly?
 
         options = session_options.default_set_options.to_h.merge(options)
         synchronize { base.set(value, options) }
@@ -469,8 +469,8 @@ module Capybara
           begin
             reloaded = query_scope.reload.first(@query.name, @query.locator, @query.options)
             @base = reloaded.base if reloaded
-          rescue StandardError => err
-            raise err unless catch_error?(err)
+          rescue StandardError => e
+            raise e unless catch_error?(e)
           end
         end
         self

data/lib/capybara/node/finders.rb

@@ -13,7 +13,7 @@ module Capybara
       #   and continuously retry finding the element until either the element is found or the time
       #   expires. The length of time +find+ will wait is controlled through {Capybara.default_max_wait_time}
       #   and defaults to 2 seconds.
-      #   @option options [false, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
+      #   @option options [false, true, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
       #
       #  page.find('#foo').find('.bar')
       #  page.find(:xpath, './/div[contains(., "bar")]')
@@ -154,11 +154,11 @@ module Capybara
       #
       # Find a button on the page.
       # This can be any \<input> element of type submit, reset, image, button or it can be a
-      # \<button> element. All buttons can be found by their id, Capbyara.test_id attribute, value, or title. \<button> elements can also be found
+      # \<button> element. All buttons can be found by their id, name, Capbyara.test_id attribute, value, or title. \<button> elements can also be found
       # by their text content, and image \<input> elements by their alt attribute
       #
       # @overload find_button([locator], **options)
-      #   @param [String] locator            id, Capybara.test_id attribute, value, title, text content, alt of image
+      #   @param [String] locator            id, name, Capybara.test_id attribute, value, title, text content, alt of image
       #
       #   @overload find_button(**options)
       #
@@ -169,8 +169,9 @@ module Capybara
       #                                                       * false - only finds an enabled button
       #                                                       * :all - finds either an enabled or disabled button
       #   @option options [String, Regexp] id                 Match buttons with the id provided
-      #   @option options [String] title              Match buttons with the title provided
-      #   @option options [String] value              Match buttons with the value provided
+      #   @option options [String] name                       Match buttons with the name provided
+      #   @option options [String] title                      Match buttons with the title provided
+      #   @option options [String] value                      Match buttons with the value provided
       #   @option options [String, Array<String>, Regexp] class    Match buttons that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
@@ -241,6 +242,7 @@ module Capybara
       # @option options [Integer] maximum          Maximum number of matches that are expected to be found
       # @option options [Integer] minimum          Minimum number of matches that are expected to be found
       # @option options [Range]   between          Number of matches found must be within the given range
+      # @option options [false, true, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
       # @overload all([kind = Capybara.default_selector], locator = nil, **options)
       # @overload all([kind = Capybara.default_selector], locator = nil, **options, &filter_block)
       #   @yieldparam element [Capybara::Node::Element]  The element being considered for inclusion in the results

data/lib/capybara/node/simple.rb

@@ -107,7 +107,7 @@ module Capybara
           !find_xpath(VISIBILITY_XPATH)
         else
           # No need for an xpath if only checking the current element
-          !(native.key?('hidden') || (native[:style] =~ /display:\s?none/) || %w[script head].include?(tag_name))
+          !(native.key?('hidden') || (/display:\s?none/.match? native[:style]) || %w[script head].include?(tag_name))
         end
       end
 
@@ -127,7 +127,8 @@ module Capybara
       #
       # @return [Boolean]     Whether the element is disabled
       def disabled?
-        native.has_attribute?('disabled')
+        native.has_attribute?('disabled') &&
+          %w[button input select textarea optgroup option menuitem fieldset].include?(tag_name)
       end
 
       ##

data/lib/capybara/queries/base_query.rb

@@ -98,7 +98,7 @@ module Capybara
 
         invalid_names = invalid_keys.map(&:inspect).join(', ')
         valid_names = valid_keys.map(&:inspect).join(', ')
-        raise ArgumentError, "invalid keys #{invalid_names}, should be one of #{valid_names}"
+        raise ArgumentError, "Invalid option(s) #{invalid_names}, should be one of #{valid_names}"
       end
     end
   end

data/lib/capybara/queries/selector_query.rb

@@ -83,7 +83,7 @@ module Capybara
           matches_system_filters?(node) &&
           matches_node_filters?(node, node_filter_errors) &&
           matches_filter_block?(node)
-      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])
+      rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : []) # rubocop:disable Naming/RescuedExceptionsVariableName
         false
       end
 
@@ -271,7 +271,7 @@ module Capybara
 
       def assert_valid_keys
         unless VALID_MATCH.include?(match)
-          raise ArgumentError, "invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}"
+          raise ArgumentError, "Invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(', ')}"
         end
 
         unhandled_options = @options.keys.reject do |option_name|
@@ -284,7 +284,7 @@ module Capybara
 
         invalid_names = unhandled_options.map(&:inspect).join(', ')
         valid_names = (valid_keys - [:allow_self]).map(&:inspect).join(', ')
-        raise ArgumentError, "invalid keys #{invalid_names}, should be one of #{valid_names}"
+        raise ArgumentError, "Invalid option(s) #{invalid_names}, should be one of #{valid_names}"
       end
 
       def filtered_expression(expr)
@@ -368,13 +368,13 @@ module Capybara
       def matches_id_filter?(node)
         return true unless use_default_id_filter? && options[:id].is_a?(Regexp)
 
-        node[:id] =~ options[:id]
+        options[:id].match? node[:id]
       end
 
       def matches_class_filter?(node)
         return true unless use_default_class_filter? && options[:class].is_a?(Regexp)
 
-        node[:class] =~ options[:class]
+        options[:class].match? node[:class]
       end
 
       def matches_style_filter?(node)
@@ -382,7 +382,7 @@ module Capybara
         when String, nil
           true
         when Regexp
-          node[:style] =~ options[:style]
+          options[:style].match? node[:style]
         when Hash
           matches_style?(node, options[:style])
         end
@@ -392,7 +392,7 @@ module Capybara
         @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)
         styles.all? do |style, value|
           if value.is_a? Regexp
-            @actual_styles[style.to_s] =~ value
+            value.match? @actual_styles[style.to_s]
           else
             @actual_styles[style.to_s] == value
           end

data/lib/capybara/queries/style_query.rb

@@ -19,7 +19,7 @@ module Capybara
         @actual_styles = node.style(*@expected_styles.keys)
         @expected_styles.all? do |style, value|
           if value.is_a? Regexp
-            @actual_styles[style] =~ value
+            value.match? @actual_styles[style]
           else
             @actual_styles[style] == value
           end

data/lib/capybara/rack_test/form.rb

@@ -56,7 +56,7 @@ private
   end
 
   def request_method
-    self[:method] =~ /post/i ? :post : :get
+    /post/i.match?(self[:method]) ? :post : :get
   end
 
   def merge_param!(params, key, value)

data/lib/capybara/registrations/drivers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+Capybara.register_driver :rack_test do |app|
+  Capybara::RackTest::Driver.new(app)
+end
+
+Capybara.register_driver :selenium do |app|
+  Capybara::Selenium::Driver.new(app)
+end
+
+Capybara.register_driver :selenium_headless do |app|
+  Capybara::Selenium::Driver.load_selenium
+  browser_options = ::Selenium::WebDriver::Firefox::Options.new
+  browser_options.args << '-headless'
+  Capybara::Selenium::Driver.new(app, browser: :firefox, options: browser_options)
+end
+
+Capybara.register_driver :selenium_chrome do |app|
+  Capybara::Selenium::Driver.load_selenium
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    # Workaround https://bugs.chromium.org/p/chromedriver/issues/detail?id=2650&q=load&sort=-id&colspec=ID%20Status%20Pri%20Owner%20Summary
+    opts.args << '--disable-site-isolation-trials'
+  end
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end
+
+Capybara.register_driver :selenium_chrome_headless do |app|
+  Capybara::Selenium::Driver.load_selenium
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    opts.args << '--headless'
+    opts.args << '--disable-gpu' if Gem.win_platform?
+    # Workaround https://bugs.chromium.org/p/chromedriver/issues/detail?id=2650&q=load&sort=-id&colspec=ID%20Status%20Pri%20Owner%20Summary
+    opts.args << '--disable-site-isolation-trials'
+  end
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end

data/lib/capybara/registrations/servers.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+Capybara.register_server :default do |app, port, _host|
+  Capybara.run_default_server(app, port)
+end
+
+Capybara.register_server :webrick do |app, port, host, **options|
+  require 'rack/handler/webrick'
+  options = { Host: host, Port: port, AccessLog: [], Logger: WEBrick::Log.new(nil, 0) }.merge(options)
+  Rack::Handler::WEBrick.run(app, options)
+end
+
+Capybara.register_server :puma do |app, port, host, **options|
+  begin
+    require 'rack/handler/puma'
+  rescue LoadError
+    raise LoadError, 'Capybara is unable to load `puma` for its server, please add `puma` to your project or specify a different server via something like `Capybara.server = :webrick`.'
+  else
+    unless Rack::Handler::Puma.respond_to?(:config)
+      raise LoadError, 'Capybara requires `puma` version 3.8.0 or higher, please upgrade `puma` or register and specify your own server block'
+    end
+  end
+  # If we just run the Puma Rack handler it installs signal handlers which prevent us from being able to interrupt tests.
+  # Therefore construct and run the Server instance ourselves.
+  # Rack::Handler::Puma.run(app, { Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false }.merge(options))
+  options = { Host: host, Port: port, Threads: '0:4', workers: 0, daemon: false }.merge(options)
+  conf = Rack::Handler::Puma.config(app, options)
+  events = conf.options[:Silent] ? ::Puma::Events.strings : ::Puma::Events.stdio
+
+  events.log 'Capybara starting Puma...'
+  events.log "* Version #{Puma::Const::PUMA_VERSION} , codename: #{Puma::Const::CODE_NAME}"
+  events.log "* Min threads: #{conf.options[:min_threads]}, max threads: #{conf.options[:max_threads]}"
+
+  Puma::Server.new(conf.app, events, conf.options).tap do |s|
+    s.binder.parse conf.options[:binds], s.events
+    s.min_threads, s.max_threads = conf.options[:min_threads], conf.options[:max_threads]
+  end.run.join
+end

data/lib/capybara/result.rb

@@ -149,10 +149,10 @@ module Capybara
     end
 
     def lazy_select_elements(&block)
-      # JRuby has an issue with lazy enumerators which
+      # JRuby < 9.2.8.0 has an issue with lazy enumerators which
       # causes a concurrency issue with network requests here
       # https://github.com/jruby/jruby/issues/4212
-      if RUBY_PLATFORM == 'java'
+      if (RUBY_PLATFORM == 'java') && (Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('9.2.8.0'))
         @elements.select(&block).to_enum # non-lazy evaluation
       else
         @elements.lazy.select(&block)

data/lib/capybara/rspec/matcher_proxies.rb

@@ -10,9 +10,9 @@ module Capybara
       end
     end
 
-    def within(*args)
+    def within(*args, &block)
       if block_given?
-        within_element(*args, &Proc.new)
+        within_element(*args, &block)
       else
         be_within(*args)
       end

data/lib/capybara/rspec/matchers/base.rb

@@ -41,8 +41,8 @@ module Capybara
       class WrappedElementMatcher < Base
         def matches?(actual)
           element_matches?(wrap(actual))
-        rescue Capybara::ExpectationNotMet => err
-          @failure_message = err.message
+        rescue Capybara::ExpectationNotMet => e
+          @failure_message = e.message
           false
         end
 

data/lib/capybara/rspec/matchers.rb

@@ -107,7 +107,7 @@ module Capybara
     #   See {Capybara::Node::Matchers#has_unchecked_field?}
 
     # RSpec matcher for text content
-    # See {Capybara::SessionMatchers#assert_text}
+    # See {Capybara::Node::Matchers#assert_text}
     def have_text(*args)
       Matchers::HaveText.new(*args)
     end

data/lib/capybara/selector/css.rb

@@ -6,14 +6,14 @@ module Capybara
       def self.escape(str)
         value = str.dup
         out = +''
-        out << value.slice!(0...1) if value =~ /^[-_]/
-        out << (value[0] =~ NMSTART ? value.slice!(0...1) : escape_char(value.slice!(0...1)))
+        out << value.slice!(0...1) if value.match?(/^[-_]/)
+        out << (value[0].match?(NMSTART) ? value.slice!(0...1) : escape_char(value.slice!(0...1)))
         out << value.gsub(/[^a-zA-Z0-9_-]/) { |char| escape_char char }
         out
       end
 
       def self.escape_char(char)
-        char =~ %r{[ -/:-~]} ? "\\#{char}" : format('\\%06x', char.ord)
+        char.match?(%r{[ -/:-~]}) ? "\\#{char}" : format('\\%06x', char.ord)
       end
 
       def self.split(css)

data/lib/capybara/selector/filters/base.rb

@@ -34,7 +34,7 @@ module Capybara
 
         def handles_option?(option_name)
           if matcher?
-            option_name =~ @matcher
+            @matcher.match? option_name
           else
             @name == option_name
           end

data/lib/capybara/selector/selector.rb

@@ -59,6 +59,7 @@ module Capybara
   #     * Locator: Matches the id, Capybara.test_id attribute, value, or title attributes, string content of a button, or the alt attribute of an image type button or of a descendant image of a button
   #     * Filters:
   #       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
+  #       * :name (String) - Matches the name attribute
   #       * :title (String) — Matches the title attribute
   #       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
   #       * :value (String) — Matches the value of an input button

data/lib/capybara/selector/xpath_extensions.rb

@@ -7,3 +7,11 @@ module XPath
     end
   end
 end
+
+module XPath
+  module DSL
+    def join(*expressions)
+      XPath::Expression.new(:join, *[self, expressions].flatten)
+    end
+  end
+end