rspec-expectations 2.13.0 → 3.0.0

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

@@ -0,0 +1,256 @@
+module RSpec
+  module Matchers
+    module BuiltIn
+      # @api private
+      # Provides the implementation for `contain_exactly` and `match_array`.
+      # Not intended to be instantiated directly.
+      class ContainExactly < BaseMatcher
+
+        # @api private
+        # @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
+          else
+            "expected a collection that can be converted to an array with " +
+            "`#to_ary` or `#to_a`, but got #{actual.inspect}"
+          end
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "`contain_exactly` does not support negation"
+        end
+
+        # @api private
+        # @return [String]
+        def description
+          "contain exactly#{to_sentence(surface_descriptions_in expected)}"
+        end
+
+      private
+
+        def match(expected, actual)
+          convert_actual_to_an_array or return false
+          match_when_sorted? || (extra_items.empty? && missing_items.empty?)
+        end
+
+        # This cannot always work (e.g. when dealing with unsortable items,
+        # or matchers as expected items), but it's practically free compared to
+        # the slowness of the full matching algorithm, and in common cases this
+        # works, so it's worth a try.
+        def match_when_sorted?
+          values_match?(safe_sort(expected), safe_sort(actual))
+        end
+
+        def convert_actual_to_an_array
+          if actual.respond_to?(:to_ary)
+            @actual = actual.to_ary
+          elsif enumerable?(actual) && actual.respond_to?(:to_a)
+            @actual = actual.to_a
+          else
+            return false
+          end
+        end
+
+        def safe_sort(array)
+          array.sort rescue array
+        end
+
+        def missing_items
+          @missing_items ||= best_solution.unmatched_expected_indexes.map do |index|
+            expected[index]
+          end
+        end
+
+        def extra_items
+          @extra_items ||= best_solution.unmatched_actual_indexes.map do |index|
+            actual[index]
+          end
+        end
+
+        def best_solution
+          @best_solution ||= pairings_maximizer.find_best_solution
+        end
+
+        def pairings_maximizer
+          @pairings_maximizer ||= begin
+            expected_matches = {}
+            actual_matches   = {}
+
+            expected.each_with_index do |e, ei|
+              expected_matches[ei] ||= []
+
+              actual.each_with_index do |a, ai|
+                actual_matches[ai] ||= []
+
+                # Normally we'd call `values_match?(e, a)` here but that contains
+                # some extra checks we don't need (e.g. to support nested data
+                # structures), and given that it's called N*M times here, it helps
+                # perf significantly to implement the matching bit ourselves.
+                if (e === a || a == e)
+                  expected_matches[ei] << ai
+                  actual_matches[ai] << ei
+                end
+              end
+            end
+
+            PairingsMaximizer.new(expected_matches, actual_matches)
+          end
+        end
+
+        # Once we started supporting composing matchers, the algorithm for this matcher got
+        # much more complicated. Consider this expression:
+        #
+        #   expect(["fool", "food"]).to contain_exactly(/foo/, /fool/)
+        #
+        # This should pass (because we can pair /fool/ with "fool" and /foo/ with "food"), but
+        # the original algorithm used by this matcher would pair the first elements it could
+        # (/foo/ with "fool"), which would leave /fool/ and "food" unmatched.  When we have
+        # an expected element which is a matcher that matches a superset of actual items
+        # compared to another expected element matcher, we need to consider every possible pairing.
+        #
+        # This class is designed to maximize the number of actual/expected pairings -- or,
+        # conversely, to minimize the number of unpaired items. It's essentially a brute
+        # force solution, but with a few heuristics applied to reduce the size of the
+        # problem space:
+        #
+        #   * Any items which match none of the items in the other list are immediately
+        #     placed into the `unmatched_expected_indexes` or `unmatched_actual_indexes` array.
+        #     The extra items and missing items in the matcher failure message are derived
+        #     from these arrays.
+        #   * Any items which reciprocally match only each other are paired up and not
+        #     considered further.
+        #
+        # What's left is only the items which match multiple items from the other list
+        # (or vice versa). From here, it performs a brute-force depth-first search,
+        # looking for a solution which pairs all elements in both lists, or, barring that,
+        # that produces the fewest unmatched items.
+        #
+        # @private
+        class PairingsMaximizer
+          Solution = Struct.new(:unmatched_expected_indexes,     :unmatched_actual_indexes,
+                                :indeterminate_expected_indexes, :indeterminate_actual_indexes) do
+            def worse_than?(other)
+              unmatched_item_count > other.unmatched_item_count
+            end
+
+            def candidate?
+              indeterminate_expected_indexes.empty? &&
+              indeterminate_actual_indexes.empty?
+            end
+
+            def ideal?
+              candidate? && (
+                unmatched_expected_indexes.empty? ||
+                unmatched_actual_indexes.empty?
+              )
+            end
+
+            def unmatched_item_count
+              unmatched_expected_indexes.count + unmatched_actual_indexes.count
+            end
+
+            def +(derived_candidate_solution)
+              self.class.new(
+                unmatched_expected_indexes + derived_candidate_solution.unmatched_expected_indexes,
+                unmatched_actual_indexes   + derived_candidate_solution.unmatched_actual_indexes,
+                # Ignore the indeterminate indexes: by the time we get here,
+                # we've dealt with all indeterminates.
+                [], []
+              )
+            end
+          end
+
+          attr_reader :expected_to_actual_matched_indexes, :actual_to_expected_matched_indexes, :solution
+
+          def initialize(expected_to_actual_matched_indexes, actual_to_expected_matched_indexes)
+            @expected_to_actual_matched_indexes = expected_to_actual_matched_indexes
+            @actual_to_expected_matched_indexes = actual_to_expected_matched_indexes
+
+            unmatched_expected_indexes, indeterminate_expected_indexes =
+              categorize_indexes(expected_to_actual_matched_indexes, actual_to_expected_matched_indexes)
+
+            unmatched_actual_indexes, indeterminate_actual_indexes =
+              categorize_indexes(actual_to_expected_matched_indexes, expected_to_actual_matched_indexes)
+
+            @solution = Solution.new(unmatched_expected_indexes,     unmatched_actual_indexes,
+                                     indeterminate_expected_indexes, indeterminate_actual_indexes)
+          end
+
+          def find_best_solution
+            return solution if solution.candidate?
+            best_solution_so_far = NullSolution
+
+            expected_index = solution.indeterminate_expected_indexes.first
+            actuals = expected_to_actual_matched_indexes[expected_index]
+
+            actuals.each do |actual_index|
+              solution = best_solution_for_pairing(expected_index, actual_index)
+              return solution if solution.ideal?
+              best_solution_so_far = solution if best_solution_so_far.worse_than?(solution)
+            end
+
+            best_solution_so_far
+          end
+
+        private
+
+          # @private
+          # Starting solution that is worse than any other real solution.
+          NullSolution = Class.new do
+            def self.worse_than?(other); true; end
+          end
+
+          def categorize_indexes(indexes_to_categorize, other_indexes)
+            unmatched     = []
+            indeterminate = []
+
+            indexes_to_categorize.each_pair do |index, matches|
+              if matches.empty?
+                unmatched << index
+              elsif !reciprocal_single_match?(matches, index, other_indexes)
+                indeterminate << index
+              end
+            end
+
+            return unmatched, indeterminate
+          end
+
+          def reciprocal_single_match?(matches, index, other_list)
+            return false unless matches.one?
+            other_list[matches.first] == [index]
+          end
+
+          def best_solution_for_pairing(expected_index, actual_index)
+            modified_expecteds = apply_pairing_to(
+              solution.indeterminate_expected_indexes,
+              expected_to_actual_matched_indexes, actual_index)
+
+            modified_expecteds.delete(expected_index)
+
+            modified_actuals   = apply_pairing_to(
+              solution.indeterminate_actual_indexes,
+              actual_to_expected_matched_indexes, expected_index)
+
+            modified_actuals.delete(actual_index)
+
+            solution + self.class.new(modified_expecteds, modified_actuals).find_best_solution
+          end
+
+          def apply_pairing_to(indeterminates, original_matches, other_list_index)
+            indeterminates.inject({}) do |accum, index|
+              accum[index] = original_matches[index] - [other_list_index]
+              accum
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,9 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `cover`.
+      # Not intended to be instantiated directly.
       class Cover < BaseMatcher
         def initialize(*expected)
           @expected = expected

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

