capybara 2.8.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbc8500c466333af5900b64e398ea4bb73221857
-  data.tar.gz: f1ccdd60394f1d8d6a73bdc6cc2f70cbd05459f6
+  metadata.gz: 074717523be47e7a162c2d4bc45f5ff49737e6a8
+  data.tar.gz: 25c95e6c9273c09663933921ba177067e622ea65
 SHA512:
-  metadata.gz: 1c18871ba8adfa7f8ed70df32f332909cff6d6ee2518fefb252de17267d5549a6a281e6958e3dfb5cda029002be4b51203d0793bbe454e96d7998583a576cd74
-  data.tar.gz: 8be99a4f361374e92c9cbb9050920e7c031d4e8cfdcbf1d5fef28cdcfe938df6b61531a817afff9a7910ea9b28b7a0636512420abcdcbedc98fd1dfbcafc25dd
+  metadata.gz: d1db39b289e31ac1432a30cbe5ff8ce957867e1b3fd854813d8bfa954af0babb5a89ac1ccfa21ff6d5074b112a69e4b6deb751bc9c054026bad65d9a2f7d6e0d
+  data.tar.gz: 635c3bfb9e2d366ad8bc87a2abe075f2286e496fd2171bf32e6ef6628a55f8f95dfee2fd8e326819ca81d1dc0c85ac0dfee86d0491c5710e5c53f6e756e50c65

data/.yard/templates_custom/default/class/html/selectors.erb

@@ -0,0 +1,38 @@
+<div id="selectors">
+  <h2>Built-in Selectors</h2>
+  <ul>
+    <% @selectors.each do |name, selector| %>
+      <li>
+        <h3>:<%= name %></h3>
+        <div class="docstring">
+          <div class="discussion">
+            <p><%= h(selector.docstring) %></p>
+          </div>
+        </div>
+        <div class="tags">
+          <p class="inline">Locator:</p>
+          <% if locator=selector.tag('locator') %>
+            <p class="inline"><%= h locator.text %></p>
+          <% end %>
+          <% if selector.has_tag?('filter') %>
+            <p>Filters:</p>
+            <ul class="param">
+              <% selector.tags('filter').each do |filter| %>
+              <li>
+                <span class="name"><%= filter.name %></span>
+                <% if filter.types  %>
+                <span class="type">(<tt><%= h(filter.types.join(', ')) %></tt>)</span>
+                <% end %>
+                <% if filter.text %>
+                —
+                <div class="inline"><p><%= h filter.text %></p></div>
+                <% end %>
+              </li>
+              <% end %>
+            </ul>
+          <% end %>
+        </div
+      </li>
+    <% end %>
+  </ul>
+</div>

data/.yard/templates_custom/default/class/html/setup.rb

@@ -0,0 +1,17 @@
+def init
+  super
+  sections.place(:builtins).before(:subclasses)
+end
+
+def builtins
+  return if object.path != "Capybara::Selector" # only show built-in selectors for Selector class
+
+  @selectors = Registry.all(:selector)
+  return if @selectors.nil? || @selectors.empty?
+
+  @selectors = @selectors.map do |selector|
+    [selector.name, selector]
+  end
+
+  erb(:selectors)
+end

data/.yard/yard_extensions.rb

@@ -0,0 +1,78 @@
+YARD::Templates::Engine.register_template_path Pathname.new('./.yard/templates_custom')
+
+YARD::Tags::Library.define_tag "Locator", :locator
+YARD::Tags::Library.define_tag "Filter", :filter, :with_types_and_name
+
+class SelectorObject < YARD::CodeObjects::Base
+  def path
+    "__Capybara" + sep + super
+  end
+end
+
+class AddSelectorHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:add_selector)
+  namespace_only
+  process do
+    name = statement.parameters.first.jump(:tstring_content, :ident).source
+    # object = YARD::CodeObjects::MethodObject.new(namespace, name.to_sym)
+    # object = SelectorObject.new(YARD::Registry.resolve(P("Capybara"), "#add_selector", false, true), name.to_sym)
+    object = SelectorObject.new(namespace, name)
+    register(object)
+    parse_block(statement.last.last, :owner => object)
+
+    # modify the object
+    object.dynamic = true
+  end
+end
+
+class AddExpressionFilterHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:xpath)
+  handles method_call(:css)
+
+  process do
+    return unless owner.is_a?(SelectorObject)
+    return if statement.parameters.empty?
+    # names = statement.parameters.children.map { |p| p.jump(:tstring_content, :ident).source.sub(/^:/, '') }
+    names = statement.parameters.children.map &:source
+    current_names = owner.tags(:filter).map(&:name)
+    (names-current_names).each do |name|
+      owner.add_tag(YARD::Tags::Tag.new(:filter, nil, nil, name))
+    end
+  end
+end
+
+class AddFilterHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:filter)
+
+  process do
+    return unless owner.is_a?(SelectorObject)
+    return if statement.parameters.empty?
+    name = statement.parameters.first.source
+    type = if statement.parameters[1] && statement.parameters[1].source == ':boolean'
+      'Boolean'
+    else
+      nil
+    end
+    if owner.tags(:filter).none? {|tag| tag.name == name }
+      filter_tag = YARD::Tags::Tag.new(:filter, nil, type, name)
+      owner.add_tag(filter_tag)
+    end
+  end
+end
+
+class FilterSetHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:filter_set)
+
+  process do
+    return unless owner.is_a?(SelectorObject)
+    return if statement.parameters.empty? || !statement.parameters[1]
+
+    names = statement.parameters[1].flatten.map { |name| ":#{name}" }
+    names.each do |name|
+      if owner.tags(:filter).none? {|tag| tag.name == name }
+        filter_tag = YARD::Tags::Tag.new(:filter, nil, nil, name)
+        owner.add_tag(filter_tag)
+      end
+    end
+  end
+end

