hashdiff 0.0.5 → 0.0.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hashdiff (0.0.4)
+    hashdiff (0.0.5)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -25,7 +25,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.
@@ -86,6 +85,10 @@ unpatch example:
     diff = HashDiff.diff(a, b) # diff two array is OK
     HashDiff.unpatch!(b, diff).should == a
 
+## Contributors
+
+- @liufengyun
+- @m-o-e
 
 ## License
 

data/changelog.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## v0.0.6 2013-3-2
+
+* Add parameter for custom property-path delimiter.
+
 ## v0.0.5 2012-7-1
 
 * fix a bug in judging whehter two objects are similiar.

data/lib/hashdiff/diff.rb

@@ -17,14 +17,14 @@ 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)
-    diffs_1 = diff(obj1, obj2, "", 0.3)
+  def self.best_diff(obj1, obj2, delimiter='.')
+    diffs_1 = diff(obj1, obj2, "", 0.3, delimiter)
     count_1 = count_diff diffs_1
 
-    diffs_2 = diff(obj1, obj2, "", 0.5)
+    diffs_2 = diff(obj1, obj2, "", 0.5, delimiter)
     count_2 = count_diff diffs_2
 
-    diffs_3 = diff(obj1, obj2, "", 0.8)
+    diffs_3 = diff(obj1, obj2, "", 0.8, delimiter)
     count_3 = count_diff diffs_3
 
     count, diffs = count_1 < count_2 ? [count_1, diffs_1] : [count_2, diffs_2]
@@ -38,6 +38,7 @@ module HashDiff
   # @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
   #
   # @return [Array] an array of changes.
   #   e.g. [[ '+', 'a.b', '45' ], [ '-', 'a.c', '5' ], [ '~', 'a.x', '45', '63']]
@@ -50,7 +51,7 @@ module HashDiff
   #   diff.should == [['-', 'b.b1', 1], ['-', 'b.b2', 2]]
   #
   # @since 0.0.1
-  def self.diff(obj1, obj2, prefix = "", similarity = 0.8)
+  def self.diff(obj1, obj2, prefix = "", similarity = 0.8, delimiter='.')
     if obj1.nil? and obj2.nil?
       return []
     end
@@ -72,7 +73,7 @@ module HashDiff
       changeset = diff_array(obj1, obj2, 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))
+          result.concat(diff(obj1[pair[0]], obj2[pair[1]], "#{prefix}[#{pair[0]}]", similarity, delimiter))
         end
       end
 
@@ -84,7 +85,7 @@ module HashDiff
         end
       end
     elsif obj1.is_a?(Hash)
-      prefix = prefix.empty? ? "" : "#{prefix}."
+      prefix = prefix.empty? ? "" : "#{prefix}#{delimiter}"
 
       deleted_keys = []
       common_keys = []
@@ -101,7 +102,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)) }
+      common_keys.each {|k| result.concat(diff(obj1[k], obj2[k], "#{prefix}#{k}", similarity, delimiter)) }
 
       # added properties
       obj2.each do |k, v|

data/lib/hashdiff/patch.rb

@@ -7,13 +7,14 @@ 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
   #
   # @return the object after patch
   #
   # @since 0.0.1
-  def self.patch!(obj, changes)
+  def self.patch!(obj, changes, delimiter='.')
     changes.each do |change|
-      parts = decode_property_path(change[1])
+      parts = decode_property_path(change[1], delimiter)
       last_part = parts.last
 
       parent_node = node(obj, parts[0, parts.size-1])
@@ -42,13 +43,14 @@ 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
   #
   # @return the object after unpatch
   #
   # @since 0.0.1
-  def self.unpatch!(obj, changes)
+  def self.unpatch!(obj, changes, delimiter='.')
     changes.reverse_each do |change|
-      parts = decode_property_path(change[1])
+      parts = decode_property_path(change[1], delimiter)
       last_part = parts.last
 
       parent_node = node(obj, parts[0, parts.size-1])

data/lib/hashdiff/util.rb

@@ -47,10 +47,12 @@ module HashDiff
   # @private
   #
   # decode property path into an array
+  # @param [String] path Property-string
+  # @param [String] delimiter Property-string delimiter
   #
   # e.g. "a.b[3].c" => ['a', 'b', 3, 'c']
-  def self.decode_property_path(path)
-    parts = path.split('.').collect do |part|
+  def self.decode_property_path(path, delimiter='.')
+    parts = path.split(delimiter).collect do |part|
       if part =~ /^(\w*)\[(\d+)\]$/
         if $1.size > 0
           [$1, $2.to_i]

data/lib/hashdiff/version.rb

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

data/spec/hashdiff/best_diff_spec.rb

@@ -9,6 +9,15 @@ describe HashDiff do
     diff.should == [["-", "x[0].c", 3], ["+", "x[0].b", 2], ["-", "x[1]", {"y"=>3}]]
   end
 
+  it "should use custom delimiter when provided" 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.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

@@ -123,5 +123,13 @@ describe HashDiff do
     diff.should == [["-", "[0].d", 4], ["-", "[1]", {"x"=>5, "y"=>6, "z"=>3}]]
   end
 
+  it "should use custom delimiter when provided" 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.should == [["-", "[0]\td", 4], ["-", "[1]", {"x"=>5, "y"=>6, "z"=>3}]]
+  end
+
 end
 

data/spec/hashdiff/util_spec.rb

@@ -6,6 +6,12 @@ describe HashDiff do
     decoded.should == ['a', 'b', 0, 'c', 'city', 5]
   end
 
+  it "should be able to decode property path with custom delimiter" do
+    decoded = HashDiff.send(:decode_property_path, "a\tb[0]\tc\tcity[5]", "\t")
+    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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashdiff
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-01 00:00:00.000000000Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19929880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *19929880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &19929380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19929380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &19928920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19928920
+  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. '
 email:
@@ -96,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: HashDiff is a diff lib to compute the smallest difference between two hashes.