• Stars
    star
    125
  • Rank 286,335 (Top 6 %)
  • Language
    CoffeeScript
  • License
    MIT License
  • Created over 10 years ago
  • Updated almost 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

JSON diff

Bugs

  • current version will not dive into nested arrays; if there is tiniest bit different between nested arrays, the diff will emit replacement for the whole nested array as a single op.
  • there is no way of specifying if an array should be compared as unordered set of elements or ordered list of elements
  • the code is in dated coffeescript, needs rewrite in modern js, ideally with ts/flow annotations.

Summary Build Status

(R)emove-(U)pdate-(S)et JSON diff library can be used standalone to compute difference between two JSON objects.

Produced diff is MongoDB compatible and can be used to modify documents with collection.update(...).

Examples

Diff

a b diff(a, b) options
{a:1} {b:2} {$unset:{a:true},$set:{b:2}}
{a:1} {b:1} {$rename:{a:'b'}}
{a:1} {} {$unset:{a:true}}
{a:1} {a:2.5} {$set:{a:2.5}}
{a:1} {a:2.5} {$inc:{a:1.5}} {inc:true}

Apply

a diff apply(a, diff)
{} {$inc:{'a.b':1}} {a:{b:1}}
{a:1.5} {$inc:{a:-2.5}} {a:-1}
{a:true} {$rename:{a:'b'}} { b: true }
{a:1,b:2} {$unset:{a:true},$set:{'c.d':3}} {b:2,c:{d:3}}

Usage

Install rus-diff in your project:

npm install rus-diff --save

Install ES6 compatibility layer:

npm install babel-polyfill --save

Usage example:

// Add ES6 polyfills.
require('babel-polyfill')

var diff = require('rus-diff').diff

var a = {
  foo: {
    bb: {
      inner: {
        this_is_a: 1,
        to_rename: "Hello"
      }
    },
    aa: 1
  },
  bar: 1,
  replace_me: 1
}

var b = {
  foo: {
    bb: {
      inner: {
        this_is_b: 2
      }
    },
    cc: {
      new_val: 2
    }
  },
  bar2: 2,
  zz: 2,
  renamed: "Hello",
  replace_me: 2
}

console.log(diff(a, b))

Produces diff:

{ '$rename': { 'foo.bb.inner.to_rename': 'renamed' },
  '$unset': { bar: true, 'foo.aa': true, 'foo.bb.inner.this_is_a': true },
  '$set':
   { bar2: 2,
     'foo.bb.inner.this_is_b': 2,
     'foo.cc': { new_val: 2 },
     replace_me: 2,
     zz: 2 } }

For more usage examples please see spec directory.

Exported functions:

// Generate diff between a and b JSON objects.
// prefix can be set to an array or string to scope (prefix) keys,
//   ie. 'foo.bar' means all changes will have keys starting with 'foo.bar...'.
// options.inc = true can be set to enable $inc part for number changes.
diff(a, b, prefix = [], options = {})

// Apply delta diff on the JSON object a. If you don't want to mutate a you
// can clone it before passing to apply:
//   apply(clone(a), delta)
apply(a, delta)

And some less important, utility functions:

// JSON object deep copy.
clone(a)

// Resolve key path on the object. Returns a tuple [a, path] where a
// is resolved object and path is an array of last component or multiple
// unresolved components.
//
// a - object
// path - an array or dot separated key path
//
// For example, having a document:
//
//   var a = { hello: { in: { nested: { world: '!' } } } }
//
//   resolve a, 'hello.in.nested'
//
// Returns [ { nested: { world: '!' } }, [ 'nested' ] ]
//
//   resolve a, 'hello.in.nested.something.other'
//
// Returns [ { world: '!' }, [ 'something', 'other' ] ]
//
resolve(a, path)

// Convert non array path into array based key path.
arrize(path)

License

The MIT License (MIT)

Copyright (c) 2014 Mirek Rusin

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.

More Repositories

1

YAML.framework

Proper YAML support for Objective-C. Based on recommended libyaml.
HTML
244
star
2

CoreWebSocket

Web Socket Server and Client Library for iOS and OSX. Follows Core Foundation API style.
C
142
star
3

node-unused-deps

Report unused npm packages in node, es6, babel or coffee project.
CoffeeScript
79
star
4

CoreJSON

Core Foundation, libyajl based JSON support.
C
49
star
5

quartzcomposer-websocket

Quartz Composer WebSocket Plug-In
Objective-C
40
star
6

CoreSQLite3

Core SQLite3 for iOS and OSX. Fast. Clean. Powerful...
C
37
star
7

rb_tree

Red-black tree C implementation
36
star
8

node-json-criteria

Criteria queries on JSON objects Mongo style
JavaScript
33
star
9

INI.framework

Ini style file read/write support with format preserving
Objective-C
25
star
10

node-json-hash

JSON hash
JavaScript
24
star
11

NSMutableDictionary-REST.framework

REST category for NSMutableDictionary - the way it should be done.
Objective-C
24
star
12

quartzcomposer-opencv

OpenCV 2.1 port for Quartz Composer
Objective-C
19
star
13

quartzcomposer-objective-c

Objective-C/C/C++ for Quartz Composer (on the fly)
Objective-C
16
star
14

quartzcomposer-exporter

Quartz Composer Movie Exporter Plug-In
Objective-C
13
star
15

quartzcomposer-vnc

Quartz Composer VNC Server Plugin
C
11
star
16

CoreOSC

Open Sound Control - iOS/OSX Framework
C
6
star
17

flovv

flovv.org engine similar to quartz composer.
C++
5
star
18

GitHub.framework

Objective-C Framework for GitHub (API v.2)
5
star
19

sqlite-amalgamation

Contains all C source code for SQLite 3.7.10 combined into a single source file .
C
4
star
20

node-pg-safe-numbers

Safe number parsing for pg and Sequelize.
JavaScript
3
star
21

CoreMono

Embed C# in your Objective-C iOS and Mac OSX projects. Yey!
C
3
star
22

oscpads

OSCpad - advanced iPad OSC controller
JavaScript
3
star
23

node-flat-flow

Tiny flow.
CoffeeScript
3
star
24

CoreTestAllocator

Core Foundation Test Allocator to spot memory leaks
C
2
star
25

node-tiny-sse

Server Sent Events (SSE) for express/connect.
CoffeeScript
2
star
26

ruby-odbc

Clone of http://www.ch-werner.de/rubyodbc + fixes
C
2
star
27

libeio

C
1
star
28

node-flovv

nodejs based flovv prototype
1
star
29

libeio-old

http://software.schmorp.de/pkg/libeio.html with some changes (autogen warnings fixed, extended attributes support)
C
1
star
30

atom-html2jade

Convert HTML to jade
CoffeeScript
1
star
31

celldb

Ruby
1
star
32

mirek.github.com

mirek.github.com
1
star
33

db-logic

Ruby on Rails database logic support
Ruby
1
star
34

atom-special-snippets

Special characters cmd-⌘, shift-⇧, opt-⌥, del-⌫, esc-⎋, etc.
CoffeeScript
1
star