@@ -1,22 +1,76 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `eq`.
+      # Not intended to be instantiated directly.
       class Eq < BaseMatcher
+
+        # @api private
+        # @return [String]
+        def failure_message
+          "\nexpected: #{format_object(expected)}\n     got: #{format_object(actual)}\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"
+        end
+
+        # @api private
+        # @return [String]
+        def description
+          "#{name_to_sentence} #{@expected.inspect}"
+        end
+
+        # @api private
+        # @return [Boolean]
+        def diffable?
+          true
+        end
+
+      private
+
         def match(expected, actual)
           actual == expected
         end
 
-        def failure_message_for_should
-          "\nexpected: #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using ==)\n"
+        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
 
-        def failure_message_for_should_not
-          "\nexpected: value != #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using ==)\n"
+        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
 
-        def diffable?; true; 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
 end
-

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

@@ -1,22 +1,34 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `eql`.
+      # Not intended to be instantiated directly.
       class Eql < BaseMatcher
-        def match(expected, actual)
-          actual.eql? expected
-        end
 
-        def failure_message_for_should
+        # @api private
+        # @return [String]
+        def failure_message
           "\nexpected: #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using eql?)\n"
         end
 
-        def failure_message_for_should_not
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
           "\nexpected: value != #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using eql?)\n"
         end
 
+        # @api private
+        # @return [Boolean]
         def diffable?
           true
         end
+
+      private
+
+        def match(expected, actual)
+          actual.eql? expected
+        end
       end
     end
   end

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

@@ -1,46 +1,80 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `equal`.
+      # Not intended to be instantiated directly.
       class Equal < BaseMatcher
