hashdiff 0.0.6 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dbf060a0b7537d436fdf1a5000e37e16227bdbe
+  data.tar.gz: 4c2b8998e3f78648c542cc4c8c7a3c95de4a6256
+SHA512:
+  metadata.gz: 239b84f71304f154f89ab66c2b654bde48ccdaa3d1ed5748bb89f6449ea7ac8a34749a32f702e0684ea6e070940d4444c38705da413bdf017c6b3a1d6715a516
+  data.tar.gz: d20d20328d875a9bd52f6087b3a1cf494534346303e1def382f0a3b836adcb047c99f421a5263d072ebad01830f2b3101962b01ef2eb3bcd9adbf313c3c799c0

data/.gitignore

@@ -8,6 +8,8 @@
 /.bundle
 /doc
 /.yardoc
+/Gemfile.lock
 
 *.swp
 *.bak
+*.gem

data/.travis.yml

@@ -2,5 +2,5 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
-  - ruby-head
+  - 2.0.0
 script: "bundle exec rake spec"

data/README.md

@@ -1,6 +1,4 @@
-# HashDiff
-
-[![Build Status](https://secure.travis-ci.org/liufengyun/hashdiff.png)](http://travis-ci.org/liufengyun/hashdiff)
+# HashDiff [![Build Status](https://secure.travis-ci.org/liufengyun/hashdiff.png)](http://travis-ci.org/liufengyun/hashdiff)
 
 HashDiff is a ruby library to compute the smallest difference between two hashes.
 
@@ -25,10 +23,6 @@ HashDiff answers the question above in an opinionated approach:
 * It compares Arrays using LCS(longest common subsequence) algorithm.
 * It recoganize similar Hashes in Array using a similarity value(0 < similarity <= 1).
 
-## Compatibility
-
-HashDiff is tested against `1.9.2`, `1.9.3` and `ruby-head`. It should work on other versions as well.
-
 ## Usage
 
 If you're using bundler, add following to the Gemfile:
@@ -85,10 +79,22 @@ unpatch example:
     diff = HashDiff.diff(a, b) # diff two array is OK
     HashDiff.unpatch!(b, diff).should == a
 
+### Options
+
+You can specify the delimiter to be something else than the dot. For example:
+
+    a = {a:{x:2, y:3, z:4}, b:{x:3, z:45}}
+    b = {a:{y:3}, b:{y:3, z:30}}
+
+    diff = HashDiff.diff(a, b, :delimiter => '\t')
+    diff.should == [['-', 'a\tx', 2], ['-', 'a\tz', 4], ['-', 'b\tx', 3], ['~', 'b\tz', 45, 30], ['+', 'b\ty', 3]]
+
+In cases you have similar hash objects in array, you can pass suitable `:similarity` value instead of the default `0.8`.
+
 ## Contributors
 
-- @liufengyun
-- @m-o-e
+- [@liufengyun](https://github.com/liufengyun)
+- [@m-o-e](https://github.com/m-o-e)
 
 ## License
 

data/changelog.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## v0.1.0 2013-8-25
+
+* use options for parameters `:delimiter` and `:similarity` in interfaces
+
 ## v0.0.6 2013-3-2
 
 * Add parameter for custom property-path delimiter.

data/lib/hashdiff/diff.rb

@@ -2,10 +2,12 @@ module HashDiff
 
   # Best diff two objects, which tries to generate the smallest change set using different similarity values.
   #
-  # HashDiff.best_diff is only meaningful in case of comparing two objects which includes similar objects in array.
+  # HashDiff.best_diff is useful in case of comparing two objects which includes similar hashes in array.
   #
   # @param [Arrary, Hash] obj1
   # @param [Arrary, Hash] obj2
+  # @param [Hash] options
+  #   `options` supports `:delimiter`. Default value for `:delimiter` is `.`(dot).
   #
   # @return [Array] an array of changes.
   #   e.g. [[ '+', 'a.b', '45' ], [ '-', 'a.c', '5' ], [ '~', 'a.x', '45', '63']]
@@ -17,14 +19,17 @@ module HashDiff
   #   diff.should == [['-', 'x[0].c', 3], ['+', 'x[0].b', 2], ['-', 'x[1].y', 3], ['-', 'x[1]', {}]]
   #
   # @since 0.0.1
-  def self.best_diff(obj1, obj2, delimiter='.')
-    diffs_1 = diff(obj1, obj2, "", 0.3, delimiter)
+  def self.best_diff(obj1, obj2, options = {})
+    opts = {similarity: 0.3}.merge!(options)
+    diffs_1 = diff(obj1, obj2, opts)
     count_1 = count_diff diffs_1
 
-    diffs_2 = diff(obj1, obj2, "", 0.5, delimiter)
+    opts = {similarity: 0.5}.merge!(options)
+    diffs_2 = diff(obj1, obj2, opts)
     count_2 = count_diff diffs_2
 
-    diffs_3 = diff(obj1, obj2, "", 0.8, delimiter)
+    opts = {similarity: 0.8}.merge!(options)
+    diffs_3 = diff(obj1, obj2, opts)
     count_3 = count_diff diffs_3
 
     count, diffs = count_1 < count_2 ? [count_1, diffs_1] : [count_2, diffs_2]
@@ -35,10 +40,12 @@ module HashDiff
   #
   # @param [Arrary, Hash] obj1
   # @param [Arrary, Hash] obj2
-  # @param [float] similarity A value > 0 and <= 1.
-  #   This parameter should be ignored in common usage.
-  #   Similarity is only meaningful if there're similar objects in arrays. See {best_diff}.
-  # @param [String] delimiter Delimiter for returned property-string
+  # @param [Hash] options
+  #   `options` can contain `:similarity` or `:delimiter`.
+  #
+  #   `:similarity` should be between (0, 1]. The default value is `0.8`. `:similarity` is meaningful if there're similar hashes in arrays. See {best_diff}.
+  #
+  #   `:delimiter` defaults to `.`(dot).
   #
   # @return [Array] an array of changes.
   #   e.g. [[ '+', 'a.b', '45' ], [ '-', 'a.c', '5' ], [ '~', 'a.x', '45', '63']]
@@ -51,41 +58,53 @@ module HashDiff
   #   diff.should == [['-', 'b.b1', 1], ['-', 'b.b2', 2]]
   #
   # @since 0.0.1
-  def self.diff(obj1, obj2, prefix = "", similarity = 0.8, delimiter='.')
+  def self.diff(obj1, obj2, options = {})
+    opts = {
+      :prefix      =>   '',
+      :similarity  =>   0.8,
+      :delimiter   =>   '.'
+    }
+
+    opts = opts.merge!(options)
+
     if obj1.nil? and obj2.nil?
       return []
     end
 
     if obj1.nil?
-      return [['~', prefix, nil, obj2]]
+      return [['~', opts[:prefix], nil, obj2]]
     end
 
     if obj2.nil?
-      return [['~', prefix, obj1, nil]]
+      return [['~', opts[:prefix], obj1, nil]]
     end
 
     if !(obj1.is_a?(Array) and obj2.is_a?(Array)) and !(obj1.is_a?(Hash) and obj2.is_a?(Hash)) and !(obj1.is_a?(obj2.class) or obj2.is_a?(obj1.class))
-      return [['~', prefix, obj1, obj2]]
+      return [['~', opts[:prefix], obj1, obj2]]
     end
 
     result = []
     if obj1.is_a?(Array)
-      changeset = diff_array(obj1, obj2, similarity) do |lcs|
+      changeset = diff_array(obj1, obj2, opts[:similarity]) do |lcs|
         # use a's index for similarity
         lcs.each do |pair|
-          result.concat(diff(obj1[pair[0]], obj2[pair[1]], "#{prefix}[#{pair[0]}]", similarity, delimiter))
+          result.concat(diff(obj1[pair[0]], obj2[pair[1]], opts.merge(prefix: "#{opts[:prefix]}[#{pair[0]}]")))
         end
       end
 
       changeset.each do |change|
         if change[0] == '-'
-          result << ['-', "#{prefix}[#{change[1]}]", change[2]]
+          result << ['-', "#{opts[:prefix]}[#{change[1]}]", change[2]]
         elsif change[0] == '+'
-          result << ['+', "#{prefix}[#{change[1]}]", change[2]]
+          result << ['+', "#{opts[:prefix]}[#{change[1]}]", change[2]]
         end
       end
     elsif obj1.is_a?(Hash)
-      prefix = prefix.empty? ? "" : "#{prefix}#{delimiter}"
+      if opts[:prefix].empty?
+        prefix = ""
+      else
+        prefix = "#{opts[:prefix]}#{opts[:delimiter]}"
+      end
 
       deleted_keys = []
       common_keys = []
@@ -102,7 +121,7 @@ module HashDiff
       deleted_keys.each {|k| result << ['-', "#{prefix}#{k}", obj1[k]] }
 
       # recursive comparison for common keys
-      common_keys.each {|k| result.concat(diff(obj1[k], obj2[k], "#{prefix}#{k}", similarity, delimiter)) }
+      common_keys.each {|k| result.concat(diff(obj1[k], obj2[k], opts.merge(prefix: "#{prefix}#{k}"))) }
 
       # added properties
       obj2.each do |k, v|
@@ -112,7 +131,7 @@ module HashDiff
       end
     else
       return [] if obj1 == obj2
-      return [['~', prefix, obj1, obj2]]
+      return [['~', opts[:prefix], obj1, obj2]]
     end
 
     result

data/lib/hashdiff/patch.rb

@@ -7,12 +7,15 @@ module HashDiff
   #
   # @param [Hash, Array] obj the object to be patchted, can be an Array of a Hash
   # @param [Array] changes e.g. [[ '+', 'a.b', '45' ], [ '-', 'a.c', '5' ], [ '~', 'a.x', '45', '63']]
-  # @param [String] delimiter Property-string delimiter
+  # @param [Hash] options
+  #   `options` supports `:delimiter`. Default value for `:delimiter` is `.`(dot).
   #
   # @return the object after patch
   #
   # @since 0.0.1
-  def self.patch!(obj, changes, delimiter='.')
+  def self.patch!(obj, changes, options = {})
+    delimiter = options[:delimiter] || '.'
+
     changes.each do |change|
       parts = decode_property_path(change[1], delimiter)
       last_part = parts.last
@@ -43,12 +46,15 @@ module HashDiff
   #
   # @param [Hash, Array] obj the object to be unpatchted, can be an Array of a Hash
   # @param [Array] changes e.g. [[ '+', 'a.b', '45' ], [ '-', 'a.c', '5' ], [ '~', 'a.x', '45', '63']]
-  # @param [String] delimiter Property-string delimiter
+  # @param [Hash] options
+  #   `options` supports `:delimiter`. Default value for `:delimiter` is `.`(dot).
   #
   # @return the object after unpatch
   #
   # @since 0.0.1
-  def self.unpatch!(obj, changes, delimiter='.')
+  def self.unpatch!(obj, changes, options = {})
+    delimiter = options[:delimiter] || '.'
+
     changes.reverse_each do |change|
       parts = decode_property_path(change[1], delimiter)
       last_part = parts.last

data/lib/hashdiff/util.rb

@@ -6,7 +6,7 @@ module HashDiff
   def self.similar?(a, b, similarity = 0.8)
     count_a = count_nodes(a)
     count_b = count_nodes(b)
-    diffs = count_diff diff(a, b, "", similarity)
+    diffs = count_diff diff(a, b, :similarity => similarity)
 
     if count_a + count_b == 0
       return true

data/lib/hashdiff/version.rb

@@ -1,3 +1,3 @@
 module HashDiff
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/spec/hashdiff/best_diff_spec.rb

@@ -13,11 +13,10 @@ describe HashDiff do
     a = {'x' => [{'a' => 1, 'c' => 3, 'e' => 5}, {'y' => 3}]}
     b = {'x' => [{'a' => 1, 'b' => 2, 'e' => 5}] }
 
-    diff = HashDiff.best_diff(a, b, "\t")
+    diff = HashDiff.best_diff(a, b, :delimiter => "\t")
     diff.should == [["-", "x[0]\tc", 3], ["+", "x[0]\tb", 2], ["-", "x[1]", {"y"=>3}]]
   end
 
-
   it "should be able to best diff array in hash" do
     a = {"menu" => {
       "id" => "file",

data/spec/hashdiff/diff_spec.rb

@@ -127,7 +127,7 @@ describe HashDiff do
     a = [{'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5}, {'x' => 5, 'y' => 6, 'z' => 3}, 3]
     b = [{'a' => 1, 'b' => 2, 'c' => 3, 'e' => 5}, 3]
 
-    diff = HashDiff.diff(a, b, "", 0.8, "\t")
+    diff = HashDiff.diff(a, b, similarity: 0.8, delimiter: "\t")
     diff.should == [["-", "[0]\td", 4], ["-", "[1]", {"x"=>5, "y"=>6, "z"=>3}]]
   end
 

data/spec/hashdiff/patch_spec.rb

@@ -134,4 +134,3 @@ describe HashDiff do
   end
 
 end
-

data/spec/hashdiff/util_spec.rb

@@ -11,7 +11,6 @@ describe HashDiff do
     decoded.should == ['a', 'b', 0, 'c', 'city', 5]
   end
 
-
   it "should be able to tell similiar hash" do
     a = {'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5}
     b = {'a' => 1, 'b' => 2, 'c' => 3, 'e' => 5}

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: hashdiff
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Liu Fengyun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,37 +27,33 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bluecloth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! ' HashDiff is a diff lib to compute the smallest difference between
-  two hashes. '
+description: ' HashDiff is a diff lib to compute the smallest difference between two
+  hashes. '
 email:
 - liufengyunchina@gmail.com
 executables: []
@@ -72,7 +65,6 @@ files:
 - .travis.yml
 - .yardopts
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -93,27 +85,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/liufengyun/hashdiff
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: HashDiff is a diff lib to compute the smallest difference between two hashes.
 test_files: []
 has_rdoc: 

data/Gemfile.lock

@@ -1,30 +0,0 @@
-PATH
-  remote: .
-  specs:
-    hashdiff (0.0.5)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    bluecloth (2.2.0)
-    diff-lcs (1.1.3)
-    rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    yard (0.8.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bluecloth
-  hashdiff!
-  rake
-  rspec (~> 2.0)
-  yard