rspec-expectations 3.0.4 → 3.12.3

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

@@ -5,7 +5,7 @@ module RSpec
       # Base class for `and` and `or` compound matchers.
       class Compound < BaseMatcher
         # @private
-        attr_reader :matcher_1, :matcher_2
+        attr_reader :matcher_1, :matcher_2, :evaluator
 
         def initialize(matcher_1, matcher_2)
           @matcher_1 = matcher_1
@@ -14,14 +14,56 @@ module RSpec
 
         # @private
         def does_not_match?(_actual)
-          raise NotImplementedError, "`expect(...).not_to " \
-            "matcher.#{conjunction} matcher` is not supported"
+          raise NotImplementedError, "`expect(...).not_to matcher.#{conjunction} matcher` " \
+            "is not supported, since it creates a bit of an ambiguity. Instead, define negated versions " \
+            "of whatever matchers you wish to negate with `RSpec::Matchers.define_negated_matcher` and " \
+            "use `expect(...).to matcher.#{conjunction} matcher`."
         end
 
         # @api private
         # @return [String]
         def description
-          singleline_message(matcher_1.description, matcher_2.description)
+          "#{matcher_1.description} #{conjunction} #{matcher_2.description}"
+        end
+
+        # @api private
+        def supports_block_expectations?
+          matcher_supports_block_expectations?(matcher_1) &&
+          matcher_supports_block_expectations?(matcher_2)
+        end
+
+        # @api private
+        def supports_value_expectations?
+          matcher_supports_value_expectations?(matcher_1) &&
+          matcher_supports_value_expectations?(matcher_2)
+        end
+
+        # @api private
+        def expects_call_stack_jump?
+          NestedEvaluator.matcher_expects_call_stack_jump?(matcher_1) ||
+          NestedEvaluator.matcher_expects_call_stack_jump?(matcher_2)
+        end
+
+        # @api private
+        # @return [Boolean]
+        def diffable?
+          matcher_is_diffable?(matcher_1) || matcher_is_diffable?(matcher_2)
+        end
+
+        # @api private
+        # @return [RSpec::Matchers::ExpectedsForMultipleDiffs]
+        def expected
+          return nil unless evaluator
+          ::RSpec::Matchers::ExpectedsForMultipleDiffs.for_many_matchers(diffable_matcher_list)
+        end
+
+      protected
+
+        def diffable_matcher_list
+          list = []
+          list.concat(diffable_matcher_list_for(matcher_1)) unless matcher_1_matches?
+          list.concat(diffable_matcher_list_for(matcher_2)) unless matcher_2_matches?
+          list
         end
 
       private
@@ -32,6 +74,16 @@ module RSpec
           super
         end
 
+        def match(_expected, actual)
+          evaluator_klass = if supports_block_expectations? && Proc === actual
+                              NestedEvaluator
+                            else
+                              SequentialEvaluator
+                            end
+
+          @evaluator = evaluator_klass.new(actual, matcher_1, matcher_2)
+        end
+
         def indent_multiline_message(message)
           message.lines.map do |line|
             line =~ /\S/ ? '   ' + line : line
@@ -39,30 +91,150 @@ module RSpec
         end
 
         def compound_failure_message
-          message_1 = matcher_1.failure_message
-          message_2 = matcher_2.failure_message
+          "#{indent_multiline_message(matcher_1.failure_message.sub(/\n+\z/, ''))}" \
+          "\n\n...#{conjunction}:" \
+          "\n\n#{indent_multiline_message(matcher_2.failure_message.sub(/\A\n+/, ''))}"
+        end
 
-          if multiline?(message_1) || multiline?(message_2)
-            multiline_message(message_1, message_2)
-          else
-            singleline_message(message_1, message_2)
-          end
+        def matcher_1_matches?
+          evaluator.matcher_matches?(matcher_1)
+        end
+
+        def matcher_2_matches?
+          evaluator.matcher_matches?(matcher_2)
+        end
+
+        def matcher_supports_block_expectations?(matcher)
+          matcher.supports_block_expectations?
+        rescue NoMethodError
+          false
         end
 
