hash_diff 0.5.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTE5YWFkZDliYzM3NGNkZTk4ZDk1Y2E3YzI0OGI3MGNmMmFmM2U4OA==
+  data.tar.gz: !binary |-
+    MDdhMjNjMGIxMTI5ODdlYjQ0NDliY2I3NGViZGNkY2Q2ZDEyODQ2NQ==
+SHA512:
+  metadata.gz: !binary |-
+    ODFlOWRmOGM4Zjc1YWYzZjgxZWM4MTRmZTMzZjY2YmRjNjJkZjI5NmNmMjVl
+    ZGE4Y2ZjYWRmNjM4YWJkNDIzY2Y2NjUxMGYyOGQ0M2Y0MzAyN2RjYTU0YmNh
+    YjY4YzQ1MDczNGNlOWQ0NmZkZjJkZjJkMDQ1ODFiOTY1NTYxMDU=
+  data.tar.gz: !binary |-
+    ZWMyZGY4ZTQ4ZDFmZDNkOGM3Y2FmMzYzODBhNjhiY2E5MGY0ZDY5NTdlY2E0
+    NGUyZmExMWQzZDkxMWQwNjNiODBhNTFkZjhkNGQxZWI5ZTVmM2ZiZmJhYTMw
+    M2Q5OWRhMjkxN2M5NzA3YTlhMGNmMDZkYjU3YjA3YzIyZGQwYzI=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 acuppy
+
+MIT License
+
+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,75 @@
+# HashDiff
+
+Deep comparison of Ruby Hash objects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hash_diff'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_diff
+
+## Usage
+
+Easily find the differences between two Ruby hashes.
+
+```ruby
+  left = { 
+    foo: 'bar',  
+    bar: 'foo',  
+    nested: { 
+      foo: 'bar',  
+      bar: { 
+        one: 'foo1' 
+      } 
+    }, 
+    num: 1 
+  }
+
+  right = { 
+    foo: 'bar2', 
+    bar: 'foo2', 
+    nested: { 
+      foo: 'bar2', 
+      bar: { 
+        two: 'foo2' 
+      } 
+    }, 
+    word: 'monkey' 
+  }
+
+  hash_diff = HashDiff::Comparison.new( left, right )
+```
+
+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"] }
+```
+
+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" }
+```
+
+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 }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hash_diff.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.description   = %q{Diff tool for deep Ruby hash comparison}
+  spec.summary       = %q{Deep Hash comparison}
+  spec.homepage      = "https://github.com/CodingZeal/hash_diff"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6.0"
+end

data/lib/hash_diff.rb

@@ -0,0 +1,2 @@
+require "hash_diff/version"
+require "hash_diff/comparison"

data/lib/hash_diff/comparison.rb

@@ -0,0 +1,73 @@
+require 'ostruct'
+
+module HashDiff
+  class Comparison < Struct.new(:left, :right)
+  
+    def diff
+      @side ||= :both
+      @diff ||= differences(left, right)
+    end
+
+    def left_diff
+      @side = :left
+      @left_diff ||= differences(left, right)
+    end
+
+    def right_diff
+      @side = :right
+      @right_diff ||= differences(left, right)
+    end
+
+    private
+
+    def clone(left, right)
+      self.dup.tap do |inst|
+        inst.left  = left
+        inst.right = right
+      end
+    end
+
+    def differences(left, right)
+      combined_attribute_keys(left, right).reduce({}, &reduction_strategy)
+    end
+
+    def reduction_strategy(opts={})
+      lambda do |diff, key|
+        diff[key] = report(key) if not equal?(key)
+        diff
+      end
+    end
+
+    def combined_attribute_keys(left, right)
+      (left.keys + right.keys).uniq
+    end
+
+    def equal?(key)
+      left.key?(key) && right.key?(key) && left[key] == right[key]
+    end
+
+    def hash?(value)
+      value.is_a? Hash
+    end
+
+    def comparable_key?(key)
+      hash?(left[key]) and hash?(right[key])
+    end
+
+    def report(key)
+      if comparable_key?(key)
+        clone(left[key], right[key]).diff
+      else
+        report_by_side(key)
+      end
+    end
+
+    def report_by_side(key)
+      case @side
+      when :left  then right[key]
+      when :right then left[key]
+      when :both  then [left[key], right[key]]
+      end
+    end
+  end
+end

data/lib/hash_diff/version.rb

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

data/spec/hash_diff/comparison_spec.rb

@@ -0,0 +1,88 @@
+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' } }
+
+  subject { HashDiff::Comparison.new(app_v1_properties, app_v2_properties) }
+
+  describe "#diff" do
+
+    context "when different" do
+      let(:diff) { 
+        {
+          foo: ["bar", "bar2"], 
+          bar: ["foo", "foo2"], 
+          nested: {
+            foo: ["bar", "bar2"], 
+            bar: {
+              one: ["foo1", nil], 
+              two: [nil, "foo2"]
+            }
+          },
+          num:  [1, nil], 
+          word: [nil, "monkey"]
+        }
+      }
+
+      its(:diff) { should == diff }
+    end
+
+    context "when similar" do
+      let(:app_v1_properties) { { foo: 'bar', bar: 'foo' } }
+
+      context "in the same order" do
+        let(:app_v2_properties) { app_v1_properties }
+
+        its(:diff) { should be_empty }
+      end
+
+      context "in a different order" do
+        let(:app_v2_properties) { { bar: 'foo', foo: 'bar' } }
+
+        its(:diff) { should be_empty }
+      end
+    end
+  end
+
+  describe "#left_diff" do
+    let(:diff) { 
+      {
+        foo: "bar2", 
+        bar: "foo2", 
+        nested: {
+          foo: "bar2", 
+          bar: {
+            one: nil, 
+            two: "foo2"
+          }
+        },
+        num:  nil, 
+        word: "monkey"
+      }
+    }
+
+    its(:left_diff) { should == diff }
+  end
+
+  describe "#right_diff" do
+    let(:diff) { 
+      {
+        foo: "bar", 
+        bar: "foo", 
+        nested: {
+          foo: "bar", 
+          bar: {
+            one: "foo1", 
+            two: nil
+          }
+        },
+        num:  1, 
+        word: nil
+      }
+    }
+
+    its(:right_diff) { should == diff }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'rspec/autorun'
+
+PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
+$LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
+Dir[File.join(PROJECT_ROOT, 'spec/support/**/*.rb')].each { |file| require(file) }
+
+require 'hash_diff'
+
+RSpec.configure do |c|
+  c.filter_run_excluding :skip_on_windows => !(RbConfig::CONFIG['host_os'] =~ /mingw32/).nil?
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: hash_diff
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Coding Zeal
+- Adam Cuppy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-02 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+description: Diff tool for deep Ruby hash comparison
+email:
+- info@codingzeal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_diff.gemspec
+- lib/hash_diff.rb
+- lib/hash_diff/comparison.rb
+- lib/hash_diff/version.rb
+- spec/hash_diff/comparison_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CodingZeal/hash_diff
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Deep Hash comparison
+test_files:
+- spec/hash_diff/comparison_spec.rb
+- spec/spec_helper.rb