rspec-expectations 3.0.0.beta2 → 3.0.0.rc1

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

@@ -1,12 +1,13 @@
 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
-        def match(expected, actual)
-          convert_actual_to_an_array or return false
-          match_when_sorted? || (extra_items.empty? && missing_items.empty?)
-        end
 
+        # @api private
+        # @return [String]
         def failure_message
           if Array === actual
             message  = "expected collection contained:  #{safe_sort(surface_descriptions_in expected).inspect}\n"
@@ -20,16 +21,25 @@ module RSpec
           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 #{_pretty_print(surface_descriptions_in expected)}"
+          "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
@@ -102,7 +112,7 @@ module RSpec
         # 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 elements which is a matcher that matches a superset of actual items
+        # 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,
@@ -191,6 +201,7 @@ module RSpec
 
         private
 
+          # @private
           # Starting solution that is worse than any other real solution.
           NullSolution = Class.new do
             def self.worse_than?(other); true; 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,32 +1,48 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `eq`.
+      # Not intended to be instantiated directly.
       class Eq < BaseMatcher
-        def match(expected, actual)
-          actual == expected
-        end
 
+        # @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
 
-        def diffable?; true; end
+        # @api private
+        # @return [Boolean]
+        def diffable?
+          true
+        end
 
       private
 
+        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
@@ -58,4 +74,3 @@ module RSpec
     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
 
+        # @api private
+        # @return [String]
         def failure_message
           "\nexpected: #{expected.inspect}\n     got: #{actual.inspect}\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"
         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,11 +1,13 @@
 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
-        end
 
+        # @api private
+        # @return [String]
         def failure_message
           if expected_is_a_literal_singleton?
             simple_failure_message
@@ -14,6 +16,8 @@ module RSpec
           end
         end
 
+        # @api private
+        # @return [String]
         def failure_message_when_negated
           return <<-MESSAGE
 
@@ -25,11 +29,17 @@ Compared using equal?, which compares object identity.
 MESSAGE
         end
 
+        # @api private
+        # @return [Boolean]
         def diffable?
           !expected_is_a_literal_singleton?
         end
 
-        private
+      private
+
+        def match(expected, actual)
+          actual.equal? expected
+        end
 
         LITERAL_SINGLETONS = [true, false, nil]
 
@@ -37,8 +47,16 @@ MESSAGE
           LITERAL_SINGLETONS.include?(expected)
         end
 
+        def actual_inspected
+          if LITERAL_SINGLETONS.include?(actual)
+            actual.inspect
+          else
+            inspect_object(actual)
+          end
+        end
+
         def simple_failure_message
-          "\nexpected #{expected.inspect}\n     got #{inspect_object(actual)}\n"
+          "\nexpected #{expected.inspect}\n     got #{actual_inspected}\n"
         end
 
         def detailed_failure_message
@@ -55,7 +73,6 @@ object identity in this example.
 MESSAGE
         end
 
-
         def inspect_object(o)
           "#<#{o.class}:#{o.object_id}> => #{o.inspect}"
         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

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

@@ -1,6 +1,9 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `has_<predicate>`.
+      # Not intended to be instantiated directly.
       class Has
         include Composable
 
@@ -8,24 +11,68 @@ module RSpec
           @method_name, @args, @block = method_name, args, block
         end
 
+        # @private
         def matches?(actual, &block)
-          actual.__send__(predicate, *@args, &(@block || block))
+          @actual = actual
+          @block ||= block
+          predicate_accessible? && predicate_matches?
         end
 
+        # @private
+        def does_not_match?(actual, &block)
+          @actual = actual
+          @block ||= block
+          predicate_accessible? && !predicate_matches?
+        end
+
+        # @api private
+        # @return [String]
         def failure_message
-          "expected ##{predicate}#{failure_message_args_description} to return true, got false"
+          validity_message || "expected ##{predicate}#{failure_message_args_description} to return true, got false"
         end
 
+        # @api private
+        # @return [String]
         def failure_message_when_negated
-          "expected ##{predicate}#{failure_message_args_description} to return false, got true"
+          validity_message || "expected ##{predicate}#{failure_message_args_description} to return false, got true"
         end
 
+        # @api private
+        # @return [String]
         def description
           [method_description, args_description].compact.join(' ')
         end
 
+        # @private
+        def supports_block_expectations?
+          false
+        end
+
       private
 
+        def predicate_accessible?
+          !private_predicate? && predicate_exists?
+        end
+
+        # support 1.8.7, evaluate once at load time for performance
+        if String === methods.first
+          def private_predicate?
+            @actual.private_methods.include? predicate.to_s
+          end
+        else
+          def private_predicate?
+            @actual.private_methods.include? predicate
+          end
+        end
+
+        def predicate_exists?
+          @actual.respond_to? predicate
+        end
+
+        def predicate_matches?
+          @actual.__send__(predicate, *@args, &@block)
+        end
+
         def predicate
           @predicate ||= :"has_#{@method_name.to_s.match(Matchers::HAS_REGEX).captures.first}?"
         end
@@ -43,6 +90,14 @@ module RSpec
           desc = args_description
           "(#{desc})" if desc
         end
+
+        def validity_message
+          if private_predicate?
+            "expected #{@actual} to respond to `#{predicate}` but `#{predicate}` is a private method"
+          elsif !predicate_exists?
+            "expected #{@actual} to respond to `#{predicate}`"
+          end
+        end
       end
     end
   end

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

@@ -1,39 +1,54 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # @api private
+      # Provides the implementation for `include`.
+      # Not intended to be instantiated directly.
       class Include < BaseMatcher
         def initialize(*expected)
           @expected = expected
         end
 
+        # @api private
+        # @return [Boolean]
         def matches?(actual)
           @actual = actual
           perform_match(:all?, :all?)
         end
 
+        # @api private
+        # @return [Boolean]
         def does_not_match?(actual)
           @actual = actual
           perform_match(:none?, :any?)
         end
 
+        # @api private
+        # @return [String]
         def description
           described_items = surface_descriptions_in(expected)
           improve_hash_formatting "include#{to_sentence(described_items)}"
         end
 
+        # @api private
+        # @return [String]
         def failure_message
           improve_hash_formatting(super)
         end
 
+        # @api private
+        # @return [String]
         def failure_message_when_negated
           improve_hash_formatting(super)
         end
 
+        # @api private
+        # @return [Boolean]
         def diffable?
           true
         end
 
-        private
+      private
 
         def perform_match(predicate, hash_subset_predicate)
           expected.__send__(predicate) do |expected_item|