hash_diff 0.8.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e02ff6f11b18eafa65d02ecd98cccf8a789d8cda
-  data.tar.gz: 70710b0568a977b1e4a4c4423a1e048a4cd76acc
+SHA256:
+  metadata.gz: 3bbc5462057be5bab5b5e0eb46aa0b8d3fc3b41990b2ea0374f24210d0ecfe1b
+  data.tar.gz: 60e2db4d4acb464a958e72599ca76fff28c7e3b447816a7f78afa330b626cd31
 SHA512:
-  metadata.gz: 17ff9470571e175b9ea761f8cbd3e0d1bfa06f26d56d08e006dfa877ec3ddc9a4f95355f59b256c3ce43dc4c32f54b0a7a6d3d58a481d39b79df08e2e963b57d
-  data.tar.gz: 9451787251c0d041a7d2b014c86bad7bbae3d442fd4bd0ddb9d968996246ca27ac747f61f96c19af66d8fcc99f9774c04b891d80383fc2ff23e54c0bd4b5ee0d
+  metadata.gz: bed9aa1ff38395a905043e6a013767f96f75ccf4dedd97f04ae6b2762e11543f6c98b42ff02fd8d9fb9781e7939caa864feadb366b479912dda565f0da42784c
+  data.tar.gz: 1943c3599f521e68e68925e48e04b718990523b89d9c7eaa4105c7112c074abf81913559335d4b4ecda3ccc406ec1107e5295b3cad331b1ee514f265edee6db8

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/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

@@ -34,27 +34,51 @@ module HashDiff
     end
 
     def combined_keys
-      (left.keys + right.keys).uniq
+      if hash?(left) && hash?(right) then
+        (left.keys + right.keys).uniq
+      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 equal?(key)
-      left[key] == right[key]
+      value_with_default(left, key) == value_with_default(right, key)
     end
 
     def hash?(value)
       value.is_a?(Hash)
     end
 
-    def comparable?(key)
+    def array?(value)
+      value.is_a?(Array)
+    end
+
+    def comparable_hash?(key)
       hash?(left[key]) && hash?(right[key])
     end
 
+    def comparable_array?(key)
+      array?(left[key]) && array?(right[key])
+    end
+
     def report_difference(key, reporter)
-      if comparable?(key)
+      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
-        reporter.call(left[key], right[key])
+        reporter.call(
+          value_with_default(left, key),
+          value_with_default(right, key)
+        )
       end
     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.8.0"
+  VERSION = "1.1.1"
 end

data/lib/hash_diff.rb

@@ -2,6 +2,8 @@ require "hash_diff/version"
 require "hash_diff/comparison"
 
 module HashDiff
+  class NO_VALUE; end
+
   def self.patch!
     Hash.class_eval do
       def diff(right)

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"]
         }
       }
@@ -45,6 +72,19 @@ describe HashDiff::Comparison do
         it { expect(subject).to be_empty }
       end
     end
+
+    context "when hashes have both symbol and string keys" do
+      let(:app_v1_properties) { { foo: "bar" } }
+      let(:app_v2_properties) { { "foo" => "bar" } }
+      let(:diff) do
+        {
+          foo: ["bar", HashDiff::NO_VALUE],
+          "foo" => [HashDiff::NO_VALUE, "bar"]
+        }
+      end
+
+      it { expect(subject).to eq(diff) }
+    end
   end
 
   describe "#left_diff" do
@@ -57,11 +97,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 +120,7 @@ describe HashDiff::Comparison do
           foo: "bar",
           bar: {
             one: "foo1",
-            two: nil
+            two: HashDiff::NO_VALUE
           }
         },
         num:  1,

metadata

@@ -1,30 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: hash_diff
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Coding Zeal
 - Adam Cuppy
-autorequire: 
+- Mike Bianco
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2022-08-29 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