-        def multiline_message(message_1, message_2)
-          [
-            indent_multiline_message(message_1.sub(/\n+\z/, '')),
-            "...#{conjunction}:",
-            indent_multiline_message(message_2.sub(/\A\n+/, ''))
-          ].join("\n\n")
+        def matcher_supports_value_expectations?(matcher)
+          matcher.supports_value_expectations?
+        rescue NoMethodError
+          true
         end
 
-        def multiline?(message)
-          message.lines.count > 1
+        def matcher_is_diffable?(matcher)
+          matcher.diffable?
+        rescue NoMethodError
+          false
         end
 
-        def singleline_message(message_1, message_2)
-          [message_1, conjunction, message_2].join(' ')
+        def diffable_matcher_list_for(matcher)
+          return [] unless matcher_is_diffable?(matcher)
+          return matcher.diffable_matcher_list if Compound === matcher
+          [matcher]
+        end
+
+        # For value expectations, we can evaluate the matchers sequentially.
+        class SequentialEvaluator
+          def initialize(actual, *)
+            @actual = actual
+          end
+
+          def matcher_matches?(matcher)
+            matcher.matches?(@actual)
+          end
+        end
+
+        # Normally, we evaluate the matching sequentially. For an expression like
+        # `expect(x).to foo.and bar`, this becomes:
+        #
+        #   expect(x).to foo
+        #   expect(x).to bar
+        #
+        # For block expectations, we need to nest them instead, so that
+        # `expect { x }.to foo.and bar` becomes:
+        #
+        #   expect {
+        #     expect { x }.to foo
+        #   }.to bar
+        #
+        # This is necessary so that the `expect` block is only executed once.
+        class NestedEvaluator
+          def initialize(actual, matcher_1, matcher_2)
+            @actual        = actual
+            @matcher_1     = matcher_1
+            @matcher_2     = matcher_2
+            @match_results = {}
+
+            inner, outer = order_block_matchers
+
+            @match_results[outer] = outer.matches?(Proc.new do |*args|
+              @match_results[inner] = inner.matches?(inner_matcher_block(args))
+            end)
+          end
+
+          def matcher_matches?(matcher)
+            @match_results.fetch(matcher) do
+              raise ArgumentError, "Your #{matcher.description} has no match " \
+               "results, this can occur when an unexpected call stack or " \
+               "local jump occurs. Perhaps one of your matchers needs to " \
+               "declare `expects_call_stack_jump?` as `true`?"
+            end
+          end
+
+        private
+
+          # Some block matchers (such as `yield_xyz`) pass args to the `expect` block.
+          # When such a matcher is used as the outer matcher, we need to forward the
+          # the args on to the `expect` block.
+          def inner_matcher_block(outer_args)
+            return @actual if outer_args.empty?
+
+            Proc.new do |*inner_args|
+              unless inner_args.empty?
+                raise ArgumentError, "(#{@matcher_1.description}) and " \
+                  "(#{@matcher_2.description}) cannot be combined in a compound expectation " \
+                  "since both matchers pass arguments to the block."
+              end
+
+              @actual.call(*outer_args)
+            end
+          end
+
+          # For a matcher like `raise_error` or `throw_symbol`, where the block will jump
+          # up the call stack, we need to order things so that it is the inner matcher.
+          # For example, we need it to be this:
+          #
+          #   expect {
+          #     expect {
+          #       x += 1
+          #       raise "boom"
+          #     }.to raise_error("boom")
+          #   }.to change { x }.by(1)
+          #
+          # ...rather than:
+          #
+          #   expect {
+          #     expect {
+          #       x += 1
+          #       raise "boom"
+          #     }.to change { x }.by(1)
+          #   }.to raise_error("boom")
+          #
+          # In the latter case, the after-block logic in the `change` matcher would never
+          # get executed because the `raise "boom"` line would jump to the `rescue` in the
+          # `raise_error` logic, so only the former case will work properly.
+          #
+          # This method figures out which matcher should be the inner matcher and which
+          # should be the outer matcher.
+          def order_block_matchers
+            return @matcher_1, @matcher_2 unless self.class.matcher_expects_call_stack_jump?(@matcher_2)
+            return @matcher_2, @matcher_1 unless self.class.matcher_expects_call_stack_jump?(@matcher_1)
+
+            raise ArgumentError, "(#{@matcher_1.description}) and " \
+              "(#{@matcher_2.description}) cannot be combined in a compound expectation " \
+              "because they both expect a call stack jump."
+          end
+
+          def self.matcher_expects_call_stack_jump?(matcher)
+            matcher.expects_call_stack_jump?
+          rescue NoMethodError
+            false
+          end
         end
 
         # @api public
