rspec-expectations 3.5.0 → 3.9.0

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

@@ -77,7 +77,11 @@ module RSpec
           end
 
           def predicates
-            @predicates ||= [:exist?, :exists?].select { |p| actual.respond_to?(p) }
+            @predicates ||= [:exist?, :exists?].select { |p| actual.respond_to?(p) && !deprecated(p, actual) }
+          end
+
+          def deprecated(predicate, actual)
+            predicate == :exists? && File == actual
           end
         end
       end

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

@@ -77,7 +77,7 @@ module RSpec
         end
 
         def method_description
-          @method_name.to_s.gsub('_', ' ')
+          @method_name.to_s.tr('_', ' ')
         end
 
         def args_description

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

@@ -15,12 +15,14 @@ module RSpec
         # @api private
         # @return [Boolean]
         def matches?(actual)
+          actual = actual.to_hash if convert_to_hash?(actual)
           perform_match(actual) { |v| v }
         end
 
         # @api private
         # @return [Boolean]
         def does_not_match?(actual)
+          actual = actual.to_hash if convert_to_hash?(actual)
           perform_match(actual) { |v| !v }
         end
 
@@ -137,6 +139,10 @@ module RSpec
             actual.include?(str) && lines.none? { |line| line == str }
           end
         end
+
+        def convert_to_hash?(obj)
+          !obj.respond_to?(:include?) && obj.respond_to?(:to_hash)
+        end
       end
     end
   end

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

@@ -172,7 +172,7 @@ module RSpec
                          "including those raised by Ruby (e.g. NoMethodError, NameError " \
                          "and ArgumentError), meaning the code you are intending to test " \
                          "may not even get reached. Instead consider using " \
-                         "`expect {}.not_to raise_error` or `expect { }.to raise_error" \
+                         "`expect { }.not_to raise_error` or `expect { }.to raise_error" \
                          "(DifferentSpecificErrorClass)`. This message can be suppressed by " \
                          "setting: `RSpec::Expectations.configuration.on_potential_false" \
                          "_positives = :nothing`")

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

@@ -125,13 +125,22 @@ module RSpec
 
           return true if expectation.empty?
 
-          signature = Support::MethodSignature.new(Support.method_handle_for(actual, name))
+          Support::StrictSignatureVerifier.new(method_signature_for(actual, name)).
+            with_expectation(expectation).valid?
+        end
+
+        def method_signature_for(actual, name)
+          method_handle = Support.method_handle_for(actual, name)
 
-          Support::StrictSignatureVerifier.new(signature).with_expectation(expectation).valid?
+          if name == :new && method_handle.owner === ::Class && ::Class === actual
+            Support::MethodSignature.new(actual.instance_method(:initialize))
+          else
+            Support::MethodSignature.new(method_handle)
+          end
         end
 
         def with_arity
-          str = ''
+          str = ''.dup
           str << " with #{with_arity_string}" if @expected_arity
           str << " #{str.length == 0 ? 'with' : 'and'} #{with_keywords_string}" if @expected_keywords && @expected_keywords.count > 0
           str << " #{str.length == 0 ? 'with' : 'and'} unlimited arguments" if @unlimited_arguments
@@ -151,7 +160,7 @@ module RSpec
                      @expected_keywords.map(&:inspect).join(' and ')
                    else
                      "#{@expected_keywords[0...-1].map(&:inspect).join(', ')}, and #{@expected_keywords.last.inspect}"
-          end
+                   end
 
           "keyword#{@expected_keywords.count == 1 ? '' : 's'} #{kw_str}"
         end

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

@@ -5,10 +5,7 @@ module RSpec
       # Provides the implementation for `satisfy`.
       # Not intended to be instantiated directly.
       class Satisfy < BaseMatcher
-        # @private
-        attr_reader :description
-
-        def initialize(description="satisfy block", &block)
+        def initialize(description=nil, &block)
           @description = description
           @block = block
         end
@@ -20,6 +17,11 @@ module RSpec
           @block.call(actual)
         end
 
