rspec-expectations 3.0.0.beta2 → 3.0.0.rc1

data/lib/rspec/matchers/built_in/start_and_end_with.rb

@@ -1,24 +1,17 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Base class for the `end_with` and `start_with` matchers.
+      # Not intended to be instantiated directly.
       class StartAndEndWith < BaseMatcher
         def initialize(*expected)
           @actual_does_not_have_ordered_elements = false
           @expected = expected.length == 1 ? expected.first : expected
         end
 
-        def match(expected, actual)
-          return false unless actual.respond_to?(:[])
-
-          begin
-            return subset_matches? if expected.respond_to?(:length)
-            element_matches?
-          rescue ArgumentError
-            @actual_does_not_have_ordered_elements = true
-            return false
-          end
-        end
-
+        # @api private
+        # @return [String]
         def failure_message
           super.tap do |msg|
             if @actual_does_not_have_ordered_elements
@@ -29,6 +22,8 @@ module RSpec
           end
         end
 
+        # @api private
+        # @return [String]
         def description
           return super unless Hash === expected
           "#{name_to_sentence} #{surface_descriptions_in(expected).inspect}"
@@ -36,13 +31,29 @@ module RSpec
 
       private
 
+        def match(expected, actual)
+          return false unless actual.respond_to?(:[])
+
+          begin
+            return subset_matches? if expected.respond_to?(:length)
+            element_matches?
+          rescue ArgumentError
+            @actual_does_not_have_ordered_elements = true
+            return false
+          end
+        end
+
         def actual_is_unordered
           ArgumentError.new("#{actual.inspect} does not have ordered elements")
         end
       end
 
+      # @api private
+      # Provides the implementation for `start_with`.
+      # Not intended to be instantiated directly.
       class StartWith < StartAndEndWith
-        private
+
+      private
 
         def subset_matches?
           values_match?(expected, actual[0, expected.length])
@@ -53,8 +64,12 @@ module RSpec
         end
       end
 
+      # @api private
+      # Provides the implementation for `end_with`.
+      # Not intended to be instantiated directly.
       class EndWith < StartAndEndWith
-        private
+
+      private
 
         def subset_matches?
           values_match?(expected, actual[-expected.length, expected.length])

data/lib/rspec/matchers/built_in/throw_symbol.rb

@@ -1,6 +1,9 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `throw_symbol`.
+      # Not intended to be instantiated directly.
       class ThrowSymbol
         include Composable
 
@@ -10,7 +13,11 @@ module RSpec
           @caught_symbol = @caught_arg = nil
         end
 
+        # @private
         def matches?(given_proc)
+          @block = given_proc
+          return false unless Proc === given_proc
+
           begin
             if @expected_symbol.nil?
               given_proc.call
@@ -54,19 +61,41 @@ module RSpec
           end
         end
 
+        def does_not_match?(given_proc)
+          !matches?(given_proc) && Proc === given_proc
+        end
+
+        # @api private
+        # @return [String]
         def failure_message
-          "expected #{expected} to be thrown, got #{caught}"
+          "expected #{expected} to be thrown, #{actual_result}"
         end
 
+        # @api private
+        # @return [String]
         def failure_message_when_negated
-          "expected #{expected('no Symbol')}#{' not' if @expected_symbol} to be thrown, got #{caught}"
+          "expected #{expected('no Symbol')}#{' not' if @expected_symbol} to be thrown, #{actual_result}"
         end
 
+        # @api private
+        # @return [String]
         def description
           "throw #{expected}"
         end
 
-        private
+        # @api private
+        # Indicates this matcher matches against a block.
+        # @return [True]
+        def supports_block_expectations?
+          true
+        end
+
+      private
+
+        def actual_result
+          return "but was not a block" unless Proc === @block
+          "got #{caught}"
+        end
 
         def expected(symbol_desc = 'a Symbol')
           throw_description(@expected_symbol || symbol_desc, @expected_arg)

data/lib/rspec/matchers/built_in/yield.rb

@@ -1,10 +1,15 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @private
+      # Object that is yielded to `expect` when one of the
+      # yield matchers is used. Provides information about
+      # the yield behavior of the object-under-test.
       class YieldProbe
         def self.probe(block)
-          probe = new
-          assert_valid_expect_block!(block)
+          probe = new(block)
+          return probe unless probe.has_block?
+          probe.assert_valid_expect_block!
           block.call(probe)
           probe.assert_used!
           probe