@@ -71,9 +243,9 @@ module RSpec
           # @api private
           # @return [String]
           def failure_message
-            if @matcher_1_matches
+            if matcher_1_matches?
               matcher_2.failure_message
-            elsif @matcher_2_matches
+            elsif matcher_2_matches?
               matcher_1.failure_message
             else
               compound_failure_message
@@ -82,11 +254,9 @@ module RSpec
 
         private
 
-          def match(_expected, actual)
-            @matcher_1_matches = matcher_1.matches?(actual)
-            @matcher_2_matches = matcher_2.matches?(actual)
-
-            @matcher_1_matches && @matcher_2_matches
+          def match(*)
+            super
+            matcher_1_matches? && matcher_2_matches?
           end
 
           def conjunction
@@ -105,8 +275,9 @@ module RSpec
 
         private
 
-          def match(_expected, actual)
-            matcher_1.matches?(actual) || matcher_2.matches?(actual)
+          def match(*)
+            super
+            matcher_1_matches? || matcher_2_matches?
           end
 
           def conjunction

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

@@ -1,6 +1,7 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # rubocop:disable Metrics/ClassLength
       # @api private
       # Provides the implementation for `contain_exactly` and `match_array`.
       # Not intended to be instantiated directly.
@@ -9,31 +10,74 @@ module RSpec
         # @return [String]
         def failure_message
           if Array === actual
-            message  = "expected collection contained:  #{safe_sort(surface_descriptions_in expected).inspect}\n"
-            message += "actual collection contained:    #{safe_sort(actual).inspect}\n"
-            message += "the missing elements were:      #{safe_sort(surface_descriptions_in missing_items).inspect}\n" unless missing_items.empty?
-            message += "the extra elements were:        #{safe_sort(extra_items).inspect}\n" unless extra_items.empty?
-            message
+            generate_failure_message
           else
             "expected a collection that can be converted to an array with " \
-            "`#to_ary` or `#to_a`, but got #{actual.inspect}"
+            "`#to_ary` or `#to_a`, but got #{actual_formatted}"
           end
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "`contain_exactly` does not support negation"
+          list = EnglishPhrasing.list(surface_descriptions_in(expected))
+          "expected #{actual_formatted} not to contain exactly#{list}"
         end
 
         # @api private
         # @return [String]
         def description
-          "contain exactly#{to_sentence(surface_descriptions_in expected)}"
+          list = EnglishPhrasing.list(surface_descriptions_in(expected))
+          "contain exactly#{list}"
+        end
+
+        def matches?(actual)
+          @pairings_maximizer = nil
+          @best_solution = nil
+          @extra_items = nil
+          @missing_items = nil
+          super(actual)
         end
 
       private
 
+        def generate_failure_message
+          message = expected_collection_line
+          message += actual_collection_line
+          message += missing_elements_line unless missing_items.empty?
+          message += extra_elements_line unless extra_items.empty?
+          message
+        end
+
+        def expected_collection_line
+          message_line('expected collection contained', expected, true)
+        end
+
+        def actual_collection_line
+          message_line('actual collection contained', actual)
+        end
+
+        def missing_elements_line
+          message_line('the missing elements were', missing_items, true)
+        end
+
+        def extra_elements_line
+          message_line('the extra elements were', extra_items)
+        end
+
+        def describe_collection(collection, surface_descriptions=false)
+          if surface_descriptions
+            "#{description_of(safe_sort(surface_descriptions_in collection))}\n"
+          else
+            "#{description_of(safe_sort(collection))}\n"
+          end
+        end
+
+        def message_line(prefix, collection, surface_descriptions=false)
+          "%-32s%s" % [prefix + ':',
+                       describe_collection(collection, surface_descriptions)]
+        end
+
         def match(_expected, _actual)
           return false unless convert_actual_to_an_array
           match_when_sorted? || (extra_items.empty? && missing_items.empty?)
