rspec-sleeping_king_studios 2.4.0 → 2.6.0.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12315df4c6674ce1c031e3028a13fca1950cbb5590bfa7d1bce275f73b7636df
-  data.tar.gz: 88d768a0f44190f0b338385c70a37601fc9358f1ed2150b1c7ce09a3df03042e
+  metadata.gz: 8dd0e24014dae4f35a224e0c8d244b7e20d827d22c88ddf966f7ae201b1e148e
+  data.tar.gz: c3658bf3b7261942c9e166df38b7fdf5639688a074ca3a4cfb70992ae2698c8e
 SHA512:
-  metadata.gz: 411868e2e3e57f709154152b0669cfdfdaee04512571ebe5b5342d14f78f0b8d825a8ebbf2bceae9ab3c788bbd1a4b1d4c28950864e14d15387bc2b6b364cfd9
-  data.tar.gz: e839d7c324b6bd127a6c59b267d0941e21965b81a3bdec559468cbcf621ff1236e776fa42e55eaee633f44d6784e317645ad7eece50ff6eabfdfee3ee03083f3
+  metadata.gz: 8fb97318df347582c4204f6a7f61e359d87069952f24ef72e928514e97d84fd82372d77300c7e1f01669fea239526ea6021d28be151f49177939ad0760755667
+  data.tar.gz: 2e1da21ffdd79e55c5891dd3a7f10247bb5aed761454ee1f7898275788cc77022ac3d0deefe3ac4a7470b0696d0ee6accb94809794b72f19a410bcd16dc4f787

data/CHANGELOG.md

@@ -1,5 +1,47 @@
 # Changelog
 
+## 2.6.0
+
+Deprecated the DelegateMethod matcher. Use `rspec-mocks` expectations instead.
+
+Deprecated the Include matcher with a block. Use the `satisfy` matcher instead.
+
+### Matchers
+
+Updated RespondToMatcher to check the arity of `#initialize` when matching against a class and the method name is `:new`.
+
+## 2.5.1
+
+Fixed a compatibility issue with Rails 6 configuration objects.
+
+## 2.5.0
+
+Added support for Ruby 2.6, dropped support for Ruby 2.3.
+
+### Matchers
+
+Implemented the BeAUuidMatcher, which expects the value to be a UUID string.
+
+Implemented the DeepMatcher, which recursively compares data structures.
+
+    expect(response).to deep_match(
+      status: 200,
+      body: {
+        order: {
+          id:    an_instance_of(Integer),
+          total: '9.99'
+        }
+      }
+    )
+
+Improved the HaveChangedMatcher to check the before and after `hash` value. This detects when an object is replaced by different but equal object, or when the initial object is a nested data structure (e.g. an Array of Hashes) and the internal elements are modified.
+
+Improved failure message of the HaveChangedMatcher when given a receiver and message.
+
+## 2.4.1
+
+Added support for RSpec 3.8.
+
 ## 2.4.0
 
 Dropped support for RSpec 3.3.

data/DEVELOPMENT.md

@@ -1,26 +1,13 @@
 # Development Notes
 
-## Version 2.4
+## Version 2.6
 
-### Bug Fixes
-
-- when skipping a shared example group with xinclude_examples, the generated context is named '(focused)'. It should instead be named '(skipped)'.
-
-### Features
-
-- Alias `have_reader`, etc as `define_reader`.
-  - Also alias shared examples.
-- Alias `have_constant` as `define_constant`.
-  - Alias #immutable as #frozen.
-  - Also alias shared examples.
-
-### Maintenance
-
-- Refactor all macro specs from spec/rspec/sleeping_king_studios/matchers/macros to the directories corresponding to the source files.
+- Deprecate `delegate_method` matcher, `include` matcher with block.
 
 ## Version 3.0
 
 - Extract out Rails-specific matchers to RSpec::SleepingKingStudios::Rails.
+  - Drop Rails 3 support.
 - Refactor property, constant matchers to Define$1Matcher.
   - HaveConstantMatcher, HaveReaderMatcher, HavePredicateMatcher, HavePropertyMatcher, HaveWriterMatcher.
   - Designate define_* macros as primary, have_* as aliases.
@@ -31,6 +18,12 @@
 
 ## Future Tasks
 
