hash_diff 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e02ff6f11b18eafa65d02ecd98cccf8a789d8cda
-  data.tar.gz: 70710b0568a977b1e4a4c4423a1e048a4cd76acc
+  metadata.gz: 0c353c43e17ed7d833fe9edf3fd4e6ec4af96aa6
+  data.tar.gz: b8b050b80bb2c69ad5e4b79a96c30cc1ede24092
 SHA512:
-  metadata.gz: 17ff9470571e175b9ea761f8cbd3e0d1bfa06f26d56d08e006dfa877ec3ddc9a4f95355f59b256c3ce43dc4c32f54b0a7a6d3d58a481d39b79df08e2e963b57d
-  data.tar.gz: 9451787251c0d041a7d2b014c86bad7bbae3d442fd4bd0ddb9d968996246ca27ac747f61f96c19af66d8fcc99f9774c04b891d80383fc2ff23e54c0bd4b5ee0d
+  metadata.gz: d528f1366911a7b69bff0af027621b0e37ca22b97b4150b4853277548f2ee242701a4320701a9432c6acfe5333b0f2b4df35ca3b0d9e401d16dab9086774086d
+  data.tar.gz: c95598db8dadac025c0f6526d55ca43ab4bf2154f782d6d1402ef3da88c7df5be5f3597f014c984e4d6858fd2cb84a364f37d9ee3c37124c73411ebb79e2be3f

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,4 +1,5 @@
 # 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)
 
 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,23 @@ 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] }
 ```
 
+#### 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 +94,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/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/lib/hash_diff/comparison.rb

@@ -38,7 +38,7 @@ module HashDiff
     end
 
     def equal?(key)
-      left[key] == right[key]
+      value_with_default(left, key) == value_with_default(right, key)
     end
 
     def hash?(value)
@@ -53,8 +53,15 @@ module HashDiff
       if comparable?(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.0.0"
 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,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_diff
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Coding Zeal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Deep Ruby Hash comparison