@@ -50,15 +94,30 @@ module RSpec
         def convert_actual_to_an_array
           if actual.respond_to?(:to_ary)
             @actual = actual.to_ary
-          elsif enumerable?(actual) && actual.respond_to?(:to_a)
+          elsif actual.respond_to?(:to_a) && !to_a_disallowed?(actual)
             @actual = actual.to_a
           else
-            return false
+            false
           end
         end
 
         def safe_sort(array)
-          array.sort rescue array
+          array.sort
+        rescue Support::AllExceptionsExceptOnesWeMustNotRescue
+          array
+        end
+
+        if RUBY_VERSION == "1.8.7"
+          def to_a_disallowed?(object)
+            case object
+            when NilClass, String then true
+            else Kernel == RSpec::Support.method_handle_for(object, :to_a).owner
+            end
+          end
+        else
+          def to_a_disallowed?(object)
+            NilClass === object
+          end
         end
 
         def missing_items
@@ -125,6 +184,7 @@ module RSpec
         #
         # @private
         class PairingsMaximizer
+          # @private
           Solution = Struct.new(:unmatched_expected_indexes,     :unmatched_actual_indexes,
                                 :indeterminate_expected_indexes, :indeterminate_actual_indexes) do
             def worse_than?(other)
@@ -227,7 +287,7 @@ module RSpec
 
             modified_expecteds.delete(expected_index)
 