+- DeepMatcher: |
+  - indifferent - symbol/string keys
+  - ordered - pre-sort arrays?
+    - only homogenous arrays?
+    - odd results unless equality comparison
+
 ### Bug Fixes
 
 - false negative on #alias_method?
@@ -58,8 +51,6 @@
 
 - BeImmutableMatcher (NEW):
   - Implement be_immutable matcher.
-- HaveChangedMatcher (NEW):
-  - Add spy+matcher for expect(my_object, :my_method).to have_changed ?
 - RespondToMatcher:
   - Implement RespondToMatcher#with_optional_keywords, #with_required_keywords.
   - Implement RespondToMatcher#with_at_least(N).arguments, equivalent to with(N).arguments.and_unlimited_arguments.

data/README.md

@@ -8,9 +8,9 @@ RSpec::SleepingKingStudios is tested against RSpec 3.3 through 3.7.
 
 Currently, the following versions of Ruby are officially supported:
 
-* 2.3
 * 2.4
 * 2.5
+* 2.6
 
 For Ruby 2.0 support, use version 2.1 or earlier: `gem "rspec-sleeping_king_studios", "~> 2.1.1"`.
 
@@ -322,7 +322,166 @@ A simplified syntax for re-using shared context or examples without having to ex
 
 (also `::xwrap_context`) A shortcut for wrapping the context or examples in an automatically-skipped `describe` block, similar to the built-in `xit` and `xdescribe` methods.
 
-## Custom Matchers
+## Contracts
+
+```ruby
+require 'rspec/sleepingkingstudios/contract'
+```
+
+A Contract encapsulates a set of RSpec expectations, which can then be used when defining a spec.
+
+```ruby
+module GreetContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  describe '#greet' do
+    it { expect(subject).to respond_to(:greet).with(1).argument }
+
+    it { expect(subject.greet 'programs').to be == 'Greetings, programs!' }
+  end
+end
+
+RSpec.describe Greeter do
+  include GreetContract
+end
+```
+
+Using a contract allows for examples to be shared between different specs, or even between projects.
+
+### Contract Methods
+
+Not all RSpec methods are defined in a Contract. Only methods that define an example (`it`) or an example group (`context` or `describe`) can be used at the top level of a Contract. However, all RSpec methods (including methods that modify the current scope, such as `let` and the `before`/`around`/`after` filters) can be used inside an example group as normal.
+
+#### `::context`
+
+Defines an example group inside the contract. This example group will be defined on all specs that include the contract.
+
+```ruby
+module TransformationContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  context 'when the moon is full' do
+    let(:moon_phase) { :full }
+
+    it { expect(werewolf).to be_transformed }
+  end
+end
+```
+
+#### `::describe`
+
+Defines an example group inside the contract. This example group will be defined on all specs that include the contract.
+
+```ruby
+module SilverContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  describe 'with a silver weapon' do
+    before(:example) do
+      weapon.material = 'silver'
+    end
+
+    it 'should kill the werewolf' do
+      expect(attack(werewolf, weapon)).to change(werewolf, :alive?).to be false
+    end
+  end
+end
+```
+
+#### `::it`
+
+Defines an example inside the contract.
+
+```ruby
+module HowlingContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  it { expect(werewolf).to respond_to(:howl) }
+end
+```
+
+#### `::shared_context`
+
+Defines a shared example group.
+
+```ruby
+module MoonContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  shared_context 'when the moon is full' do
+    before(:example) { moon.phase = :full }
+  end
+end
+```
+
+**Note:** When the `Contract` is included in an RSpec example group, any shared example groups defined at the top level of a contract are also included in that example group, even outside of the contract itself. This may cause namespace collisions with shared example groups defined elsewhere in the example group or by other included contracts.
+
+#### `::shared_examples`
+
+Defines a shared example group.
+
+```ruby
+module HairContract
+  extend RSpec::SleepingKingStudios::Contract
+
+  shared_examples 'should be hairy' do
+    describe '#hairy?' do
+      it { expect(werewolf.hairy?).to be true }
+    end
+  end
+end
+```
+
+**Note:** When the `Contract` is included in an RSpec example group, any shared example groups defined at the top level of a contract are also included in that example group, even outside of the contract itself. This may cause namespace collisions with shared example groups defined elsewhere in the example group or by other included contracts.
+
+### Developing Contracts
+
+```ruby
+module VampireContract
+  extend RSpec::SleepingKingStudios::Contract
+  extend RSpec::SleepingKingStudios::Contracts::Development
+
+  fdescribe '#drink' do
+    it { expect(drink 'blood').to be true }
+
+    xit { expect(drink 'holy water').to be false }
+  end
+
+  pending
+end
+```
+
+The `RSpec::SleepingKingStudios::Contracts::Development` module provides methods for defining focused or pending examples and example groups. These are intended for use when developing a contract, and should not be included in the final version. Having skipped or focused example groups in a shared contract can have unexpected effects when the contract is included by the end user.
+
+#### `::fcontext`
+
+Defines a focused example group inside the contract.
+
+#### `::fdescribe`
+
+Defines a focused example group inside the contract.
+
+#### `::fit`
+
+Defines a focused example inside the contract.
+
+#### `::pending`
+
+Marks the contract as pending.
+
+#### `::xcontext`
+
+Defines a skipped example group inside the contract.
+
+#### `::xdescribe`
+
+Defines a skipped example group inside the contract.
+
+#### `::xit`
+
+Defines a skipped example inside the contract.
+
+## Matchers
 
 To enable a custom matcher, simply require the associated file. Matchers can be required individually or by category:
 
@@ -447,6 +606,22 @@ Checks if the object aliases the specified method with the specified other name.
 
 * **`#as`:** Required. Expects one String or Symbol, which is the name of the generated method.
 
+#### `#be_a_uuid` Matcher
+
+    require 'rspec/sleeping_king_studios/matchers/core/be_a_uuid'
+
+**Aliases:** `#a_uuid`.
+
+**How To Use:**
+
+    # With an object comparison.
+    expect(string).to be_a_uuid
+
+    # Inside a composable matcher.
+    expect(array).to include(a_uuid)
+
+**Parameters:** None.
+
 #### `#be_boolean` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/core/be_boolean'
@@ -488,6 +663,52 @@ Verifies that the actual object can be constructed using `::new`. Can take an op
 * **`#with_keywords`:** (also `and_keywords`) Expects one or more String or Symbol arguments. Verifies that the class's constructor accepts each provided keyword or has a variadic keyword of the form `**params`. As of 2.1.0 and required keywords, verifies that all required keywords are provided.
 * **`#with_arbitrary_keywords`:** (also `and_arbitrary_keywords`) No parameters. Verifies that the class's constructor accepts any keyword arguments via a variadic keyword of the form `**params`.
 
+#### `#deep_match` Matcher
+
+    require 'rspec/sleeping_king_studios/matchers/core/deep_match'
+
+Performs a recursive comparison between two object or data structures. Also supports using RSpec matchers as values in the expected object.
+
+**How To Use:**
+
+    expected = {
+      status: 200,
+      body: {
+        order: {
+          id:    an_instance_of(Integer),
+          total: '9.99'
+        }
+      }
+    }
+    expect(response).to deep_match(expected)
+
+When the value does not match the expectation, the failure message will provide a detailed diff showing added, missing, and changed values.
+
+    response = {
+      status: 400,
+      body: {
+        order: {
+          fulfilled: false,
+          total:     '19.99'
+        }
+      },
+      errors: ['Insufficient funds']
+    }
+    expect(response).to deep_match(expected)
+    # Failure/Error: expect(response).to deep_match(expected)
+    #
+    #   expected: == {:body=>{:order=>{:id=>an instance of Integer, :total=>"9.99"}}, :status=>200}
+    #        got:    {:status=>400, :body=>{:order=>{:fulfilled=>false, :total=>"19.99"}}, :errors=>["Insufficient funds"]}
+    #
+    #   (compared using HashDiff)
+    #
+    #   Diff:
+    #   + :body.:order.:fulfilled => got false
+    #   - :body.:order.:id => expected an instance of Integer
+    #   ~ :body.:order.:total => expected "9.99", got "19.99"
+    #   + :errors => got ["Insufficient funds"]
+    #   ~ :status => expected 200, got 400
+
 #### `#delegate_method` Matcher
 
     require 'rspec/sleeping_king_studios/matchers/core/delegate_method'

data/lib/rspec/sleeping_king_studios/examples/rspec_matcher_examples.rb

