rspec-expectations 2.11.3 → 3.11.0

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

@@ -0,0 +1,169 @@
+module RSpec
+  module Matchers
+    module BuiltIn
+      # @api private
+      # Asbtract 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/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,40 @@
 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
+        # @api private
+        # @return [String]
+        def failure_message
+          "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using ==)\n"
         end
 
-        def failure_message_for_should
-          "\nexpected: #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using ==)\n"
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "\nexpected: value != #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using ==)\n"
         end
 
-        def failure_message_for_should_not
-          "\nexpected: value != #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using ==)\n"
+        # @api private
+        # @return [String]
+        def description
+          "eq #{expected_formatted}"
         end
 
-        def diffable?; true; end
+        # @api private
+        # @return [Boolean]
+        def diffable?
+          true
+        end
+
+      private
+
+        def match(expected, actual)
+          actual == expected
+        end
       end
     end
   end
 end
-

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

@@ -1,22 +1,33 @@
 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
+        # @api private
+        # @return [String]
+        def failure_message
+          "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using eql?)\n"
         end
 
-        def failure_message_for_should
-          "\nexpected: #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using eql?)\n"
-        end
-
-        def failure_message_for_should_not
-          "\nexpected: value != #{expected.inspect}\n     got: #{actual.inspect}\n\n(compared using eql?)\n"
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "\nexpected: value != #{expected_formatted}\n     got: #{actual_formatted}\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,42 +1,79 @@
 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
-          return <<-MESSAGE
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          <<-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
-'actual.should eq(expected)' 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 actual_inspected
+          if LITERAL_SINGLETONS.include?(actual)
+            actual_formatted
+          else
+            inspect_object(actual)
+          end
+        end
+
+        def simple_failure_message
+          "\nexpected #{expected_formatted}\n     got #{actual_inspected}\n"
         end
 
-        def diffable?; true; end
+        def detailed_failure_message
+          <<-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.
 
-        private
+MESSAGE
+        end
 
         def inspect_object(o)
-          "#<#{o.class}:#{o.object_id}> => #{o.inspect}"
+          "#<#{o.class}:#{o.object_id}> => #{RSpec::Support::ObjectFormatter.format(o)}"
         end
       end
     end

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

@@ -1,23 +1,87 @@
 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_formatted} to exist#{@test.validity_message}"
+        end
+
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          "expected #{actual_formatted} not to exist#{@test.validity_message}"
+        end
+
+        # @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) && !deprecated(p, actual) }
+          end
+
+          def deprecated(predicate, actual)
+            predicate == :exists? && File == actual
           end
         end
       end

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

@@ -1,46 +1,165 @@
 module RSpec
   module Matchers
     module BuiltIn
-      class Has
-        def initialize(expected, *args)
-          @expected, @args = expected, args
+      # @api private
+      # Provides the implementation for dynamic predicate matchers.
+      # Not intended to be inherited directly.
+      class DynamicPredicate < BaseMatcher
+        include BeHelpers
+
+        def initialize(method_name, *args, &block)
+          @method_name, @args, @block = method_name, args, block
+        end
+        ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
+
+        # @private
+        def matches?(actual, &block)
+          @actual = actual
+          @block ||= block
+          predicate_accessible? && predicate_matches?
         end
 
-        def matches?(actual)
-          actual.__send__(predicate(@expected), *@args)
+        # @private
+        def does_not_match?(actual, &block)
+          @actual = actual
+          @block ||= block
+          predicate_accessible? && predicate_matches?(false)
         end
-        alias == matches?
 
-        def failure_message_for_should
-          "expected ##{predicate(@expected)}#{failure_message_args_description} to return true, got false"
+        # @api private
+        # @return [String]
+        def failure_message
+          failure_message_expecting(true)
         end
 
-        def failure_message_for_should_not
-          "expected ##{predicate(@expected)}#{failure_message_args_description} to return false, got true"
+        # @api private
+        # @return [String]
+        def failure_message_when_negated
+          failure_message_expecting(false)
         end
 
