capybara 3.29.0 → 3.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f11a887ca6aed51d064d9c8eb797e0db4605a3d013082a11f4f4b1013b27bef
-  data.tar.gz: 714e834fdb1c2f0e692f547a1d032113dd888d6905eddecc60f05503720bcd8e
+  metadata.gz: dd31d35629d475d7fdaba1d6e415599d995a08f27b28fa619a3a4449b61b91d8
+  data.tar.gz: 27c812629e2d99e8f4c62fa7961df9b499c5346b1c61092faf487f592356033d
 SHA512:
-  metadata.gz: 82c37d1b9c8d1c7f9d858f8d7aebebfc2ecee4c5e35d35f9a3c949d978e4e97d48f78b9d5f93079e209fc779ab31e5707ecce8ac0d2a4ce8108fc3be2437e1bc
-  data.tar.gz: '06886b335dd0ef5f93f59a09026877bc460e6430b2d2f1902cd31a3179b1bd52b9418a1b43ab558dcf18e92b198506023c3549a065949bb33f881538ec9e018d'
+  metadata.gz: 946e3f2de0137ddaa6e3a2febba2c87244997737c54a10024133de110ca41b8aeddcb66e0437bef5d826e9fe21d4c42701674c3864bd578d24c30c7b1f90e2a9
+  data.tar.gz: f9409de3e2e0ea44e0bb6b6f77cce7e0e8f5a4d95c43fb62af2eb63d11e755d6a8c00b9b9b4d2bbe2729538d0d1038e92468e0a7994d1578b50e05b5227b87f4

data/History.md

@@ -1,5 +1,44 @@
+# Version 3.31.0
+Release date: 2020-01-26
+
+### Added
+
+* Support setting range inputs with the selenium driver [Andrew White]
+* Support setting range inputs with the rack driver
+* Support drop modifier keys in drag & drop [Elliot Crosby-McCullough]
+* `enabled_options` and `disabled options` filters for select selector
+* Support beginless ranges
+* Optionally allow `all` results to be reloaded when stable - Beta feature - may be removed in
+  future version if problems occur
+
+### Fixed
+
+* Fix Ruby 2.7 deprecation notices around keyword arguments. I have tried to do this without
+  any breaking changes, but due to the nature of the 2.7 changes and some selector types accepting
+  Hashes as locators there are a lot of edge cases. If you find any broken cases please report
+  them and I'll see if they're fixable.
+* Clicking on details/summary element behavior in rack_test driver_
+
+# Version 3.30.0
+Release date: 2019-12-24
+
+### Added
+
+* Display pending requests when they don't complete in time [Juan Carlos Medina]
+* :order option in selector queries - set to :reverse to for reverse document order results
+* Support regexp for :name and :placeholder options in selectors that import filters from
+  _field filter set
+
+### Fixed
+
+* Issue around automatic port assignment - Issue #2245
+* Label selector when label has no id - Issue #2260
+* Preserve clientX/clientY in Selenium HTML5 drag emulation [Nicolò G.]
+* table selector using :with_cols option if last specified column matched but others didn't - Issue #2287
+* Some tests updated for Ruby 2.7 behavior change around keyword args
+
 # Version 3.29.0
-Release date: Unreleased
+Release date: 2019-09-02
 
 ### Added
 

data/README.md

@@ -7,7 +7,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.29.x version of Capybara.
+**Note** You are viewing the README for the 3.31.x stable branch of Capybara.
 
 Capybara helps you test web applications by simulating how a real user would
 interact with your app. It is agnostic about the driver running your tests and

data/lib/capybara/config.rb

@@ -27,7 +27,9 @@ module Capybara
     attr_writer :reuse_server
 
     def threadsafe=(bool)
-      raise 'Threadsafe setting cannot be changed once a session is created' if (bool != threadsafe) && Session.instance_created?
+      if (bool != threadsafe) && Session.instance_created?
+        raise 'Threadsafe setting cannot be changed once a session is created'
+      end
 
       @threadsafe = bool
     end
@@ -59,7 +61,7 @@ module Capybara
       @server = if name.respond_to? :call
         name
       elsif options
-        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, options) }
+        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, **options) }
       else
         Capybara.servers[name.to_sym]
       end
@@ -83,7 +85,9 @@ module Capybara
 
     def deprecate(method, alternate_method, once = false)
       @deprecation_notified ||= {}
-      warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once && @deprecation_notified[method]
+      unless once && @deprecation_notified[method]
+        warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
+      end
       @deprecation_notified[method] = true
     end
   end

data/lib/capybara/dsl.rb

@@ -47,8 +47,16 @@ module Capybara
     end
 
     Session::DSL_METHODS.each do |method|