data/.yardopts

@@ -0,0 +1 @@
+--load ./.yard/yard_extensions.rb

data/History.md

@@ -1,5 +1,17 @@
+#Version 2.9.0
+Release date: 2016-09-19
+
+### Fixed
+* Issue with rack-test driver and obselete mime-types when using `#attach_file` - Issue #1756 [Thomas Walpole]
+
+### Added
+* `:class` option to many of the built-in selectors [Thomas Walpole]
+* Removed need to specify value when creating `:boolean` filter type in custom selectors [Thomas Walpole]
+* Filters can now be implemented through the XPath/CSS expressions in custom selectors [Thomas Walpole]
+* `Element#matches_xpath?` and `Element#matches_css?` [Thomas Walpole]
+
 #Version 2.8.1
-Release data: 2016-08-25
+Release date: 2016-08-25
 
 ###Fixed
 * Fixed error message from have_text when text is not found but contains regex special characters [Ryunosuke Sato]

data/README.md

@@ -13,7 +13,7 @@ through an external gem.
 **Need help?** Ask on the mailing list (please do not open an issue on
 GitHub): http://groups.google.com/group/ruby-capybara
 
-**Note: Firefox 48** If you're using Firefox with selenium-webdrvier, stay on either Firefox 45.0esr or 47.0.1 and selenium-webdriver 2.53.4.  Firefox 48 requires geckodriver and selenium-webdriver v3, the combo of which currently has multiple issues and is feature incomplete.
+**Note: Firefox 48** If you're using Firefox with selenium-webdriver, stay on either Firefox [45.0esr](https://ftp.mozilla.org/pub/firefox/releases/45.0esr/) or [47.0.1](https://ftp.mozilla.org/pub/firefox/releases/47.0.1/) and selenium-webdriver 2.53.4.  Firefox 48 requires geckodriver and selenium-webdriver v3, the combo of which currently has multiple issues and is feature incomplete.
 
 ## Table of contents
 

data/lib/capybara/helpers.rb

@@ -51,65 +51,6 @@ module Capybara
       html
     end
 
-    ##
-    #
-    # Checks if the given count matches the given count options.
-    # Defaults to true if no options are specified. If multiple
-    # options are provided, it tests that all conditions are met;
-    # however, if :count is supplied, all other options are ignored.
-    #
-    # @param [Integer] count     The actual number. Should be coercible via Integer()
-    # @option [Range] between    Count must be within the given range
-    # @option [Integer] count    Count must be exactly this
-    # @option [Integer] maximum  Count must be smaller than or equal to this value
-    # @option [Integer] minimum  Count must be larger than or equal to this value
-    #
-    def matches_count?(count, options={})
-      return (Integer(options[:count]) == count)     if options[:count]
-      return false if options[:maximum] && (Integer(options[:maximum]) < count)
-      return false if options[:minimum] && (Integer(options[:minimum]) > count)
-      return false if options[:between] && !(options[:between] === count)
-      return true
-    end
-
-    ##
-    #
-    # Checks if a count of 0 is valid for the given options hash.
-    # Returns false if options hash does not specify any count options.
-    #
-    def expects_none?(options={})
-      if [:count, :maximum, :minimum, :between].any? { |k| options.has_key? k }
-        matches_count?(0,options)
-      else
-        false
-      end
-    end
-
-    ##
-    #
-    # Generates a failure message given a description of the query and count
-    # options.
-    #
-    # @param [String] description   Description of a query
-    # @option [Range] between       Count should have been within the given range
-    # @option [Integer] count       Count should have been exactly this
-    # @option [Integer] maximum     Count should have been smaller than or equal to this value
-    # @option [Integer] minimum     Count should have been larger than or equal to this value
-    #
-    def failure_message(description, options={})
-      message = String.new("expected to find #{description}")
-      if options[:count]
-        message << " #{options[:count]} #{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]} #{declension('time', 'times', options[:maximum])}"
-      elsif options[:minimum]
-        message << " at least #{options[:minimum]} #{declension('time', 'times', options[:minimum])}"
-      end
-      message
-    end
-
     ##
     #
     # A poor man's `pluralize`. Given two declensions, one singular and one