+        # @api private
+        # @return [String]
         def description
-          [method_description(@expected), args_description].compact.join(' ')
+          "#{method_description}#{args_to_sentence}"
+        end
+
+      private
+
+        def predicate_accessible?
+          @actual.respond_to? predicate
+        end
+
+        # support 1.8.7, evaluate once at load time for performance
+        if String === methods.first
+          # :nocov:
+          def private_predicate?
+            @actual.private_methods.include? predicate.to_s
+          end
+          # :nocov:
+        else
+          def private_predicate?
+            @actual.private_methods.include? predicate
+          end
+        end
+
+        def predicate_result
+          @predicate_result = actual.__send__(predicate_method_name, *@args, &@block)
+        end
+
+        def predicate_method_name
+          predicate
+        end
+
+        def predicate_matches?(value=true)
+          if RSpec::Expectations.configuration.strict_predicate_matchers?
+            value == predicate_result
+          else
+            value == !!predicate_result
+          end
+        end
+
+        def root
+          # On 1.9, there appears to be a bug where String#match can return `false`
+          # rather than the match data object. Changing to Regex#match appears to
+          # work around this bug. For an example of this bug, see:
+          # https://travis-ci.org/rspec/rspec-expectations/jobs/27549635
+          self.class::REGEX.match(@method_name.to_s).captures.first
         end
 
-        private
+        def method_description
+          EnglishPhrasing.split_words(@method_name)
+        end
+
+        def failure_message_expecting(value)
+          validity_message ||
+            "expected `#{actual_formatted}.#{predicate}#{args_to_s}` to #{expectation_of value}, got #{description_of @predicate_result}"
+        end
+
+        def expectation_of(value)
+          if RSpec::Expectations.configuration.strict_predicate_matchers?
+            "return #{value}"
+          elsif value
+            "be truthy"
+          else
+            "be falsey"
+          end
+        end
+
+        def validity_message
+          return nil if predicate_accessible?
+
+          "expected #{actual_formatted} to respond to `#{predicate}`#{failure_to_respond_explanation}"
+        end
+
+        def failure_to_respond_explanation
+          if private_predicate?
+            " but `#{predicate}` is a private method"
+          end
+        end
+      end
+
+      # @api private
+      # Provides the implementation for `has_<predicate>`.
+      # Not intended to be instantiated directly.
+      class Has < DynamicPredicate
+        # :nodoc:
+        REGEX = Matchers::HAS_REGEX
+      private
+        def predicate
+          @predicate ||= :"has_#{root}?"
+        end
+      end
+
+      # @api private
+      # Provides the implementation of `be_<predicate>`.
+      # Not intended to be instantiated directly.
+      class BePredicate < DynamicPredicate
+        # :nodoc:
+        REGEX = Matchers::BE_PREDICATE_REGEX
+      private
+        def predicate
+          @predicate ||= :"#{root}?"
+        end
 
-        def predicate(sym)
-          "#{sym.to_s.sub("have_","has_")}?".to_sym
+        def predicate_method_name
+          actual.respond_to?(predicate) ? predicate : present_tense_predicate
         end
 
-        def method_description(method)
-          method.to_s.gsub('_', ' ')
+        def failure_to_respond_explanation
+          super || if predicate == :true?
+                     " or perhaps you meant `be true` or `be_truthy`"
+                   elsif predicate == :false?
+                     " or perhaps you meant `be false` or `be_falsey`"
+                   end
         end
 
-        def args_description
-          return nil if @args.empty?
-          @args.map { |arg| arg.inspect }.join(', ')
+        def predicate_accessible?
+          super || actual.respond_to?(present_tense_predicate)
         end
 
-        def failure_message_args_description
-          desc = args_description
-          "(#{desc})" if desc
+        def present_tense_predicate
+          :"#{root}s?"
         end
       end
     end