json-merge_patch 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ce09ddf6d3610381e68fbb86d8ccf6874573007
-  data.tar.gz: 15046d860a25fc45329f784fd3a9a639534be7d2
+  metadata.gz: 9638a01b320666a7b5270d234ddb50acc746c952
+  data.tar.gz: f3a2bd4ecb11392969eb47306df2ce8407d46ce2
 SHA512:
-  metadata.gz: 3afcecc326503602ae67a18db19bc3d34596543ffe68e57a0284eb22c4b7bb4bbc5d7e2d70b03d8000e7077e0bf5bdd11ef14fd55b266939b5da4f6ee7255641
-  data.tar.gz: fadeda3faadfbe333ad0e9da52a0301d17b008936d3a41f46d6345ad1bca05487988947ae7d1208577438bd5e867904b61b3ad6a27547db157cd60b95a408c4d
+  metadata.gz: 46b929805693acbb5f82575086898a2fe1320b456e8b2f373780bb09bfac2fec6d296fae57a4a30bfaeb6ad15d70cddd3d00823b0de01af120c10705035c8184
+  data.tar.gz: 1670820bea9e3df973c6c2a2572ad2e3df01f6bb376eaeff092b655a233be9e0aa2ddbab8f60e36ddb10c47e7a7637209522b046bd90aa9ac75a9fe6ffee9994

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in json-merge_patch.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/README.md

@@ -1,6 +1,6 @@
 # Json::MergePatch
 