@@ -12,11 +17,16 @@ module RSpec
 
         attr_accessor :num_yields, :yielded_args
 
-        def initialize
+        def initialize(block)
+          @block = block
           @used = false
           self.num_yields, self.yielded_args = 0, []
         end
 
+        def has_block?
+          Proc === @block
+        end
+
         def to_proc
           @used = true
 
@@ -58,71 +68,98 @@ module RSpec
                 "are."
         end
 
-        def self.assert_valid_expect_block!(block)
-          return if block.arity == 1
+        def assert_valid_expect_block!
+          return if @block.arity == 1
           raise "Your expect block must accept an argument to be used with this " +
                 "matcher. Pass the argument as a block on to the method you are testing."
         end
       end
 
+      # @api private
+      # Provides the implementation for `yield_control`.
+      # Not intended to be instantiated directly.
       class YieldControl < BaseMatcher
         def initialize
           @expectation_type = nil
           @expected_yields_count = nil
         end
 
-        def matches?(block)
-          probe = YieldProbe.probe(block)
-
-          if @expectation_type
-            probe.num_yields.send(@expectation_type, @expected_yields_count)
-          else
-            probe.yielded_once?(:yield_control)
-          end
-        end
-
+        # @api public
+        # Specifies that the method is expected to yield once.
         def once
           exactly(1)
           self
         end
 
+        # @api public
+        # Specifies that the method is expected to yield once.
         def twice
           exactly(2)
           self
         end
 
+        # @api public
+        # Specifies that the method is expected to yield the given number of times.
         def exactly(number)
           set_expected_yields_count(:==, number)
           self
         end
 
+        # @api public
+        # Specifies the maximum number of times the method is expected to yield
         def at_most(number)
           set_expected_yields_count(:<=, number)
           self
         end
 
+        # @api public
+        # Specifies the minimum number of times the method is expected to yield
         def at_least(number)
           set_expected_yields_count(:>=, number)
           self
         end
 
+        # @api public
+        # No-op. Provides syntactic sugar.
         def times
           self
         end
 
-        def failure_message
-          'expected given block to yield control'.tap do |failure_message|
-            failure_message << relativity_failure_message
+        # @private
+        def matches?(block)
+          @probe = YieldProbe.probe(block)
+          return false unless @probe.has_block?
+
+          if @expectation_type
+            @probe.num_yields.__send__(@expectation_type, @expected_yields_count)
+          else
+            @probe.yielded_once?(:yield_control)
           end
         end
 
+        # @private
+        def does_not_match?(block)
+          !matches?(block) && @probe.has_block?
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message
+          'expected given block to yield control' + failure_reason
+        end
+
+        # @api private
+        # @return [String]
         def failure_message_when_negated
-          'expected given block not to yield control'.tap do |failure_message|
-            failure_message << relativity_failure_message
-          end
+          'expected given block not to yield control' + failure_reason
         end
 
-        private
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
+      private
 
         def set_expected_yields_count(relativity, n)
           @expectation_type = relativity
@@ -133,7 +170,8 @@ module RSpec
                                    end
         end
 
-        def relativity_failure_message
+        def failure_reason
+          return " but was not a block" unless @probe.has_block?
           return '' unless @expected_yields_count
           " #{human_readable_expecation_type}#{human_readable_count}"
         end
@@ -155,32 +193,54 @@ module RSpec
         end
       end
 
+      # @api private
+      # Provides the implementation for `yield_with_no_args`.
+      # Not intended to be instantiated directly.
       class YieldWithNoArgs < BaseMatcher
-
+        # @private
         def matches?(block)
           @probe = YieldProbe.probe(block)
+          return false unless @probe.has_block?
           @probe.yielded_once?(:yield_with_no_args) && @probe.single_yield_args.empty?
         end
 
+        # @private
+        def does_not_match?(block)
+          !matches?(block) && @probe.has_block?
+        end
+
+        # @private
         def failure_message
-          "expected given block to yield with no arguments, but #{failure_reason}"
+          "expected given block to yield with no arguments, but #{positive_failure_reason}"
         end
 
+        # @private
         def failure_message_when_negated
-          "expected given block not to yield with no arguments, but did"
+          "expected given block not to yield with no arguments, but #{negative_failure_reason}"
+        end
+
+        # @private
+        def supports_block_expectations?
+          true
         end
 
       private
 