@@ -8,14 +8,14 @@ require 'rspec/sleeping_king_studios/matchers/base_matcher'
 module RSpec::SleepingKingStudios::Examples::RSpecMatcherExamples
   extend RSpec::SleepingKingStudios::Concerns::SharedExampleGroup
 
-  private def config
+  private def rspec_config
     RSpec.configuration.sleeping_king_studios
-  end # method config
+  end # method rspec_config
 
   private def compare_message actual, expected
     case expected
     when String
-      if config.examples.match_string_failure_message_as == :exact
+      if rspec_config.examples.match_string_failure_message_as == :exact
         expect(actual).to be == expected
       else
         expect(actual).to include expected
@@ -29,8 +29,12 @@ module RSpec::SleepingKingStudios::Examples::RSpecMatcherExamples
     end # when
   end # method compare_message
 
+  private def format_expected(object)
+    RSpec::Support::ObjectFormatter.format(object)
+  end
+
   private def handle_missing_failure_message message
-    case config.examples.handle_missing_failure_message_with
+    case rspec_config.examples.handle_missing_failure_message_with
     when :pending
       skip message
     when :exception

data/lib/rspec/sleeping_king_studios/matchers/built_in/include_matcher.rb

@@ -17,7 +17,12 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
     #   should return true if and only if the item matches the desired
     #   predicate.
     def initialize *expected, &block
-      expected << block if block_given?
+      if block_given?
+        SleepingKingStudios::Tools::CoreTools
+          .deprecate('IncludeMatcher with a block')
+
+          expected << block
+      end
 
       if expected.empty? && !allow_empty_matcher?
         raise ArgumentError,

data/lib/rspec/sleeping_king_studios/matchers/built_in/respond_to_matcher.rb

@@ -87,18 +87,18 @@ module RSpec::SleepingKingStudios::Matchers::BuiltIn
 
         method =
           begin
-            actual.method(method_name)
+            if actual.is_a?(Class) && method_name.intern == :new
+              actual.instance_method(:initialize)
+            else
+              actual.method(method_name)
+            end
           rescue NameError
-            nil
-          end # unless
+            @failing_method_reasons[method_name] = {
+              :is_not_a_method => true
+            } # end hash
 
-        unless method.is_a?(Method)
-          @failing_method_reasons[method_name] = {
-            :is_not_a_method => true
-          } # end hash
-
-          next false
-        end # unless
+            next false
+          end
 
         next true unless method_signature_expectation?
 

data/lib/rspec/sleeping_king_studios/matchers/core/be_a_uuid.rb

@@ -0,0 +1,17 @@
+# frozen_string_literals: true
+
+require 'rspec/sleeping_king_studios/matchers/core/be_a_uuid_matcher'
+require 'rspec/sleeping_king_studios/matchers/macros'
+
+module RSpec::SleepingKingStudios::Matchers::Macros
+  # @see RSpec::SleepingKingStudios::Matchers::Core::BeAUuidMatcher#matches?
+  def be_a_uuid
+    RSpec::SleepingKingStudios::Matchers::Core::BeAUuidMatcher.new
+  end
+
+  # @!method a_uuid
+  #   @see RSpec::SleepingKingStudios::Matchers::Core::BeBooleanMatcher#matches?
+  alias_matcher :a_uuid, :be_a_uuid do |description|
+    'a UUID'
+  end
+end

data/lib/rspec/sleeping_king_studios/matchers/core/be_a_uuid_matcher.rb

@@ -0,0 +1,81 @@
+# frozen_string_literals: true
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/core'
+
+module RSpec::SleepingKingStudios::Matchers::Core
+  # Matcher for testing whether an object is a UUID string.
+  #
+  # @since 2.5.0
+  class BeAUuidMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    # (see BaseMatcher#description)
+    def description
+      'be a UUID'
+    end
+
+    # (see BaseMatcher#failure_message)
+    def failure_message
+      message = super() + ', but '
+
+      return message + 'was not a String' unless string?
+
+      return message + 'was too short' if too_short?
+
+      return message + 'was too long' if too_long?
+
+      return message + 'has invalid characters' if invalid_characters?
+
+      return message + 'the format is invalid' unless valid_format?
+
+      message
+    end
+
+    # Checks if the object is a UUID string.
+    #
+    # @param [Object] actual The object to check.
+    #
+    # @return [Boolean] true if the object is a string with the correct format;
+    #   otherwise false.
+    def matches?(actual)
+      super
+
+      string? && valid_length? && valid_characters? && valid_format?
+    end
+
+    private
+
+    def invalid_characters?
+      @invalid_characters ||= @actual.match?(/[^A-Fa-f0-9\-]/)
+    end
+
+    def string?
+      @string ||= @actual.is_a?(String)
+    end
+
+    def too_long?
+      @too_long ||= @actual.length > 36
+    end
+
+    def too_short?
+      @too_short ||= @actual.length < 36
+    end
+
+    def uuid_format
+      chars = '[A-Fa-f0-9\-]'
+
+      /\A#{chars}{8}-#{chars}{4}-#{chars}{4}-#{chars}{4}-#{chars}{12}\z/
+    end
+
+    def valid_characters?
+      !invalid_characters?
+    end
+
+    def valid_format?
+      @valid_format || @actual.match?(uuid_format)
+    end
+
+    def valid_length?
+      !too_short? && !too_long?
+    end
+  end
+end