-        def match(expected, actual)
-          actual.equal? expected
+
+        # @api private
+        # @return [String]
+        def failure_message
+          if expected_is_a_literal_singleton?
+            simple_failure_message
+          else
+            detailed_failure_message
+          end
         end
 
-        def failure_message_for_should
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
           return <<-MESSAGE
 
-expected #{inspect_object(expected)}
-     got #{inspect_object(actual)}
+expected not #{inspect_object(actual)}
+         got #{inspect_object(expected)}
 
-Compared using equal?, which compares object identity,
-but expected and actual are not the same object. Use
-`#{eq_expression}` if you don't care about
-object identity in this example.
+Compared using equal?, which compares object identity.
 
 MESSAGE
         end
 
-        def failure_message_for_should_not
-          return <<-MESSAGE
+        # @api private
+        # @return [Boolean]
+        def diffable?
+          !expected_is_a_literal_singleton?
+        end
 
-expected not #{inspect_object(actual)}
-         got #{inspect_object(expected)}
+      private
 
-Compared using equal?, which compares object identity.
+        def match(expected, actual)
+          actual.equal? expected
+        end
 
-MESSAGE
+        LITERAL_SINGLETONS = [true, false, nil]
+
+        def expected_is_a_literal_singleton?
+          LITERAL_SINGLETONS.include?(expected)
         end
 
-        def diffable?; true; end
+        def actual_inspected
+          if LITERAL_SINGLETONS.include?(actual)
+            actual.inspect
+          else
+            inspect_object(actual)
+          end
+        end
 
-        private
+        def simple_failure_message
+          "\nexpected #{expected.inspect}\n     got #{actual_inspected}\n"
+        end
 
-        def inspect_object(o)
-          "#<#{o.class}:#{o.object_id}> => #{o.inspect}"
+        def detailed_failure_message
+          return <<-MESSAGE
+
+expected #{inspect_object(expected)}
+     got #{inspect_object(actual)}
+
+Compared using equal?, which compares object identity,
+but expected and actual are not the same object. Use
+`expect(actual).to eq(expected)` if you don't care about
+object identity in this example.
+
+MESSAGE
         end
 
-        def eq_expression
-          Expectations::Syntax.positive_expression("actual", "eq(expected)")
+        def inspect_object(o)
+          "#<#{o.class}:#{o.object_id}> => #{o.inspect}"
         end
       end
     end

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

@@ -1,25 +1,89 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `exist`.
+      # Not intended to be instantiated directly.
       class Exist < BaseMatcher
         def initialize(*expected)
           @expected = expected
         end
 
+        # @api private
+        # @return [Boolean]
         def matches?(actual)
           @actual = actual
-          predicates = [:exist?, :exists?].select { |p| @actual.respond_to?(p) }
-          existence_values = predicates.map { |p| @actual.__send__(p, *@expected) }
-          uniq_truthy_values = existence_values.map { |v| !!v }.uniq
-
-          case uniq_truthy_values.size
-          when 0; raise NoMethodError.new("#{@actual.inspect} does not respond to either #exist? or #exists?")
-          when 1; existence_values.first
-          else raise "#exist? and #exists? returned different values:\n\n" +
-            " exist?: #{existence_values.first}\n" +
-            "exists?: #{existence_values.last}"
+          @test = ExistenceTest.new @actual, @expected
+          @test.valid_test? && @test.actual_exists?
+        end
+
+        # @api private
+        # @return [Boolean]
+        def does_not_match?(actual)
+          @actual = actual
+          @test = ExistenceTest.new @actual, @expected
+          @test.valid_test? && !@test.actual_exists?
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message
+          "expected #{@actual.inspect} to exist#{@test.validity_message}"
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "expected #{@actual.inspect} not to exist#{@test.validity_message}"
+        end
+
+      private
+
+        # @api private
+        # Simple class for memoizing actual/expected for this matcher
+        # and examining the match
+        class ExistenceTest < Struct.new(:actual, :expected)
+
+          # @api private
+          # @return [Boolean]
+          def valid_test?
+            uniq_truthy_values.size == 1
+          end
+
+          # @api private
+          # @return [Boolean]
+          def actual_exists?
+            existence_values.first
+          end
+
+          # @api private
+          # @return [String]
+          def validity_message
+            case uniq_truthy_values.size
+            when 0
+              " but it does not respond to either `exist?` or `exists?`"
+            when 2
+              " but `exist?` and `exists?` returned different values:\n\n"\
+              " exist?: #{existence_values.first}\n"\
+              "exists?: #{existence_values.last}"
+            end
+          end
+
+        private
+
+          def uniq_truthy_values
+            @uniq_truthy_values ||= existence_values.map { |v| !!v }.uniq
+          end
+
+          def existence_values
+            @existence_values ||= predicates.map { |p| actual.__send__(p, *expected) }
+          end
+
+          def predicates
+            @predicates ||= [:exist?, :exists?].select { |p| actual.respond_to?(p) }
           end
         end
+
       end
     end
   end