-      define_method method do |*args, &block|
-        page.send method, *args, &block
+      if RUBY_VERSION >= '2.7'
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          def #{method}(...)
+            page.method("#{method}").call(...)
+          end
+        METHOD
+      else
+        define_method method do |*args, &block|
+          page.send method, *args, &block
+        end
       end
     end
   end

data/lib/capybara/helpers.rb

@@ -87,7 +87,9 @@ module Capybara
       end
 
       def expired?
-        raise Capybara::FrozenInTime, 'Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead' if stalled?
+        if stalled?
+          raise Capybara::FrozenInTime, 'Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead'
+        end
 
         current - @start >= @expire_in
       end

data/lib/capybara/minitest.rb

@@ -52,6 +52,7 @@ module Capybara
             raise ::Minitest::Assertion, e.message
           end
         ASSERTION
+        ruby2_keywords "assert_#{assertion_name}" if respond_to?(:ruby2_keywords)
       end
 
       alias_method :refute_title, :assert_no_title
@@ -109,6 +110,7 @@ module Capybara
             raise ::Minitest::Assertion, e.message
           end
         ASSERTION
+        ruby2_keywords "assert_#{assertion_name}" if respond_to?(:ruby2_keywords)
       end
 
       alias_method :refute_selector, :assert_no_selector
@@ -120,14 +122,16 @@ module Capybara
         define_method "assert_#{selector_type}" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           locator, options = extract_locator(args)
-          assert_selector(subject, selector_type.to_sym, locator, options, &optional_filter_block)
+          assert_selector(subject, selector_type.to_sym, locator, **options, &optional_filter_block)
         end
+        ruby2_keywords "assert_#{selector_type}" if respond_to?(:ruby2_keywords)
 
         define_method "assert_no_#{selector_type}" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           locator, options = extract_locator(args)
-          assert_no_selector(subject, selector_type.to_sym, locator, options, &optional_filter_block)
+          assert_no_selector(subject, selector_type.to_sym, locator, **options, &optional_filter_block)
         end
+        ruby2_keywords "assert_no_#{selector_type}" if respond_to?(:ruby2_keywords)
         alias_method "refute_#{selector_type}", "assert_no_#{selector_type}"
       end
 
@@ -135,14 +139,22 @@ module Capybara
         define_method "assert_#{field_type}_field" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           locator, options = extract_locator(args)
-          assert_selector(subject, :field, locator, options.merge(field_type.to_sym => true), &optional_filter_block)
+          assert_selector(subject, :field, locator, **options.merge(field_type.to_sym => true), &optional_filter_block)
         end
+        ruby2_keywords "assert_#{field_type}_field" if respond_to?(:ruby2_keywords)
 
         define_method "assert_no_#{field_type}_field" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           locator, options = extract_locator(args)
-          assert_no_selector(subject, :field, locator, options.merge(field_type.to_sym => true), &optional_filter_block)
+          assert_no_selector(
+            subject,
+            :field,
+            locator,
+            **options.merge(field_type.to_sym => true),
+            &optional_filter_block
+          )
         end
+        ruby2_keywords "assert_no_#{field_type}_field" if respond_to?(:ruby2_keywords)
         alias_method "refute_#{field_type}_field", "assert_no_#{field_type}_field"
       end
 
@@ -151,11 +163,13 @@ module Capybara
           subject, args = determine_subject(args)
           assert_matches_selector(subject, selector_type.to_sym, *args, &optional_filter_block)
         end
+        ruby2_keywords "assert_matches_#{selector_type}" if respond_to?(:ruby2_keywords)
 
         define_method "assert_not_matches_#{selector_type}" do |*args, &optional_filter_block|
           subject, args = determine_subject(args)
           assert_not_matches_selector(subject, selector_type.to_sym, *args, &optional_filter_block)
         end
+        ruby2_keywords "assert_not_matches_#{selector_type}" if respond_to?(:ruby2_keywords)
         alias_method "refute_matches_#{selector_type}", "assert_not_matches_#{selector_type}"
       end
 

data/lib/capybara/node/actions.rb

@@ -23,7 +23,7 @@ module Capybara
       # @return [Capybara::Node::Element]  The element clicked
       #
       def click_link_or_button(locator = nil, **options)
-        find(:link_or_button, locator, options).click
+        find(:link_or_button, locator, **options).click
       end
       alias_method :click_on, :click_link_or_button
 
@@ -39,7 +39,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element clicked
       def click_link(locator = nil, **options)
-        find(:link, locator, options).click
+        find(:link, locator, **options).click
       end
 
       ##
