jsondiff 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.2)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec

data/README.md

@@ -0,0 +1,40 @@
+# JSON Diff - JSON Patch Generator
+
+A JSON patch generator in Ruby that is compliant to the JSON Patch specification [RFC6902](http://www.rfc-editor.org/rfc/rfc6902.txt).
+
+To apply a patch, you should use [hana](https://github.com/tenderlove/hana).
+
+## Status
+
+This is proof of concept only. Only example of the specification works.
+
+As for now, it generate only patch with *add*, *remove* and *replace*  operations.
+
+## Install
+
+No gems yet
+
+## Usage
+
+```ruby
+JsonDiff.generate({foo: :bar}, {foo: :plop})
+```
+=> will result in
+
+```ruby
+[{:op=>:replace, :path=>"/foo", :value=>:plop}]
+```
+
+## Tests
+
+    rspec
+
+## License
+
+Copyright (c) 2013 François de Metz
+
+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.

data/jsondiff.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/json_diff/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["François de Metz"]
+  gem.email         = ["francois@2metz.fr"]
+  gem.description   = %q{Generate a JSON Patch from 2 ruby hash}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/francois2metz/jsondiff"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.name          = "jsondiff"
+  gem.require_paths = ["lib"]
+  gem.version       = JsonDiff::VERSION
+
+  gem.add_development_dependency "rspec", "~> 2.13.0"
+end

data/lib/json_diff.rb

@@ -0,0 +1,15 @@
+require 'json_diff/helpers'
+require 'json_diff/hash_diff'
+require 'json_diff/array_diff'
+
+module JsonDiff
+  # Generate a patch from two ruby hash
+  #
+  # hash1 - the first hash
+  # hash2 - the second hash
+  #
+  # Returns an array of operations
+  def self.generate(hash1, hash2)
+    HashDiff.generate([], "", hash1, hash2)
+  end
+end

data/lib/json_diff/array_diff.rb

@@ -0,0 +1,34 @@
+module JsonDiff
+  class ArrayDiff
+    include Helpers
+
+    def self.generate(result, prefix, array1, array2)
+      if array1.size < array2.size
+        array2.each_with_index do |value, index|
+          if array1.at(index) != value
+            result << add_op(prefix, index, value)
+            array1.insert(index, value)
+          end
+        end
+      elsif array1.size > array2.size
+        array1.each_with_index do |value, index|
+          if array2.at(index) != value
+            result << remove_op(prefix, index)
+            array1.delete_at(index)
+          end
+        end
+      end
+      array2.each_with_index do |value, index|
+        if array1.at(index) != value
+          if value.kind_of?(Hash) && array1.at(index).kind_of?(Hash)
+            HashDiff.generate(result, "#{prefix}/#{index}", array1.at(index), value)
+          elsif value.kind_of?(Array) && array1.at(index).kind_of?(Array)
+            ArrayDiff.generate(result, "#{prefix}/#{index}", array1.at(index), value)
+          else
+            result << replace_op(prefix, index, value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json_diff/hash_diff.rb

@@ -0,0 +1,30 @@
+module JsonDiff
+  class HashDiff
+    include Helpers
+
+    def self.generate(result, prefix, hash1, hash2)
+      hash2.each do |key, value|
+        if !hash1.has_key? key
+          result << add_op(prefix, key, value)
+        else
+          value2 = hash1.fetch(key)
+          if value != value2
+            if value.kind_of?(Array) && value2.kind_of?(Array)
+              ArrayDiff.generate(result, "#{prefix}/#{key}", value2, value)
+            elsif value.kind_of?(Hash) && value2.kind_of?(Hash)
+              HashDiff.generate(result, "#{prefix}/#{key}", value2, value)
+            else
+              result << replace_op(prefix, key, value)
+            end
+          end
+        end
+      end
+      hash1.each do |key, value|
+        unless hash2.has_key? key
+          result << remove_op(prefix, key)
+        end
+      end
+      result
+    end
+  end
+end

data/lib/json_diff/helpers.rb

@@ -0,0 +1,21 @@
+module JsonDiff
+  module Helpers
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def add_op(prefix, key, value)
+        {op: :add, path: "#{prefix}/#{key}", value: value}
+      end
+
+      def remove_op(prefix, key)
+        {op: :remove, path: "#{prefix}/#{key}"}
+      end
+
+      def replace_op(prefix, key, value)
+        {op: :replace, path: "#{prefix}/#{key}", value: value}
+      end
+    end
+  end
+end

data/lib/json_diff/version.rb

@@ -0,0 +1,3 @@
+module JsonDiff
+  VERSION = '0.0.1'
+end

data/spec/diff_spec.rb

@@ -0,0 +1,87 @@
+require_relative 'spec_helper'
+
+describe JsonDiff do
+  describe "#generate" do
+    it "generate empty patch if nothing has changed" do
+      subject.generate({}, {}).should == []
+    end
+
+    context "add op" do
+      it "on hash member" do
+        subject.generate({foo: :bar},
+                         {foo: :bar, baz: :qux})
+          .should == [{ op: :add, path: "/baz", value: :qux }]
+      end
+
+      it "on array element" do
+        subject.generate({foo: [:bar, :baz]},
+                         {foo: [:bar, :qux, :baz]})
+          .should == [{ op: :add, path: "/foo/1", value: :qux }]
+      end
+
+      it "on nested member object" do
+        subject.generate({foo: :bar},
+                         {foo: :bar, child: {grandchild: {}}})
+          .should == [{ op: :add, path: "/child", value: {grandchild: {}} }]
+      end
+
+      it "on more nested member object" do
+        subject.generate({child: {grandchild: {foo: :bar}}},
+                         {child: {grandchild: {foo: :bar, chuck: :norris}}})
+          .should == [{ op: :add, path: "/child/grandchild/chuck", value: :norris }]
+      end
+
+      it "on nested object inside arrays" do
+        subject.generate({child: [{foo: :bar}]},
+                         {child: [{foo: :bar, chuck: :norris}]})
+          .should == [{ op: :add, path: '/child/0/chuck', value: :norris}]
+      end
+
+      it "on nested array inside arrays" do
+        subject.generate({child: [[:foo, :bar]]},
+                         {child: [[:foo, :bar, :chuck]]})
+          .should == [{ op: :add, path: '/child/0/2', value: :chuck}]
+      end
+    end
+
+    context "remove op" do
+      it "on hash member" do
+        subject.generate({foo: :bar, baz: :qux},
+                         {foo: :bar})
+          .should == [{ op: :remove, path: "/baz"}]
+      end
+
+      it "on array element" do
+        subject.generate({foo: [:bar, :qux, :baz]},
+                         {foo: [:bar, :baz]})
+          .should == [{ op: :remove, path: "/foo/1" }]
+      end
+    end
+
+    context "replace op" do
+      it "on hash member" do
+        subject.generate({foo: :bar, baz: :qux},
+                         {foo: :bar, baz: :boo})
+          .should == [{ op: :replace, path: "/baz", value: :boo}]
+      end
+
+      it "on array element" do
+        subject.generate({foo: [:bar, :qux, :baz]},
+                         {foo: [:bar, :foo, :baz]})
+          .should == [{ op: :replace, path: "/foo/1", value: :foo }]
+      end
+
+      it "when type differ from array to hash" do
+        subject.generate({foo: [:bar]},
+                         {foo: {bar: :foo}})
+          .should == [{ op: :replace, path: "/foo", value: {bar: :foo} }]
+      end
+
+      it "when type differ from hash to array" do
+        subject.generate({foo: {bar: :foo}},
+                         {foo: [:bar]})
+          .should == [{ op: :replace, path: "/foo", value: [:bar] }]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require_relative '../lib/json_diff'
+
+RSpec.configure do |c|
+  c.filter_run focus: true
+  c.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: jsondiff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- François de Metz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20852580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: *20852580
+description: Generate a JSON Patch from 2 ruby hash
+email:
+- francois@2metz.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- jsondiff.gemspec
+- lib/json_diff.rb
+- lib/json_diff/array_diff.rb
+- lib/json_diff/hash_diff.rb
+- lib/json_diff/helpers.rb
+- lib/json_diff/version.rb
+- spec/diff_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/francois2metz/jsondiff
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/diff_spec.rb
+- spec/spec_helper.rb