+        # @private
+        def description
+          @description ||= "satisfy #{block_representation}"
+        end
+
         # @api private
         # @return [String]
         def failure_message
@@ -31,6 +33,27 @@ module RSpec
         def failure_message_when_negated
           "expected #{actual_formatted} not to #{description}"
         end
+
+      private
+
+        if RSpec::Support::RubyFeatures.ripper_supported?
+          def block_representation
+            if (block_snippet = extract_block_snippet)
+              "expression `#{block_snippet}`"
+            else
+              'block'
+            end
+          end
+
+          def extract_block_snippet
+            return nil unless @block
+            Expectations::BlockSnippetExtractor.try_extracting_single_line_body_of(@block, matcher_name)
+          end
+        else
+          def block_representation
+            'block'
+          end
+        end
       end
     end
   end

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

@@ -8,19 +8,17 @@ module RSpec
       # yield matchers is used. Provides information about
       # the yield behavior of the object-under-test.
       class YieldProbe
-        def self.probe(block)
-          probe = new(block)
+        def self.probe(block, &callback)
+          probe = new(block, &callback)
           return probe unless probe.has_block?
-          probe.assert_valid_expect_block!
-          block.call(probe)
-          probe.assert_used!
-          probe
+          probe.probe
         end
 
         attr_accessor :num_yields, :yielded_args
 
-        def initialize(block)
+        def initialize(block, &callback)
           @block = block
+          @callback = callback || Proc.new {}
           @used = false
           self.num_yields = 0
           self.yielded_args = []
@@ -30,13 +28,22 @@ module RSpec
           Proc === @block
         end
 
+        def probe
+          assert_valid_expect_block!
+          @block.call(self)
+          assert_used!
+          self
+        end
+
         def to_proc
           @used = true
 
           probe = self
+          callback = @callback
           Proc.new do |*args|
             probe.num_yields += 1
             probe.yielded_args << args
+            callback.call(*args)
             nil # to indicate the block does not return a meaningful value
           end
         end
@@ -56,12 +63,6 @@ module RSpec
           end
         end
 
-        def successive_yield_args
-          yielded_args.map do |arg_array|
-            arg_array.size == 1 ? arg_array.first : arg_array
-          end
-        end
-
         def assert_used!
           return if @used
           raise 'You must pass the argument yielded to your expect block on ' \
@@ -269,10 +270,15 @@ module RSpec
 
         # @private
         def matches?(block)
-          @probe = YieldProbe.probe(block)
+          @args_matched_when_yielded = true
+          @probe = YieldProbe.new(block) do
+            @actual = @probe.single_yield_args
+            @actual_formatted = actual_formatted
+            @args_matched_when_yielded &&= args_currently_match?
+          end
           return false unless @probe.has_block?
-          @actual = @probe.single_yield_args
-          @probe.yielded_once?(:yield_with_args) && args_match?
+          @probe.probe
+          @probe.yielded_once?(:yield_with_args) && @args_matched_when_yielded
         end
 
         # @private
@@ -293,7 +299,7 @@ module RSpec
         # @private
         def description
           desc = 'yield with args'
-          desc << "(#{expected_arg_description})" unless @expected.empty?
+          desc = "#{desc}(#{expected_arg_description})" unless @expected.empty?
           desc
         end
 
@@ -317,16 +323,16 @@ module RSpec
         def negative_failure_reason
           if !@probe.has_block?
             'was not a block'
-          elsif all_args_match?
+          elsif @args_matched_when_yielded && !@expected.empty?
             'yielded with expected arguments' \
               "\nexpected not: #{surface_descriptions_in(@expected).inspect}" \
-              "\n         got: #{actual_formatted}"
+              "\n         got: #{@actual_formatted}"
           else
             'did'
           end
         end
 
-        def args_match?
+        def args_currently_match?
           if @expected.empty? # expect {...}.to yield_with_args
             @positive_args_failure = 'yielded with no arguments' if @actual.empty?
             return !@actual.empty?
