capybara 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31eb0715167852439533fdb10e4cb15b9cb1d7531e7821a6f70d2a208d6cb232
-  data.tar.gz: 58f5b7496bade61b732ab10831dc237f64dc7f288bd34bdbe61b58535d0fa475
+  metadata.gz: 354c57c570fb124607ab4255934f26bdb55b81716b846a2d76bb938ecae5d0c0
+  data.tar.gz: 128b9ee025bcd0021bc7e966a57d96fc05b516bd8dcb29756f3206f8aef15d4f
 SHA512:
-  metadata.gz: 5563fda1e5f2965eb8d93cf42ecb8423bb316d6381410a79dc3a18d41364502b893ff5ce7974f48888f87583f53d7b43037a5f80c20fd20b1bad6a2d1a144f51
-  data.tar.gz: 8361afb0ecb0fbe34b045b031ae2466483128f69ccb2be4637ad77a7ec41bac39fa44acd8ae1cbefdb94b4bec1679ee2e6e25fadc7d8062130ac59d992b45c36
+  metadata.gz: c55429aed39e48dbe84375f0822e2f0f244e4572474a797a27e8f83bdf0fa3c8062ca91d6696aba1b54c228908385351c483598a9f44718529d7ad4139b0717c
+  data.tar.gz: 8c61a46eb89183e28c4e0e7be76118ccecceb3383a6c7c37b2f9d7d0aa5efe5971146a97374146df09881a2fe0da94f58a89822cdb9e6d53b95f502782eb9106

data/History.md

