hashdiff 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dbf060a0b7537d436fdf1a5000e37e16227bdbe
-  data.tar.gz: 4c2b8998e3f78648c542cc4c8c7a3c95de4a6256
+  metadata.gz: f76f1e64a73818c32f00f87cac3ba70d68253b10
+  data.tar.gz: a21cb6f9b8657866cca3628f1489301546baf2f8
 SHA512:
-  metadata.gz: 239b84f71304f154f89ab66c2b654bde48ccdaa3d1ed5748bb89f6449ea7ac8a34749a32f702e0684ea6e070940d4444c38705da413bdf017c6b3a1d6715a516
-  data.tar.gz: d20d20328d875a9bd52f6087b3a1cf494534346303e1def382f0a3b836adcb047c99f421a5263d072ebad01830f2b3101962b01ef2eb3bcd9adbf313c3c799c0
+  metadata.gz: 9d5e16abeea6634037f6e3696530ea575a8373a19a431ecbe4ab792e9e47d907a380fee1eb65f9aa33e5b0fc48e1237a004fc1859d74583161909ee35d72ac4d
+  data.tar.gz: 92a95d686c55d47db575f768cbf9fc0c4e274b86b1c454f6780135a2db5bf6ac007fa54e5e3e3fad37628313791624634a1e309999e1810d21a37585a051cdfb

data/README.md

@@ -1,4 +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) [![Gem Version](https://badge.fury.io/rb/hashdiff.png)](http://badge.fury.io/rb/hashdiff)
 
 HashDiff is a ruby library to compute the smallest difference between two hashes.
 
@@ -81,7 +81,9 @@ unpatch example:
 
 ### Options
 
-You can specify the delimiter to be something else than the dot. For example:
+There're two options available: `:delimiter` and `:similarity`.
+
+You can specify `: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}}
@@ -89,7 +91,7 @@ You can specify the delimiter to be something else than the dot. For example:
     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`.
+In cases you have similar hash objects in array, you can pass a custom value for `:similarity` instead of the default `0.8`.
 
 ## Contributors
 

data/hashdiff.gemspec

@@ -4,6 +4,7 @@ require 'hashdiff/version'
 Gem::Specification.new do |s|
   s.name        = %q{hashdiff}
   s.version     = HashDiff::VERSION
+  s.license     = 'MIT'
   s.summary     = %q{ HashDiff is a diff lib to compute the smallest difference between two hashes. }
   s.description = %q{ HashDiff is a diff lib to compute the smallest difference between two hashes. }
 

data/lib/hashdiff/diff.rb

@@ -6,8 +6,8 @@ module HashDiff
   #
   # @param [Arrary, Hash] obj1
   # @param [Arrary, Hash] obj2
-  # @param [Hash] options
-  #   `options` supports `:delimiter`. Default value for `:delimiter` is `.`(dot).
+  # @param [Hash] options supports following keys:
+  #   :delimiter - default value is '.'(dot).
   #
   # @return [Array] an array of changes.
   #   e.g. [[ '+', 'a.b', '45' ], [ '-', 'a.c', '5' ], [ '~', 'a.x', '45', '63']]
@@ -40,12 +40,10 @@ module HashDiff
   #
   # @param [Arrary, Hash] obj1
   # @param [Arrary, Hash] obj2
-  # @param [Hash] options
-  #   `options` can contain `:similarity` or `:delimiter`.
+  # @param [Hash] options supports following keys:
+  #   :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}.
   #
-  #   `: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).
+  #   :delimiter - defaults to '.'(dot).
   #
   # @return [Array] an array of changes.
   #   e.g. [[ '+', 'a.b', '45' ], [ '-', 'a.c', '5' ], [ '~', 'a.x', '45', '63']]

data/lib/hashdiff/patch.rb

@@ -7,8 +7,8 @@ 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 [Hash] options
-  #   `options` supports `:delimiter`. Default value for `:delimiter` is `.`(dot).
+  # @param [Hash] options supports following keys:
+  #   :delimiter - default value is '.'(dot).
   #
   # @return the object after patch
   #
@@ -46,8 +46,8 @@ 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 [Hash] options
-  #   `options` supports `:delimiter`. Default value for `:delimiter` is `.`(dot).
+  # @param [Hash] options supports following keys:
+  #   :delimiter - default value is '.'(dot).
   #
   # @return the object after unpatch
   #

data/lib/hashdiff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashdiff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Liu Fengyun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -84,7 +84,8 @@ files:
 - spec/hashdiff/util_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/liufengyun/hashdiff
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []