rspec-expectations 3.0.0.beta1 → 3.0.0.beta2

data/lib/rspec/matchers.rb

@@ -1,26 +1,22 @@
 require 'rspec/matchers/pretty'
-
+require 'rspec/matchers/composable'
 require 'rspec/matchers/built_in'
-require 'rspec/matchers/matcher'
-require 'rspec/matchers/operator_matcher'
-
 require 'rspec/matchers/generated_descriptions'
-require 'rspec/matchers/method_missing'
-require 'rspec/matchers/compatibility'
 require 'rspec/matchers/dsl'
-require 'rspec/matchers/test_unit_integration'
+require 'rspec/matchers/matcher_delegator'
+require 'rspec/matchers/aliased_matcher'
 
 module RSpec
   # RSpec::Matchers provides a number of useful matchers we use to define
   # expectations. A matcher is any object that responds to the following:
   #
   #     matches?(actual)
-  #     failure_message_for_should
+  #     failure_message
   #
   # These methods are also part of the matcher protocol, but are optional:
   #
   #     does_not_match?(actual)
-  #     failure_message_for_should_not
+  #     failure_message_when_negated
   #     description
   #
   # ## Predicates
@@ -59,6 +55,12 @@ module RSpec
   # You can use this feature to invoke any predicate that begins with "has_", whether it is
   # part of the Ruby libraries (like `Hash#has_key?`) or a method you wrote on your own class.
   #
+  # Note that RSpec does not provide composable aliases for these dynamic predicate
+  # matchers. You can easily define your own aliases, though:
+  #
+  #     RSpec::Matchers.alias_matcher :a_user_who_is_an_admin, :be_an_admin
+  #     expect(user_list).to include(a_user_who_is_an_admin)
+  #
   # ## Custom Matchers
   #
   # When you find that none of the stock matchers provide a natural feeling
@@ -98,11 +100,11 @@ module RSpec
   #         player.in_zone?(zone)
   #       end
   #
-  #       failure_message_for_should do |player|
+  #       failure_message do |player|
   #         # generate and return the appropriate string.
   #       end
   #
-  #       failure_message_for_should_not do |player|
+  #       failure_message_when_negated do |player|
   #         # generate and return the appropriate string.
   #       end
   #
@@ -113,8 +115,8 @@ module RSpec
   #
   # Each of the message-generation methods has access to the block arguments
   # passed to the <tt>create</tt> method (in this case, <tt>zone</tt>). The
-  # failure message methods (<tt>failure_message_for_should</tt> and
-  # <tt>failure_message_for_should_not</tt>) are passed the actual value (the
+  # failure message methods (<tt>failure_message</tt> and
+  # <tt>failure_message_when_negated</tt>) are passed the actual value (the
   # receiver of <tt>expect(..)</tt> or <tt>expect(..).not_to</tt>).
   #
   # ### Custom Matcher from scratch
@@ -131,11 +133,11 @@ module RSpec
   #         @target.current_zone.eql?(Zone.new(@expected))
   #       end
   #
-  #       def failure_message_for_should
+  #       def failure_message
   #         "expected #{@target.inspect} to be in Zone #{@expected}"
   #       end
   #
-  #       def failure_message_for_should_not
+  #       def failure_message_when_negated
   #         "expected #{@target.inspect} not to be in Zone #{@expected}"
   #       end
   #     end
@@ -171,32 +173,90 @@ module RSpec
   #     RSpec::configure do |config|
   #       config.include(CustomGameMatchers)
   #     end