@@ -1,3 +1,19 @@
+# Version 3.4.0
+Release date: 2018-07-19
+
+### Fixed
+
+* Make selenium driver :backspace clear stategy work even if caret location is in middle of field content [Champier Cyril]
+* Selenium issue with fieldset nested in disabled fieldset not being considered disabled
+* `Session#evaluate_script` and `Element#evaluate_script` now strip leading/trailing whitespace from scripts [Ian Lesperance]
+
+### Added
+
+* Work around Selenium lack of support for `file_detector` with remote geckodriver
+* `#within_frame` locator is optional when only one frame exists
+* `Capybara.test_id` option that allows for matching the Capybara provided selector types on an arbitrary attribute
+  (defaults to nil), set to your test id attribute ('data-test-id, etc) if using test id attributes in your project
+
 # Version 3.3.1
 Release date: 2018-06-27
 

data/README.md

@@ -7,7 +7,7 @@
 [![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 development version of Capybara.  If you are using the current release version
-you can find the README at https://github.com/teamcapybara/capybara/blob/3.3_stable/README.md
+you can find the README at https://github.com/teamcapybara/capybara/blob/3.4_stable/README.md
 
 
 Capybara helps you test web applications by simulating how a real user would
@@ -387,12 +387,10 @@ See the section on adding and configuring drivers.
 
 ### <a name="selenium"></a>Selenium
 
-At the moment, Capybara supports [Selenium 2.0+
-(Webdriver)](http://seleniumhq.org/docs/01_introducing_selenium.html#selenium-2-aka-selenium-webdriver),
-*not* Selenium RC. In order to use Selenium, you'll need to install the
-`selenium-webdriver` gem, and add it to your Gemfile if you're using bundler.
-Provided Firefox is installed, everything is set up for you, and you should be
-able to start using Selenium right away.
+Capybara supports [Selenium 3.5+
+(Webdriver)](https://www.seleniumhq.org/projects/webdriver/).
+In order to use Selenium, you'll need to install the`selenium-webdriver` gem,
+and add it to your Gemfile if you're using bundler.
 
 **Note**: drivers which run the server in a different thread may not share the
 same transaction as your tests, causing data not to be shared between your test

data/lib/capybara.rb

@@ -83,6 +83,7 @@ module Capybara
     # [threadsafe = Boolean]  Whether sessions can be configured individually (Default: false)
     # [server = Symbol]  The name of the registered server to use when running the app under test (Default: :webrick)
     # [default_set_options = Hash]  The default options passed to Node::set (Default: {})
+    # [test_id = Symbol/String/nil] Optional attribute to match locator aginst with builtin selectors along with id (Default: nil)
     #
     # === DSL Options
     #
@@ -444,23 +445,22 @@ 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`."
+    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`.'
   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))
 
-  conf = Rack::Handler::Puma.config(app, { Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false }.merge(options))
+  conf = Rack::Handler::Puma.config(app, { Host: host, Port: port, Threads: '0:4', workers: 0, daemon: false }.merge(options))
   events = conf.options[:Silent] ? ::Puma::Events.strings : ::Puma::Events.stdio
 
-  events.log "Capybara starting Puma..."
+  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 = conf.options[:min_threads]
-    s.max_threads = conf.options[:max_threads]
+    s.min_threads, s.max_threads = conf.options[:min_threads], conf.options[:max_threads]
   end.run.join
 end
 
@@ -471,7 +471,7 @@ Capybara.configure do |config|
   config.default_selector = :css
   config.default_max_wait_time = 2
   config.ignore_hidden_elements = true
-  config.default_host = "http://www.example.com"
+  config.default_host = 'http://www.example.com'
   config.automatic_reload = true
   config.match = :smart
   config.exact = false
@@ -483,6 +483,7 @@ Capybara.configure do |config|
   config.enable_aria_label = false
   config.reuse_server = true
   config.default_set_options = {}
+  config.test_id = nil
 end
 
 Capybara.register_driver :rack_test do |app|

data/lib/capybara/config.rb

@@ -26,7 +26,7 @@ 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?
+      raise 'Threadsafe setting cannot be changed once a session is created' if (bool != threadsafe) && Session.instance_created?
       @threadsafe = bool
     end
 

data/lib/capybara/dsl.rb

@@ -5,12 +5,12 @@ require 'capybara'
 module Capybara
   module DSL
     def self.included(base)
-      warn "including Capybara::DSL in the global scope is not recommended!" if base == Object
+      warn 'including Capybara::DSL in the global scope is not recommended!' if base == Object
       super
     end
 
     def self.extended(base)
-      warn "extending the main object with Capybara::DSL is not recommended!" if base == TOPLEVEL_BINDING.eval("self")
+      warn 'extending the main object with Capybara::DSL is not recommended!' if base == TOPLEVEL_BINDING.eval('self')
       super
     end
 

data/lib/capybara/helpers.rb

@@ -15,7 +15,7 @@ module Capybara
     # @return [String]         Normalized text
     #
     def normalize_whitespace(text)
-      warn "DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver"
+      warn 'DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver'
       text.to_s.gsub(/[[:space:]]+/, ' ').strip
     end
 
@@ -33,7 +33,7 @@ module Capybara
       return text if text.is_a?(Regexp)
 
       escaped = Regexp.escape(text)
-      escaped = escaped.gsub("\\ ", "[[:blank:]]") if all_whitespace
+      escaped = escaped.gsub('\\ ', '[[:blank:]]') if all_whitespace
       escaped = "\\A#{escaped}\\z" if exact
       Regexp.new(escaped, options)
     end
@@ -48,7 +48,7 @@ module Capybara
     # @return [String]         The modified HTML code
     #
     def inject_asset_host(html, host: Capybara.asset_host)
-      if host && Nokogiri::HTML(html).css("base").empty?
+      if host && Nokogiri::HTML(html).css('base').empty?
         match = html.match(/<head[^<]*?>/)
         return html.clone.insert match.end(0), "<base href='#{host}' />" if match
       end

data/lib/capybara/minitest/spec.rb

@@ -175,13 +175,13 @@ module Capybara
 end
 
 class Capybara::Session
-  include Capybara::Minitest::Expectations unless ENV["MT_NO_EXPECTATIONS"]
+  include Capybara::Minitest::Expectations unless ENV['MT_NO_EXPECTATIONS']
 end
 
 class Capybara::Node::Base
-  include Capybara::Minitest::Expectations unless ENV["MT_NO_EXPECTATIONS"]
+  include Capybara::Minitest::Expectations unless ENV['MT_NO_EXPECTATIONS']
 end
 
 class Capybara::Node::Simple
-  include Capybara::Minitest::Expectations unless ENV["MT_NO_EXPECTATIONS"]
+  include Capybara::Minitest::Expectations unless ENV['MT_NO_EXPECTATIONS']
 end

data/lib/capybara/node/actions.rb

@@ -27,13 +27,13 @@ module Capybara
 
       ##
       #
-      # Finds a link by id, text or title and clicks it. Also looks at image
+      # Finds a link by id, Capybara.test_id attribute, text or title and clicks it. Also looks at image
       # alt text inside the link.
       #
       # @macro waiting_behavior
       #
       # @overload click_link([locator], options)
-      #   @param [String] locator         text, id, title or nested image's alt attribute
+      #   @param [String] locator         text, id, Capybara.test_id attribute, title or nested image's alt attribute
       #   @param options                  See {Capybara::Node::Finders#find_link}
       #
       # @return [Capybara::Node::Element]  The element clicked
@@ -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, value, or title. \<button> elements can also be found
+      # \<button> element. All buttons can be found by their id, 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
       #
       # @macro waiting_behavior
@@ -61,7 +61,7 @@ module Capybara
       ##
       #
       # Locate a text field or text area and fill it in with the given text
-      # The field can be found via its name, id or label text.
+      # The field can be found via its name, id, Capybara.test_id attribute, or label text.
       #
       #     page.fill_in 'Name', with: 'Bob'
       #
@@ -80,9 +80,9 @@ module Capybara
       #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from Capybara.default_set_options)
       #
       # @return [Capybara::Node::Element]  The element filled_in
-      def fill_in(locator = nil, with:, fill_options: {}, **options)
-        options[:with] = options.delete(:currently_with) if options.key?(:currently_with)
-        find(:fillable_field, locator, options).set(with, fill_options)
+      def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)
+        find_options[:with] = currently_with if currently_with
+        find(:fillable_field, locator, find_options).set(with, fill_options)
       end
 
       # @!macro label_click
@@ -170,13 +170,13 @@ module Capybara
       # @macro waiting_behavior
       #
       # @param value [String] Which option to select
-      # @param from: [String]  The id, name or label of the select box
+      # @param from: [String]  The id, Capybara.test_id atrtribute, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element selected
       def select(value = nil, from: nil, **options)
         el = from ? find_select_or_datalist_input(from, options) : self
 
-        if el.respond_to?(:tag_name) && (el.tag_name == "input")
+        if el.respond_to?(:tag_name) && (el.tag_name == 'input')
           select_datalist_option(el, value)
         else
           el.find(:option, value, options).select_option
@@ -194,7 +194,7 @@ module Capybara
       # @macro waiting_behavior
       #
       # @param value [String]      Which option to unselect
-      # @param from: [String]      The id, name or label of the select box
+      # @param from: [String]      The id, Capybara.test_id attribute, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element unselected
       def unselect(value = nil, from: nil, **options)
@@ -205,7 +205,9 @@ module Capybara
       ##
       #
       # Find a file field on the page and attach a file given its path. The file field can
-      # be found via its name, id or label text.
+      # be found via its name, id or label text. In the case of the file field being hidden for
+      # styling reasons the `make_visible` option can be used to temporarily change the CSS of
+      # the file field, attach the file, and then revert the CSS back to original.
       #
       #     page.attach_file(locator, '/path/to/file.png')
       #
@@ -256,11 +258,9 @@ module Capybara
 
       def select_datalist_option(input, value)
         datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT)
-        if (option = datalist_options.find { |o| o['value'] == value || o['label'] == value })
-          input.set(option['value'])
-        else
-          raise ::Capybara::ElementNotFound, %(Unable to find datalist option "#{value}")
-        end
+        option = datalist_options.find { |o| o.values_at('value', 'label').include?(value) }
+        raise ::Capybara::ElementNotFound, %(Unable to find datalist option "#{value}") unless option
+        input.set(option['value'])
       rescue ::Capybara::NotSupportedByDriverError
         # Implement for drivers that don't support JS
         datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == input[:list]], visible: false)
@@ -271,7 +271,7 @@ module Capybara
       def while_visible(element, visible_css)
         visible_css = { opacity: 1, display: 'block', visibility: 'visible' } if visible_css == true
         _update_style(element, visible_css)
-        raise ExpectationNotMet, "The style changes in :make_visible did not make the file input visible" unless element.visible?
+        raise ExpectationNotMet, 'The style changes in :make_visible did not make the file input visible' unless element.visible?
         begin
           yield element
         ensure
@@ -282,7 +282,7 @@ module Capybara
       def _update_style(element, style)
         element.execute_script(UPDATE_STYLE_SCRIPT, style)
       rescue Capybara::NotSupportedByDriverError
-        warn "The :make_visible option is not supported by the current driver - ignoring"
+        warn 'The :make_visible option is not supported by the current driver - ignoring'
       end
 
       def _reset_style(element)

data/lib/capybara/node/base.rb

@@ -86,7 +86,7 @@ module Capybara
             raise e unless driver.wait? && catch_error?(e, errors)
             raise e if timer.expired?
             sleep(0.05)
-            raise Capybara::FrozenInTime, "Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead" if timer.stalled?
+            raise Capybara::FrozenInTime, 'Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead' if timer.stalled?
             reload if session_options.automatic_reload
             retry
           ensure

data/lib/capybara/node/element.rb

@@ -82,7 +82,7 @@ module Capybara
       #
       def style(*styles)
         styles = styles.flatten.map(&:to_s)
-        raise ArgumentError, "You must specify at least one CSS style" if styles.empty?
+        raise ArgumentError, 'You must specify at least one CSS style' if styles.empty?
         begin
           synchronize { base.style(styles) }
         rescue NotImplementedError => e
@@ -399,7 +399,7 @@ module Capybara
       def evaluate_script(script, *args)
         session.evaluate_script(<<~JS, self, *args)
           (function(){
-            return #{script}
+            return #{script.strip}
           }).apply(arguments[0], Array.prototype.slice.call(arguments,1));
         JS
       end

data/lib/capybara/node/finders.rb

@@ -89,7 +89,7 @@ module Capybara
       # Find a form field on the page. The field can be found by its name, id or label text.
       #
       # @overload find_field([locator], **options)
-      #   @param [String] locator             name, id, placeholder or text of associated label element
+      #   @param [String] locator             name, id, Capybara.test_id attribute, placeholder or text of associated label element
       #
       #   @macro waiting_behavior
       #
@@ -120,7 +120,7 @@ module Capybara
       # Find a link on the page. The link can be found by its id or text.
       #
       # @overload find_link([locator], **options)
-      #   @param [String] locator            id, title, text, or alt of enclosed img element
+      #   @param [String] locator            id, Capybara.test_id attribute, title, text, or alt of enclosed img element
       #
       #   @macro waiting_behavior
       #
@@ -139,11 +139,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, value, or title. \<button> elements can also be found
+      # \<button> element. All buttons can be found by their id, 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, value, title, text content, alt of image
+      #   @param [String] locator            id, Capybara.test_id attribute, value, title, text content, alt of image
       #
       #   @overload find_button(**options)
       #
@@ -290,8 +290,8 @@ module Capybara
             result = query.resolve_for(self)
           end
 
-          raise Capybara::Ambiguous, "Ambiguous match, found #{result.size} elements matching #{query.description}" if ambiguous?(query, result)
-          raise Capybara::ElementNotFound, "Unable to find #{query.description}" if result.empty?
+          raise Capybara::Ambiguous, "Ambiguous match, found #{result.size} elements matching #{query.applied_description}" if ambiguous?(query, result)
+          raise Capybara::ElementNotFound, "Unable to find #{query.applied_description}" if result.empty?
 
           result.first
         end.tap(&:allow_reload!)

data/lib/capybara/node/matchers.rb

@@ -382,7 +382,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has a radio button or
-      # checkbox with the given label, value or id, that is currently
+      # checkbox with the given label, value, id, or Capybara.test_id attribute that is currently
       # checked.
       #
       # @param [String] locator           The label, name or id of a checked field