@@ -335,7 +341,7 @@ module RSpec
           unless (match = all_args_match?)
             @positive_args_failure = 'yielded with unexpected arguments' \
               "\nexpected: #{surface_descriptions_in(@expected).inspect}" \
-              "\n     got: #{actual_formatted}"
+              "\n     got: #{@actual_formatted}"
           end
 
           match
@@ -356,10 +362,21 @@ module RSpec
 
         # @private
         def matches?(block)
-          @probe = YieldProbe.probe(block)
+          @actual_formatted = []
+          @actual = []
+          args_matched_when_yielded = true
+          yield_count = 0
+
+          @probe = YieldProbe.probe(block) do |*arg_array|
+            arg_or_args = arg_array.size == 1 ? arg_array.first : arg_array
+            @actual_formatted << RSpec::Support::ObjectFormatter.format(arg_or_args)
+            @actual << arg_or_args
+            args_matched_when_yielded &&= values_match?(@expected[yield_count], arg_or_args)
+            yield_count += 1
+          end
+
           return false unless @probe.has_block?
-          @actual = @probe.successive_yield_args
-          args_match?
+          args_matched_when_yielded && yield_count == @expected.length
         end
 
         def does_not_match?(block)
@@ -390,10 +407,6 @@ module RSpec
 
       private
 
-        def args_match?
-          values_match?(@expected, @actual)
-        end
-
         def expected_arg_description
           @expected.map { |e| description_of e }.join(', ')
         end
@@ -403,7 +416,7 @@ module RSpec
 
           'yielded with unexpected arguments' \
           "\nexpected: #{surface_descriptions_in(@expected).inspect}" \
-          "\n     got: #{actual_formatted}"
+          "\n     got: [#{@actual_formatted.join(", ")}]"
         end
 
         def negative_failure_reason
@@ -411,7 +424,7 @@ module RSpec
 
           'yielded with expected arguments' \
           "\nexpected not: #{surface_descriptions_in(@expected).inspect}" \
-          "\n         got: #{actual_formatted}"
+          "\n         got: [#{@actual_formatted.join(", ")}]"
         end
       end
     end

data/lib/rspec/matchers/composable.rb

@@ -130,8 +130,6 @@ module RSpec
           object.clone
         elsif Hash === object
           Hash[with_matchers_cloned(object.to_a)]
-        elsif Struct === object || unreadable_io?(object)
-          object
         elsif should_enumerate?(object)
           object.map { |subobject| with_matchers_cloned(subobject) }
         else
@@ -139,24 +137,10 @@ module RSpec
         end
       end
 
-      if String.ancestors.include?(Enumerable) # 1.8.7
-        # :nocov:
-        # Strings are not enumerable on 1.9, and on 1.8 they are an infinitely
-        # nested enumerable: since ruby lacks a character class, it yields
-        # 1-character strings, which are themselves enumerable, composed of a
-        # a single 1-character string, which is an enumerable, etc.
-        #
-        # @api private
-        def should_enumerate?(item)
-          return false if String === item
-          Enumerable === item && !(Range === item) && item.none? { |subitem| subitem.equal?(item) }
-        end
-        # :nocov:
-      else
-        # @api private
-        def should_enumerate?(item)
-          Enumerable === item && !(Range === item) && item.none? { |subitem| subitem.equal?(item) }
-        end
+      # @api private
+      # We should enumerate arrays as long as they are not recursive.
+      def should_enumerate?(item)
+        Array === item && item.none? { |subitem| subitem.equal?(item) }
       end
 
       # @api private
@@ -172,10 +156,12 @@ module RSpec
       # Wraps an item in order to surface its `description` via `inspect`.
       # @api private
       DescribableItem = Struct.new(:item) do
+        # Inspectable version of the item description
         def inspect
           "(#{item.description})"
         end
 
+        # A pretty printed version of the item description.
         def pretty_print(pp)
           pp.text "(#{item.description})"
         end

data/lib/rspec/matchers/dsl.rb

@@ -2,7 +2,70 @@ module RSpec
   module Matchers
     # Defines the custom matcher DSL.
     module DSL
