easy_diff 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Abner Qian
+
+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.rdoc

@@ -0,0 +1,136 @@
+= easy_diff
+
+Easy Diff enhances the functionality of Hash, allowing recursive diff, merge, and unmerge of arbitrarily constructed hashes.
+This is perfect for people who need to do diffs on not only plain text files but also data as Hash or JSON objects. Unmerge
+is included with diff and merge to more easily allow versioning of arbitrary data.
+
+== Install
+
+  gem install easy_diff
+  
+== Examples
+
+=== Hash#easy_diff
+
+Takes another hash and recursively determines the differences between the two. This method returns two hashes.
+The first contains what has to be removed from self to create the second hash. The second contains what has to be added.
+
+  original = {
+    :tags => ['a', 'b', 'c'],
+    :pos => {:x => '1', :y => '2'},
+    :some_str => "bla",
+    :some_int => 1,
+    :some_bool => false,
+    :extra_removed => "bye"
+  }
+  
+  modified = {
+    :tags => ['b', 'c', 'd'],
+    :pos => {:x => '3', :y => '2'},
+    :some_str => "bla",
+    :some_int => 2,
+    :some_bool => true,
+    :extra_added => "hi"
+  }
+  
+  removed, added = original.easy_diff modified
+  
+  # The removed and added hashes should contain the following:
+  # removed = {
+  #     :tags => ['a'],
+  #     :pos => {:x => '1'},
+  #     :some_int => 1,
+  #     :some_bool => false,
+  #     :extra_removed => "bye"
+  #   }
+  #   
+  #   added = {
+  #     :tags => ['d'],
+  #     :pos => {:x => '3'},
+  #     :some_int => 2,
+  #     :some_bool => true,
+  #     :extra_added => "hi"
+  #   }
+  
+=== Hash#easy_merge
+
+Takes a hash and recursively merges it with self. Arrays are merged by the union operation and then sorted.
+Using Hash#easy_merge! will modify self instead of returning a new hash.
+
+  original = {
+    :tags => ['a', 'b', 'c'],
+    :pos => {:x => '1', :y => '2'},
+    :some_str => "bla",
+    :some_int => 1,
+    :some_bool => false,
+    :extra_removed => "bye"
+  }
+  
+  extra = {
+    :tags => ['d'],
+    :pos => {:x => '3'},
+    :some_int => 2,
+    :some_bool => true,
+    :extra_added => "hi"
+  }
+  
+  merged = original.easy_merge extra
+
+  # The merged hash should look like this:
+  # merged = {
+  #   :tags => ['a', 'b', 'c', 'd'],
+  #   :pos => {:x => '3', :y => '2'},
+  #   :some_str => "bla",
+  #   :some_int => 2,
+  #   :some_bool => true,
+  #   :extra_removed => "bye",
+  #   :extra_added => "hi"
+  # }
+  
+=== Hash#easy_unmerge
+
+Takes a hash and recursively unmerges it with self. By unmerging, I mean it will remove all matching values from
+the hash. All matching elements will be removed in arrays as well and then the arrays will be sorted.
+Using Hash#easy_unmerge! will modify self instead of returning a new hash.
+
+  original = {
+    :tags => ['b', 'c', 'd'],
+    :pos => {:x => '3', :y => '2'},
+    :some_str => "bla",
+    :some_int => 2,
+    :some_bool => true,
+    :extra_added => "hi"
+  }
+  
+  extra = {
+    :tags => ['d'],
+    :pos => {:x => '3'},
+    :some_int => 2,
+    :some_bool => true,
+    :extra_added => "hi"
+  }
+  
+  unmerged = original.easy_unmerge extra
+
+  # The unmerged hash should look like this:
+  # unmerged =  {
+  #     :tags => ['b', 'c'],
+  #     :pos => {:y => '2'},
+  #     :some_str => "bla"
+  #   }
+  
+== Contributing to easy_diff
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Abner Qian. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "easy_diff"
+  gem.homepage = "http://github.com/Blargel/easy_diff"
+  gem.license = "MIT"
+  gem.summary = %Q{Recursive diff, merge, and unmerge for hashes and arrays.}
+  gem.description = %Q{Easy Diff enhances the functionality of Hash, allowing recursive diff, merge, and unmerge of arbitrarily constructed hashes.
+  This is perfect for people who need to do diffs on not only plain text files but also data as Hash or JSON objects. Unmerge
+  is included with diff and merge to more easily allow versioning of arbitrary data.}
+  gem.email = "LargeBagel@gmail.com"
+  gem.authors = ["Abner Qian"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/easy_diff.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/easy_diff/safe_dup')
+require File.expand_path(File.dirname(__FILE__) + '/easy_diff/core')
+require File.expand_path(File.dirname(__FILE__) + '/easy_diff/hash_ext')
+
+Object.send :include, EasyDiff::SafeDup
+Hash.send :include, EasyDiff::HashExt

data/lib/easy_diff/core.rb

@@ -0,0 +1,66 @@
+module EasyDiff
+  module Core
+    def self.easy_diff(original, modified)
+      removed = nil
+      added   = nil
+
+      if original.nil?
+        added = modified.safe_dup 
+      elsif modified.nil?
+        removed = original.safe_dup 
+      elsif original.is_a?(Hash) && modified.is_a?(Hash)
+        removed = {}
+        added   = {}
+        original_keys   = original.keys
+        modified_keys   = modified.keys
+        keys_in_common  = original_keys & modified_keys
+        keys_removed    = original_keys - modified_keys
+        keys_added      = modified_keys - original_keys
+        keys_removed.each{ |key| removed[key] = original[key].safe_dup }
+        keys_added.each{ |key| added[key] = modified[key].safe_dup }
+        keys_in_common.each do |key|
+          r, a = easy_diff original[key], modified[key]
+          removed[key] = r unless r.nil?
+          added[key] = a unless a.nil?
+        end
+      elsif original.is_a?(Array) && modified.is_a?(Array)
+        removed = original - modified
+        added   = modified - original
+      elsif original != modified
+        removed   = original
+        added     = modified
+      end
+      return removed, added
+    end
+  
+    def self.easy_unmerge!(original, removed)
+      if original.is_a?(Hash) && removed.is_a?(Hash)
+        original_keys  = original.keys
+        removed_keys   = removed.keys
+        keys_in_common = original_keys & removed_keys
+        keys_in_common.each{ |key| original.delete(key) if easy_unmerge!(original[key], removed[key]).nil? }
+      elsif original.is_a?(Array) && removed.is_a?(Array)
+        original.reject!{ |e| removed.include?(e) }
+        original.sort!
+      elsif original == removed
+        original = nil
+      end
+      original
+    end
+  
+    def self.easy_merge!(original, added)
+      if added.nil?
+        return original
+      elsif original.is_a?(Hash) && added.is_a?(Hash)
+        added_keys = added.keys
+        added_keys.each{ |key| original[key] = easy_merge!(original[key], added[key])}
+      elsif original.is_a?(Array) && added.is_a?(Array)
+        original |=  added
+        original.sort!
+      else
+        original = added.safe_dup
+      end
+      original
+    end
+  end
+end

data/lib/easy_diff/hash_ext.rb

@@ -0,0 +1,23 @@
+module EasyDiff
+  module HashExt
+    def easy_diff(other)
+      EasyDiff::Core.easy_diff self, other
+    end
+
+    def easy_merge!(other)
+      EasyDiff::Core.easy_merge! self, other
+    end
+
+    def easy_unmerge!(other)
+      EasyDiff::Core.easy_unmerge! self, other
+    end
+  
+    def easy_merge(other)
+      self.dup.easy_merge!(other)
+    end
+  
+    def easy_unmerge(other)
+      self.dup.easy_unmerge!(other)
+    end
+  end
+end

data/lib/easy_diff/safe_dup.rb

@@ -0,0 +1,11 @@
+module EasyDiff
+  module SafeDup
+    def safe_dup
+      begin
+        self.dup
+      rescue TypeError
+        self
+      end
+    end
+  end
+end

data/spec/easy_diff_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe EasyDiff do
+  before :each do
+    @original = {
+      :tags => ['a', 'b', 'c'],
+      :pos => {:x => '1', :y => '2'},
+      :some_str => "bla",
+      :some_int => 1,
+      :some_bool => false,
+      :extra_removed => "bye"
+    }
+    
+    @modified = {
+      :tags => ['b', 'c', 'd'],
+      :pos => {:x => '3', :y => '2'},
+      :some_str => "bla",
+      :some_int => 2,
+      :some_bool => true,
+      :extra_added => "hi"
+    }
+    
+    @removed = {
+      :tags => ['a'],
+      :pos => {:x => '1'},
+      :some_int => 1,
+      :some_bool => false,
+      :extra_removed => "bye"
+    }
+    
+    @added = {
+      :tags => ['d'],
+      :pos => {:x => '3'},
+      :some_int => 2,
+      :some_bool => true,
+      :extra_added => "hi"
+    }
+  end
+  it "should compute easy_diff" do
+    removed, added = @original.easy_diff @modified
+    removed.should == @removed
+    added.should == @added
+  end
+  
+  it "should compute easy_unmerge" do
+    unmerged = @modified.easy_unmerge @added
+    unmerged.should == {
+      :tags => ['b', 'c'],
+      :pos => {:y => '2'},
+      :some_str => "bla"
+    }
+  end
+  
+  it "should compute easy_merge" do
+   merged = @original.easy_merge @added
+   merged.should == {
+     :tags => ['a', 'b', 'c', 'd'],
+     :pos => {:x => '3', :y => '2'},
+     :some_str => "bla",
+     :some_int => 2,
+     :some_bool => true,
+     :extra_removed => "bye",
+     :extra_added => "hi"
+   }
+  end
+  
+  it "should stay the same" do
+    removed, added = @original.easy_diff @modified
+    unmerged = @modified.easy_unmerge added
+    original = unmerged.easy_merge removed
+    original.should == @original
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'easy_diff'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: easy_diff
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Abner Qian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-03 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: |-
+  Easy Diff enhances the functionality of Hash, allowing recursive diff, merge, and unmerge of arbitrarily constructed hashes.
+    This is perfect for people who need to do diffs on not only plain text files but also data as Hash or JSON objects. Unmerge
+    is included with diff and merge to more easily allow versioning of arbitrary data.
+email: LargeBagel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/easy_diff.rb
+- lib/easy_diff/core.rb
+- lib/easy_diff/hash_ext.rb
+- lib/easy_diff/safe_dup.rb
+- spec/easy_diff_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Blargel/easy_diff
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 744956757776922527
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Recursive diff, merge, and unmerge for hashes and arrays.
+test_files: 
+- spec/easy_diff_spec.rb
+- spec/spec_helper.rb