rspec-expectations 3.2.1 → 3.3.0

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

@@ -12,7 +12,6 @@ module RSpec
       # strongly recommend that you do not base your custom matchers on this
       # class. If/when this changes, we will announce it and remove this warning.
       class BaseMatcher
-        include RSpec::Matchers::Pretty
         include RSpec::Matchers::Composable
 
         # @api private
@@ -53,11 +52,12 @@ module RSpec
         end
 
         # @api private
-        # Generates a "pretty" description using the logic in {Pretty}.
+        # Generates a description using {EnglishPhrasing}.
         # @return [String]
         def description
-          return name_to_sentence unless defined?(@expected)
-          "#{name_to_sentence}#{to_sentence @expected}"
+          desc = EnglishPhrasing.split_words(self.class.matcher_name)
+          desc << EnglishPhrasing.list(@expected) if defined?(@expected)
+          desc
         end
 
         # @api private
@@ -80,21 +80,70 @@ module RSpec
           false
         end
 
+        # @private
+        def expected_formatted
+          RSpec::Support::ObjectFormatter.format(@expected)
+        end
+
+        # @private
+        def actual_formatted
+          RSpec::Support::ObjectFormatter.format(@actual)
+        end
+
+        # @private
+        def self.matcher_name
+          @matcher_name ||= underscore(name.split("::").last)
+        end
+
+        # @private
+        # Borrowed from ActiveSupport.
+        def self.underscore(camel_cased_word)
+          word = camel_cased_word.to_s.dup
+          word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+        private_class_method :underscore
+
       private
 
         def assert_ivars(*expected_ivars)
           return unless (expected_ivars - present_ivars).any?
-          raise "#{self.class.name} needs to supply#{to_sentence expected_ivars}"
+          ivar_list = EnglishPhrasing.list(expected_ivars)
+          raise "#{self.class.name} needs to supply#{ivar_list}"
         end
 
         if RUBY_VERSION.to_f < 1.9
+          # :nocov:
           def present_ivars
             instance_variables.map { |v| v.to_sym }
           end
+          # :nocov:
         else
           alias present_ivars instance_variables
         end
 
+        # @private
+        module HashFormatting
+          # `{ :a => 5, :b => 2 }.inspect` produces:
+          #
+          #     {:a=>5, :b=>2}
+          #
+          # ...but it looks much better as:
+          #
+          #     {:a => 5, :b => 2}
+          #
+          # This is idempotent and safe to run on a string multiple times.
+          def improve_hash_formatting(inspect_string)
+            inspect_string.gsub(/(\S)=>(\S)/, '\1 => \2')
+          end
+          module_function :improve_hash_formatting
+        end
+
+        include HashFormatting
+
         # @api private
         # Provides default implementations of failure messages, based on the `description`.
         module DefaultFailureMessages
@@ -104,7 +153,7 @@ module RSpec
           # you often only need to override `description`.
           # @return [String]
           def failure_message
-            "expected #{actual.inspect} to #{description}"
+            "expected #{description_of @actual} to #{description}"
           end
 
           # @api private
@@ -113,7 +162,7 @@ module RSpec
           # you often only need to override `description`.
           # @return [String]
           def failure_message_when_negated
-            "expected #{actual.inspect} not to #{description}"
+            "expected #{description_of @actual} not to #{description}"
           end
 
           # @private

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

@@ -8,13 +8,13 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "expected: truthy value\n     got: #{actual.inspect}"
+          "expected: truthy value\n     got: #{actual_formatted}"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "expected: falsey value\n     got: #{actual.inspect}"
+          "expected: falsey value\n     got: #{actual_formatted}"
         end
 
       private
@@ -31,13 +31,13 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "expected: falsey value\n     got: #{actual.inspect}"
+          "expected: falsey value\n     got: #{actual_formatted}"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "expected: truthy value\n     got: #{actual.inspect}"
+          "expected: truthy value\n     got: #{actual_formatted}"
         end
 
       private
@@ -54,7 +54,7 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "expected: nil\n     got: #{actual.inspect}"
+          "expected: nil\n     got: #{actual_formatted}"
         end
 
         # @api private
@@ -83,15 +83,15 @@ module RSpec
         end
 
         def inspected_args
-          @args.map { |a| a.inspect }
+          @args.map { |a| RSpec::Support::ObjectFormatter.format(a) }
         end
 
         def expected_to_sentence
-          split_words(@expected)
+          EnglishPhrasing.split_words(@expected)
         end
 
         def args_to_sentence
-          to_sentence(@args)
+          EnglishPhrasing.list(@args)
         end
       end
 
