rspec-expectations 3.8.6 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f0c43e7a6933605f4b96eb0a5545bd5e1b03a2b2de4471edada5000f3c5c37
-  data.tar.gz: 62b85e7625d066114174dfaa586dbb2cb419aa0bc470b68918c2524b841f8762
+  metadata.gz: d8cb915ab51f5b587fcbaa864e697cc291ff3c1f49afd8d829837c1a9c4c4f6b
+  data.tar.gz: 6aa770883cacbfcf2921074a98506a0a789b4557ee6a7ea79738f008107e582d
 SHA512:
-  metadata.gz: 5ba237ec4317b7af0780f5e929e10da26b501f76a23cb807684498a21118ef0f72598c1ded7ee0436a8a29f97ea16a0d4f887c7b345b22302f5b8ef50c660beb
-  data.tar.gz: 4138b8b208b668216660d55f5634440e8240c4a36f15489fc3e1e6093d4a8530fc419d9f958ea4526ac63e7e9e2d589c7716a21832d257adac823486d5dfae77
+  metadata.gz: fc2669ca822767874cc62c9e7cef32040f90da7cd0d4c13b1bd97fde68230f7f7019a8b717e2ebfcd223da5b9e25aaa60270c0797ba4d304def5e4ae3bb63f03
+  data.tar.gz: e9d7a9e1b186c1eee547c315f177181992f5be9e35c61a16a041d97901537d054943a779e0d6bd7f2502e51a1fcbf95f0f6a10eab46fcdd85bebd8be1170a369

data/Changelog.md