+  #
+  # ### Making custom matchers composable
+  #
+  # RSpec's built-in matchers are designed to be composed, in expressions like:
+  #
+  #     expect(["barn", 2.45]).to contain_exactly(
+  #       a_value_within(0.1).of(2.5),
+  #       a_string_starting_with("bar")
+  #     )
+  #
+  # Custom matchers can easily participate in composed matcher expressions like these.
+  # Include {RSpec::Matchers::Composable} in your custom matcher to make it support
+  # being composed (matchers defined using the DSL have this included automatically).
+  # Within your matcher's `matches?` method (or the `match` block, if using the DSL),
+  # use `values_match?(expected, actual)` rather than `expected == actual`.
+  # Under the covers, `values_match?` is able to match arbitrary
+  # nested data structures containing a mix of both matchers and non-matcher objects.
+  # It uses `===` and `==` to perform the matching, considering the values to
+  # match if either returns `true`. The `Composable` mixin also provides some helper
+  # methods for surfacing the matcher descriptions within your matcher's description
+  # or failure messages.
+  #
+  # RSpec's built-in matchers each have a number of aliases that rephrase the matcher
+  # from a verb phrase (such as `be_within`) to a noun phrase (such as `a_value_within`),
+  # which reads better when the matcher is passed as an argument in a composed matcher
+  # expressions, and also uses the noun-phrase wording in the matcher's `description`,
+  # for readable failure messages. You can alias your custom matchers in similar fashion
+  # using {RSpec::Matchers.alias_matcher}.
   module Matchers
-    # @api private
-    def self.is_a_matcher?(obj)
-      return true  if ::RSpec::Matchers::BuiltIn::BaseMatcher === obj
-      return false if obj.respond_to?(:i_respond_to_everything_so_im_not_really_a_matcher)
-      return false unless obj.respond_to?(:matches?)
-
-      obj.respond_to?(:failure_message_for_should) || obj.respond_to?(:failure_message)
+    # Defines a matcher alias. The returned matcher's `description` will be overriden
+    # to reflect the phrasing of the new name, which will be used in failure messages
+    # when passed as an argument to another matcher in a composed matcher expression.
+    #
+    # @param new_name [Symbol] the new name for the matcher
+    # @param old_name [Symbol] the original name for the matcher
+    # @yield [String] optional block that, when given is used to define the overriden
+    #   description. The yielded arg is the original description. If no block is
+    #   provided, a default description override is used based on the old and
+    #   new names.
+    #
+    # @example
+    #
+    #   RSpec::Matchers.alias_matcher :a_list_that_sums_to, :sum_to
+    #   sum_to(3).description # => "sum to 3"
+    #   a_list_that_sums_to(3).description # => "a list that sums to 3"
+    #
+    # @example
+    #
+    #   RSpec::Matchers.alias_matcher :a_list_sorted_by, :be_sorted_by do |description|
+    #     description.sub("be sorted by", "a list sorted by")
+    #   end
+    #
+    #   be_sorted_by(:age).description # => "be sorted by age"
+    #   a_list_sorted_by(:age).description # => "a list sorted by age"
+    def self.alias_matcher(new_name, old_name, &description_override)
+      description_override ||= lambda do |old_desc|
+        old_desc.gsub(Pretty.split_words(old_name), Pretty.split_words(new_name))
+      end
+
+      define_method(new_name) do |*args, &block|
+        matcher = __send__(old_name, *args, &block)
+        AliasedMatcher.new(matcher, description_override)
+      end
     end
 
     # Passes if actual is truthy (anything but false or nil)
     def be_truthy
       BuiltIn::BeTruthy.new
     end
+    alias_matcher :a_truthy_value, :be_truthy
 
-    # Passes if actual is falsy (false or nil)
+    # Passes if actual is falsey (false or nil)
     def be_falsey
       BuiltIn::BeFalsey.new
     end
-
-    alias_method :be_falsy, :be_falsey
+    alias_matcher :be_falsy,       :be_falsey
+    alias_matcher :a_falsey_value, :be_falsey
+    alias_matcher :a_falsy_value,  :be_falsey
 
     # Passes if actual is nil
     def be_nil
       BuiltIn::BeNil.new
     end
+    alias_matcher :a_nil_value, :be_nil
 
     # @example
     #   expect(actual).to     be_truthy
@@ -222,12 +282,12 @@ module RSpec
       args.empty? ?
         Matchers::BuiltIn::Be.new : equal(*args)
     end
+    alias_matcher :a_value, :be
 
     # passes if target.kind_of?(klass)
     def be_a(klass)
       be_a_kind_of(klass)
     end
-
     alias_method :be_an, :be_a
 
     # Passes if actual.instance_of?(expected)