+      # 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.
+      #
+      # @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"
+      #
+      # @param new_name [Symbol] the new name for the matcher
+      # @param old_name [Symbol] the original name for the matcher
+      # @param options  [Hash] options for the aliased matcher
+      # @option options [Class] :klass the ruby class to use as the decorator. (Not normally used).
+      # @yield [String] optional block that, when given, is used to define the overriden
+      #   logic. The yielded arg is the original description or failure message. If no
+      #   block is provided, a default override is used based on the old and new names.
+      # @see RSpec::Matchers
+      def alias_matcher(new_name, old_name, options={}, &description_override)
+        description_override ||= lambda do |old_desc|
+          old_desc.gsub(EnglishPhrasing.split_words(old_name), EnglishPhrasing.split_words(new_name))
+        end
+        klass = options.fetch(:klass) { AliasedMatcher }
+
+        define_method(new_name) do |*args, &block|
+          matcher = __send__(old_name, *args, &block)
+          matcher.matcher_name = new_name if matcher.respond_to?(:matcher_name=)
+          klass.new(matcher, description_override)
+        end
+      end
+
+      # Defines a negated matcher. The returned matcher's `description` and `failure_message`
+      # will be overriden to reflect the phrasing of the new name, and the match logic will
+      # be based on the original matcher but negated.
+      #
+      # @example
+      #   RSpec::Matchers.define_negated_matcher :exclude, :include
+      #   include(1, 2).description # => "include 1 and 2"
+      #   exclude(1, 2).description # => "exclude 1 and 2"
+      #
+      # @param negated_name [Symbol] the name for the negated matcher
+      # @param base_name [Symbol] the name of the original matcher that will be negated
+      # @yield [String] optional block that, when given, is used to define the overriden
+      #   logic. The yielded arg is the original description or failure message. If no
+      #   block is provided, a default override is used based on the old and new names.
+      # @see RSpec::Matchers
+      def define_negated_matcher(negated_name, base_name, &description_override)
+        alias_matcher(negated_name, base_name, :klass => AliasedNegatedMatcher, &description_override)
+      end
+
       # Defines a custom matcher.
+      #
+      # @param name [Symbol] the name for the matcher
+      # @yield [Object] block that is used to define the matcher.
+      #   The block is evaluated in the context of your custom matcher class.
+      #   When args are passed to your matcher, they will be yielded here,
+      #   usually representing the expected value(s).
       # @see RSpec::Matchers
       def define(name, &declarations)
         warn_about_block_args(name, declarations)
@@ -84,8 +147,14 @@ module RSpec
         # is rarely necessary, but can be helpful, for example, when specifying
         # asynchronous processes that require different timeouts.
         #
+        # By default the match block will swallow expectation errors (e.g.
+        # caused by using an expectation such as `expect(1).to eq 2`), if you
+        # with to allow these to bubble up, pass in the option
+        # `:notify_expectation_failures => true`.
+        #
+        # @param [Hash] options for defining the behavior of the match block.
         # @yield [Object] actual the actual value (i.e. the value wrapped by `expect`)
-        def match_when_negated(&match_block)
+        def match_when_negated(options={}, &match_block)
           define_user_override(:does_not_match?, match_block) do |actual|
             begin
               @actual = actual
@@ -93,6 +162,7 @@ module RSpec
                 super(*actual_arg_for(match_block))
               end
             rescue RSpec::Expectations::ExpectationNotMetError
+              raise if options[:notify_expectation_failures]
               false
             end
           end
@@ -266,7 +336,7 @@ module RSpec
         #
         # This compiles the user block into an actual method, allowing
         # them to use normal method constructs like `return`
-        # (e.g. for a early guard statement), while allowing us to define
+        # (e.g. for an early guard statement), while allowing us to define
         # an override that can provide the wrapped handling
         # (e.g. assigning `@actual`, rescueing errors, etc) and
         # can `super` to the user's definition.
@@ -462,5 +532,3 @@ module RSpec
     end
   end
 end
-
-RSpec::Matchers.extend RSpec::Matchers::DSL