data/lib/rspec/sleeping_king_studios/matchers/core/deep_match.rb

@@ -0,0 +1,11 @@
+# frozen_string_literals: true
+
+require 'rspec/sleeping_king_studios/matchers/core/deep_matcher'
+require 'rspec/sleeping_king_studios/matchers/macros'
+
+module RSpec::SleepingKingStudios::Matchers::Macros
+  # @see RSpec::SleepingKingStudios::Matchers::Core::BeBooleanMatcher#matches?
+  def deep_match(expected)
+    RSpec::SleepingKingStudios::Matchers::Core::DeepMatcher.new(expected)
+  end
+end

data/lib/rspec/sleeping_king_studios/matchers/core/deep_matcher.rb

@@ -0,0 +1,219 @@
+# frozen_string_literals: true
+
+require 'hashdiff'
+
+require 'rspec/sleeping_king_studios/matchers/base_matcher'
+require 'rspec/sleeping_king_studios/matchers/core'
+
+module RSpec::SleepingKingStudios::Matchers::Core
+  # Matcher for performing a deep comparison between two objects.
+  #
+  # @since 2.5.0
+  class DeepMatcher < RSpec::SleepingKingStudios::Matchers::BaseMatcher
+    # @param [Object] expected The expected object.
+    def initialize(expected)
+      @expected = expected
+    end
+
+    # (see BaseMatcher#description)
+    def description
+      "match #{format_expected(@expected)}"
+    end # method description
+
+    # Inverse of #matches? method.
+    #
+    # @param [Object] actual The object to check.
+    #
+    # @return [Boolean] true if the actual object does not match the
+    #   expectation, otherwise true.
+    #
+    # @see #matches?
+    def does_not_match? actual
+      super
+
+      if matcher?(@expected)
+        delegate_to_negated_matcher(@expected)
+      elsif @expected.is_a?(Array) && actual.is_a?(Array)
+        diff_arrays_negated
+      elsif @expected.is_a?(Hash) && actual.is_a?(Hash)
+        diff_hashes_negated
+      else
+        delegate_to_negated_matcher(equality_matcher)
+      end
+
+      !@matches
+    end
+
+    # (see BaseMatcher#failure_message)
+    def failure_message
+      @failure_message
+    end
+
+    # (see BaseMatcher#failure_message_when_negated)
+    def failure_message_when_negated
+      @failure_message_when_negated
+    end
+
+    # Performs a deep comparison between the actual object and the expected
+    # object. The type of comparison depends on the type of the expected object:
+    #
+    # - If the expected object is an RSpec matcher, the #matches? method on the
+    #   matcher is called with the expected object.
+    # - If the expected object is an Array, then each item is compared based on
+    #   the type of the expected item.
+    # - If the expected object is a Hash, then the keys must match and each
+    #   value is compared based on the type of the expected value.
+    # - Otherwise, the two objects are compared using an equality comparison.
+    #
+    # @param [Object] actual The object to check.
+    #
+    # @return [Boolean] true if the actual object matches the expectation,
+    #   otherwise false.
+    def matches?(actual)
+      super
+
+      if matcher?(@expected)
+        delegate_to_matcher(@expected)
+      elsif @expected.is_a?(Array) && actual.is_a?(Array)
+        diff_arrays
+      elsif @expected.is_a?(Hash)  && actual.is_a?(Hash)
+        diff_hashes
+      else
+        delegate_to_matcher(equality_matcher)
+      end
+
+      @matches
+    end
+
+    private
+
+    def compare_arrays(expected, actual)
+      compare_hashes({ _ary: expected }, { _ary: actual })
+        .map { |(char, path, *values)| [char, path[1..-1], *values] }
+    end
+
+    def compare_hashes(expected, actual)
+      HashDiff.diff(expected, actual, array_path: true, use_lcs: false) \
+      do |path, exp, act|
+        # Handle missing keys with matcher values.
+        next nil unless nested_key?(actual, path)
+
+        next exp.matches?(act) if matcher?(exp)
+      end
+    end
+
+    def delegate_to_matcher(matcher)
+      @matches = matcher.matches?(actual)
+
+      return if @matches
+
+      @failure_message = matcher.failure_message
+    end
+
+    def delegate_to_negated_matcher(matcher)
+      @matches =
+        if matcher.respond_to?(:does_not_match?)
+          !matcher.does_not_match?(actual)
+        else
+          matcher.matches?(actual)
+        end
+
+      return unless @matches
+
+      @failure_message_when_negated = matcher.failure_message_when_negated
+    end
+
+    def diff_arrays
+      diff     = compare_arrays(@expected, actual)
+      @matches = diff.empty?
+
+      @failure_message = format_message(diff)
+    end
+
+    def diff_arrays_negated
+      diff     = compare_arrays(@expected, actual)
+      @matches = diff.empty?
+
+      @failure_message_when_negated =
+        "`expect(#{format_expected(@expected)}).not_to be == #{actual.inspect}`"
+    end
+
+    def diff_hashes
+      diff     = compare_hashes(@expected, actual)
+      @matches = diff.empty?
+
+      @failure_message = format_message(diff)
+    end
+
+    def diff_hashes_negated
+      diff     = compare_hashes(@expected, actual)
+      @matches = diff.empty?
+
+      @failure_message_when_negated =
+        "`expect(#{format_expected(@expected)}).not_to be == #{actual.inspect}`"
+    end
+
+    def equality_matcher
+      matchers_delegate.be == @expected
+    end
+
+    def format_diff(diff)
+      diff
+        .sort_by { |(char, path, *_values)| [path.map(&:to_s)] }
+        .map { |item| format_diff_item(*item) }
+        .join "\n"
+    end
+
+    def format_diff_item(char, path, *values)
+      "#{char} #{format_diff_path(path)} => #{format_diff_values(char, values)}"
+    end
+
+    def format_diff_path(path)
+      path.map(&:inspect).join('.')
+    end
+
+    def format_diff_values(char, values)
+      case char
+      when '-'
+        "expected #{format_expected(values.first)}"
+      when '~'
+        "expected #{format_expected(values.first)}, got #{values.last.inspect}"
+      when '+'
+        "got #{values.last.inspect}"
+      end
+    end
+
+    def format_expected(object)
+      RSpec::Support::ObjectFormatter.format(object)
+    end
+
+    def format_message(diff)
+      "expected: == #{format_expected(@expected)}\n" \
+      "     got:    #{@actual.inspect}\n" \
+      "\n" \
+      "(compared using HashDiff)\n" \
+      "\n" \
+      "Diff:\n" \
+      "#{format_diff(diff)}"
+    end
+
+    def matcher?(object)
+      %i[description failure_message failure_message_when_negated matches?]
+        .all? { |method_name| object.respond_to?(method_name) }
+    end
+
+    def matchers_delegate
+      Object.new.extend RSpec::Matchers
+    end
+
+    def nested_key?(object, path)
+      key    = path.last
+      object = object.dig(*path[0...-1]) if path.size > 1
+
+      return object.key?(key) if object.is_a?(Hash)
+      return object.size > key if object.is_a?(Array)
+
+      false
+    end
+  end
+end