@@ -240,8 +300,8 @@ module RSpec
     def be_an_instance_of(expected)
       BuiltIn::BeAnInstanceOf.new(expected)
     end
-
-    alias_method :be_instance_of, :be_an_instance_of
+    alias_method  :be_instance_of, :be_an_instance_of
+    alias_matcher :an_instance_of, :be_an_instance_of
 
     # Passes if actual.kind_of?(expected)
     #
@@ -253,8 +313,25 @@ module RSpec
     def be_a_kind_of(expected)
       BuiltIn::BeAKindOf.new(expected)
     end
+    alias_method  :be_kind_of, :be_a_kind_of
+    alias_matcher :a_kind_of,  :be_a_kind_of
 
-    alias_method :be_kind_of, :be_a_kind_of
+    # Passes if actual.between?(min, max). Works with any Comparable object,
+    # including String, Symbol, Time, or Numeric (Fixnum, Bignum, Integer,
+    # Float, Complex, and Rational).
+    #
+    # By default, `be_between` is inclusive (i.e. passes when given either the max or min value),
+    # but you can make it `exclusive` by chaining that off the matcher.
+    #
+    # @example
+    #
+    #   expect(5).to      be_between(1, 10)
+    #   expect(11).not_to be_between(1, 10)
+    #   expect(10).not_to be_between(1, 10).exclusive
+    def be_between(min, max)
+      BuiltIn::BeBetween.new(min, max)
+    end
+    alias_matcher :a_value_between, :be_between
 
     # Passes if actual == expected +/- delta
     #
@@ -265,6 +342,8 @@ module RSpec
     def be_within(delta)
       BuiltIn::BeWithin.new(delta)
     end
+    alias_matcher :a_value_within, :be_within
+    alias_matcher :within,         :be_within
 
     # Applied to a proc, specifies that its execution will cause some value to
     # change.
@@ -275,9 +354,18 @@ module RSpec
     # You can either pass <tt>receiver</tt> and <tt>message</tt>, or a block,
     # but not both.
     #
-    # When passing a block, it must use the <tt>{ ... }</tt> format, not
-    # do/end, as <tt>{ ... }</tt> binds to the +change+ method, whereas do/end
-    # would errantly bind to the +expect(..)+ or +expect(..).not_to+ method.
+    # When passing a block, it must use the `{ ... }` format, not
+    # do/end, as `{ ... }` binds to the `change` method, whereas do/end
+    # would errantly bind to the `expect(..).to` or `expect(...).not_to` method.
+    #
+    # You can chain any of the following off of the end to specify details
+    # about the change:
+    #
+    # * `by`
+    # * `by_at_least`
+    # * `by_at_most`
+    # * `from`
+    # * `to`
     #
     # @example
     #
@@ -305,7 +393,7 @@ module RSpec
     #   string = "string"
     #   expect {
     #     string
-    #   }.not_to change { string }
+    #   }.not_to change { string }.from("string")
     #
     #   expect {
     #     person.happy_birthday
@@ -326,15 +414,40 @@ module RSpec
     #
     # == Notes
     #
-    # Evaluates <tt>receiver.message</tt> or <tt>block</tt> before and after it
-    # evaluates the block passed to <tt>expect</tt>.
+    # Evaluates `receiver.message` or `block` before and after it
+    # evaluates the block passed to `expect`.
     #
-    # <tt>expect( ... ).not_to change</tt> only supports the form with no subsequent
-    # calls to <tt>by</tt>, <tt>by_at_least</tt>, <tt>by_at_most</tt>,
-    # <tt>to</tt> or <tt>from</tt>.
+    # `expect( ... ).not_to change` supports the form that specifies `from`
+    # (which specifies what you expect the starting, unchanged value to be)
+    # but does not support forms with subsequent calls to `by`, `by_at_least`,
+    # `by_at_most` or `to`.
     def change(receiver=nil, message=nil, &block)
       BuiltIn::Change.new(receiver, message, &block)
     end