-        def failure_reason
-          if @probe.num_yields.zero?
-            "did not yield"
-          else
-            "yielded with arguments: #{@probe.single_yield_args.inspect}"
-          end
+        def positive_failure_reason
+          return "was not a block" unless @probe.has_block?
+          return "did not yield" if @probe.num_yields.zero?
+          "yielded with arguments: #{@probe.single_yield_args.inspect}"
+        end
+
+        def negative_failure_reason
+          return "was not a block" unless @probe.has_block?
+          "did"
         end
       end
 
+      # @api private
+      # Provides the implementation for `yield_with_args`.
+      # Not intended to be instantiated directly.
       class YieldWithArgs
         include Composable
 
@@ -188,34 +248,47 @@ module RSpec
           @expected = args
         end
 
+        # @private
         def matches?(block)
           @probe = YieldProbe.probe(block)
+          return false unless @probe.has_block?
           @actual = @probe.single_yield_args
           @probe.yielded_once?(:yield_with_args) && args_match?
         end
 
+        # @private
+        def does_not_match?(block)
+          !matches?(block) && @probe.has_block?
+        end
+
+        # @private
         def failure_message
           "expected given block to yield with arguments, but #{positive_failure_reason}"
         end
 
+        # @private
         def failure_message_when_negated
           "expected given block not to yield with arguments, but #{negative_failure_reason}"
         end
 
+        # @private
         def description
           desc = "yield with args"
           desc << "(#{expected_arg_description})" unless @expected.empty?
           desc
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
       private
 
         def positive_failure_reason
-          if @probe.num_yields.zero?
-            "did not yield"
-          else
-            @positive_args_failure
-          end
+          return "was not a block" unless @probe.has_block?
+          return "did not yield" if @probe.num_yields.zero?
+          @positive_args_failure
         end
 
         def expected_arg_description
@@ -223,7 +296,9 @@ module RSpec
         end
 
         def negative_failure_reason
-          if all_args_match?
+          if !@probe.has_block?
+            "was not a block"
+          elsif all_args_match?
             "yielded with expected arguments" +
               "\nexpected not: #{surface_descriptions_in(@expected).inspect}" +
               "\n         got: #{@actual.inspect}"
@@ -252,6 +327,9 @@ module RSpec
         end
       end
 
+      # @api private
+      # Provides the implementation for `yield_successive_args`.
+      # Not intended to be instantiated directly.
       class YieldSuccessiveArgs
         include Composable
 
@@ -259,30 +337,40 @@ module RSpec
           @expected = args
         end
 
+        # @private
         def matches?(block)
           @probe = YieldProbe.probe(block)
+          return false unless @probe.has_block?
           @actual = @probe.successive_yield_args
           args_match?
         end
 
+        def does_not_match?(block)
+          !matches?(block) && @probe.has_block?
+        end
+
+        # @private
         def failure_message
-          "expected given block to yield successively with arguments, but yielded with unexpected arguments" +
-            "\nexpected: #{surface_descriptions_in(@expected).inspect}" +
-            "\n     got: #{@actual.inspect}"
+          "expected given block to yield successively with arguments, but #{positive_failure_reason}"
         end
 
+        # @private
         def failure_message_when_negated
-          "expected given block not to yield successively with arguments, but yielded with expected arguments" +
-              "\nexpected not: #{surface_descriptions_in(@expected).inspect}" +
-              "\n         got: #{@actual.inspect}"
+          "expected given block not to yield successively with arguments, but #{negative_failure_reason}"
         end
 
+        # @private
         def description
           desc = "yield successive args"
           desc << "(#{expected_arg_description})"
           desc
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
       private
 
         def args_match?
@@ -292,6 +380,22 @@ module RSpec
         def expected_arg_description
           @expected.map { |e| description_of e }.join(", ")
         end
+
+        def positive_failure_reason
+          return "was not a block" unless @probe.has_block?
+
+          "yielded with unexpected arguments" +
+          "\nexpected: #{surface_descriptions_in(@expected).inspect}" +
+          "\n     got: #{@actual.inspect}"
+        end
+
+        def negative_failure_reason
+          return "was not a block" unless @probe.has_block?
+
+          "yielded with expected arguments" +
+          "\nexpected not: #{surface_descriptions_in(@expected).inspect}" +
+          "\n         got: #{@actual.inspect}"
+        end
       end
     end
   end