data/lib/rspec/sleeping_king_studios/matchers/core/delegate_method_matcher.rb

@@ -125,6 +125,8 @@ module RSpec::SleepingKingStudios::Matchers::Core
 
     # (see BaseMatcher#matches?)
     def matches? actual
+      SleepingKingStudios::Tools::CoreTools.deprecate('DelegateMethodMatcher')
+
       super
 
       raise ArgumentError.new('must specify a target') if @target.nil?
@@ -187,14 +189,22 @@ module RSpec::SleepingKingStudios::Matchers::Core
 
     private
 
-    def call_method arguments, expected_return = DEFAULT_EXPECTED_RETURN
+    def call_method(arguments:, keywords:, expected_return: DEFAULT_EXPECTED_RETURN)
       if @expected_block
         @received_block = false
         block           = ->(*args, **kwargs, &block) {}
 
-        return_value = @actual.send(@expected, *arguments, &block)
+        if keywords.empty?
+          return_value = @actual.send(@expected, *arguments, &block)
+        else
+          return_value = @actual.send(@expected, *arguments, **keywords, &block)
+        end
       else
-        return_value = @actual.send(@expected, *arguments)
+        if keywords.empty?
+          return_value = @actual.send(@expected, *arguments)
+        else
+          return_value = @actual.send(@expected, *arguments, **keywords)
+        end
       end
 
       @received_return_values << return_value
