rspec-expectations 3.2.1 → 3.3.0

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

@@ -114,7 +114,7 @@ module RSpec
         end
 
         def throw_description(symbol, arg)
-          symbol_description = symbol.is_a?(String) ? symbol : symbol.inspect
+          symbol_description = symbol.is_a?(String) ? symbol : description_of(symbol)
 
           arg_description = if arg
                               " with #{description_of arg}"

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

@@ -78,6 +78,7 @@ module RSpec
                   "matcher. Pass the argument as a block on to the method you are testing."
           end
         else
+          # :nocov:
           # On 1.8.7, `lambda { }.arity` and `lambda { |*a| }.arity` both return -1,
           # so we can't distinguish between accepting no args and an arg splat.
           # It's OK to skip, this, though; it just provides a nice error message
@@ -86,6 +87,7 @@ module RSpec
           def assert_valid_expect_block!
             # nothing to do
           end
+          # :nocov:
         end
       end
 
@@ -247,7 +249,7 @@ module RSpec
         def positive_failure_reason
           return "was not a block" unless @probe.has_block?
           return "did not yield" if @probe.num_yields.zero?
-          "yielded with arguments: #{@probe.single_yield_args.inspect}"
+          "yielded with arguments: #{description_of @probe.single_yield_args}"
         end
 
         def negative_failure_reason
@@ -317,7 +319,7 @@ module RSpec
           elsif all_args_match?
             "yielded with expected arguments" \
               "\nexpected not: #{surface_descriptions_in(@expected).inspect}" +
-              "\n         got: #{@actual.inspect}"
+              "\n         got: #{actual_formatted}"
           else
             "did"
           end
@@ -332,7 +334,7 @@ module RSpec
           unless (match = all_args_match?)
             @positive_args_failure = "yielded with unexpected arguments" \
               "\nexpected: #{surface_descriptions_in(@expected).inspect}" +
-              "\n     got: #{@actual.inspect}"
+              "\n     got: #{actual_formatted}"
           end
 
           match
@@ -400,7 +402,7 @@ module RSpec
 
           "yielded with unexpected arguments" \
           "\nexpected: #{surface_descriptions_in(@expected).inspect}" \
-          "\n     got: #{@actual.inspect}"
+          "\n     got: #{actual_formatted}"
         end
 
         def negative_failure_reason
@@ -408,7 +410,7 @@ module RSpec
 
           "yielded with expected arguments" \
           "\nexpected not: #{surface_descriptions_in(@expected).inspect}" \
-          "\n         got: #{@actual.inspect}"
+          "\n         got: #{actual_formatted}"
         end
       end
     end

data/lib/rspec/matchers/composable.rb

@@ -80,8 +80,7 @@ module RSpec
       #
       # @!visibility public
       def description_of(object)
-        return object.description if Matchers.is_a_describable_matcher?(object)
-        object.inspect
+        RSpec::Support::ObjectFormatter.format(object)
       end
 
       # Transforms the given data structue (typically a hash or array)
@@ -102,12 +101,12 @@ module RSpec
         elsif Hash === item
           Hash[surface_descriptions_in(item.to_a)]
         elsif Struct === item
-          item.inspect
+          RSpec::Support::ObjectFormatter.format(item)
         elsif should_enumerate?(item)
           begin
             item.map { |subitem| surface_descriptions_in(subitem) }
           rescue IOError # STDOUT is enumerable but `map` raises an error
-            item.inspect
+            RSpec::Support::ObjectFormatter.format(item)
           end
         else
           item
@@ -149,6 +148,7 @@ module RSpec
       end
 
       if String.ancestors.include?(Enumerable) # 1.8.7
+        # :nocov:
         # Strings are not enumerable on 1.9, and on 1.8 they are an infinitely
         # nested enumerable: since ruby lacks a character class, it yields
         # 1-character strings, which are themselves enumerable, composed of a
@@ -159,6 +159,7 @@ module RSpec
           return false if String === item
           Enumerable === item && !(Range === item)
         end
+        # :nocov:
       else
         # @api private
         def should_enumerate?(item)

data/lib/rspec/matchers/dsl.rb

@@ -24,9 +24,11 @@ module RSpec
           end
         end
       else
+        # :nocov:
         def warn_about_block_args(*)
           # There's no way to detect block params on 1.8 since the method reflection APIs don't expose it
         end
+        # :nocov:
       end
 
       RSpec.configure { |c| c.extend self } if RSpec.respond_to?(:configure)
@@ -58,13 +60,18 @@ module RSpec
           define_user_override(:matches?, match_block) do |actual|
             begin
               @actual = actual
