rspec-expectations 2.13.0 → 2.99.0

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

@@ -17,13 +17,13 @@ module RSpec
         end
 
         def description
-          "include#{expected_to_sentence}"
+          "include#{to_sentence expected}"
         end
 
         def diffable?
           # Matchers do not diff well, since diff uses their inspect
           # output, which includes their instance variables and such.
-          @expected.none? { |e| is_a_matcher?(e) }
+          @expected.none? { |e| RSpec::Matchers.is_a_matcher?(e) }
         end
 
         private
@@ -53,15 +53,7 @@ module RSpec
         end
 
         def comparing_with_matcher?(actual, expected)
-          actual.is_a?(Array) && is_a_matcher?(expected)
-        end
-
-        def is_a_matcher?(object)
-          return false if object.respond_to?(:i_respond_to_everything_so_im_not_really_a_matcher)
-
-          [:failure_message_for_should, :failure_message].any? do |msg|
-            object.respond_to?(msg)
-          end && object.respond_to?(:matches?)
+          actual.is_a?(Array) && RSpec::Matchers.is_a_matcher?(expected)
         end
       end
     end

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

@@ -6,6 +6,11 @@ module RSpec
         def match(expected, actual)
           actual.match expected
         end
+
+        def diffable?
+          true
+        end
+
       end
     end
   end

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

@@ -27,7 +27,7 @@ module RSpec
         end
 
         def description
-          "contain exactly #{_pretty_print(expected)}"
+          "contain exactly#{to_sentence(expected)}"
         end
 
         private

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

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class RaiseError
+        include MatchAliases
+
         def initialize(expected_error_or_message=Exception, expected_message=nil, &block)
           @block = block
           @actual_error = nil
@@ -14,19 +16,35 @@ module RSpec
         end
 
         def matches?(given_proc, negative_expectation = false)
+          if negative_expectation && (expecting_specific_exception? || @expected_message)
+            what_to_deprecate = if expecting_specific_exception? && @expected_message
+                                  "`expect { }.not_to raise_error(SpecificErrorClass, message)`"
+                                elsif expecting_specific_exception?
+                                  "`expect { }.not_to raise_error(SpecificErrorClass)`"
+                                elsif @expected_message
+                                  "`expect { }.not_to raise_error(message)`"
+                                end
+
+            RSpec.deprecate(
+              what_to_deprecate,
+              :replacement => "`expect { }.not_to raise_error` (with no args)"
+            )
+          end
           @raised_expected_error = false
           @with_expected_message = false
           @eval_block = false
           @eval_block_passed = false
+          unless given_proc.respond_to?(:call)
+            ::Kernel.warn "`raise_error` was called with non-proc object #{given_proc.inspect}"
+            return false
+          end
           begin
             given_proc.call
-          rescue @expected_error => @actual_error
-            @raised_expected_error = true
-            @with_expected_message = verify_message
           rescue Exception => @actual_error
-            # This clause should be empty, but rcov will not report it as covered
-            # unless something (anything) is executed within the clause
-            "http://eigenclass.org/hiki.rb?rcov-0.8.0"
+            if @actual_error == @expected_error || @expected_error === @actual_error
+              @raised_expected_error = true
+              @with_expected_message = verify_message
+            end
           end
 
           unless negative_expectation
@@ -35,7 +53,6 @@ module RSpec
         ensure
           return (@raised_expected_error & @with_expected_message) ? (@eval_block ? @eval_block_passed : true) : false
         end
-        alias == matches?
 
         def does_not_match?(given_proc)
           !matches?(given_proc, :negative_expectation)
@@ -74,12 +91,17 @@ module RSpec
           "raise #{expected_error}"
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
         private
 
         def expected_error
           case @expected_message
           when nil
-            @expected_error
+            @expected_error.inspect
           when Regexp
             "#{@expected_error} with message matching #{@expected_message.inspect}"
           else
@@ -101,6 +123,10 @@ module RSpec
             *backtrace
           ].join("\n  # ")
         end
+
+        def expecting_specific_exception?
+          @expected_error != Exception
+        end
       end
     end
   end

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

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class RespondTo
+        include MatchAliases
+
         def initialize(*names)
           @names = names
           @expected_arity = nil