@@ -215,19 +225,22 @@ module RSpec::SleepingKingStudios::Matchers::Core
     def delegates_method?
       stub_target!
 
-      args = @expected_arguments.dup
-      args << @expected_keywords unless @expected_keywords.empty?
-
       if @expected_return_values.empty?
-        call_method(args)
+        call_method(arguments: @expected_arguments, keywords: @expected_keywords)
       else
         @expected_return_values.each do |return_value|
-          call_method(args, return_value)
+          call_method(arguments: @expected_arguments, keywords: @expected_keywords, expected_return: return_value)
         end # each
       end # if-else
 
       matcher = RSpec::Mocks::Matchers::HaveReceived.new(@expected)
-      matcher = matcher.with(*args) unless args.empty?
+      if !@expected_arguments.empty? && !@expected_keywords.empty?
+        matcher = matcher.with(*@expected_arguments, **@expected_keywords)
+      elsif !@expected_arguments.empty?
+        matcher = matcher.with(*@expected_arguments)
+      elsif !@expected_keywords.empty?
+        matcher = matcher.with(**@expected_keywords)
+      end
 
       unless @expected_return_values.empty?
         matcher = matcher.exactly(@expected_return_values.count).times

data/lib/rspec/sleeping_king_studios/matchers/core/have_changed_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 require 'rspec/sleeping_king_studios/matchers/base_matcher'
 require 'rspec/sleeping_king_studios/matchers/core'
 require 'rspec/sleeping_king_studios/support/value_spy'
@@ -76,7 +78,7 @@ module RSpec::SleepingKingStudios::Matchers::Core
       unless @match_initial_value.nil? || @match_initial_value
         return "expected #{value_spy.description} to have initially " \
           "been #{@expected_initial_value.inspect}, but was " \
-          "#{initial_value.inspect}"
+          "#{value_spy.initial_inspect}"
       end
 
       message = "expected #{value_spy.description} to have changed"
@@ -107,13 +109,13 @@ module RSpec::SleepingKingStudios::Matchers::Core
       unless @match_initial_value.nil? || @match_initial_value
         return "expected #{value_spy.description} to have initially " \
           "been #{@expected_initial_value.inspect}, but was " \
-          "#{initial_value.inspect}"
+          "#{value_spy.initial_inspect}"
       end
 
       message = "expected #{value_spy.description} not to have changed"
 
       message <<
-        ", but did change from #{initial_value.inspect} to " <<
+        ", but did change from #{value_spy.initial_inspect} to " <<
         current_value.inspect
 
       message

data/lib/rspec/sleeping_king_studios/support/value_spy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 require 'rspec/sleeping_king_studios/support'
 
 module RSpec::SleepingKingStudios::Support
@@ -23,8 +25,8 @@ module RSpec::SleepingKingStudios::Support
   #   value.initial_value #=> 4
   #   value.current_value #=> 3
   class ValueSpy
-    # @overload initialize(object, method_name)
-    #   @param [Object] object The object to watch.
+    # @overload initialize(receiver, method_name)
+    #   @param [Object] receiver The object to watch.
     #
     #   @param [Symbol, String] method_name The name of the method to watch.
     #
@@ -32,23 +34,34 @@ module RSpec::SleepingKingStudios::Support
     #   @yield The value to watch. The block will be called each time the value
     #     is requested, and the return value of the block will be given as the
     #     current value.