-              super(*actual_arg_for(match_block))
+              RSpec::Support.with_failure_notifier(RAISE_NOTIFIER) do
+                super(*actual_arg_for(match_block))
+              end
             rescue RSpec::Expectations::ExpectationNotMetError
               false
             end
           end
         end
 
+        # @private
+        RAISE_NOTIFIER = Proc.new { |err, _opts| raise err }
+
         # Use this to define the block for a negative expectation (`expect(...).not_to`)
         # when the positive and negative forms require different handling. This
         # is rarely necessary, but can be helpful, for example, when specifying
@@ -300,7 +307,9 @@ module RSpec
 
         # The default description.
         def description
-          "#{name_to_sentence}#{to_sentence expected}#{chained_method_clause_sentences}"
+          english_name = EnglishPhrasing.split_words(name)
+          expected_list = EnglishPhrasing.list(expected)
+          "#{english_name}#{expected_list}#{chained_method_clause_sentences}"
         end
 
         # Matchers do not support block expectations by default. You
@@ -320,7 +329,9 @@ module RSpec
           return '' unless Expectations.configuration.include_chain_clauses_in_custom_matcher_descriptions?
 
           @chained_method_clauses.map do |(method_name, method_args)|
-            " #{split_words(method_name)}#{to_sentence(method_args)}"
+            english_name = EnglishPhrasing.split_words(method_name)
+            arg_list = EnglishPhrasing.list(method_args)
+            " #{english_name}#{arg_list}"
           end.join
         end
       end
@@ -336,9 +347,6 @@ module RSpec
         # Allows expectation expressions to be used in the match block.
         include RSpec::Matchers
 
-        # Converts matcher name and expected args to an English expresion.
-        include RSpec::Matchers::Pretty
-
         # Supports the matcher composability features of RSpec 3+.
         include Composable
 
@@ -357,6 +365,9 @@ module RSpec
         # The block parameter used in the expectation
         attr_reader :block_arg
 
+        # The name of the matcher.
+        attr_reader :name
+
         # @api private
         def initialize(name, declarations, matcher_execution_context, *expected, &block_arg)
           @name     = name
@@ -406,11 +417,13 @@ module RSpec
             super || @matcher_execution_context.respond_to?(method, include_private)
           end
         else # for 1.8.7
+          # :nocov:
           # Indicates that this matcher responds to messages
           # from the `@matcher_execution_context` as well.
           def respond_to?(method, include_private=false)
             super || @matcher_execution_context.respond_to?(method, include_private)
           end
+          # :nocov:
         end
 
       private

data/lib/rspec/matchers/english_phrasing.rb

@@ -0,0 +1,42 @@
+module RSpec
+  module Matchers
+    # Facilitates converting ruby objects to English phrases.
+    module EnglishPhrasing
+      # Converts a symbol into an English expression.
+      #
+      #     split_words(:banana_creme_pie) #=> "banana creme pie"
+      #
+      def self.split_words(sym)
+        sym.to_s.gsub(/_/, ' ')
+      end
+
+      # @note The returned string has a leading space except
+      # when given an empty list.
+      #
+      # Converts an object (often a collection of objects)
+      # into an English list.
+      #
+      #     list(['banana', 'kiwi', 'mango'])
+      #     #=> " \"banana\", \"kiwi\", and \"mango\""
+      #
+      # Given an empty collection, returns the empty string.
+      #
+      #     list([]) #=> ""
+      #
+      def self.list(obj)
+        return " #{RSpec::Support::ObjectFormatter.format(obj)}" if !obj || Struct === obj
+        items = Array(obj).map { |w| RSpec::Support::ObjectFormatter.format(w) }
+        case items.length
+        when 0
+          ""
+        when 1
+          " #{items[0]}"
+        when 2
+          " #{items[0]} and #{items[1]}"
+        else
+          " #{items[0...-1].join(', ')}, and #{items[-1]}"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/matchers/expecteds_for_multiple_diffs.rb

@@ -53,13 +53,7 @@ module RSpec
     private
 
       def self.diff_label_for(matcher)
-        "Diff for (#{truncated(description_for(matcher))}):"
-      end
-
-      def self.description_for(matcher)
-        matcher.description
-      rescue NoMethodError
-        matcher.inspect
+        "Diff for (#{truncated(RSpec::Support::ObjectFormatter.format(matcher))}):"
       end
 
       def self.truncated(description)
@@ -70,7 +64,7 @@ module RSpec
       def diffs(differ, actual)
         @expected_list.map do |(expected, diff_label)|
           diff = differ.diff(actual, expected)
-          next if diff.empty?
+          next if diff.strip.empty?
           "#{diff_label}#{diff}"
         end.compact.join("\n")
       end

data/lib/rspec/matchers/fail_matchers.rb