-[![Build Status](https://travis-ci.org/steveklabnik/json-merge_patch.png)](https://travis-ci.org/steveklabnik/json-merge_patch)
+[![Build Status](https://travis-ci.org/steveklabnik/json-merge_patch.png)](https://travis-ci.org/steveklabnik/json-merge_patch) [![Code Climate](https://codeclimate.com/github/steveklabnik/json-merge_patch.png)](https://codeclimate.com/github/steveklabnik/json-merge_patch) [![Coverage Status](https://coveralls.io/repos/steveklabnik/json-merge_patch/badge.png)](https://coveralls.io/r/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
@@ -59,9 +59,9 @@ JSON
 JSON.merge(document, merge_patch)
 # => 
 {
-  "title": "Goodbye!",
+  "title": "Hello!",
+  "phoneNumber": "+01-123-456-7890",
   "author" : {
-    "phoneNumber": "+01-123-456-7890",
     "givenName" : "John",
   },
   "tags":["example"],
@@ -69,6 +69,17 @@ JSON.merge(document, merge_patch)
 }
 ```
 
+If you'd prefer to operate on pure Ruby objects rather than JSON strings, you
+can construct a `MergePatch` object instead.
+
+```
+JSON::MergePatch.new({}, {"foo" => "bar"}).call
+=> {"foo"=>"bar"}
+```
+
+Also check out [http://json-merge-patch.herokuapp.com/](http://json-merge-patch.herokuapp.com/),
+which is a Rails app that serves up `json-merge-patch` responses.
+
 ## Contributing
 
 1. Fork it

data/json-merge_patch.gemspec

@@ -5,12 +5,12 @@ require 'json/merge_patch/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "json-merge_patch"
-  spec.version       = Json::MergePatch::VERSION
+  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.homepage      = "http://json-merge-patch.herokuapp.com/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/json/merge_patch.rb

@@ -2,35 +2,112 @@ require 'json'
 require "json/merge_patch/version"
 
 module JSON
+  # This represents an error that occurs during merging.
   MergeError = Class.new(StandardError)
 
+  # Merges a patch into the existing JSON document.
+  #
+  # @param document [String] the original JSON document.
+  # @param merge_patch [Symbol] the merge-patch JSON document.
+  # @return [String] the final document after applying the patch
   def self.merge(document, merge_patch)
-    document = JSON.parse(document)
-    merge_patch = JSON.parse(merge_patch)
+    orig = JSON.parse(document)
+    patch = JSON.parse(merge_patch)
+    JSON.dump(MergePatch.new(orig, patch).call)
+  rescue
+    raise MergeError
+  end
 
-    if merge_patch.is_a? Array
-      return JSON.dump(merge_patch)
+  # This class represents a merge patch.
+  class MergePatch
+
+    # Sets up a MergePatch.
+    #
+    # @param orig [Object] the original document
+    # @param patch [Object] the patch document
+    def initialize(orig, patch)
+      @orig = orig
+      @patch = patch
     end
 
-    if document.is_a? Array
-      return JSON.dump(merge_patch)
+    # Applies the patch the original object.
+    #
+    # @return [Object] the document after applying the patch.
+    def call
+      if @patch.nil?
+        return @orig
+      elsif @patch.kind_of?(Array) || @orig.kind_of?(Array)
+        @orig = purge_nils(@patch)
+      elsif is_primitive?(@patch) || is_primitive?(@orig)
+        @orig = @patch
+      elsif @patch.kind_of?(Hash)
+        @patch.each_key do |m|
+          if @orig.has_key?(m)
+            if @patch[m].nil?
+              @orig.delete(m)
+            else
+              if is_primitive?(@patch[m])
+                @orig[m] = @patch[m]
+              else
+                if @orig[m].kind_of?(Array)
+                  result = purge_nils(@patch[m])
+                  if result.nil?
+                    @orig.delete(m)
+                  else
+                    @orig[m] = result
+                  end
+                else
+                  @orig[m] = self.class.new(@orig[m], @patch[m]).call
+                end
+              end
+            end
+          elsif !(@patch[m].nil?)
+            result = purge_nils(@patch[m])
+            if result.nil?
+              @orig.delete(m)
+            else
+              @orig[m] = result
+            end
+          end
+        end
+      end
+      @orig
     end
 
-    if merge_patch.is_a? Hash
-      document.merge!(merge_patch)
-      document.delete_if(&method(:recursive_delete_if))
-      return JSON.dump(document)
+    private
+
+    def is_primitive?(val)
+      case val
+      when String
+        true
+      when Fixnum
+        true
+      when TrueClass
+        true
+      when FalseClass
+        true
+      else
+        false
+      end
     end
-  rescue
-    raise MergeError
-  end
 
-  def self.recursive_delete_if(key, value)
-    if value.kind_of?(Hash)
-      value.delete_if(&method(:recursive_delete_if))
-      nil
-    else
-      value.nil?
+    def purge_nils(obj)
+      return nil if obj.nil?
+      return obj.compact if obj.kind_of?(Array)
+      return obj if is_primitive?(obj)
+
+      obj.each do |m|
+        if obj[m].nil?
+          if obj.kind_of?(Array)
+            obj.delete_at(m)
+          else
+            obj.delete(m)
+          end
+        elsif obj[m].kind_of?(Hash)
+          purge_nils(obj[m])
+        end
+      end
+      obj
     end
   end
 end

data/lib/json/merge_patch/version.rb

@@ -1,5 +1,8 @@
-module Json
-  module MergePatch
-    VERSION = "0.1.0"
+# The Ruby standard Library exports JSON
+# http://www.ruby-doc.org/stdlib-1.9.3/libdoc/json/rdoc/
+module JSON
+  class MergePatch
+    # The current version of json-merge_patch
+    VERSION = "1.0.0"
   end
 end

data/test/merge_patch_test.rb

@@ -207,21 +207,9 @@ describe "README example" do
     }
     JSON
 
-    expected = <<-JSON.strip_heredoc.gsub(/\s/, "")
-    {
-      "title": "Goodbye!",
-      "author" : {
-      "phoneNumber": "+01-123-456-7890",
-      "givenName" : "John",
-      },
-      "tags":["example"],
-      "content": "This will be unchanged"
-    }
-    JSON
+    expected = %q'{"title":"Hello!","author":{"givenName":"John"},"tags":["example"],"content":"This will be unchanged","phoneNumber":"+01-123-456-7890"}'
 
-    pending do 
-      assert_equal expected, JSON.merge(document, merge_patch)
-    end
+    assert_equal expected, JSON.merge(document, merge_patch)
   end
 end
 

data/test/test_helper.rb

@@ -1,3 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter do |source_file|
+    source_file.filename =~ /test/
+  end
+end
+
+require 'coveralls'
+Coveralls.wear!
+
 require 'minitest/autorun'
 
 def pending

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-merge_patch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,7 +70,7 @@ files:
 - lib/json/merge_patch/version.rb
 - test/merge_patch_test.rb
 - test/test_helper.rb
-homepage: https://github.com/steveklabnik/json-merge_patch
+homepage: http://json-merge-patch.herokuapp.com/
 licenses:
 - MIT
 metadata: {}