json-merge_patch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bda345671285245e45dc0666b0ce0e79c15d3950
+  data.tar.gz: c1b5cd2284d269260896ff5be37e1eda7eba05b9
+SHA512:
+  metadata.gz: 19dc0616daa81fa8d9b8de3db0b496a2447ee81325e0a786fca1468ad03c63f9a30e2d733bc4ff4fdc3994d87cfe4bd46119eaa3e33a4315001af47dcb8f0755
+  data.tar.gz: 60c56930ed226e38e7d7fd5199f3f2e85ff97220a325c2f29e4660f8fd31929e1daa91be87dfbe4e021ce080fe7d30645705ee385e67c7b07acc5769f229993d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json-merge_patch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steve Klabnik
+
+MIT License
+
+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/README.md

@@ -0,0 +1,78 @@
+# Json::MergePatch
+
+[![Build Status](https://travis-ci.org/steveklabnik/json-merge_patch.png)](https://travis-ci.org/steveklabnik/json-merge_patch)
+
+This gem augments Ruby's built-in JSON library to support merging JSON blobs
+in accordance with the [draft-snell-merge-patch
+draft](http://tools.ietf.org/html/draft-snell-merge-patch-08).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'json-merge_patch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-merge_patch
+
+## Usage
+
+First, require the gem:
+
+```ruby
+require 'json/merge_patch'
+```
+
+Then, use it:
+
+```ruby
+# The example from http://tools.ietf.org/html/draft-snell-merge-patch-08#section-2
+
+document = <<-JSON
+{
+  "title": "Goodbye!",
+    "author" : {
+      "givenName" : "John",
+      "familyName" : "Doe"
+    },
+    "tags":["example","sample"],
+    "content": "This will be unchanged"
+}
+JSON
+
+merge_patch = <<-JSON
+{
+  "title": "Hello!",
+    "phoneNumber": "+01-123-456-7890",
+    "author": {
+      "familyName": null
+    },
+    "tags": ["example"]
+}
+JSON
+
+JSON.merge(document, merge_patch)
+# => 
+{
+  "title": "Goodbye!",
+  "author" : {
+    "phoneNumber": "+01-123-456-7890",
+    "givenName" : "John",
+  },
+  "tags":["example"],
+  "content": "This will be unchanged"
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/json-merge_patch.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json/merge_patch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-merge_patch"
+  spec.version       = Json::MergePatch::VERSION
+  spec.authors       = ["Steve Klabnik"]
+  spec.email         = ["steve@steveklabnik.com"]
+  spec.description   = %q{An implementation of the json-merge-patch draft.}
+  spec.summary       = %q{An implementation of the json-merge-patch draft.}
+  spec.homepage      = "https://github.com/steveklabnik/json-merge_patch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/lib/json/merge_patch.rb

@@ -0,0 +1,27 @@
+require 'json'
+require "json/merge_patch/version"
+
+module JSON
+  MergeError = Class.new(StandardError)
+
+  def self.merge(document, merge_patch)
+    document = JSON.parse(document)
+    merge_patch = JSON.parse(merge_patch)
+
+    if merge_patch.is_a? Array
+      return JSON.dump(merge_patch)
+    end
+
+    if document.is_a? Array
+      return JSON.dump(merge_patch)
+    end
+
+    if merge_patch.is_a? Hash
+      document.merge!(merge_patch)
+      document.delete_if {|k, v| v.nil? }
+      return JSON.dump(document)
+    end
+  rescue 
+    raise MergeError
+  end
+end

data/lib/json/merge_patch/version.rb

@@ -0,0 +1,5 @@
+module Json
+  module MergePatch
+    VERSION = "0.0.1"
+  end
+end

data/test/merge_patch_test.rb

@@ -0,0 +1,179 @@
+require 'test_helper'
+
+require 'json/merge_patch'
+
+describe "Section 1" do
+=begin
+1.  If either the root of the JSON data provided in the payload or
+    the root of the target resource are JSON Arrays, the target
+    resource is to be replaced, in whole, by the provided data.  Any
+    object member contained in the provided data whose value is
+    explicitly null is to be treated as if the member was undefined.
+=end
+
+  describe "if the root of the data provided is an array" do
+    let(:merge_patch) { %q'["foo"]' }
+
+    it "replaces the root whole" do
+      document = %q'{"foo":"bar"}'
+
+      expected = %q'["foo"]'
+
+      assert_equal expected, JSON.merge(document, merge_patch)
+    end
+  end
+
+  describe "if the root of the target resource is an array" do
+    let(:document) { %q'["foo"]' }
+
+    it "replaces the root whole" do
+      merge_patch = %q'{"foo":"bar"}'
+
+      expected = %q'{"foo":"bar"}'
+
+      assert_equal expected, JSON.merge(document, merge_patch)
+    end
+  end
+end
+
+describe "section 2" do
+=begin
+2.  If the root of the JSON data provided in the payload is an
+       Object, for each distinct member specified within that object:
+=end
+
+  describe "part 1" do
+=begin
+*  If the member is currently undefined within the target
+   resource, and the given value is not null, the member and the
+   value are to be added to the target.  Any object member
+   contained in the provided data whose value is explicitly null
+   is to be treated as if the member were undefined.
+=end
+    it "adds members" do
+      document = %q'{"foo":"bar"}'
+
+      merge_patch = %q'{"foo":"bar","baz":"quxx"}'
+
+      expected = %q'{"foo":"bar","baz":"quxx"}'
+
+      assert_equal expected, JSON.merge(document, merge_patch)
+    end
+  end
+
+  describe "part 2" do
+=begin
+*  If the value is explicitly set to null and that member is
+   currently defined within the target resource, the existing
+   member is removed.
+=end
+    it "removes members" do
+      document = %q'{"foo":"bar"}'
+
+      merge_patch = %q'{"foo":null}'
+
+      expected = %q'{}'
+
+      assert_equal expected, JSON.merge(document, merge_patch)
+    end
+  end
+
+  describe "part 3" do
+=begin
+*  If the value is either a non-null JSON primitive or an Array
+   and that member is currently defined within the target
+   resource, the existing value for that member is to be replaced
+   with that provided.  Any object member contained in the
+   provided data whose value is explicitly null is to be treated
+   as if the member were undefined.
+=end
+  end
+
+  describe "part 4" do
+=begin
+*  If the value is a JSON object and that member is currently
+   defined for the target resource and the existing value is a
+   JSON primitive or Array, the existing value is to be replaced
+   in whole by the object provided.  Any object member contained
+   in the provided data whose value is explicitly null is to be
+   treated as if the member was undefined.
+=end
+  end
+
+  describe "part 5" do
+=begin
+*  If the value is a JSON object and that member is currently
+   defined within the target resource and the existing value is
+   also a JSON object, then recursively apply Rule #2 to each
+   object.
+=end
+  end
+
+  describe "part 6" do
+=begin
+*  Any member currently defined within the target resource that
+   does not explicitly appear within the patch is to remain
+   untouched and unmodified.
+=end
+    it "leaves well enough alone!" do
+      document = %q'{"content": "This will be unchanged"}'
+
+      merge_patch = %q'{}'
+
+      expected = %q'{"content":"This will be unchanged"}'
+
+      assert_equal expected, JSON.merge(document, merge_patch)
+    end
+  end
+end
+
+describe "README example" do
+  it "works properly" do
+    document = <<-JSON.strip_heredoc.chomp
+    {
+      "title": "Goodbye!",
+        "author" : {
+          "givenName" : "John",
+          "familyName" : "Doe"
+        },
+        "tags":["example","sample"],
+        "content": "This will be unchanged"
+    }
+    JSON
+
+    merge_patch = <<-JSON.strip_heredoc.chomp
+    {
+      "title": "Hello!",
+        "phoneNumber": "+01-123-456-7890",
+        "author": {
+          "familyName": null
+        },
+        "tags": ["example"]
+    }
+    JSON
+
+    expected = <<-JSON.strip_heredoc.chomp
+    {
+      "title": "Goodbye!",
+      "author" : {
+      "phoneNumber": "+01-123-456-7890",
+      "givenName" : "John",
+      },
+      "tags":["example"],
+      "content": "This will be unchanged"
+    }
+    JSON
+
+    pending do 
+      assert_equal expected, JSON.merge(document, merge_patch)
+    end
+  end
+end
+
+describe "errors" do
+  it "throws an error when stuff goes wrong" do
+    assert_raises(JSON::MergeError) do
+      JSON.merge(nil, nil)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+
+def pending
+  begin
+    yield
+    fail "OMG pending test passed."
+  rescue MiniTest::Assertion
+    skip "Still pending"
+  end
+end
+
+class String
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.send(:size) || 0
+    gsub(/^[ \t]{#{indent}}/, '')
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: json-merge_patch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steve Klabnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An implementation of the json-merge-patch draft.
+email:
+- steve@steveklabnik.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json-merge_patch.gemspec
+- lib/json/merge_patch.rb
+- lib/json/merge_patch/version.rb
+- test/merge_patch_test.rb
+- test/test_helper.rb
+homepage: https://github.com/steveklabnik/json-merge_patch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0
+signing_key: 
+specification_version: 4
+summary: An implementation of the json-merge-patch draft.
+test_files:
+- test/merge_patch_test.rb
+- test/test_helper.rb
+has_rdoc: