capybara 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4d75941bdc33b8e4b3d26aa8beb1a6d063fabca
-  data.tar.gz: 692a680d4d550e566e6c558bfe53608a024b4e49
+  metadata.gz: bc177e8165f5b72a1dc1c1303b726701bc24254c
+  data.tar.gz: dab6b087b3ef03904d496bef6d3f66e2736b5bbd
 SHA512:
-  metadata.gz: e9eee2dae8d51f3bff73da658a08d2aeefd6383c16cec7b269abbb2c99203239c996c83b0145946d473cc0d3d1076abd623f672dfa07dd4ad0ed9a74ea2ef001
-  data.tar.gz: 2fef0e0fb22d31ccbd4879df37100feb6c717508c57266539245d07a3ba74c3849ae02cab2dfc735054b6344effb2c4f6783658e95a3513737aa81cabb39f83e
+  metadata.gz: f21cbebab1e87a9b9a411caf05acab9d912257604d6004db90af7439a692b862966e11291134424105698477b772cca46774aa95aad6ab78bdecd827ab862e83
+  data.tar.gz: c643a679ac6ac6cf17f03d63f74a97a20919980eead96c30b8b8c571120b19e0f94d2b7be978878580c6365483cc41476a83710b96200559e6be124dce620af0

data/History.md

@@ -1,4 +1,30 @@
-#2.11.0
+#Version 2.12.0
+Release date: 2017-01-22
+
+### Added
+
+* Session#switch_to_frame for manually handling frame switching - Issue #1365 [Thomas Walpole]
+* Session#within_frame now accepts a selector type (defaults to :frame) and locator [Thomas Walpole]
+* Session#execute_script and Session#evaluate_script now accept optional arguments that will be passed to the JS function.  This may not be supported
+  by all drivers, and the types of arguments that may be passed is limited.  If drivers opt to support this feature they should support passing page elements. [Thomas Walpole]
+* :exact option for text and title matchers - Issue #1256 [Thomas Walpole]
+* :exact_text option for selector finders/minders - Issue #1256 [Thomas Walpole]
+* Capybara.exact_text setting that affects the text matchers and :text options passed to selector finders/matchers. Issue #1256 [Thomas Walpole]
+* :make_visible option for #attach_file that allows for convenient changing of the CSS style of a file input element before attaching the file to it.  Requires driver
+  support for passing page elements to Session#execute_script [Thomas Walpole]
+* assert_all_selectors/assert_none_of_selectors assertions added
+* :link selector (used by find_link/click_link) now supports finding hyperlink placeholders (no href attribute) when href: nil option is specified [Thomas Walpole]
+* `within_element` as an alias of `within` due to RSpec collision
+
+### Fixed
+*  Fields inside a disabled fieldset are now correctly considered disabled - Issue #1816 [Thomas Walpole]
+*  Lazy Capybara::Results evaluation enabled for JRuby 9.1.6.0+
+*  A driver returning nil for #current_url won't raise an exception when calling #current_path [Dylan Reichstadt]
+*  Support Ruby 2.4.0 unified Integer [Koichi ITO]
+*  RackTest driver no longer modifies the text content of textarea elements in order to behave more like a real browser [Thomas Walpole]
+*  TextQuery (assert_text/have_text/etc) now ignores errors when trying to generate more helpful errors messages so the original error isn't hidden [Thomas Walpole]
+
+#Version 2.11.0
 Release date: 2016-12-05
 
 ### Added
@@ -13,14 +39,14 @@ Release date: 2016-12-05
 * Selenium driver with Chrome should support multiple file upload [Thomas Walpole]
 * Fix visible: :hidden with :text option behavior [Thomas Walpole]
 
-#2.10.2
+#Version 2.10.2
 Release date: 2016-11-30
 
 ### Fixed
 * App exceptions with multiple parameter initializers now re-raised correctly - Issue #1785 [Michael Lutsiuk]
 * Use Addressable::URI when parsing current_path since it's more lenient of technically invalid URLs - Issue #1801 [Marcos Duque, Thomas Walpole]
 
-#2.10.1
+#Version 2.10.1
 Release date: 2016-10-08
 
 ### Fixed
@@ -28,7 +54,7 @@ Release date: 2016-10-08
 * Capybara::Result optimization disabled in JRuby due to issue with lazy enumerator evaluation [Thomas Walpole]
   See: https://github.com/jruby/jruby/issues/4212
 
-#2.10.0
+#Version 2.10.0
 Release date: 2016-10-05
 
 ### Added

data/README.md

@@ -672,6 +672,10 @@ Or have it save and automatically open:
 save_and_open_screenshot
 ```
 
+Screenshots are saved to `Capybara.save_path`, relative to the app directory.
+If you have required `capybara/rails`, `Capybara.save_path` will default to
+`tmp/capybara`.
+
 ## <a name="matching"></a>Matching
 
 It is possible to customize how Capybara finds elements. At your disposal

data/lib/capybara.rb

@@ -29,6 +29,7 @@ module Capybara
     attr_accessor :raise_server_errors, :server_errors
     attr_writer :default_driver, :current_driver, :javascript_driver, :session_name, :server_host
     attr_reader :save_and_open_page_path
+    attr_accessor :exact_text
     attr_accessor :app
 
     ##
@@ -244,7 +245,7 @@ module Capybara
     # manually.
     #
     # @param [Rack Application] app    The rack application to run
-    # @param [Fixnum] port              The port to run the application on
+    # @param [Integer] port              The port to run the application on
     #
     def run_default_server(app, port)
       servers[:webrick].call(app, port, server_host)
@@ -368,7 +369,7 @@ module Capybara
     def HTML(html)
       Nokogiri::HTML(html).tap do |document|
         document.xpath('//textarea').each do |textarea|
-          textarea.content=textarea.content.sub(/\A\n/,'')
+          textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/,'')
         end
       end
     end
@@ -495,6 +496,7 @@ Capybara.configure do |config|
   config.automatic_reload = true
   config.match = :smart
   config.exact = false
+  config.exact_text = false
   config.raise_server_errors = true
   config.server_errors = [StandardError]
   config.visible_text_only = false

data/lib/capybara/driver/base.rb

@@ -28,11 +28,11 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#go_forward'
   end
 
-  def execute_script(script)
+  def execute_script(script, *args)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#execute_script'
   end
 
-  def evaluate_script(script)
+  def evaluate_script(script, *args)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#evaluate_script'
   end
 

data/lib/capybara/helpers.rb

@@ -28,8 +28,14 @@ module Capybara
     # @param [String] text Text to escape
     # @return [String]     Escaped text
     #
-    def to_regexp(text, options=nil)
-      text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(normalize_whitespace(text)), options)
+    def to_regexp(text, regexp_options=nil, exact=false)
+      if text.is_a?(Regexp)
+        text
+      else
+        escaped = Regexp.escape(normalize_whitespace(text))
+        escaped = "\\A#{escaped}\\z" if exact
+        Regexp.new(escaped, regexp_options)
+      end
     end
 
     ##

data/lib/capybara/node/actions.rb

@@ -75,6 +75,7 @@ module Capybara
       #   @macro waiting_behavior
       #   @option options [String] :with          The value to fill in - required
       #   @option options [Hash] :fill_options    Driver specific options regarding how to fill fields
+      #   @option options [String] :currently_with The current value property of the field to fill in
       #   @option options [Boolean] :multiple      Match fields that can have multiple values?
       #   @option options [String] :id             Match fields that match the id attribute
       #   @option options [String] :name           Match fields that match the name attribute
@@ -87,6 +88,7 @@ module Capybara
         raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with)
         with = options.delete(:with)
         fill_options = options.delete(:fill_options)
+        options[:with] = options.delete(:currently_with) if options.has_key?(:currently_with)
         find(:fillable_field, locator, options).set(with, fill_options)
       end
 
@@ -228,6 +230,7 @@ module Capybara
       # @option options [String] id             Match fields that match the id attribute
       # @option options [String] name           Match fields that match the name attribute
       # @option options [String, Array<String>] :class    Match links that match the class(es) provided
+      # @option options [true, Hash] make_visible   A Hash of CSS styles to change before attempting to attach the file, if `true` { opacity: 1, display: 'block', visibility: 'visible' } is used (may not be supported by all drivers)
       #
       # @return [Capybara::Node::Element]  The file field element
       def attach_file(locator, path, options={})
@@ -235,10 +238,58 @@ module Capybara
         Array(path).each do |p|
           raise Capybara::FileNotFound, "cannot attach file, #{p} does not exist" unless File.exist?(p.to_s)
         end
-        find(:file_field, locator, options).set(path)
+        # Allow user to update the CSS style of the file input since they are so often hidden on a page
+        if style = options.delete(:make_visible)
+          style = { opacity: 1, display: 'block', visibility: 'visible' } if style == true
+          ff = find(:file_field, locator, options.merge({visible: :all}))
+          _update_style(ff, style)
+          if ff.visible?
+            begin
+              ff.set(path)
+            ensure
+              _reset_style(ff)
+            end
+          else
+            raise ExpectationNotMet, "The style changes in :make_visible did not make the file input visible"
+          end
+        else
+          find(:file_field, locator, options).set(path)
+        end
       end
 
     private
+      def _update_style(element, style)
+        script = <<-JS
+          var el = arguments[0];
+          el.capybara_style_cache = el.style.cssText;
+          var css = arguments[1];
+          for (var prop in css){
+            if (css.hasOwnProperty(prop)) {
+              el.style[prop] = css[prop]
+            }
+          }
+        JS
+        begin
+          session.execute_script(script, element, style)
+        rescue Capybara::NotSupportedByDriverError
+          warn "The :make_visible option is not supported by the current driver - ignoring"
+        end
+      end
+
+      def _reset_style(element)
+        script = <<-JS
+          var el = arguments[0];
+          if (el.hasOwnProperty('capybara_style_cache')) {
+            el.style.cssText = el.capybara_style_cache;
+            delete el.capybara_style_cache;
+          }
+        JS
+        begin
+          session.execute_script(script, element)
+        rescue
+        end
+      end
+
 
       def _check_with_label(selector, checked, locator, options)
         locator, options = nil, locator if locator.is_a? Hash

data/lib/capybara/node/document_matchers.rb

@@ -11,6 +11,7 @@ module Capybara
       #   @overload $0(regexp, options = {})
       #     @param regexp [Regexp]           The regexp that title should match to
       #   @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for title to eq/match given string/regexp argument
+      #   @option options [Boolean] :exact (false) When passed a string should the match be exact or just substring
       # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
       # @return [true]
       #

data/lib/capybara/node/finders.rb

@@ -89,7 +89,7 @@ module Capybara
       #
       #   @macro waiting_behavior
       #
-      #   @option options [String,Regexp] href        Value to match against the links href
+      #   @option options [String,Regexp,nil] href        Value to match against the links href, if nil finds link placeholders (<a> elements with no href attribute)
       #   @option options [String] id                 Match links with the id provided
       #   @option options [String] title              Match links with the title provided
       #   @option options [String] alt                Match links with a contained img element whose alt matches
@@ -188,6 +188,7 @@ module Capybara
       # @param [Symbol] kind                       Optional selector type (:css, :xpath, :field, etc.) - Defaults to Capybara.default_selector
       # @param [String] locator                    The selector
       # @option options [String, Regexp] text      Only find elements which contain this text or match this regexp
+      # @option options [String, Boolean] exact_text (Capybara.exact_text) When String the string the elements contained text must match exactly, when Boolean controls whether the :text option must match exactly
       # @option options [Boolean, Symbol] visible  Only find elements with the specified visibility:
       #                                              * true - only finds visible elements.
       #                                              * false - finds invisible _and_ visible elements.

data/lib/capybara/node/matchers.rb

@@ -97,6 +97,58 @@ module Capybara
         end
       end
 
+      # Asserts that all of the provided selectors are present on the given page
+      # or descendants of the current node.  If options are provided, the assertion
+      # will check that each locator is present with those options as well (other than :wait).
+      #
+      #   page.assert_all_of_selectors(:custom, 'Tom', 'Joe', visible: all)
+      #   page.assert_all_of_selectors(:css, '#my_div', 'a.not_clicked')
+      #
+      # It accepts all options that {Capybara::Node::Finders#all} accepts,
+      # such as :text and :visible.
+      #
+      # The :wait option applies to all of the selectors as a group, so all of the locators must be present
+      # within :wait (Defaults to Capybara.default_max_wait_time) seconds.
+      #
+      # @overload assert_all_of_selectors([kind = Capybara.default_selector], *locators, options = {})
+      #
+      def assert_all_of_selectors(*args, &optional_filter_block)
+        options = if args.last.is_a?(Hash) then args.pop.dup else {} end
+        selector = if args.first.is_a?(Symbol) then args.shift else Capybara.default_selector end
+        wait = options.fetch(:wait, Capybara.default_max_wait_time)
+        synchronize(wait) do
+          args.each do |locator|
+            assert_selector(selector, locator, options, &optional_filter_block)
+          end
+        end
+      end
+
+      # Asserts that none of the provided selectors are present on the given page
+      # or descendants of the current node. If options are provided, the assertion
+      # will check that each locator is present with those options as well (other than :wait).
+      #
+      #   page.assert_none_of_selectors(:custom, 'Tom', 'Joe', visible: all)
+      #   page.assert_none_of_selectors(:css, '#my_div', 'a.not_clicked')
+      #
+      # It accepts all options that {Capybara::Node::Finders#all} accepts,
+      # such as :text and :visible.
+      #
+      # The :wait option applies to all of the selectors as a group, so none of the locators must be present
+      # within :wait (Defaults to Capybara.default_max_wait_time) seconds.
+      #
+      # @overload assert_none_of_selectors([kind = Capybara.default_selector], *locators, options = {})
+      #
+      def assert_none_of_selectors(*args, &optional_filter_block)
+        options = if args.last.is_a?(Hash) then args.pop.dup else {} end
+        selector = if args.first.is_a?(Symbol) then args.shift else Capybara.default_selector end
+        wait = options.fetch(:wait, Capybara.default_max_wait_time)
+        synchronize(wait) do
+          args.each do |locator|
+            assert_no_selector(selector, locator, options, &optional_filter_block)
+          end
+        end
+      end
+
       ##
       #
       # Asserts that a given selector is not on the page or a descendant of the current node.
@@ -546,6 +598,7 @@ module Capybara
       #     @option options [Integer] :maximum (nil)   Maximum number of times the text is expected to occur
       #     @option options [Range]   :between (nil)   Range of times that is expected to contain number of times text occurs
       #     @option options [Numeric] :wait (Capybara.default_max_wait_time)      Maximum time that Capybara will wait for text to eq/match given string/regexp argument
+      #     @option options [Boolean] :exact (Capybara.exact_text) Whether text must be an exact match or just substring
       #   @overload $0(text, options = {})
       #     @param [String, Regexp] text               The string/regexp to check for. If it's a string, text is expected to include it. If it's a regexp, text is expected to match it.
       #     @option options [Integer] :count (nil)     Number of times the text is expected to occur
@@ -553,6 +606,7 @@ module Capybara
       #     @option options [Integer] :maximum (nil)   Maximum number of times the text is expected to occur
       #     @option options [Range]   :between (nil)   Range of times that is expected to contain number of times text occurs
       #     @option options [Numeric] :wait (Capybara.default_max_wait_time)      Maximum time that Capybara will wait for text to eq/match given string/regexp argument
+      #     @option options [Boolean] :exact (Capybara.exact_text) Whether text must be an exact match or just substring
       # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
       # @return [true]
       #

data/lib/capybara/node/simple.rb

@@ -76,7 +76,7 @@ module Capybara
       #
       def value
         if tag_name == 'textarea'
-          native.content
+          native['_capybara_raw_value']
         elsif tag_name == 'select'
           if native['multiple'] == 'multiple'
             native.xpath(".//option[@selected='selected']").map { |option| option[:value] || option.content  }

data/lib/capybara/queries/current_path_query.rb

@@ -17,10 +17,12 @@ module Capybara
         @actual_path = if options[:url]
           session.current_url
         else
+          uri = ::Addressable::URI.parse(session.current_url)
+
           if options[:only_path]
-            ::Addressable::URI.parse(session.current_url).path
+            uri.path unless uri.nil? # Ensure the parsed url isn't nil.
           else
-            ::Addressable::URI.parse(session.current_url).request_uri
+            uri.request_uri unless uri.nil? # Ensure the parsed url isn't nil.
           end
         end
 

data/lib/capybara/queries/selector_query.rb

@@ -4,7 +4,7 @@ module Capybara
     class SelectorQuery < Queries::BaseQuery
       attr_accessor :selector, :locator, :options, :expression, :find, :negative
 
-      VALID_KEYS = COUNT_KEYS + [:text, :id, :class, :visible, :exact, :match, :wait, :filter_set]
+      VALID_KEYS = COUNT_KEYS + [:text, :id, :class, :visible, :exact, :exact_text, :match, :wait, :filter_set]
       VALID_MATCH = [:first, :smart, :prefer_exact, :one]
 
       def initialize(*args, &filter_block)
@@ -42,7 +42,8 @@ module Capybara
 
       def description
         @description = String.new("#{label} #{locator.inspect}")
-        @description << " with text #{options[:text].inspect}" if options[:text]
+        @description << " with#{" exact" if exact_text === true} text #{options[:text].inspect}" if options[:text]
+        @description << " with exact text #{options[:exact_text]}" if options[:exact_text].is_a?(String)
         @description << " with id #{options[:id]}" if options[:id]
         @description << " with classes #{Array(options[:class]).join(',')}]" if options[:class]
         @description << selector.description(options)
@@ -52,7 +53,22 @@ module Capybara
 
       def matches_filters?(node)
         if options[:text]
-          regexp = options[:text].is_a?(Regexp) ? options[:text] : Regexp.escape(options[:text].to_s)
+          regexp = if options[:text].is_a?(Regexp)
+            options[:text]
+          else
+            if exact_text === true
+              "\\A#{Regexp.escape(options[:text].to_s)}\\z"
+            else
+              Regexp.escape(options[:text].to_s)
+            end
+          end
+          text_visible = visible
+          text_visible = :all if text_visible == :hidden
+          return false if not node.text(text_visible).match(regexp)
+        end
+
+        if exact_text.is_a?(String)
+          regexp = "\\A#{Regexp.escape(options[:exact_text])}\\z"
           text_visible = visible
           text_visible = :all if text_visible == :hidden
           return false if not node.text(text_visible).match(regexp)
@@ -187,6 +203,10 @@ module Capybara
           warn "The :exact option only has an effect on queries using the XPath#is method. Using it with the query \"#{expression.to_s}\" has no effect."
         end
       end
+
+      def exact_text
+        exact_text = options.fetch(:exact_text, Capybara.exact_text)
+      end
     end
   end
 end

data/lib/capybara/queries/text_query.rb

@@ -10,8 +10,8 @@ module Capybara
         unless @expected_text.is_a?(Regexp)
           @expected_text = Capybara::Helpers.normalize_whitespace(@expected_text)
         end
-        @search_regexp = Capybara::Helpers.to_regexp(@expected_text)
         @options ||= {}
+        @search_regexp = Capybara::Helpers.to_regexp(@expected_text, nil, exact?)
         assert_valid_keys
       end
 
@@ -33,12 +33,16 @@ module Capybara
         if @expected_text.is_a?(Regexp)
           "text matching #{@expected_text.inspect}"
         else
-          "text #{@expected_text.inspect}"
+          "#{"exact " if exact?}text #{@expected_text.inspect}"
         end
       end
 
       private
 
+      def exact?
+        options.fetch(:exact, Capybara.exact_text)
+      end
+
       def build_message(report_on_invisible)
         message = String.new()
         unless (COUNT_KEYS & @options.keys).empty?
@@ -57,10 +61,14 @@ module Capybara
         end
 
         if @node and check_visible_text? and report_on_invisible
-          invisible_text = text(@node, :all)
-          invisible_count = invisible_text.scan(@search_regexp).size
-          if invisible_count != @count
-            details_message << ". it was found #{invisible_count} #{Capybara::Helpers.declension("time", "times", invisible_count)} including non-visible text"
+          begin
+            invisible_text = text(@node, :all)
+            invisible_count = invisible_text.scan(@search_regexp).size
+            if invisible_count != @count
+              details_message << ". it was found #{invisible_count} #{Capybara::Helpers.declension("time", "times", invisible_count)} including non-visible text"
+            end
+          rescue
+            # An error getting the non-visible text (if element goes out of scope) should not affect the response
           end
         end
 
@@ -70,7 +78,7 @@ module Capybara
       end
 
       def valid_keys
-        COUNT_KEYS + [:wait]
+        COUNT_KEYS + [:wait, :exact]
       end
 
       def check_visible_text?