+    alias_matcher :a_block_changing,  :change
+    alias_matcher :changing,          :change
+
+    # Passes if actual contains all of the expected regardless of order.
+    # This works for collections. Pass in multiple args and it will only
+    # pass if all args are found in collection.
+    #
+    # @note This is also available using the `=~` operator with `should`,
+    #       but `=~` is not supported with `expect`.
+    #
+    # @note This matcher only supports positive expectations.
+    #       `expect(...).not_to contain_exactly(other_array)` is not supported.
+    #
+    # @example
+    #
+    #   expect([1, 2, 3]).to contain_exactly(1, 2, 3)
+    #   expect([1, 2, 3]).to contain_exactly(1, 3, 2)
+    #
+    # @see #match_array
+    def contain_exactly(*items)
+      BuiltIn::ContainExactly.new(items)
+    end
+    alias_matcher :a_collection_containing_exactly, :contain_exactly
+    alias_matcher :containing_exactly,              :contain_exactly
 
     # Passes if actual covers expected. This works for
     # Ranges. You can also pass in multiple args
@@ -350,7 +463,9 @@ module RSpec
     # ### Warning:: Ruby >= 1.9 only
     def cover(*values)
       BuiltIn::Cover.new(*values)
-    end if (1..2).respond_to?(:cover?)
+    end
+    alias_matcher :a_range_covering, :cover
+    alias_matcher :covering,         :cover
 
     # Matches if the actual value ends with the expected value(s). In the case
     # of a string, matches against the last `expected.length` characters of the
@@ -365,6 +480,9 @@ module RSpec
     def end_with(*expected)
       BuiltIn::EndWith.new(*expected)
     end
+    alias_matcher :a_collection_ending_with, :end_with
+    alias_matcher :a_string_ending_with,     :end_with
+    alias_matcher :ending_with,              :end_with
 
     # Passes if <tt>actual == expected</tt>.
     #
@@ -378,8 +496,10 @@ module RSpec
     def eq(expected)
       BuiltIn::Eq.new(expected)
     end
+    alias_matcher :an_object_eq_to, :eq
+    alias_matcher :eq_to,           :eq
 
-    # Passes if +actual.eql?(expected)+
+    # Passes if `actual.eql?(expected)`
     #
     # See http://www.ruby-doc.org/core/classes/Object.html#M001057 for more
     # information about equality in Ruby.
@@ -391,6 +511,8 @@ module RSpec
     def eql(expected)
       BuiltIn::Eql.new(expected)
     end
+    alias_matcher :an_object_eql_to, :eql
+    alias_matcher :eql_to,           :eql
 
     # Passes if <tt>actual.equal?(expected)</tt> (object identity).
     #
@@ -404,6 +526,8 @@ module RSpec
     def equal(expected)
       BuiltIn::Equal.new(expected)
     end
+    alias_matcher :an_object_equal_to, :equal
+    alias_matcher :equal_to,           :equal
 
     # Passes if `actual.exist?` or `actual.exists?`
     #
@@ -412,6 +536,8 @@ module RSpec
     def exist(*args)
       BuiltIn::Exist.new(*args)
     end
+    alias_matcher :an_object_existing, :exist
+    alias_matcher :existing,           :exist
 
     # Passes if actual includes expected. This works for
     # collections and Strings. You can also pass in multiple args
@@ -428,14 +554,40 @@ module RSpec
     def include(*expected)
       BuiltIn::Include.new(*expected)
     end
+    alias_matcher :a_collection_including, :include
+    alias_matcher :a_string_including,     :include
+    alias_matcher :a_hash_including,       :include
+    alias_matcher :including,              :include
 
-    # Given a Regexp or String, passes if actual.match(pattern)
+    # Given a `Regexp` or `String`, passes if `actual.match(pattern)`
+    # Given an arbitrary nested data structure (e.g. arrays and hashes),
+    # matches if `expected === actual` || `actual == expected` for each
+    # pair of elements.
     #
     # @example
     #
     #   expect(email).to match(/^([^\s]+)((?:[-a-z0-9]+\.)+[a-z]{2,})$/i)
     #   expect(email).to match("@example.com")
     #