-    def initialize(object = nil, method_name = nil, &block)
+    def initialize(receiver = nil, method_name = nil, &block)
       @observed_block = if block_given?
         block
       else
         @method_name = method_name
 
-        -> { object.send(method_name) }
+        -> { receiver.send(method_name) }
       end
 
-      @initial_value = current_value
+      @receiver        = receiver
+      @initial_hash    = current_value.hash
+      @initial_inspect = current_value.inspect
+      @initial_value   = current_value
     end
 
+    # @return [Integer] the hash of the watched value at the time the spy was
+    #   initialized.
+    attr_reader :initial_hash
+
+    # @return [String] the string representation of the watched value at the
+    #   time the spy was initialized
+    attr_reader :initial_inspect
+
     # @return [Object] the watched value at the time the spy was initialized.
     attr_reader :initial_value
 
     def changed?
-      !RSpec::Support::FuzzyMatcher.values_match?(initial_value, current_value)
+      initial_value != current_value || initial_hash != current_value.hash
     end
 
     # @return [Object] the watched value when #current_value is called.
@@ -61,7 +74,19 @@ module RSpec::SleepingKingStudios::Support
     def description
       return 'result' unless @method_name
 
-      "##{@method_name}"
+      format_message
+    end
+
+    private
+
+    attr_reader :method_name
+
+    attr_reader :receiver
+
+    def format_message
+      return "#{receiver}.#{method_name}" if receiver.is_a?(Module)
+
+      "#{receiver.class}##{method_name}"
     end
   end
 end

data/lib/rspec/sleeping_king_studios/version.rb

@@ -1,4 +1,4 @@
-# lib/rspec/sleeping_king_studios/version.rb
+# frozen_string_literals: true
 
 module RSpec
   module SleepingKingStudios
@@ -11,13 +11,13 @@ module RSpec
       # Major version.
       MAJOR = 2
       # Minor version.
-      MINOR = 4
+      MINOR = 6
       # Patch version.
       PATCH = 0
       # Prerelease version.
-      PRERELEASE = nil
+      PRERELEASE = :rc
       # Build metadata.
-      BUILD = nil
+      BUILD = 0
 
       # Generates the gem version string from the Version constants.
       #
@@ -36,9 +36,9 @@ module RSpec
         str << ".#{build}" unless build.nil? || (build.respond_to?(:empty?) && build.empty?)
 
         str
-      end # class method to_version
-    end # module
+      end
+    end
 
     VERSION = Version.to_gem_version
-  end # module
-end # module
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sleeping_king_studios
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0.rc.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.8
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -28,16 +42,22 @@ dependencies:
   name: sleeping_king_studios-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +126,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +177,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -161,7 +187,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 description: |2
       A collection of RSpec patches and custom matchers. The features can be
       included individually or by category. For more information, check out the
@@ -217,10 +243,14 @@ files:
 - lib/rspec/sleeping_king_studios/matchers/core/alias_method.rb
 - lib/rspec/sleeping_king_studios/matchers/core/alias_method_matcher.rb
 - lib/rspec/sleeping_king_studios/matchers/core/all.rb
+- lib/rspec/sleeping_king_studios/matchers/core/be_a_uuid.rb
+- lib/rspec/sleeping_king_studios/matchers/core/be_a_uuid_matcher.rb
 - lib/rspec/sleeping_king_studios/matchers/core/be_boolean.rb
 - lib/rspec/sleeping_king_studios/matchers/core/be_boolean_matcher.rb
 - lib/rspec/sleeping_king_studios/matchers/core/construct.rb
 - lib/rspec/sleeping_king_studios/matchers/core/construct_matcher.rb
+- lib/rspec/sleeping_king_studios/matchers/core/deep_match.rb
+- lib/rspec/sleeping_king_studios/matchers/core/deep_matcher.rb
 - lib/rspec/sleeping_king_studios/matchers/core/delegate_method.rb
 - lib/rspec/sleeping_king_studios/matchers/core/delegate_method_matcher.rb
 - lib/rspec/sleeping_king_studios/matchers/core/have_changed.rb
@@ -247,7 +277,9 @@ files:
 homepage: http://sleepingkingstudios.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/sleepingkingstudios/rspec-sleeping_king_studios/issues
+  source_code_uri: https://github.com/sleepingkingstudios/rspec-sleeping_king_studios
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -259,12 +291,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A collection of RSpec patches and custom matchers.