@@ -55,7 +55,7 @@ module Capybara
       #   @param [Hash] options        See {Capybara::Node::Finders#find_button}
       # @return [Capybara::Node::Element]  The element clicked
       def click_button(locator = nil, **options)
-        find(:button, locator, options).click
+        find(:button, locator, **options).click
       end
 
       ##
@@ -88,7 +88,7 @@ module Capybara
       def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)
         find_options[:with] = currently_with if currently_with
         find_options[:allow_self] = true if locator.nil?
-        find(:fillable_field, locator, find_options).set(with, fill_options)
+        find(:fillable_field, locator, **find_options).set(with, **fill_options)
       end
 
       # @!macro label_click
@@ -119,7 +119,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element chosen or the label clicked
       def choose(locator = nil, **options)
-        _check_with_label(:radio_button, true, locator, options)
+        _check_with_label(:radio_button, true, locator, **options)
       end
 
       ##
@@ -147,7 +147,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element checked or the label clicked
       def check(locator = nil, **options)
-        _check_with_label(:checkbox, true, locator, options)
+        _check_with_label(:checkbox, true, locator, **options)
       end
 
       ##
@@ -175,7 +175,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element unchecked or the label clicked
       def uncheck(locator = nil, **options)
-        _check_with_label(:checkbox, false, locator, options)
+        _check_with_label(:checkbox, false, locator, **options)
       end
 
       ##
@@ -205,7 +205,7 @@ module Capybara
         if el.respond_to?(:tag_name) && (el.tag_name == 'input')
           select_datalist_option(el, value)
         else
-          el.find(:option, value, options).select_option
+          el.find(:option, value, **options).select_option
         end
       end
 
@@ -229,8 +229,8 @@ module Capybara
       def unselect(value = nil, from: nil, **options)
         raise ArgumentError, 'The :from option does not take an element' if from.is_a? Capybara::Node::Element
 
-        scope = from ? find(:select, from, options) : self
-        scope.find(:option, value, options).unselect_option
+        scope = from ? find(:select, from, **options) : self
+        scope.find(:option, value, **options).unselect_option
       end
 
       ##
@@ -276,7 +276,9 @@ module Capybara
       #   @yield Block whose actions will trigger the system file chooser to be shown
       # @return [Capybara::Node::Element]  The file field element
       def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments
-        raise ArgumentError, '``#attach_file` does not support passing both a locator and a block' if locator && block_given?
+        if locator && block_given?
+          raise ArgumentError, '``#attach_file` does not support passing both a locator and a block'
+        end
 
         Array(paths).each do |path|
           raise Capybara::FileNotFound, "cannot attach file, #{path} does not exist" unless File.exist?(path.to_s)
@@ -295,10 +297,10 @@ module Capybara
         end
         # Allow user to update the CSS style of the file input since they are so often hidden on a page
         if make_visible
-          ff = file_field || find(:file_field, locator, options.merge(visible: :all))
+          ff = file_field || find(:file_field, locator, **options.merge(visible: :all))
           while_visible(ff, make_visible) { |el| el.set(paths) }
         else
-          (file_field || find(:file_field, locator, options)).set(paths)
+          (file_field || find(:file_field, locator, **options)).set(paths)
         end
       end
 
@@ -307,12 +309,12 @@ module Capybara
       def find_select_or_datalist_input(from, options)
         synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
           begin
-            find(:select, from, options)
+            find(:select, from, **options)
           rescue Capybara::ElementNotFound => select_error # rubocop:disable Naming/RescuedExceptionsVariableName
             raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }
 
             begin
-              find(:datalist_input, from, options)
+              find(:datalist_input, from, **options)
             rescue Capybara::ElementNotFound => dlinput_error # rubocop:disable Naming/RescuedExceptionsVariableName
               raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
             end
@@ -338,7 +340,9 @@ module Capybara
           visible_css = { opacity: 1, display: 'block', visibility: 'visible', width: 'auto', height: 'auto' }
         end
         _update_style(element, visible_css)
-        raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible' unless element.visible?
+        unless element.visible?
+          raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible'
+        end
 
         begin
           yield element
@@ -355,7 +359,7 @@ module Capybara
 
       def _reset_style(element)
         element.execute_script(RESET_STYLE_SCRIPT)
