hash_diff 0.5.1 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTE5YWFkZDliYzM3NGNkZTk4ZDk1Y2E3YzI0OGI3MGNmMmFmM2U4OA==
+    NmI4YmU1N2U2YWY3MjI1YTA5M2NiMDExZjViNDk3YjE5ZTE1YTVmYg==
   data.tar.gz: !binary |-
-    MDdhMjNjMGIxMTI5ODdlYjQ0NDliY2I3NGViZGNkY2Q2ZDEyODQ2NQ==
+    ZmIxMzIyODkzMzBjOTg5ODRkMmQ0MTRhMTNhMzAwMDAzMGM1MmIxMg==
 SHA512:
   metadata.gz: !binary |-
-    ODFlOWRmOGM4Zjc1YWYzZjgxZWM4MTRmZTMzZjY2YmRjNjJkZjI5NmNmMjVl
-    ZGE4Y2ZjYWRmNjM4YWJkNDIzY2Y2NjUxMGYyOGQ0M2Y0MzAyN2RjYTU0YmNh
-    YjY4YzQ1MDczNGNlOWQ0NmZkZjJkZjJkMDQ1ODFiOTY1NTYxMDU=
+    M2UxM2M2NmYzOTVhYTAwNzg2NWJlY2RmMDQyNjc0YzgzNDA1NDA1M2YyZGYz
+    ZmMzNTAzY2UxMGU0MDI3MWFiYWI4NTBjNDQ4OTAxNjgxYTZlZGUzMjE4YmM3
+    ZjA0OTc3ZGVjZjk2ZTJlZDBkYzU1ZDYzNDY4OThlZmZhN2MxYTU=
   data.tar.gz: !binary |-
-    ZWMyZGY4ZTQ4ZDFmZDNkOGM3Y2FmMzYzODBhNjhiY2E5MGY0ZDY5NTdlY2E0
-    NGUyZmExMWQzZDkxMWQwNjNiODBhNTFkZjhkNGQxZWI5ZTVmM2ZiZmJhYTMw
-    M2Q5OWRhMjkxN2M5NzA3YTlhMGNmMDZkYjU3YjA3YzIyZGQwYzI=
+    NjI4OTQ3MzViNjZiYzE0MjNlYzQwNjM4YTBmNjM0NTRjMDI4YWU5YzU0MTky
+    MjBiMzA5M2NmOTRhYjU5ZDg2ZGE5ZGEyNWQyOWQ1MWM2NTdlYjJhYWMyZDBk
+    MTVlZWQ3YzJjNDAyZmE2MmRiZDBjOWQxMDVmMWNmYmJlNTZmODk=

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hash_diff.gemspec
-gemspec
-
-gem 'debugger'
+gemspec

data/README.md

@@ -66,6 +66,29 @@ Comparison#right_diff returns only the right side differences
   hash_diff.right_diff # => { foo: "bar", bar: "foo", nested: { foo: "bar", bar: { one: "foo1", two: nil } }, num:  1, word: nil }
 ```
 
+You can also use these shorthand methods
+
+```ruby
+  HashDiff.diff(left, right)
+  HashDiff.left_diff(left, right)
+  HashDiff.right_diff(left, right)
+```
+
+Hash#diff is not provided by default, and monkey patching is frowned upon by some, but to provide a one way shorthand, use the following code snippet.
+
+```ruby
+  class Hash
+    def diff(right)
+      HashDiff.right_diff(self, right)
+    end
+  end
+
+  left  = { foo: 'bar', num: 1 }
+  right = { foo: 'baz', num: 1 }
+
+  left.diff(right) # => { foo: 'baz' }
+```
+
 ## Contributing
 
 1. Fork it

data/hash_diff.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Coding Zeal", "Adam Cuppy"]
   spec.email         = ["info@codingzeal.com"]
   spec.description   = %q{Diff tool for deep Ruby hash comparison}
-  spec.summary       = %q{Deep Hash comparison}
+  spec.summary       = %q{Deep Ruby Hash comparison}
   spec.homepage      = "https://github.com/CodingZeal/hash_diff"
   spec.license       = "MIT"
 

data/lib/hash_diff.rb

@@ -1,2 +1,18 @@
 require "hash_diff/version"
-require "hash_diff/comparison"
+require "hash_diff/comparison"
+
+module HashDiff
+  class << self
+    def diff(*args)
+      Comparison.new(*args).diff
+    end
+
+    def left_diff(*args)
+      Comparison.new(*args).left_diff
+    end
+
+    def right_diff(*args)
+      Comparison.new(*args).right_diff
+    end
+  end
+end

data/lib/hash_diff/version.rb

@@ -1,3 +1,3 @@
 module HashDiff
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/hash_diff_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe HashDiff do
+  describe ".diff" do
+    let(:comparison) { double("comparison") }
+    let(:left) { double("left") }
+    let(:right) { double("right") }
+
+    it "delegates to Comparison#diff" do
+      HashDiff::Comparison.should_receive(:new).with(left, right).and_return(comparison)
+      comparison.should_receive(:diff)
+      HashDiff.diff(left, right)
+    end
+  end
+
+  describe ".left_diff" do
+    let(:comparison) { double("comparison") }
+    let(:left) { double("left") }
+    let(:right) { double("right") }
+    
+    it "delegates to Comparison#left_diff" do
+      HashDiff::Comparison.should_receive(:new).with(left, right).and_return(comparison)
+      comparison.should_receive(:left_diff)
+      HashDiff.left_diff(left, right)
+    end
+  end
+
+  describe ".right_diff" do
+    let(:comparison) { double("comparison") }
+    let(:left) { double("left") }
+    let(:right) { double("right") }
+    
+    it "delegates to Comparison#right_diff" do
+      HashDiff::Comparison.should_receive(:new).with(left, right).and_return(comparison)
+      comparison.should_receive(:right_diff)
+      HashDiff.right_diff(left, right)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_diff
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Coding Zeal
@@ -70,6 +70,7 @@ files:
 - lib/hash_diff/comparison.rb
 - lib/hash_diff/version.rb
 - spec/hash_diff/comparison_spec.rb
+- spec/hash_diff_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/CodingZeal/hash_diff
 licenses:
@@ -94,7 +95,8 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Deep Hash comparison
+summary: Deep Ruby Hash comparison
 test_files:
 - spec/hash_diff/comparison_spec.rb
+- spec/hash_diff_spec.rb
 - spec/spec_helper.rb