deep_matching 0.1.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1c4618fd1c4b6e162e57faeeae9097d2b2bce2a6c1fa729aa2fa1b404030e2f
+  data.tar.gz: 9f1f06687ec0224054cf6fba236c376cdd2b592e67e74a21adf18c9c10b3f452
+SHA512:
+  metadata.gz: 2ec4b92888949bd63f4a3516ba19b9ecc794676bb360b8fd17eaeb7bcfc52455032db482a91b2c8acc40d34d12f4fceef1d85f6782765c96995876fead140b9e
+  data.tar.gz: 802c4767423fe761460b413fa0e78d393c301743b6c73f84b94a3c98538d086f9836f1ee61beebe7c87efe40adb4ed32a7c21cc085d64bae2707237592c7f4a8

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-12-17
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mark Burns
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# DeepMatching
+
+This allows you to get detailed error messages on exactly where your heavily nested hashes differ
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+```ruby
+require 'deep_matching'
+RSpec.configure do |config|
+  config.include DeepMatching
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/deep_matching.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/deep_matching/deep_matcher.rb

@@ -0,0 +1,72 @@
+require 'active_support/all'
+
+module DeepMatching
+  class DeepMatcher
+    include DeepMatching
+    include ActiveModel::Model
+    attr_accessor :nested_expectation_parameters, :actual_object, :expected_object
+
+    delegate :evaluation_context, :nesting, :ignore_list, to: :nested_expectation_parameters
+
+    def matches?
+      return true if ignore?
+
+      case expected_object
+      when Array
+        array_matches?
+      when Hash
+        hash_matches?
+      else
+        false
+      end
+    end
+
+    def array_matches?
+      within_example do |actual_object, expected_object, nested_expectation_parameters|
+        expected_object.each_with_index do |expected_value, index|
+          child_level_expect(actual_object, index, expected_value, nested_expectation_parameters)
+        end
+      end
+    end
+
+    def hash_matches?
+      within_example do |actual_object, expected_object, nested_expectation_parameters|
+        expected_object.each do |key, expected_value|
+          child_level_expect(actual_object, key, expected_value, nested_expectation_parameters)
+        end
+      end
+    end
+
+    def to_indifferent(hash)
+      hash.respond_to?(:with_indifferent_access) ? hash.with_indifferent_access : hash
+    end
+
+    private
+
+    def child_level_expect(actual_object, key, expected_value, nested_expectation_parameters)
+      nested = nested_expectation_parameters.dup
+      nested.nesting += [key]
+
+      expect_deep_matching(actual_object&.try(:[], key), expected_value, nested_expectation_parameters: nested)
+    end
+
+    # this exists so we can make assertions within the example
+    # but have the benefits of using a class
+    def within_example
+      # this is so we have access to the current self from within
+      # the instance_eval
+      this = self
+
+      evaluation_context.instance_eval do
+        actual_object = this.to_indifferent(this.actual_object)
+        expected_object = this.to_indifferent(this.expected_object)
+
+        yield actual_object, expected_object, this.nested_expectation_parameters
+      end
+    end
+
+    def ignore?
+      nesting.in?(ignore_list)
+    end
+  end
+end

data/lib/deep_matching/nested_expectation_parameters.rb

@@ -0,0 +1,6 @@
+module DeepMatching
+  class NestedExpectationParameters
+    include ActiveModel::Model
+    attr_accessor :evaluation_context, :obj, :expected_obj, :nesting, :ignore_list, :failure_message_extra_context
+  end
+end

data/lib/deep_matching/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeepMatching
+  VERSION = '0.1.0-alpha.1'
+end

data/lib/deep_matching.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+require 'deep_matching/deep_matcher'
+require 'deep_matching/nested_expectation_parameters'
+
+module DeepMatching
+  # I tried writing this as an RSpec matcher, but couldn't easily make it
+  # find all nested failures with aggregate_failures, rather than just the
+  # first one
+  def expect_deep_matching(actual_object, expected_object, ignore_list: [], nested_expectation_parameters: nil,
+                           failure_message_extra_context: '')
+    nested_expectation_parameters ||= NestedExpectationParameters.new(
+      nesting: [],
+      ignore_list: ignore_list,
+      evaluation_context: self,
+      failure_message_extra_context: failure_message_extra_context
+    )
+
+    return true if deep_matches?(
+      actual_object, expected_object,
+      nested_expectation_parameters: nested_expectation_parameters
+    )
+
+    failure_message = deep_matching_failure_message_for(
+      actual_object,
+      nested_expectation_parameters.nesting,
+      nested_expectation_parameters.failure_message_extra_context
+    )
+
+    make_assertion_about!(actual_object, expected_object, failure_message, nested_expectation_parameters.evaluation_context)
+  end
+
+  def deep_matches?(actual_object, expected_object, nested_expectation_parameters:)
+    DeepMatcher.new(
+      actual_object:,
+      expected_object:,
+      nested_expectation_parameters:
+    ).matches?
+  end
+
+  private
+
+  def make_assertion_about!(actual_object, expected_object, failure_message, evaluation_context)
+    evaluation_context.instance_eval do
+      case expected_object
+      when RSpec::Mocks::ArgumentMatchers::KindOf
+        make_assertion_about_kind_of(actual_object, expected_object, failure_message)
+      when Regexp
+        expect(actual_object).to match(expected_object), failure_message.call(:match, expected_object)
+      else
+        expect(actual_object).to eq(expected_object), failure_message.call(:eq, expected_object)
+      end
+    end
+  end
+
+  def make_assertion_about_kind_of(actual_object, expected, _failured_message)
+    expected = expected.instance_eval { @klass }
+    expect(actual_object).to be_a(expected), failure_message.call(:be_a, expected)
+  end
+
+  def deep_matching_failure_message_for(actual_object, nesting, failure_message_extra_context)
+    lambda do |comparison, expected|
+      nesting_message = nesting.length > 1 ? 'Expected nested hash key at' : 'Expected hash key at'
+      [failure_message_extra_context.presence,
+       "#{nesting_message} '#{nesting.join('.')}'",
+       "to #{comparison}",
+       "#{expected.inspect},",
+       'but got',
+       actual_object.inspect].compact.join("\n")
+    end
+  end
+end

data/sig/deep_matching.rbs

@@ -0,0 +1,4 @@
+module DeepMatching
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: deep_matching
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha.1
+platform: ruby
+authors:
+- Mark Burns
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A method to use in RSpec to spot hash differences
+email:
+- markburns@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/deep_matching.rb
+- lib/deep_matching/deep_matcher.rb
+- lib/deep_matching/nested_expectation_parameters.rb
+- lib/deep_matching/version.rb
+- sig/deep_matching.rbs
+homepage: https://github.com/markburns/deep_matching
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/markburns/deep_matching
+  source_code_uri: https://github.com/markburns/deep_matching
+  changelog_uri: https://github.com/markburns/deep_matching/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Find exactly where your two large nested hashes differ
+test_files: []