-      rescue StandardError # rubocop:disable Lint/HandleExceptions swallow extra errors
+      rescue StandardError # rubocop:disable Lint/SuppressedException swallow extra errors
       end
 
       def _check_with_label(selector, checked, locator,
@@ -364,13 +368,13 @@ module Capybara
 
         synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
           begin
-            el = find(selector, locator, options)
+            el = find(selector, locator, **options)
             el.set(checked)
           rescue StandardError => e
             raise unless allow_label_click && catch_error?(e)
 
             begin
-              el ||= find(selector, locator, options.merge(visible: :all))
+              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 e

data/lib/capybara/node/document.rb

@@ -40,8 +40,8 @@ module Capybara
         find(:xpath, '/html').evaluate_script(*args)
       end
 
-      def scroll_to(*args)
-        find(:xpath, '//body').scroll_to(*args)
+      def scroll_to(*args, **options)
+        find(:xpath, '//body').scroll_to(*args, **options)
       end
     end
   end

data/lib/capybara/node/document_matchers.rb

@@ -42,7 +42,7 @@ module Capybara
       # @return [Boolean]
       #
       def has_title?(title, **options)
-        make_predicate(options) { assert_title(title, options) }
+        make_predicate(options) { assert_title(title, **options) }
       end
 
       ##
@@ -52,13 +52,13 @@ module Capybara
       # @return [Boolean]
       #
       def has_no_title?(title, **options)
-        make_predicate(options) { assert_no_title(title, options) }
+        make_predicate(options) { assert_no_title(title, **options) }
       end
 
     private
 
       def _verify_title(title, options)
-        query = Capybara::Queries::TitleQuery.new(title, options)
+        query = Capybara::Queries::TitleQuery.new(title, **options)
         synchronize(query.wait) { yield(query) }
         true
       end

data/lib/capybara/node/element.rb

@@ -27,9 +27,11 @@ module Capybara
         @query_scope = query_scope
         @query = query
         @allow_reload = false
+        @query_idx = nil
       end
 
-      def allow_reload!
+      def allow_reload!(idx = nil)
+        @query_idx = idx
         @allow_reload = true
       end
 
@@ -113,10 +115,12 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element
       def set(value, **options)
-        raise Capybara::ReadOnlyElementError, "Attempt to set readonly element with value: #{value}" if ENV['CAPYBARA_THOROUGH'] && readonly?
+        if ENV['CAPYBARA_THOROUGH'] && readonly?
+          raise Capybara::ReadOnlyElementError, "Attempt to set readonly element with value: #{value}"
+        end
 
         options = session_options.default_set_options.to_h.merge(options)
-        synchronize { base.set(value, options) }
+        synchronize { base.set(value, **options) }
         self
       end
 
@@ -163,8 +167,8 @@ module Capybara
       #       offset will be from the element center, otherwise it will be from the top left corner of the element
       # @return [Capybara::Node::Element]  The element
       def click(*keys, **options)
-        perform_click_action(keys, options) do |k, opts|
-          base.click(k, opts)
+        perform_click_action(keys, **options) do |k, opts|
+          base.click(k, **opts)
         end
       end
 
@@ -176,8 +180,8 @@ module Capybara
       # @macro click_modifiers
       # @return [Capybara::Node::Element]  The element
       def right_click(*keys, **options)
-        perform_click_action(keys, options) do |k, opts|
-          base.right_click(k, opts)
+        perform_click_action(keys, **options) do |k, opts|
+          base.right_click(k, **opts)
         end
       end
 
@@ -189,8 +193,8 @@ module Capybara
       # @macro click_modifiers
       # @return [Capybara::Node::Element]  The element
       def double_click(*keys, **options)
-        perform_click_action(keys, options) do |k, opts|
-          base.double_click(k, opts)
+        perform_click_action(keys, **options) do |k, opts|
+          base.double_click(k, **opts)
         end
       end
 
@@ -405,6 +409,8 @@ module Capybara
       # @option options [Boolean] :html5   When using Chrome/Firefox with Selenium enables to force the use of HTML5
       #                                    (true) or legacy (false) dragging. If not specified the driver will attempt to
       #                                    detect the correct method to use.
+      # @option options [Array<Symbol>,Symbol] :drop_modifiers   Modifier keys which should be held while the dragged element is dropped.
+      #
       #
       # @return [Capybara::Node::Element]  The dragged element
       def drag_to(node, **options)
@@ -543,14 +549,13 @@ module Capybara
 
       # @api private
       def reload
-        if @allow_reload
-          begin
-            reloaded = @query.resolve_for(query_scope.reload)&.first
+        return self unless @allow_reload
 
-            @base = reloaded.base if reloaded
-          rescue StandardError => e
-            raise e unless catch_error?(e)
-          end
+        begin
+          reloaded = @query.resolve_for(query_scope.reload)[@query_idx.to_i]
+          @base = reloaded.base if reloaded
+        rescue StandardError => e
+          raise e unless catch_error?(e)
         end
         self
       end