json-diff 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2079e5281095664f9827f175517045a3164b675b
-  data.tar.gz: 6a7d698b88209ed747f621ab609d3a735270fec0
+  metadata.gz: 7ff98bfabbd5790a20441a9efb6abbc3ff11214a
+  data.tar.gz: 36be41ebbaee8a09fedf8199a81e236692261d1a
 SHA512:
-  metadata.gz: bb9cf0f504e1e0892697bee3d5b4beefa7f0eff93fadc57c9bbfccc852a7f4f5c3210a02a74d1d0bc0141887437224182ee5116c9d9e92c2a5506f634d77da0e
-  data.tar.gz: a045d4d6507b8834ce9bc92f8be212777777b94cc15068a362649b608887af9dcb92e8172913bfb82a2230f9c279e366ba99eff972af2a04221cba60ae17d04f
+  metadata.gz: b140221da9b734eaaf0532e8391b50e0dca60d6ea39c3b4a0b8c0c0952392ac02e5f65864242a5f131934fd75e02a74de16a5f59c8e9182beb14b1c86201d0a7
+  data.tar.gz: dea0ec9287eb8e4bbe5f8948e3ec9a398408d26b0f1a5f8af9774e14a406686493d60420232412d82c168e5f60c7372eafc2ba89f3a05471ae37a3d7ca643cb7

data/README.md

@@ -23,6 +23,7 @@ Outputs [RFC6902][]. Look at [hana][] for a JSON patch algorithm that can use th
 - `moves`\*: include move operations. Set it to false to remove clutter.
 - `additions`\*: include add operations. Se it to false to remove clutter.
 - `original_indices`\*: array indices are those from the source array (for `from` fields, or `path` fields on remove operations) or the target array (for other `path` fields). It eases manual checking of differences.
+- `similarity`: procedure taking (before, after) objects. Returns a probability between 0 and 1 of how likely `after` is a modification of `before`, or nil if you wish to fall back to the default computation.
 
 \* Changing this option prevents the use of the output for JSON patching.
 