data/lib/capybara/node/actions.rb

@@ -64,16 +64,18 @@ module Capybara
       #
       #     page.fill_in 'Name', :with => 'Bob'
       #
-      # @macro waiting_behavior
       #
-      # @param [String] locator                 Which field to fill in
-      # @param [Hash] options
-      # @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 [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
-      # @option options [String] placeholder    Match fields that match the placeholder attribute
+      # @overload fill_in([locator], options={})
+      #   @param [String] locator                 Which field to fill in
+      #   @param [Hash] options
+      #   @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 [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
+      #   @option options [String] :placeholder    Match fields that match the placeholder attribute
+      #   @option options [String, Array<String>] :class    Match links that match the class(es) provided
       #
       def fill_in(locator, options={})
         locator, options = nil, locator if locator.is_a? Hash
@@ -97,8 +99,9 @@ module Capybara
       #   @param [String] locator           Which radio button to choose
       #
       #   @option options [String] :option  Value of the radio_button to choose
-      #   @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] :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
       #   @macro waiting_behavior
       #   @macro label_click
       def choose(locator, options={})
@@ -133,6 +136,7 @@ module Capybara
       #   @option options [String] :option  Value of the checkbox to select
       #   @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
       #   @macro label_click
       #   @macro waiting_behavior
       #
@@ -168,6 +172,7 @@ module Capybara
       #   @option options [String] :option  Value of the checkbox to deselect
       #   @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
       #   @macro label_click
       #   @macro waiting_behavior
       #
@@ -253,6 +258,7 @@ module Capybara
       # @option options [Boolean] multiple Match field which allows multiple file selection
       # @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
       #
       def attach_file(locator, path, options={})
         locator, path, options = nil, locator, path if path.is_a? Hash

data/lib/capybara/node/finders.rb

@@ -70,6 +70,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] placeholder    Match fields that match the placeholder attribute
+      #   @option options [String, Array<String>] Match fields that match the class(es) passed
       # @return [Capybara::Node::Element]   The found element
       #
 
@@ -89,6 +90,10 @@ module Capybara
       #   @macro waiting_behavior
       #
       #   @option options [String,Regexp] href        Value to match against the links href
+      #   @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
+      #   @option options [String, Array<String>] class    Match links that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
       def find_link(locator=nil, options={})
@@ -114,6 +119,10 @@ module Capybara
       #                                                       * true - only finds a disabled button
       #                                                       * false - only finds an enabled button
       #                                                       * :all - finds either an enabled or disabled button
+      #   @option options [String] 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, Array<String>] class    Match links that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
       def find_button(locator=nil, options={})

data/lib/capybara/node/matchers.rb

@@ -5,7 +5,7 @@ module Capybara
 
       ##
       #
-      # Checks if a given selector is on the page or current node.
+      # Checks if a given selector is on the page or a descendant of the current node.
       #
       #     page.has_selector?('p#foo')
       #     page.has_selector?(:xpath, './/p[@id="foo"]')
@@ -44,7 +44,7 @@ module Capybara
 
       ##
       #
-      # Checks if a given selector is not on the page or current node.
+      # Checks if a given selector is not on the page or a descendant of the current node.
       # Usage is identical to Capybara::Node::Matchers#has_selector?
       #
       # @param (see Capybara::Node::Finders#has_selector?)
@@ -59,7 +59,6 @@ module Capybara
       ##
       #
       # Checks if the current node matches given selector
-      # Usage is identical to Capybara::Node::Matchers#has_selector?
       #
       # @param (see Capybara::Node::Finders#has_selector?)
       # @return [Boolean]
@@ -70,6 +69,27 @@ module Capybara
         return false
       end
 
+      ##
+      #
+      # Checks if the current node matches given XPath expression
+      #
+      # @param [String, XPath::Expression] xpath The XPath expression to match against the current code
+      # @return [Boolean]
+      #
+      def matches_xpath?(xpath, options={})
+        matches_selector?(:xpath, xpath, options)
+      end
+
+      ##
+      #
+      # Checks if the current node matches given CSS selector
+      #
+      # @param [String] css The CSS selector to match against the current code
+      # @return [Boolean]
+      #
+      def matches_css?(css, options={})
+        matches_selector?(:css, css, options)
+      end
 
       ##
       #
