hash_diff 0.7.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 138f8fc905ed5caa8160dc05131bfd1d1f484908
-  data.tar.gz: 7bc15e4a8d6e0fa94bd1c4bc0f29d67e34ad7dc1
+SHA256:
+  metadata.gz: 8ef02ebe0aac07af77b8e597a40b218c4b2f20c53f3f895fc131d07961a38011
+  data.tar.gz: 7b03cd799b1f0a5eded66d91d5ed0f9b882ef38e26fec1c004568d71e5e68d0b
 SHA512:
-  metadata.gz: 702c7c4b34e50a6b410ed191a57e185a55ba96d3ca95c855b68f349fc267f1204ab00bd439fa248d23ab22a456aff5a84c0fac04356004017a7d6ce77076e50d
-  data.tar.gz: 14211e477a53d725526d6f7c271338a49727d81bafa447842cef00ded7e561184f590478294a1b7a19f868c122e2c60f8e4dd1969e7cc470f78cd6d96477f282
+  metadata.gz: 0e29131dc0ebf4b1e61997526c45ec123ac1ad3fa1f6182bd147e45586d4caa251ae113ebd7273efb5a107207ae6733688be1d3eb43712d1d79547754ceec13c
+  data.tar.gz: d37b0e72862bdb28550c8b481bdf03e377b7e2e20473b4111f444bc3c19f3402d1cd4eba0b92b1c22083ad1b211760f84c204c40247a08b37be6f50a928b6e64

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/codeql.yml

@@ -0,0 +1,59 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '39 15 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/ruby.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['1.9', '2.0', '2.1', '2.2', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 acuppy
+Copyright (c) 2013 Zeal, LLC (dba. Coding Zeal)
 
 MIT License
 

data/README.md

@@ -1,5 +1,6 @@
 # HashDiff
-[![Build Status](https://travis-ci.org/CodingZeal/hash_diff.png?branch=master)](https://travis-ci.org/CodingZeal/hash_diff) [![Code Climate](https://codeclimate.com/github/CodingZeal/hash_diff.png)](https://codeclimate.com/github/CodingZeal/hash_diff) [![Gem Version](https://badge.fury.io/rb/hash_diff.png)](http://badge.fury.io/rb/hash_diff)
+
+[![Ruby](https://github.com/CodingZeal/hash_diff/actions/workflows/ruby.yml/badge.svg)](https://github.com/CodingZeal/hash_diff/actions/workflows/ruby.yml) [![Code Climate](https://codeclimate.com/github/CodingZeal/hash_diff.png)](https://codeclimate.com/github/CodingZeal/hash_diff) [![Gem Version](https://badge.fury.io/rb/hash_diff.png)](http://badge.fury.io/rb/hash_diff)
 
 Deep comparison of Ruby Hash objects
 
@@ -31,7 +32,8 @@ Easily find the differences between two Ruby hashes.
         one: 'foo1'
       }
     },
-    num: 1
+    num: 1,
+    favorite_restaurant: "Shoney's"
   }
 
   right = {
@@ -43,7 +45,8 @@ Easily find the differences between two Ruby hashes.
         two: 'foo2'
       }
     },
-    word: 'monkey'
+    word: 'monkey',
+    favorite_restaurant: nil
   }
 
   hash_diff = HashDiff::Comparison.new( left, right )
@@ -52,19 +55,25 @@ Easily find the differences between two Ruby hashes.
 Comparison#diff returns the left and right side differences
 
 ```ruby
-  hash_diff.diff # => { foo: ["bar", "bar2"], bar: ["foo", "foo2"], nested: { foo: ["bar", "bar2"], bar: { one: ["foo1", nil], two: [nil, "foo2"] } }, num:  [1, nil], word: [nil, "monkey"] }
+  hash_diff.diff # => { foo: ["bar", "bar2"], bar: ["foo", "foo2"], nested: { foo: ["bar", "bar2"], bar: { one: ["foo1", HashDiff::NO_VALUE], two: [HashDiff::NO_VALUE, "foo2"] } }, num:  [1, HashDiff::NO_VALUE], word: [HashDiff::NO_VALUE, "monkey"], favorite_restaurant: ["Shoney's", nil] }
 ```
 