@@ -10,7 +12,6 @@ module RSpec
         def matches?(actual)
           find_failing_method_names(actual, :reject).empty?
         end
-        alias == matches?
 
         def does_not_match?(actual)
           find_failing_method_names(actual, :select).empty?
@@ -38,6 +39,11 @@ module RSpec
         end
         alias :arguments :argument
 
+        # @private
+        def supports_block_expectations?
+          false
+        end
+
         private
 
         def find_failing_method_names(actual, filter_method)

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

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class Satisfy
+        include MatchAliases
+
         def initialize(&block)
           @block = block
         end
@@ -11,7 +13,6 @@ module RSpec
           @actual = actual
           @block.call(actual)
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected #{@actual} to satisfy block"
@@ -24,6 +25,11 @@ module RSpec
         def description
           "satisfy block"
         end
+
+        # @private
+        def supports_block_expectations?
+          false
+        end
       end
     end
   end

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

@@ -2,6 +2,8 @@ module RSpec
   module Matchers
     module BuiltIn
       class ThrowSymbol
+        include MatchAliases
+
         def initialize(expected_symbol = nil, expected_arg=nil)
           @expected_symbol = expected_symbol
           @expected_arg = expected_arg
@@ -51,7 +53,6 @@ module RSpec
             end
           end
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected #{expected} to be thrown, got #{caught}"
@@ -65,7 +66,14 @@ module RSpec
           "throw #{expected}"
         end
 
-        private
+        # @api private
+        # Indicates this matcher matches against a block.
+        # @return [True]
+        def supports_block_expectations?
+          true
+        end
+
+      private
 
         def expected(symbol_desc = 'a Symbol')
           throw_description(@expected_symbol || symbol_desc, @expected_arg)

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

@@ -65,17 +65,97 @@ module RSpec
       end
 
       class YieldControl < BaseMatcher
+        def initialize
+          @expectation_type = nil
+          @expected_yields_count = nil
+        end
+
         def matches?(block)
           probe = YieldProbe.probe(block)
-          probe.yielded_once?(:yield_control)
+
+          if @expectation_type
+            probe.num_yields.send(@expectation_type, @expected_yields_count)
+          else
+            probe.yielded_once?(:yield_control)
+          end
+        end
+
+        def once
+          exactly(1)
+          self
+        end
+
+        def twice
+          exactly(2)
+          self
+        end
+
+        def exactly(number)
+          set_expected_yields_count(:==, number)
+          self
+        end
+
+        def at_most(number)
+          set_expected_yields_count(:<=, number)
+          self
+        end
+
+        def at_least(number)
+          set_expected_yields_count(:>=, number)
+          self
+        end
+
+        def times
+          self
         end
 
         def failure_message_for_should
-          "expected given block to yield control"
+          'expected given block to yield control'.tap do |failure_message|
+            failure_message << relativity_failure_message
+          end
         end
 
         def failure_message_for_should_not
-          "expected given block not to yield control"
+          'expected given block not to yield control'.tap do |failure_message|
+            failure_message << relativity_failure_message
+          end
+        end
+
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
+      private
+
+        def set_expected_yields_count(relativity, n)
+          @expectation_type = relativity
+          @expected_yields_count = case n
+                                   when Numeric then n
+                                   when :once then 1
+                                   when :twice then 2
+                                   end
+        end
+
+        def relativity_failure_message
+          return '' unless @expected_yields_count
+          " #{human_readable_expecation_type}#{human_readable_count}"
+        end
+
+        def human_readable_expecation_type
+          case @expectation_type
+          when :<= then 'at most '
+          when :>= then 'at least '
+          else ''
+          end
+        end
+
+        def human_readable_count
+          case @expected_yields_count
+          when 1 then "once"
+          when 2 then "twice"
+          else "#{@expected_yields_count} times"
+          end
         end
       end
 
@@ -94,6 +174,11 @@ module RSpec
           "expected given block not to yield with no arguments, but did"
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
       private
 
         def failure_reason
@@ -106,6 +191,8 @@ module RSpec
       end
 
       class YieldWithArgs
+        include MatchAliases
+
         def initialize(*args)
           @expected = args
         end