@@ -85,10 +105,31 @@ module Capybara
         return false
       end
 
+      ##
+      #
+      # Checks if the current node does not match given XPath expression
+      #
+      # @param [String, XPath::Expression] xpath The XPath expression to match against the current code
+      # @return [Boolean]
+      #
+      def not_matches_xpath?(xpath, options={})
+        not_matches_selector?(:xpath, xpath, options)
+      end
+
+      ##
+      #
+      # Checks if the current node does not match given CSS selector
+      #
+      # @param [String] css The CSS selector to match against the current code
+      # @return [Boolean]
+      #
+      def not_matches_css?(css, options={})
+        not_matches_selector?(:css, css, options)
+      end
 
       ##
       #
-      # Asserts that a given selector is on the page or current node.
+      # Asserts that a given selector is on the page or a descendant of the current node.
       #
       #     page.assert_selector('p#foo')
       #     page.assert_selector(:xpath, './/p[@id="foo"]')
@@ -123,7 +164,7 @@ module Capybara
         query = Capybara::Queries::SelectorQuery.new(*args)
         synchronize(query.wait) do
           result = query.resolve_for(self)
-          unless result.matches_count? && ((!result.empty?) || Capybara::Helpers.expects_none?(query.options))
+          unless result.matches_count? && ((!result.empty?) || query.expects_none?)
             raise Capybara::ExpectationNotMet, result.failure_message
           end
         end
@@ -132,7 +173,7 @@ module Capybara
 
       ##
       #
-      # Asserts that a given selector is not on the page or current node.
+      # Asserts that a given selector is not on the page or a descendant of the current node.
       # Usage is identical to Capybara::Node::Matchers#assert_selector
       #
       # Query options such as :count, :minimum, :maximum, and :between are
@@ -150,7 +191,7 @@ module Capybara
         query = Capybara::Queries::SelectorQuery.new(*args)
         synchronize(query.wait) do
           result = query.resolve_for(self)
-          if result.matches_count? && ((!result.empty?) || Capybara::Helpers.expects_none?(query.options))
+          if result.matches_count? && ((!result.empty?) || query.expects_none?)
             raise Capybara::ExpectationNotMet, result.negative_failure_message
           end
         end
@@ -199,7 +240,7 @@ module Capybara
 
       ##
       #
-      # Checks if a given XPath expression is on the page or current node.
+      # Checks if a given XPath expression is on the page or a descendant of the current node.
       #
       #     page.has_xpath?('.//p[@id="foo"]')
       #
@@ -232,7 +273,7 @@ module Capybara
 
       ##
       #
-      # Checks if a given XPath expression is not on the page or current node.
+      # Checks if a given XPath expression is not on the page or a descendant of the current node.
       # Usage is identical to Capybara::Node::Matchers#has_xpath?
       #
       # @param (see Capybara::Node::Finders#has_xpath?)
@@ -244,7 +285,7 @@ module Capybara
 
       ##
       #
-      # Checks if a given CSS selector is on the page or current node.
+      # Checks if a given CSS selector is on the page or a descendant of the current node.
       #
       #     page.has_css?('p#foo')
       #
@@ -271,7 +312,7 @@ module Capybara
 
       ##
       #
-      # Checks if a given CSS selector is not on the page or current node.
+      # Checks if a given CSS selector is not on the page or a descendant of the current node.
       # Usage is identical to Capybara::Node::Matchers#has_css?
       #
       # @param (see Capybara::Node::Finders#has_css?)
@@ -520,8 +561,7 @@ module Capybara
         query = Capybara::Queries::TextQuery.new(*args)
         synchronize(query.wait) do
           count = query.resolve_for(self)
-          matches_count = Capybara::Helpers.matches_count?(count, query.options)
-          unless matches_count && ((count > 0) || Capybara::Helpers.expects_none?(query.options))
+          unless query.matches_count?(count) && ((count > 0) || query.expects_none?)
             raise Capybara::ExpectationNotMet, query.failure_message
           end
         end
@@ -540,8 +580,7 @@ module Capybara
         query = Capybara::Queries::TextQuery.new(*args)
         synchronize(query.wait) do
           count = query.resolve_for(self)
-          matches_count = Capybara::Helpers.matches_count?(count, query.options)
-          if matches_count && ((count > 0) || Capybara::Helpers.expects_none?(query.options))
+          if query.matches_count?(count) && ((count > 0) || query.expects_none?)
             raise Capybara::ExpectationNotMet, query.negative_failure_message
           end
         end