+You can also compare two arrays. The comparison is sensitive to the order of the elements in the array.
+
+#### Missing keys
+
+When there is a key that exists on one side it will return `HashDiff::NO_VALUE` to represent a missing key.
+
 Comparison#left_diff returns only the left side differences
 
 ```ruby
-  hash_diff.left_diff # => { foo: "bar2", bar: "foo2", nested: { foo: "bar2", bar: { one: nil, two: "foo2" } }, num:  nil, word: "monkey" }
+  hash_diff.left_diff # => {:foo=>"bar2", :bar=>"foo2", :nested=>{:foo=>"bar2", :bar=>{:one=>HashDiff::NO_VALUE, :two=>"foo2"}}, :num=>HashDiff::NO_VALUE, :favorite_restaurant=>nil, :word=>"monkey"}
 ```
 
 Comparison#right_diff returns only the right side differences
 
 ```ruby
-  hash_diff.right_diff # => { foo: "bar", bar: "foo", nested: { foo: "bar", bar: { one: "foo1", two: nil } }, num:  1, word: nil }
+  hash_diff.right_diff # => {:foo=>"bar", :bar=>"foo", :nested=>{:foo=>"bar", :bar=>{:one=>"foo1", :two=>HashDiff::NO_VALUE}}, :num=>1, :favorite_restaurant=>"Shoney's", :word=>HashDiff::NO_VALUE}
 ```
 
 You can also use these shorthand methods