+    # @example
+    #
+    #   hash = {
+    #     :a => {
+    #       :b => ["foo", 5],
+    #       :c => { :d => 2.05 }
+    #     }
+    #   }
+    #
+    #   expect(hash).to match(
+    #     :a => {
+    #       :b => a_collection_containing_exactly(
+    #         a_string_starting_with("f"),
+    #         an_instance_of(Fixnum)
+    #       ),
+    #       :c => { :d => (a_value < 3) }
+    #     }
+    #   )
+    #
     # @note The `match_regex` alias is deprecated and is not recommended for use.
     #       It was added in 2.12.1 to facilitate its use from within custom
     #       matchers (due to how the custom matcher DSL was evaluated in 2.x,
@@ -443,7 +595,52 @@ module RSpec
     def match(expected)
       BuiltIn::Match.new(expected)
     end
-    alias_method :match_regex, :match
+    alias_matcher :match_regex,        :match
+    alias_matcher :an_object_matching, :match
+    alias_matcher :a_string_matching,  :match
+    alias_matcher :matching,           :match
+
+    # An alternate form of `contain_exactly` that accepts
+    # the expected contents as a single array arg rather
+    # that splatted out as individual items.
+    #
+    # @example
+    #
+    #   expect(results).to contain_exactly(1, 2)
+    #   # is identical to:
+    #   expect(results).to match_array([1, 2])
+    #
+    # @see #contain_exactly
+    def match_array(items)
+      contain_exactly(*items)
+    end
+
+    # With no arg, passes if the block outputs `to_stdout` or `to_stderr`.
+    # With a string, passes if the blocks outputs that specific string `to_stdout` or `to_stderr`.
+    # With a regexp or matcher, passes if the blocks outputs a string `to_stdout` or `to_stderr` that matches.
+    #
+    # @example
+    #
+    #   expect { print 'foo' }.to output.to_stdout
+    #   expect { print 'foo' }.to output('foo').to_stdout
+    #   expect { print 'foo' }.to output(/foo/).to_stdout
+    #
+    #   expect { do_something }.to_not output.to_stdout
+    #
+    #   expect { warn('foo') }.to output.to_stderr
+    #   expect { warn('foo') }.to output('foo').to_stderr
+    #   expect { warn('foo') }.to output(/foo/).to_stderr
+    #
+    #   expect { do_something }.to_not output.to_stderr
+    #
+    # @note This matcher works by temporarily replacing `$stdout` or `$stderr`,
+    # so it's not able to intercept stream output that explicitly uses `STDOUT`/`STDERR`
+    # or that uses a reference to `$stdout`/`$stderr` that was stored before the
+    # matcher is used.
+    def output(expected=nil)
+      BuiltIn::Output.new(expected)
+    end
+    alias_matcher :a_block_outputting, :output
 
     # With no args, matches if any error is raised.
     # With a named error, matches only if that specific error is raised.
@@ -463,8 +660,15 @@ module RSpec
     def raise_error(error=Exception, message=nil, &block)
       BuiltIn::RaiseError.new(error, message, &block)
     end
+    alias_method  :raise_exception,  :raise_error
 
-    alias_method :raise_exception, :raise_error
+    alias_matcher :a_block_raising,  :raise_error do |desc|
+      desc.sub("raise", "a block raising")
+    end
+
+    alias_matcher :raising,        :raise_error do |desc|
+      desc.sub("raise", "raising")
+    end
 
     # Matches if the target object responds to all of the names
     # provided. Names can be Strings or Symbols.
@@ -476,6 +680,8 @@ module RSpec
     def respond_to(*names)
       BuiltIn::RespondTo.new(*names)
     end
+    alias_matcher :an_object_responding_to, :respond_to
+    alias_matcher :responding_to,           :respond_to
 
     # Passes if the submitted block returns true. Yields target to the
     # block.
@@ -493,6 +699,8 @@ module RSpec
     def satisfy(&block)
       BuiltIn::Satisfy.new(&block)
     end
+    alias_matcher :an_object_satisfying, :satisfy
+    alias_matcher :satisfying,           :satisfy
 
     # Matches if the actual value starts with the expected value(s). In the
     # case of a string, matches against the first `expected.length` characters
@@ -507,6 +715,9 @@ module RSpec
     def start_with(*expected)
       BuiltIn::StartWith.new(*expected)
     end