@@ -92,9 +93,10 @@ JsonDiff.generate(
 
 Roughly ordered by priority.
 
-- Support adding a custom procedure which computes similarities.
 - Support LCS as an option. (The default will remain what yields the best results, regardless of the time it takes.)
 - Support specifying a depth for similarity computation.
+- Character-wise substring add and remove operations.
+- SVG output.
 
 ---
 

data/json-diff.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.version     = JsonDiff::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Captain Train']
+  s.authors     = ['Thaddée Tyl']
   s.email       = ['ttyl@captaintrain.com']
-  s.homepage    = 'http://github.com/captaintrain/json-diff'
+  s.homepage    = 'http://github.com/espadrine/json-diff'
   s.summary     = %q{Compute the difference between two JSON-serializable Ruby objects.}
   s.description = %q{Take two Ruby objects that can be serialized to JSON. Output an array of operations (additions, deletions, moves) that would convert the first one to the second one.}
   s.files       = `git ls-files`.split("\n")

data/lib/json-diff/diff.rb

@@ -50,7 +50,7 @@ module JsonDiff
           changes << remove(inner_path, include_was ? item : nil)
         end
       else
-        pairing = array_pairing(before, after)
+        pairing = array_pairing(before, after, opts)
         # FIXME: detect replacements.
 
         # All detected moves that do not reach the similarity limit are deleted
@@ -111,11 +111,15 @@ module JsonDiff
   # {pairs: [[before index, after index, similarity]],
   #  removed: [before index],
   #  added: [after index]}
-  def self.array_pairing(before, after)
+  #
+  # - options[:similarity]: procedure taking (before, after) objects.
+  #   Returns a probability between 0 and 1 of how likely `after` is a
+  #   modification of `before`, or nil if it cannot determine it.
+  def self.array_pairing(before, after, options)
     # Array containing the array of similarities from before to after.
     similarities = before.map do |before_item|
       after.map do |after_item|
-        similarity(before_item, after_item)
+        similarity(before_item, after_item, options)
       end
     end
 
@@ -181,10 +185,18 @@ module JsonDiff
 
   # Compute an arbitrary notion of how probable it is that one object is the
   # result of modifying the other.
-  def self.similarity(before, after)
+  #
+  # - options[:similarity]: procedure taking (before, after) objects.
+  #   Returns a probability between 0 and 1 of how likely `after` is a
+  #   modification of `before`, or nil if it cannot determine it.
+  def self.similarity(before, after, options)
     return 0.0 if before.class != after.class
 
-    # FIXME: call custom similarity procedure.
+    # Use the custom similarity procedure if it isn't nil.
+    if options[:similarity] != nil
+      custom_result = options[:similarity].call(before, after)
+      return custom_result if custom_result != nil
+    end
 
     if before.is_a?(Hash)
       if before.size == 0
@@ -199,7 +211,7 @@ module JsonDiff
       # We don't consider key renames.
       similarities = []
       before.each do |before_key, before_item|
-        similarities << similarity(before_item, after[before_key])
+        similarities << similarity(before_item, after[before_key], options)
       end
       # Also consider keys' names.
       before_keys = before.keys
@@ -216,7 +228,7 @@ module JsonDiff
       # similarity between each elements of the list.
       similarities = before.map do |before_item|
         after.map do |after_item|
-          similarity(before_item, after_item)
+          similarity(before_item, after_item, options)
         end.max || 0.0
       end
 

data/lib/json-diff/version.rb

@@ -1,3 +1,3 @@
 module JsonDiff
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/json-diff/diff_spec.rb

@@ -62,8 +62,8 @@ describe JsonDiff do
     expect(diff).to eql([
       {'op' => 'replace', 'path' => "/2/pillar", 'was' => 0, 'value' => 1},
       {'op' => 'remove', 'path' => "/0", 'was' => "laundry"},
-      {'op' => 'move', 'from' => "/2", 'path' => "/0"},
-      {'op' => 'move', 'from' => "/1", 'path' => "/2"},
+      {'op' => 'move', 'from' => "/0", 'path' => "/2"},
+      {'op' => 'move', 'from' => "/1", 'path' => "/0"},
       {'op' => 'add', 'path' => "/2", 'value' => 3},
     ])
   end
@@ -116,4 +116,35 @@ describe JsonDiff do
     ])
   end
 
+  it "should be able to diff two objects with a custom similarity" do
+    similarity = -> (before, after) do
+      if before.is_a?(Hash) && after.is_a?(Hash)
+        if before[:id] == after[:id]
+          1.0
+        else
+          0.0
+        end
+      end
+    end
+
+    diff = JsonDiff.diff([
+      {id: 1, we: "must", start: "somewhere"},
+      {id: 2, and: "this", will: "do"},
+    ], [
+      {id: 2, insert: "something", completely: "different"},
+      {id: 1, this: "too", is: "different"},
+    ], similarity: similarity)
+    expect(diff).to eql([
+      {'op' => 'remove', 'path' => '/0/we'},
+      {'op' => 'remove', 'path' => '/0/start'},
+      {'op' => 'add', 'path' => '/0/this', 'value' => 'too'},
+      {'op' => 'add', 'path' => '/0/is', 'value' => 'different'},
+      {'op' => 'remove', 'path' => '/1/and'},
+      {'op' => 'remove', 'path' => '/1/will'},
+      {'op' => 'add', 'path' => '/1/insert', 'value' => 'something'},
+      {'op' => 'add', 'path' => '/1/completely', 'value' => 'different'},
+      {'op' => 'move', 'from' => '/0', 'path' => '/1'},
+    ])
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-diff
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
-- Captain Train
+- Thaddée Tyl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies: []
 description: Take two Ruby objects that can be serialized to JSON. Output an array
   of operations (additions, deletions, moves) that would convert the first one to
@@ -19,8 +19,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - Makefile
@@ -36,7 +36,7 @@ files:
 - spec/json-diff/index-map_spec.rb
 - spec/json-diff/operation_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/captaintrain/json-diff
+homepage: http://github.com/espadrine/json-diff
 licenses:
 - MIT
 metadata: {}
@@ -46,17 +46,17 @@ 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.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Compute the difference between two JSON-serializable Ruby objects.