@@ -395,7 +395,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has no radio button or
-      # checkbox with the given label, value or id, that is currently
+      # checkbox with the given label, value or id, or Capybara.test_id attribute that is currently
       # checked.
       #
       # @param [String] locator           The label, name or id of a checked field
@@ -408,7 +408,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has a radio button or
-      # checkbox with the given label, value or id, that is currently
+      # checkbox with the given label, value or id, or Capybara.test_id attribute that is currently
       # unchecked.
       #
       # @param [String] locator           The label, name or id of an unchecked field
@@ -421,7 +421,7 @@ module Capybara
       ##
       #
       # Checks if the page or current node has no radio button or
-      # checkbox with the given label, value or id, that is currently
+      # checkbox with the given label, value or id, or Capybara.test_id attribute that is currently
       # unchecked.
       #
       # @param [String] locator           The label, name or id of an unchecked field
@@ -520,7 +520,7 @@ module Capybara
       #
       def assert_matches_selector(*args, &optional_filter_block)
         _verify_match_result(args, optional_filter_block) do |result|
-          raise Capybara::ExpectationNotMet, "Item does not match the provided selector" unless result.include? self
+          raise Capybara::ExpectationNotMet, 'Item does not match the provided selector' unless result.include? self
         end
       end
 

data/lib/capybara/node/simple.rb

@@ -81,7 +81,7 @@ module Capybara
           if multiple?
             native.xpath(".//option[@selected='selected']").map { |option| option[:value] || option.content }
           else
-            option = native.xpath(".//option[@selected='selected']").first || native.xpath(".//option").first
+            option = native.xpath(".//option[@selected='selected']").first || native.xpath('.//option').first
             option[:value] || option.content if option
           end
         elsif tag_name == 'input' && %w[radio checkbox].include?(native[:type])
@@ -100,7 +100,7 @@ module Capybara
       # @return [Boolean]     Whether the element is visible
       #
       def visible?(check_ancestors = true)
-        return false if (tag_name == 'input') && (native[:type] == "hidden")
+        return false if (tag_name == 'input') && (native[:type] == 'hidden')
 
         if check_ancestors
           !native.xpath("boolean(./ancestor-or-self::*[contains(@style, 'display:none') or contains(@style, 'display: none') or @hidden or name()='script' or name()='head'])")

data/lib/capybara/queries/ancestor_query.rb

@@ -12,7 +12,7 @@ module Capybara
         end
       end
 
-      def description
+      def description(applied = false)
         child_query = @child_node&.instance_variable_get(:@query)
         desc = super
         desc += " that is an ancestor of #{child_query.description}" if child_query

data/lib/capybara/queries/base_query.rb

@@ -73,15 +73,16 @@ module Capybara
       end
 
       def count_message
-        message = +""
-        if options[:count]
-          message << " #{options[:count]} #{Capybara::Helpers.declension('time', 'times', options[:count])}"
-        elsif options[:between]
-          message << " between #{options[:between].first} and #{options[:between].last} times"
-        elsif options[:maximum]
-          message << " at most #{options[:maximum]} #{Capybara::Helpers.declension('time', 'times', options[:maximum])}"
-        elsif options[:minimum]
-          message << " at least #{options[:minimum]} #{Capybara::Helpers.declension('time', 'times', options[:minimum])}"
+        message = +''
+        count, between, maximum, minimum = options.values_at(:count, :between, :maximum, :minimum)
+        if count
+          message << " #{count} #{Capybara::Helpers.declension('time', 'times', count)}"
+        elsif between
+          message << " between #{between.first} and #{between.last} times"
+        elsif maximum
+          message << " at most #{maximum} #{Capybara::Helpers.declension('time', 'times', maximum)}"
+        elsif minimum
+          message << " at least #{minimum} #{Capybara::Helpers.declension('time', 'times', minimum)}"
         end
         message
       end
@@ -90,8 +91,8 @@ module Capybara
         invalid_keys = @options.keys - valid_keys
         return if invalid_keys.empty?
 
-        invalid_names = invalid_keys.map(&:inspect).join(", ")
-        valid_names = valid_keys.map(&:inspect).join(", ")
+        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}"
       end
     end