+    alias_matcher :a_collection_starting_with, :start_with
+    alias_matcher :a_string_starting_with,     :start_with
+    alias_matcher :starting_with,              :start_with
 
     # Given no argument, matches if a proc throws any Symbol.
     #
@@ -528,6 +739,14 @@ module RSpec
       BuiltIn::ThrowSymbol.new(expected_symbol, expected_arg)
     end
 
+    alias_matcher :a_block_throwing, :throw_symbol do |desc|
+      desc.sub("throw", "a block throwing")
+    end
+
+    alias_matcher :throwing,        :throw_symbol do |desc|
+      desc.sub("throw", "throwing")
+    end
+
     # Passes if the method called in the expect block yields, regardless
     # of whether or not arguments are yielded.
     #
@@ -543,6 +762,8 @@ module RSpec
     def yield_control
       BuiltIn::YieldControl.new
     end
+    alias_matcher :a_block_yielding_control,  :yield_control
+    alias_matcher :yielding_control,          :yield_control
 
     # Passes if the method called in the expect block yields with
     # no arguments. Fails if it does not yield, or yields with arguments.
@@ -560,6 +781,8 @@ module RSpec
     def yield_with_no_args
       BuiltIn::YieldWithNoArgs.new
     end
+    alias_matcher :a_block_yielding_with_no_args,  :yield_with_no_args
+    alias_matcher :yielding_with_no_args,          :yield_with_no_args
 
     # Given no arguments, matches if the method called in the expect
     # block yields with arguments (regardless of what they are or how
@@ -589,6 +812,8 @@ module RSpec
     def yield_with_args(*args)
       BuiltIn::YieldWithArgs.new(*args)
     end
+    alias_matcher :a_block_yielding_with_args,  :yield_with_args
+    alias_matcher :yielding_with_args,          :yield_with_args
 
     # Designed for use with methods that repeatedly yield (such as
     # iterators). Passes if the method called in the expect block yields
@@ -609,25 +834,38 @@ module RSpec
     def yield_successive_args(*args)
       BuiltIn::YieldSuccessiveArgs.new(*args)
     end
+    alias_matcher :a_block_yielding_successive_args,  :yield_successive_args
+    alias_matcher :yielding_successive_args,          :yield_successive_args
+
+  private
+
+    BE_PREDICATE_REGEX = /^(be_(?:an?_)?)(.*)/
+    HAS_REGEX = /^(?:have_)(.*)/
+
+    def method_missing(method, *args, &block)
+      case method.to_s
+        when BE_PREDICATE_REGEX
+          BuiltIn::BePredicate.new(method, *args, &block)
+        when HAS_REGEX
+          BuiltIn::Has.new(method, *args, &block)
+        else
+          super
+      end
+    end
 
-    # Passes if actual contains all of the expected regardless of order.
-    # This works for collections. Pass in multiple args and it will only
-    # pass if all args are found in collection.
-    #
-    # @note This is also available using the `=~` operator with `should`,
-    #       but `=~` is not supported with `expect`.
-    #
-    # @note This matcher only supports positive expectations.
-    #       expect(..).not_to match_array(other_array) is not supported.
-    #
-    # @example
-    #
-    #   expect([1,2,3]).to match_array([1,2,3])
-    #   expect([1,2,3]).to match_array([1,3,2])
-    def match_array(array)
-      BuiltIn::MatchArray.new(array)
+    # @api private
+    def self.is_a_matcher?(obj)
+      return true  if ::RSpec::Matchers::BuiltIn::BaseMatcher === obj
+      return false if obj.respond_to?(:i_respond_to_everything_so_im_not_really_a_matcher)
+      return false unless obj.respond_to?(:matches?)
+
+      obj.respond_to?(:failure_message) ||
+      obj.respond_to?(:failure_message_for_should) # support legacy matchers
     end
 
-    OperatorMatcher.register(Enumerable, '=~', BuiltIn::MatchArray)
+    # @api private
+    def self.is_a_describable_matcher?(obj)
+      is_a_matcher?(obj) && obj.respond_to?(:description)
+    end
   end
 end