@@ -108,13 +108,13 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "expected #{@actual.inspect} to evaluate to true"
+          "expected #{actual_formatted} to evaluate to true"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "expected #{@actual.inspect} to evaluate to false"
+          "expected #{actual_formatted} to evaluate to false"
         end
 
         [:==, :<, :<=, :>=, :>, :===, :=~].each do |operator|
@@ -149,13 +149,13 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "expected: #{@operator} #{@expected.inspect}\n     got: #{@operator.to_s.gsub(/./, ' ')} #{@actual.inspect}"
+          "expected: #{@operator} #{expected_formatted}\n     got: #{@operator.to_s.gsub(/./, ' ')} #{actual_formatted}"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          message = "`expect(#{@actual.inspect}).not_to be #{@operator} #{@expected.inspect}`"
+          message = "`expect(#{actual_formatted}).not_to be #{@operator} #{expected_formatted}`"
           if [:<, :>, :<=, :>=].include?(@operator)
             message + " not only FAILED, it is a bit confusing."
           else
@@ -220,9 +220,11 @@ module RSpec
 
         # 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
@@ -252,19 +254,27 @@ module RSpec
         end
 
         def prefix_to_sentence
-          split_words(@prefix)
+          EnglishPhrasing.split_words(@prefix)
         end
 
         def failure_message_expecting(value)
           validity_message ||
-            "expected `#{@actual.inspect}.#{predicate}#{args_to_s}` to return #{value}, got #{@predicate_matches.inspect}"
+            "expected `#{actual_formatted}.#{predicate}#{args_to_s}` to return #{value}, got #{description_of @predicate_matches}"
         end
 
         def validity_message
           return nil if predicate_accessible?
 
           msg = "expected #{@actual} to respond to `#{predicate}`"
-          msg << " but `#{predicate}` is a private method" if private_predicate?
+
+          if private_predicate?
+            msg << " but `#{predicate}` is a private method"
+          elsif predicate == :true?
+            msg << " or perhaps you meant `be true` or `be_truthy`"
+          elsif predicate == :false?
+            msg << " or perhaps you meant `be false` or `be_falsey`"
+          end
+
           msg
         end
       end

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

@@ -55,7 +55,7 @@ module RSpec
         # @api private
         # @return [String]
         def description
-          "be between #{@min.inspect} and #{@max.inspect} (#{@mode})"
+          "be between #{description_of @min} and #{description_of @max} (#{@mode})"
         end
 
       private

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

@@ -38,13 +38,13 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "expected #{@actual.inspect} to #{description}#{not_numeric_clause}"
+          "expected #{actual_formatted} to #{description}#{not_numeric_clause}"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "expected #{@actual.inspect} not to #{description}"
+          "expected #{actual_formatted} not to #{description}"
         end
 
         # @api private

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

@@ -9,27 +9,29 @@ 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  = "expected collection contained:  #{description_of(safe_sort(surface_descriptions_in expected))}\n"
+            message += "actual collection contained:    #{description_of(safe_sort(actual))}\n"
+            message += "the missing elements were:      #{description_of(safe_sort(surface_descriptions_in missing_items))}\n" unless missing_items.empty?
+            message += "the extra elements were:        #{description_of(safe_sort(extra_items))}\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}"
+            "`#to_ary` or `#to_a`, but got #{actual_formatted}"
           end
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "expected #{actual.inspect} not to contain exactly#{to_sentence(surface_descriptions_in expected)}"
+          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
 
       private
@@ -58,7 +60,9 @@ module RSpec
         end
 
         def safe_sort(array)
-          array.sort rescue array
+          array.sort
+        rescue Exception
+          array
         end
 
         def missing_items

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

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

@@ -48,14 +48,14 @@ MESSAGE
 
         def actual_inspected
           if LITERAL_SINGLETONS.include?(actual)
-            actual.inspect
+            actual_formatted
           else
             inspect_object(actual)
           end
         end
 
         def simple_failure_message
-          "\nexpected #{expected.inspect}\n     got #{actual_inspected}\n"
+          "\nexpected #{expected_formatted}\n     got #{actual_inspected}\n"
         end
 
         def detailed_failure_message
@@ -73,7 +73,7 @@ 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

@@ -28,13 +28,13 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "expected #{@actual.inspect} to exist#{@test.validity_message}"
+          "expected #{actual_formatted} to exist#{@test.validity_message}"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "expected #{@actual.inspect} not to exist#{@test.validity_message}"
+          "expected #{actual_formatted} not to exist#{@test.validity_message}"
         end
 
         # @api private

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

@@ -49,9 +49,11 @@ module RSpec
 
         # 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
@@ -80,7 +82,7 @@ module RSpec
 
         def args_description
           return nil if @args.empty?
-          @args.map { |arg| arg.inspect }.join(', ')
+          @args.map { |arg| RSpec::Support::ObjectFormatter.format(arg) }.join(', ')
         end
 
         def failure_message_args_description