@@ -115,7 +202,6 @@ module RSpec
           @actual = @probe.single_yield_args
           @probe.yielded_once?(:yield_with_args) && args_match?
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected given block to yield with arguments, but #{positive_failure_reason}"
@@ -131,6 +217,11 @@ module RSpec
           desc
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
       private
 
         def positive_failure_reason
@@ -176,6 +267,8 @@ module RSpec
       end
 
       class YieldSuccessiveArgs
+        include MatchAliases
+
         def initialize(*args)
           @expected = args
         end
@@ -185,7 +278,6 @@ module RSpec
           @actual = @probe.successive_yield_args
           args_match?
         end
-        alias == matches?
 
         def failure_message_for_should
           "expected given block to yield successively with arguments, but yielded with unexpected arguments" +
@@ -205,6 +297,11 @@ module RSpec
           desc
         end
 
+        # @private
+        def supports_block_expectations?
+          true
+        end
+
       private
 
         def args_match?

data/lib/rspec/matchers/built_in.rb

@@ -4,8 +4,8 @@ module RSpec
       require 'rspec/matchers/built_in/base_matcher'
       autoload :BeAnInstanceOf, 'rspec/matchers/built_in/be_instance_of'
       autoload :Be,             'rspec/matchers/built_in/be'
-      autoload :BeTrue,         'rspec/matchers/built_in/be'
-      autoload :BeFalse,        'rspec/matchers/built_in/be'
+      autoload :BeTruthy,         'rspec/matchers/built_in/be'
+      autoload :BeFalsey,        'rspec/matchers/built_in/be'
       autoload :BeNil,          'rspec/matchers/built_in/be'
       autoload :BeComparedTo,   'rspec/matchers/built_in/be'
       autoload :BePredicate,    'rspec/matchers/built_in/be'

data/lib/rspec/matchers/differentiate_block_method_types.rb

@@ -0,0 +1,55 @@
+module RSpec
+  module Matchers
+    # Evaluates a block in order to determine what methods, if any,
+    # it defines as instance methods (using `def foo`) vs singleton
+    # methods (using `def self.foo`).
+    #
+    # @api private
+    class DifferentiateBlockMethodTypes
+      def initialize(*block_args, &block)
+        @block_args = block_args
+        @block = block
+
+        ignore_macro_methods
+
+        capture_added_methods(singletons_singleton_class, singleton_methods)
+        capture_added_methods(singleton_class, instance_methods)
+
+        singleton_class.class_exec(*block_args, &block)
+      end
+
+      def singleton_methods
+        @singleton_methods ||= []
+      end
+
+      def instance_methods
+        @instance_methods ||= []
+      end
+
+    private
+
+      def capture_added_methods(object, method_list)
+        object.__send__(:define_method, :singleton_method_added) do |method_name|
+          method_list << method_name
+        end
+
+        method_list.delete(:singleton_method_added)
+      end
+
+      unless method_defined?(:singleton_class)
+        def singleton_class
+          class << self; self; end
+        end
+      end
+
+      def singletons_singleton_class
+        class << singleton_class; self; end
+      end
+
+      def ignore_macro_methods
+        def singleton_class.method_missing(*); self; end
+      end
+    end
+  end
+end
+

data/lib/rspec/matchers/dsl.rb

@@ -7,7 +7,8 @@ module RSpec
         matcher_template = RSpec::Matchers::DSL::Matcher.new(name, &declarations)
         define_method name do |*expected|
           matcher = matcher_template.for_expected(*expected)
-          matcher.matcher_execution_context = @matcher_execution_context ||= self
+          @matcher_execution_context ||= self
+          matcher.instance_variable_set(:@matcher_execution_context, @matcher_execution_context)
           matcher
         end
       end

data/lib/rspec/matchers/match_aliases.rb

@@ -0,0 +1,22 @@
+module RSpec
+  module Matchers
+    module MatchAliases
+      def ==(other)
+        return true if equal?(other)
+
+        matched = matches?(other)
+
+        if matched
+          RSpec.deprecate("Using `matcher == value` as an alias for `#matches?`", :replacement => "`matcher === value`")
+        end
+
+        matched
+      end
+
+      def ===(other)
+        matches?(other)
+      end
+    end
+  end
+end
+