@@ -1,3 +1,17 @@
+### 3.9.0 / 2019-10-02
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.8.5...v3.9.0)
+
+Enhancements:
+
+* The `respond_to` matcher now uses the signature from `initialize` to validate checks
+  for `new` (unless `new` is non standard). (Jon Rowe, #1072)
+* Generated descriptions for matchers now use `is expected to` rather than `should` in
+  line with our preferred DSL. (Pete Johns, #1080, rspec/rspec-core#2572)
+* Add the ability to re-raise expectation errors when matching
+  with `match_when_negated` blocks. (Jon Rowe, #1130)
+* Add a warning when an empty diff is produce due to identical inspect output.
+  (Benoit Tigeot, #1126)
+
 ### 3.8.6 / 2019-10-07
 
 Bug Fixes:

data/README.md

@@ -175,30 +175,45 @@ expect(1..10).to cover(3)
 ### Collection membership
 
 ```ruby
-expect(actual).to include(expected)
+# exact order, entire collection
+expect(actual).to eq(expected)
+
+# exact order, partial collection (based on an exact position)
 expect(actual).to start_with(expected)
 expect(actual).to end_with(expected)
 
-expect(actual).to contain_exactly(individual, items)
-# ...which is the same as:
-expect(actual).to match_array(expected_array)
+# any order, entire collection
+expect(actual).to match_array(expected)
+
+# You can also express this by passing the expected elements
+# as individual arguments
+expect(actual).to contain_exactly(expected_element1, expected_element2)
+
+ # any order, partial collection
+expect(actual).to include(expected)
 ```
 
 #### Examples
 
 ```ruby
-expect([1, 2, 3]).to include(1)
-expect([1, 2, 3]).to include(1, 2)
-expect([1, 2, 3]).to start_with(1)
-expect([1, 2, 3]).to start_with(1, 2)
-expect([1, 2, 3]).to end_with(3)
-expect([1, 2, 3]).to end_with(2, 3)
-expect({:a => 'b'}).to include(:a => 'b')
-expect("this string").to include("is str")
-expect("this string").to start_with("this")
-expect("this string").to end_with("ring")
-expect([1, 2, 3]).to contain_exactly(2, 3, 1)
-expect([1, 2, 3]).to match_array([3, 2, 1])
+expect([1, 2, 3]).to eq([1, 2, 3])            # Order dependent equality check
+expect([1, 2, 3]).to include(1)               # Exact ordering, partial collection matches
+expect([1, 2, 3]).to include(2, 3)            #
+expect([1, 2, 3]).to start_with(1)            # As above, but from the start of the collection
+expect([1, 2, 3]).to start_with(1, 2)         #
+expect([1, 2, 3]).to end_with(3)              # As above but from the end of the collection
+expect([1, 2, 3]).to end_with(2, 3)           #
+expect({:a => 'b'}).to include(:a => 'b')     # Matching within hashes
+expect("this string").to include("is str")    # Matching within strings
+expect("this string").to start_with("this")   #
+expect("this string").to end_with("ring")     #
+expect([1, 2, 3]).to contain_exactly(2, 3, 1) # Order independent matches
+expect([1, 2, 3]).to match_array([3, 2, 1])   #
+
+# Order dependent compound matchers
+expect(
+  [{:a => 'hash'},{:a => 'another'}]
+).to match([a_hash_including(:a => 'hash'), a_hash_including(:a => 'another')])
 ```
 
 ## `should` syntax

data/lib/rspec/expectations/handler.rb

@@ -52,7 +52,7 @@ module RSpec
       end
 
       def self.verb
-        "should"
+        'is expected to'
       end
 
       def self.should_method
@@ -82,7 +82,7 @@ module RSpec
       end
 
       def self.verb
-        "should not"
+        'is expected not to'
       end
 
       def self.should_method

data/lib/rspec/expectations/version.rb

@@ -2,7 +2,7 @@ module RSpec
   module Expectations
     # @private
     module Version
-      STRING = '3.8.6'
+      STRING = '3.9.0'
     end
   end
 end

data/lib/rspec/matchers.rb

@@ -1003,31 +1003,35 @@ module RSpec
       is_a_matcher?(obj) && obj.respond_to?(:description)
     end
 
-    if RSpec::Support::Ruby.mri? && RUBY_VERSION[0, 3] == '1.9'
-      # @api private
-      # Note that `included` doesn't work for this because it is triggered
-      # _after_ `RSpec::Matchers` is an ancestor of the inclusion host, rather
-      # than _before_, like `append_features`. It's important we check this before
-      # in order to find the cases where it was already previously included.
-      def self.append_features(mod)
-        return super if mod < self # `mod < self` indicates a re-inclusion.
+    class << self
+      private
 
-        subclasses = ObjectSpace.each_object(Class).select { |c| c < mod && c < self }
-        return super unless subclasses.any?
+      if RSpec::Support::Ruby.mri? && RUBY_VERSION[0, 3] == '1.9'
+        # Note that `included` doesn't work for this because it is triggered
+        # _after_ `RSpec::Matchers` is an ancestor of the inclusion host, rather
+        # than _before_, like `append_features`. It's important we check this before
+        # in order to find the cases where it was already previously included.
+        # @api private
+        def append_features(mod)
+          return super if mod < self # `mod < self` indicates a re-inclusion.
 
-        subclasses.reject! { |s| subclasses.any? { |s2| s < s2 } } # Filter to the root ancestor.
-        subclasses = subclasses.map { |s| "`#{s}`" }.join(", ")
+          subclasses = ObjectSpace.each_object(Class).select { |c| c < mod && c < self }
+          return super unless subclasses.any?
 
-        RSpec.warning "`#{self}` has been included in a superclass (`#{mod}`) " \
-                      "after previously being included in subclasses (#{subclasses}), " \
-                      "which can trigger infinite recursion from `super` due to an MRI 1.9 bug " \
-                      "(https://redmine.ruby-lang.org/issues/3351). To work around this, " \
-                      "either upgrade to MRI 2.0+, include a dup of the module (e.g. " \
-                      "`include #{self}.dup`), or find a way to include `#{self}` in `#{mod}` " \
-                      "before it is included in subclasses (#{subclasses}). See " \
-                      "https://github.com/rspec/rspec-expectations/issues/814 for more info"
+          subclasses.reject! { |s| subclasses.any? { |s2| s < s2 } } # Filter to the root ancestor.
+          subclasses = subclasses.map { |s| "`#{s}`" }.join(", ")
 
-        super
+          RSpec.warning "`#{self}` has been included in a superclass (`#{mod}`) " \
+                        "after previously being included in subclasses (#{subclasses}), " \
+                        "which can trigger infinite recursion from `super` due to an MRI 1.9 bug " \
+                        "(https://redmine.ruby-lang.org/issues/3351). To work around this, " \
+                        "either upgrade to MRI 2.0+, include a dup of the module (e.g. " \
+                        "`include #{self}.dup`), or find a way to include `#{self}` in `#{mod}` " \
+                        "before it is included in subclasses (#{subclasses}). See " \
+                        "https://github.com/rspec/rspec-expectations/issues/814 for more info"
+
+          super
+        end
       end
     end
   end

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

@@ -154,7 +154,12 @@ module RSpec
           end
 
           def matcher_matches?(matcher)
-            @match_results.fetch(matcher)
+            @match_results.fetch(matcher) do
+              raise ArgumentError, "Your #{matcher.description} has no match " \
+               "results, this can occur when an unexpected call stack or " \
+               "local jump occurs. Prehaps one of your matchers needs to " \
+               "declare `expects_call_stack_jump?` as `true`?"
+            end
           end
 
         private

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

@@ -125,9 +125,18 @@ module RSpec
 
           return true if expectation.empty?
 
-          signature = Support::MethodSignature.new(Support.method_handle_for(actual, name))
+          Support::StrictSignatureVerifier.new(method_signature_for(actual, name)).
+            with_expectation(expectation).valid?
+        end
+
+        def method_signature_for(actual, name)
+          method_handle = Support.method_handle_for(actual, name)
 
-          Support::StrictSignatureVerifier.new(signature).with_expectation(expectation).valid?
+          if name == :new && method_handle.owner === ::Class && ::Class === actual
+            Support::MethodSignature.new(actual.instance_method(:initialize))
+          else
+            Support::MethodSignature.new(method_handle)
+          end
         end
 
         def with_arity

data/lib/rspec/matchers/dsl.rb

@@ -147,8 +147,14 @@ module RSpec
         # is rarely necessary, but can be helpful, for example, when specifying
         # asynchronous processes that require different timeouts.
         #
+        # By default the match block will swallow expectation errors (e.g.
+        # caused by using an expectation such as `expect(1).to eq 2`), if you
+        # with to allow these to bubble up, pass in the option
+        # `:notify_expectation_failures => true`.
+        #
+        # @param [Hash] options for defining the behavior of the match block.
         # @yield [Object] actual the actual value (i.e. the value wrapped by `expect`)
-        def match_when_negated(&match_block)
+        def match_when_negated(options={}, &match_block)
           define_user_override(:does_not_match?, match_block) do |actual|
             begin
               @actual = actual
@@ -156,6 +162,7 @@ module RSpec
                 super(*actual_arg_for(match_block))
               end
             rescue RSpec::Expectations::ExpectationNotMetError
+              raise if options[:notify_expectation_failures]
               false
             end
           end

data/lib/rspec/matchers/expecteds_for_multiple_diffs.rb

@@ -52,20 +52,29 @@ module RSpec
 
     private
 
-      def self.diff_label_for(matcher)
-        "Diff for (#{truncated(RSpec::Support::ObjectFormatter.format(matcher))}):"
-      end
+      class << self
+        private
+
+        def diff_label_for(matcher)
+          "Diff for (#{truncated(RSpec::Support::ObjectFormatter.format(matcher))}):"
+        end
 
-      def self.truncated(description)
-        return description if description.length <= DESCRIPTION_MAX_LENGTH
-        description[0...DESCRIPTION_MAX_LENGTH - 3] << "..."
+        def truncated(description)
+          return description if description.length <= DESCRIPTION_MAX_LENGTH
+          description[0...DESCRIPTION_MAX_LENGTH - 3] << "..."
+        end
       end
 
       def diffs(differ, actual)
         @expected_list.map do |(expected, diff_label)|
           diff = differ.diff(actual, expected)
           next if diff.strip.empty?
-          "#{diff_label}#{diff}"
+          if diff == "\e[0m\n\e[0m"
+            "#{diff_label}\n" \
+              "  <The diff is empty, are your objects producing identical `#inspect` output?>"
+          else
+            "#{diff_label}#{diff}"
+          end
         end.compact.join("\n")
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-expectations
 version: !ruby/object:Gem::Version
-  version: 3.8.6
+  version: 3.9.0
 platform: ruby
 authors:
 - Steven Baker
@@ -53,14 +53,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
 description: rspec-expectations provides a simple, readable API to express expected
   outcomes of a code example.
 email: rspec@googlegroups.com
@@ -188,7 +202,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rspec/rspec-expectations/issues
-  changelog_uri: https://github.com/rspec/rspec-expectations/blob/v3.8.6/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-expectations/blob/v3.9.0/Changelog.md
   documentation_uri: https://rspec.info/documentation/
   mailing_list_uri: https://groups.google.com/forum/#!forum/rspec
   source_code_uri: https://github.com/rspec/rspec-expectations
@@ -211,5 +225,5 @@ requirements: []
 rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: rspec-expectations-3.8.6
+summary: rspec-expectations-3.9.0
 test_files: []