@@ -0,0 +1,42 @@
+require 'rspec/expectations'
+
+module RSpec
+  module Matchers
+    # Matchers for testing RSpec matchers. Include them with:
+    #
+    #     require 'rspec/matchers/fail_matchers'
+    #     RSpec.configure do |config|
+    #       config.include RSpec::Matchers::FailMatchers
+    #     end
+    #
+    module FailMatchers
+      # Matches if an expectation fails
+      #
+      # @example
+      #   expect { some_expectation }.to fail
+      def fail(&block)
+        raise_error(RSpec::Expectations::ExpectationNotMetError, &block)
+      end
+
+      # Matches if an expectation fails with the provided message
+      #
+      # @example
+      #   expect { some_expectation }.to fail_with("some failure message")
+      #   expect { some_expectation }.to fail_with(/some failure message/)
+      def fail_with(message)
+        raise_error(RSpec::Expectations::ExpectationNotMetError, message)
+      end
+
+      # Matches if an expectation fails including the provided message
+      #
+      # @example
+      #   expect { some_expectation }.to fail_including("portion of some failure message")
+      def fail_including(*snippets)
+        raise_error(
+          RSpec::Expectations::ExpectationNotMetError,
+          a_string_including(*snippets)
+        )
+      end
+    end
+  end
+end

data/lib/rspec/matchers/matcher_delegator.rb

@@ -19,9 +19,11 @@ module RSpec
           super || base_matcher.respond_to?(name, include_all)
         end
       else
+        # :nocov:
         def respond_to?(name, include_all=false)
           super || base_matcher.respond_to?(name, include_all)
         end
+        # :nocov:
       end
 
       def initialize_copy(other)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-expectations
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Steven Baker
@@ -45,7 +45,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-support
@@ -53,14 +53,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +153,7 @@ files:
 - lib/rspec/expectations/configuration.rb
 - lib/rspec/expectations/expectation_target.rb
 - lib/rspec/expectations/fail_with.rb
+- lib/rspec/expectations/failure_aggregator.rb
 - lib/rspec/expectations/handler.rb
 - lib/rspec/expectations/minitest_integration.rb
 - lib/rspec/expectations/syntax.rb
@@ -189,11 +190,12 @@ files:
 - lib/rspec/matchers/built_in/yield.rb
 - lib/rspec/matchers/composable.rb
 - lib/rspec/matchers/dsl.rb
+- lib/rspec/matchers/english_phrasing.rb
 - lib/rspec/matchers/expecteds_for_multiple_diffs.rb
+- lib/rspec/matchers/fail_matchers.rb
 - lib/rspec/matchers/generated_descriptions.rb
 - lib/rspec/matchers/matcher_delegator.rb
 - lib/rspec/matchers/matcher_protocol.rb
-- lib/rspec/matchers/pretty.rb
 homepage: http://github.com/rspec/rspec-expectations
 licenses:
 - MIT
@@ -214,10 +216,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rspec
+rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: rspec-expectations-3.2.1
+summary: rspec-expectations-3.3.0
 test_files: []
 has_rdoc: 

data/lib/rspec/matchers/pretty.rb

@@ -1,77 +0,0 @@
-module RSpec
-  module Matchers
-    # @api private
-    # Contains logic to facilitate converting ruby symbols and
-    # objects to english phrases.
-    module Pretty
-      # @api private
-      # Converts a symbol into an english expression.
-      def split_words(sym)
-        sym.to_s.gsub(/_/, ' ')
-      end
-      module_function :split_words
-
-      # @api private
-      # Converts a collection of objects into an english expression.
-      def to_sentence(words)
-        return " #{words.inspect}" if !words || Struct === words
-        words = Array(words).map { |w| to_word(w) }
-        case words.length
-        when 0
-          ""
-        when 1
-          " #{words[0]}"
-        when 2
-          " #{words[0]} and #{words[1]}"
-        else
-          " #{words[0...-1].join(', ')}, and #{words[-1]}"
-        end
-      end
-
-      # @api private
-      # Converts the given item to string suitable for use in a list expression.
-      def to_word(item)
-        is_matcher_with_description?(item) ? item.description : item.inspect
-      end
-
-      # @private
-      # Provides an English expression for the matcher name.
-      def name_to_sentence
-        split_words(name)
-      end
-
-      # @api private
-      # Provides a name for the matcher.
-      def name
-        defined?(@name) ? @name : underscore(self.class.name.split("::").last)
-      end
-
-      # @private
-      # Borrowed from ActiveSupport
-      def 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
-
-      def is_matcher_with_description?(object)
-        RSpec::Matchers.is_a_matcher?(object) && object.respond_to?(:description)
-      end
-
-      # `{ :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
-    end
-  end
-end