@@ -87,14 +96,11 @@ Hash#diff is not provided by default, and monkey patching is frowned upon by som
   left.diff(right) # => { foo: 'baz' }
 ```
 
-## Credits
-
-Authored by Adam Cuppy (@acuppy) of Coding ZEAL (http://codingzeal.com)
+## License
 
-![Coding ZEAL](https://googledrive.com/host/0B3TWa6M1MsWeWmxRZWhscllwTzA/ZEAL-logo-final-150.png)
+Authored by the Engineering Team of [Coding ZEAL](https://codingzeal.com?utm_source=github)
 
-This is freely distributed under the MIT license.  Use it, modify it,
-enjoy :)
+Copyright (c) 2017 Zeal, LLC. Licensed under the [MIT license](https://opensource.org/licenses/MIT).
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/hash_diff.gemspec

@@ -6,8 +6,8 @@ require 'hash_diff/version'
 Gem::Specification.new do |spec|
   spec.name          = "hash_diff"
   spec.version       = HashDiff::VERSION
-  spec.authors       = ["Coding Zeal", "Adam Cuppy"]
-  spec.email         = ["info@codingzeal.com"]
+  spec.authors       = ["Coding Zeal", "Adam Cuppy", "Mike Bianco"]
+  spec.email         = ["info@codingzeal.com", "mike@mikebian.co"]
   spec.description   = %q{Diff tool for deep Ruby hash comparison}
   spec.summary       = %q{Deep Ruby Hash comparison}
   spec.homepage      = "https://github.com/CodingZeal/hash_diff"
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.1"
 end

data/lib/hash_diff/comparison.rb

@@ -1,74 +1,84 @@
 module HashDiff
-  class Comparison < Struct.new(:left, :right)
-  
+  class Comparison
+    def initialize(left, right)
+      @left  = left
+      @right = right
+    end
+
+    attr_reader :left, :right
+
     def diff
-      @diff ||= differences(left, right)
+      @diff ||= find_differences { |l, r| [l, r] }
     end
 
     def left_diff
-      @concern = :left
-      @left_diff ||= differences(left, right)
+      @left_diff ||= find_differences { |_, r| r }
     end
 
     def right_diff
-      @concern = :right
-      @right_diff ||= differences(left, right)
+      @right_diff ||= find_differences { |l, _| l }
     end
 
-    private
+    protected
 
-    def concern
-      @concern ||= :both
+    def find_differences(&reporter)
+      combined_keys.each_with_object({ }, &comparison_strategy(reporter))
     end
 
-    def clone(left, right)
-      self.dup.tap do |inst|
-        inst.left  = left
-        inst.right = right
+    private
+
+    def comparison_strategy(reporter)
+      lambda do |key, diff|
+        diff[key] = report_difference(key, reporter) unless equal?(key)
       end
     end
 
-    def differences(left, right)
-      combined_attribute_keys.reduce({}, &reduction_strategy)
+    def combined_keys
+      if hash?(left) && hash?(right) then
+        (left.keys + right.keys).uniq.sort
+      elsif array?(left) && array?(right) then
+        (0..[left.size, right.size].max).to_a
+      else
+        raise ArgumentError, "Don't know how to extract keys. Neither arrays nor hashes given"
+      end
     end
 
-    def reduction_strategy
-      lambda do |diff, key|
-        diff[key] = report(key) if not equal?(key)
-        diff
-      end
+    def equal?(key)
+      value_with_default(left, key) == value_with_default(right, key)
     end
 
-    def combined_attribute_keys
-      (left.keys + right.keys).uniq
+    def hash?(value)
+      value.is_a?(Hash)
     end
 
-    def equal?(key)
-      left[key] == right[key]
+    def array?(value)
+      value.is_a?(Array)
     end
 
-    def hash?(value)
-      value.is_a? Hash
+    def comparable_hash?(key)
+      hash?(left[key]) && hash?(right[key])
     end
 
-    def comparable?(key)
-      hash?(left[key]) and hash?(right[key])
+    def comparable_array?(key)
+      array?(left[key]) && array?(right[key])
     end
 
-    def report(key)
-      if comparable?(key)
-        clone(left[key], right[key]).diff
+    def report_difference(key, reporter)
+      if comparable_hash?(key)
+        self.class.new(left[key], right[key]).find_differences(&reporter)
+      elsif comparable_array?(key)
+        self.class.new(left[key], right[key]).find_differences(&reporter)
       else
-        report_concern(key)
+        reporter.call(
+          value_with_default(left, key),
+          value_with_default(right, key)
+        )
       end
     end
 
-    def report_concern(key)
-      case concern
-      when :left  then right[key]
-      when :right then left[key]
-      when :both  then [left[key], right[key]]
-      end
+    def value_with_default(obj, key)
+      obj.fetch(key, NO_VALUE)
     end
   end
 end
+

data/lib/hash_diff/version.rb

@@ -1,3 +1,3 @@
 module HashDiff
-  VERSION = "0.7.0"
+  VERSION = "1.1.0"
 end

data/lib/hash_diff.rb

@@ -2,25 +2,27 @@ require "hash_diff/version"
 require "hash_diff/comparison"
 
 module HashDiff
-  class << self
-    def diff(*args)
-      Comparison.new(*args).diff
-    end
+  class NO_VALUE; end
 
-    def left_diff(*args)
-      Comparison.new(*args).left_diff
-    end
+  def self.patch!
+    Hash.class_eval do
+      def diff(right)
+        HashDiff.left_diff(self, right)
+      end
+    end unless Hash.new.respond_to?(:diff)
+  end
+
+  module_function
 
-    def right_diff(*args)
-      Comparison.new(*args).right_diff
-    end
+  def diff(*args)
+    Comparison.new(*args).diff
+  end
+
+  def left_diff(*args)
+    Comparison.new(*args).left_diff
+  end
 
-    def patch!
-      Hash.class_eval do
-        def diff right
-          HashDiff.left_diff self, right
-        end
-      end unless self.class.respond_to? :diff
-    end
+  def right_diff(*args)
+    Comparison.new(*args).right_diff
   end
 end

data/spec/hash_diff/array_comparison_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe HashDiff::Comparison do
+  let(:left) {
+    [
+      {
+        foo: 'bar',
+        bar: 'foo',
+      },
+      {
+        nested: {
+          foo: 'bar',
+          bar: {
+            one: 'foo1'
+          }
+        },
+      },
+      {
+        num: 1,
+        word: nil
+      }
+    ]
+  }
+
+  def comparison(to_compare)
+    HashDiff::Comparison.new(left, to_compare)
+  end
+
+  def right
+    [
+      {
+        foo: 'bar',
+        bar: 'foo',
+      },
+      {
+        nested: {
+          foo: 'bar',
+          bar: {
+            one: 'foo1'
+          }
+        },
+      },
+      {
+        num: 1,
+        word: nil
+      }
+    ]
+  end
+
+  describe 'when arrays are the same' do
+    it 'properly determines equality' do
+      expect(comparison(right).diff).to be_empty
+    end
+
+    it 'handles empty arrays' do
+      expect(HashDiff::Comparison.new([], []).diff).to be_empty
+    end
+  end
+
+  describe 'when arrays are different' do
+    it 'reports arrays as not equal with a different order' do
+      # move an item from the end to the beginning
+      right_shuffled = right
+      popped = right_shuffled.pop
+      right_shuffled.unshift(popped)
+
+      expect(comparison(right_shuffled).diff).to_not be_empty
+    end
+
+    it 'should a deep comparison' do
+      right_with_extra_nested_element = right
+      right_with_extra_nested_element[1][:nested][:bar][:two] = 'two'
+
+      expect(comparison(right_with_extra_nested_element).diff).to_not be_empty
+    end
+  end
+
+end

data/spec/hash_diff/comparison_spec.rb

@@ -2,10 +2,37 @@ require "spec_helper"
 
 describe HashDiff::Comparison do
 
-  let(:app_v1_properties) { { foo: 'bar',  bar: 'foo',  nested: { foo: 'bar',  bar: { one: 'foo1' } }, num: 1 } }
-  let(:app_v2_properties) { { foo: 'bar2', bar: 'foo2', nested: { foo: 'bar2', bar: { two: 'foo2' } }, word: 'monkey' } }
+  let(:app_v1_properties) {
+    {
+      foo: 'bar',
+      bar: 'foo',
+      nested: {
+        foo: 'bar',
+        bar: {
+          one: 'foo1'
+        }
+      },
+      num: 1,
+      word: nil
+    }
+  }
+  let(:app_v2_properties) {
+    {
+      foo: 'bar2',
+      bar: 'foo2',
+      nested: {
+        foo: 'bar2',
+        bar: {
+          two: 'foo2'
+        }
+      },
+      word: 'monkey'
+    }
+  }
 
-  subject(:comparison) { HashDiff::Comparison.new(app_v1_properties, app_v2_properties) }
+  subject(:comparison) {
+    HashDiff::Comparison.new(app_v1_properties, app_v2_properties)
+  }
 
   describe "#diff" do
     subject { comparison.diff }
@@ -18,11 +45,11 @@ describe HashDiff::Comparison do
           nested: {
             foo: ["bar", "bar2"],
             bar: {
-              one: ["foo1", nil],
-              two: [nil, "foo2"]
+              one: ["foo1", HashDiff::NO_VALUE],
+              two: [HashDiff::NO_VALUE, "foo2"]
             }
           },
-          num:  [1, nil],
+          num:  [1, HashDiff::NO_VALUE],
           word: [nil, "monkey"]
         }
       }
@@ -57,11 +84,11 @@ describe HashDiff::Comparison do
         nested: {
           foo: "bar2",
           bar: {
-            one: nil,
+            one: HashDiff::NO_VALUE,
             two: "foo2"
           }
         },
-        num:  nil,
+        num:  HashDiff::NO_VALUE,
         word: "monkey"
       }
     }
@@ -80,7 +107,7 @@ describe HashDiff::Comparison do
           foo: "bar",
           bar: {
             one: "foo1",
-            two: nil
+            two: HashDiff::NO_VALUE
           }
         },
         num:  1,

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'rspec'
-require 'rspec/autorun'
 
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
 $LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
@@ -9,4 +8,4 @@ require 'hash_diff'
 
 RSpec.configure do |c|
   c.filter_run_excluding :skip_on_windows => !(RbConfig::CONFIG['host_os'] =~ /mingw32/).nil?
-end
+end

metadata

@@ -1,30 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: hash_diff
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Coding Zeal
 - Adam Cuppy
-autorequire: 
+- Mike Bianco
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,12 +57,16 @@ dependencies:
 description: Diff tool for deep Ruby hash comparison
 email:
 - info@codingzeal.com
+- mike@mikebian.co
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/codeql.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -70,6 +75,7 @@ files:
 - lib/hash_diff.rb
 - lib/hash_diff/comparison.rb
 - lib/hash_diff/version.rb
+- spec/hash_diff/array_comparison_spec.rb
 - spec/hash_diff/comparison_spec.rb
 - spec/hash_diff_spec.rb
 - spec/spec_helper.rb
@@ -77,7 +83,7 @@ homepage: https://github.com/CodingZeal/hash_diff
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,13 +98,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Deep Ruby Hash comparison
 test_files:
+- spec/hash_diff/array_comparison_spec.rb
 - spec/hash_diff/comparison_spec.rb
 - spec/hash_diff_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/.travis.yml

@@ -1,6 +0,0 @@
-script: "bundle exec rspec spec"
-
-language: ruby
-
-rvm:
-  - 1.9.3