-            modified_actuals   = apply_pairing_to(
+            modified_actuals = apply_pairing_to(
               solution.indeterminate_actual_indexes,
               actual_to_expected_matched_indexes, expected_index)
 
@@ -244,6 +304,7 @@ module RSpec
           end
         end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

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

@@ -0,0 +1,169 @@
+module RSpec
+  module Matchers
+    module BuiltIn
+      # @api private
+      # Abstract class to implement `once`, `at_least` and other
+      # count constraints.
+      module CountExpectation
+        # @api public
+        # Specifies that the method is expected to match once.
+        def once
+          exactly(1)
+        end
+
+        # @api public
+        # Specifies that the method is expected to match twice.
+        def twice
+          exactly(2)
+        end
+
+        # @api public
+        # Specifies that the method is expected to match thrice.
+        def thrice
+          exactly(3)
+        end
+
+        # @api public
+        # Specifies that the method is expected to match the given number of times.
+        def exactly(number)
+          set_expected_count(:==, number)
+          self
+        end
+
+        # @api public
+        # Specifies the maximum number of times the method is expected to match
+        def at_most(number)
+          set_expected_count(:<=, number)
+          self
+        end
+
+        # @api public
+        # Specifies the minimum number of times the method is expected to match
+        def at_least(number)
+          set_expected_count(:>=, number)
+          self
+        end
+
+        # @api public
+        # No-op. Provides syntactic sugar.
+        def times
+          self
+        end
+
+      protected
+        # @api private
+        attr_reader :count_expectation_type, :expected_count
+
+      private
+
+        if RUBY_VERSION.to_f > 1.8
+          def cover?(count, number)
+            count.cover?(number)
+          end
+        else
+          def cover?(count, number)
+            number >= count.first && number <= count.last
+          end
+        end
+
+        def expected_count_matches?(actual_count)
+          @actual_count = actual_count
+          return @actual_count > 0 unless count_expectation_type
+          return cover?(expected_count, actual_count) if count_expectation_type == :<=>
+
+          @actual_count.__send__(count_expectation_type, expected_count)
+        end
+
+        def has_expected_count?
+          !!count_expectation_type
+        end
+
+        def set_expected_count(relativity, n)
+          raise_unsupported_count_expectation if unsupported_count_expectation?(relativity)
+
+          count = count_constraint_to_number(n)
+
+          if count_expectation_type == :<= && relativity == :>=
+            raise_impossible_count_expectation(count) if count > expected_count
+            @count_expectation_type = :<=>
+            @expected_count = count..expected_count
+          elsif count_expectation_type == :>= && relativity == :<=
+            raise_impossible_count_expectation(count) if count < expected_count
+            @count_expectation_type = :<=>
+            @expected_count = expected_count..count
+          else
+            @count_expectation_type = relativity
+            @expected_count = count
+          end
+        end
+
+        def raise_impossible_count_expectation(count)
+          text =
+            case count_expectation_type
+            when :<= then "at_least(#{count}).at_most(#{expected_count})"
+            when :>= then "at_least(#{expected_count}).at_most(#{count})"
+            end
+          raise ArgumentError, "The constraint #{text} is not possible"
+        end
+
+        def raise_unsupported_count_expectation
+          text =
+            case count_expectation_type
+            when :<= then "at_least"
+            when :>= then "at_most"
+            when :<=> then "at_least/at_most combination"
+            else "count"
+            end
+          raise ArgumentError, "Multiple #{text} constraints are not supported"
+        end
+
+        def count_constraint_to_number(n)
+          case n
+          when Numeric then n
+          when :once then 1
+          when :twice then 2
+          when :thrice then 3
+          else
+            raise ArgumentError, "Expected a number, :once, :twice or :thrice," \
+              " but got #{n}"
+          end
+        end
+
+        def unsupported_count_expectation?(relativity)
+          return true if count_expectation_type == :==
+          return true if count_expectation_type == :<=>
+          (count_expectation_type == :<= && relativity == :<=) ||
+            (count_expectation_type == :>= && relativity == :>=)
+        end
+
+        def count_expectation_description
+          "#{human_readable_expectation_type}#{human_readable_count(expected_count)}"
+        end
+
+        def count_failure_reason(action)
+          "#{count_expectation_description}" \
+          " but #{action}#{human_readable_count(@actual_count)}"
+        end
+
+        def human_readable_expectation_type
+          case count_expectation_type
+          when :<= then ' at most'
+          when :>= then ' at least'
+          when :<=> then ' between'
+          else ''
+          end
+        end
+
+        def human_readable_count(count)
+          case count
+          when Range then " #{count.first} and #{count.last} times"
+          when nil then ''
+          when 1 then ' once'
+          when 2 then ' twice'
+          else " #{count} times"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,19 +8,19 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "\nexpected: #{format_object(expected)}\n     got: #{format_object(actual)}\n\n(compared using ==)\n"
+          "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using ==)\n"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "\nexpected: value != #{format_object(expected)}\n     got: #{format_object(actual)}\n\n(compared using ==)\n"
+          "\nexpected: value != #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using ==)\n"
         end
 
         # @api private
         # @return [String]
         def description
-          "#{name_to_sentence} #{@expected.inspect}"
+          "eq #{expected_formatted}"
         end
 
         # @api private
@@ -34,41 +34,6 @@ module RSpec
         def match(expected, actual)
           actual == expected
         end
-
-        def format_object(object)
-          if Time === object
-            format_time(object)
-          elsif defined?(DateTime) && DateTime === object
-            format_date_time(object)
-          elsif defined?(BigDecimal) && BigDecimal === object
-            "#{object.to_s 'F'} (#{object.inspect})"
-          else
-            object.inspect
-          end
-        end
-
-        TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
-
-        if Time.method_defined?(:nsec)
-          def format_time(time)
-            time.strftime("#{TIME_FORMAT}.#{"%09d" % time.nsec} %z")
-          end
-        else # for 1.8.7
-          def format_time(time)
-            time.strftime("#{TIME_FORMAT}.#{"%06d" % time.usec} %z")
-          end
-        end
-
-        DATE_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S.%N %z"
-        # ActiveSupport sometimes overrides inspect. If `ActiveSupport` is
-        # defined use a custom format string that includes more time precision.
-        def format_date_time(date_time)
-          if defined?(ActiveSupport)
-            date_time.strftime(DATE_TIME_FORMAT)
-          else
-            date_time.inspect
-          end
-        end
       end
     end
   end

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

@@ -8,13 +8,13 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "\nexpected: #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using eql?)\n"
+          "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using eql?)\n"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "\nexpected: value != #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using eql?)\n"
+          "\nexpected: value != #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using eql?)\n"
         end
 
         # @api private