object_patch 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d001241ee49b3b29f9a8a04bd8aa4ea32720175
+  data.tar.gz: 4dd6636e8c29378d7038cacf6972697ef1d69f71
+SHA512:
+  metadata.gz: 69fecfe300ec106c18761625fa0e0b059dc69b1f2e62a2d5e9b1b0fe3620e6b57146bb6d153d5448b0c013c06af895a178f13f02ea70d000b87f85b1187cc2dd
+  data.tar.gz: a8759ce823f1e00a6b43bf15aab0714d76a2f33c364bb3a94f921cc5c02904c3c50fa01792ce348730fa736b249a4b1a6db0f4522e977edac039a1720e8c29e2

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/.gitmodules

@@ -0,0 +1,4 @@
+[submodule "spec/fixtures/json-patch-tests"]
+	path = spec/fixtures/json-patch-tests
+	url = https://github.com/json-patch/json-patch-tests.git
+	branch = master

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/.yardopts

@@ -0,0 +1,3 @@
+--private
+--protected
+lib/**/*.rb - README.md LICENSE.txt

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sam Stelfox
+
+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,77 @@
+# ObjectPatch
+
+Please note this project isn't complete in either the generation or application
+of patches.
+
+ObjectPatch is a pure ruby implementation of [RFC6902
+(JSON::Patch)](http://tools.ietf.org/rfc/rfc6902.txt) for standard hashes,
+arrays, and scalar types. This will both generate patches as well as apply
+them.
+
+Rather than restricting end-users to the native JSON library, ObjectPatch only
+operates on pure Ruby objects. These objects can be converted to a proper JSON
+encoding using the standard JSON library or any other JSON compliant encoder.
+
+The application of patches is based on
+[Hana](http://github.com/tenderlove/hana). I greatly respect tenderlove but
+disagreed with pieces of his implementation. I could have chosen to make pull
+requests but since I was going to be extending the scope of the project I
+decided to create my own project. At the very least it seemed like a fun
+project to attempt.
+
+The generation of patches attempts to do so in a way to minimize the size of
+the patch, this is particularily difficult in arrays where the deletion of a
+single element at the beginning may be hard to distinguish from the changing of
+multiple values and the removal of the last.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'object_patch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_patch
+
+## Usage
+
+TODO: Write usage instructions here
+
+## RFC6901
+
+There is one thing that I implemented within this RFC that is either an
+extension or a violation of the RFC depending on your view of it. The violation
+specifically is I have allowed negative array addressing (ie -1 is the last
+element, -2 the second to last, &c). The absolute value of the index can't be
+greater than or equal to the the length of the array.
+
+## RFC6902
+
+One thing to note is that while referencing [RFC6902
+(JSON::Patch)](http://tools.ietf.org/rfc/rfc6902.txt) it came to my attention
+that the published RFC was missing a section that was part of the accepted
+revision (specifically the appendix). The revision of the document that was
+accepted by the IETF can be [found
+here](http://tools.ietf.org/id/draft-ietf-appsawg-json-patch-10.txt). This was
+gleaned from the public history of review of the RFC which is [available
+here](https://datatracker.ietf.org/doc/rfc6902/history/).
+
+I referenced the draft version 10 for any information available in the appendix
+and the published version when the information was available there.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch off of the current `develop` head (`git checkout
+   -b my-new-feature origin/develop`)
+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
+
+I'll respond to all pull requests within two weeks, hopefully in under one.
+

data/Rakefile

@@ -0,0 +1,18 @@
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :environment do
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+  require 'object_patch'
+end
+
+desc "Run a pry session with the gem code loaded"
+task :console => :environment do
+  require 'pry'
+  pry
+end

data/TODO.md

@@ -0,0 +1,7 @@
+
+* Apparently string reuse is better done through constants to prevent them
+  from being recreated all the time such as accessing common hash keys, think
+  'path', 'from', 'value', 'op'.
+* The big one: Generation of patches based on the difference of two provided
+  hashes.
+

data/lib/object_patch.rb

@@ -0,0 +1,46 @@
+
+
+require "object_patch/exceptions"
+require "object_patch/generator"
+require "object_patch/operation_factory"
+require "object_patch/operations"
+require "object_patch/pointer"
+require "object_patch/version"
+
+module ObjectPatch # :nodoc:
+
+  # Applies a series of patches to a source document. It is important to note
+  # that this will return the changed document but will also modify the original
+  # document that got passed in, using dup also isn't enough to prevent this
+  # modification as any subvalues within a hash or an array will not by
+  # duplicated. A deep duplication by marshalling the object, encoding and
+  # decoding as JSON, or using a recursive function to duplicate all of an
+  # object's contents would prevent your source from being modified.
+  #
+  # The JSON Patch RFC specifies that the original document shouldn't be
+  # modified unless the whole series of patches is able to be applied
+  # successfully.
+  #
+  # @param [Object] source The source document that will be modified.
+  # @param [Array<Hash<String => String>>] patches An array of JSON patch
+  #   operations that should be applied to the source document.
+  # @return [Object] The modified source document.
+  def apply(source, patches)
+    patches.inject(source) do |src, patch|
+      OperationFactory.build(patch).apply(src)
+    end
+  end
+
+  # Proxies the generation of a new set of patches to the Generator.
+  #
+  # @see [Generator#generate]
+  # @param [Object] source The source document
+  # @param [Object] target The target document we'll generate the
+  #   differences for.
+  # @return [Array<Hash>]
+  def generate(source, target)
+    Generator.generate(source, target)
+  end
+
+  module_function :apply, :generate
+end

data/lib/object_patch/exceptions.rb

@@ -0,0 +1,51 @@
+
+module ObjectPatch
+  # This is a parent exception for anything that is going to get raised by this
+  # gem, allowing users of this code to catch all the subclasses.
+  BaseException = Class.new(StandardError)
+
+  # Raised when the index value that was attempted to be accessed isn't a
+  # numeric identifier or '-' (the special index value defined in JSON Pointer).
+  InvalidIndexError = Class.new(BaseException)
+
+  # An exception that gets raised when a patch contains an invalid operation.
+  InvalidOperation = Class.new(BaseException)
+
+  # An exception that gets raised when an operation takes place on a missing
+  # hash key, or a missing hash key is somewhere along the path.
+  MissingTargetException = Class.new(BaseException)
+
+  # Raised when a non-integer value is attempted to be used to access some part
+  # of an array.
+  ObjectOperationOnArrayException = Class.new(BaseException)
+
+  # When an integer value outside the available range of an array is used to
+  # access an array this will get raised.
+  OutOfBoundsException = Class.new(BaseException)
+
+  # When the path provided attempts to cross a scalar value, this exception will
+  # be raised.
+  TraverseScalarException = Class.new(BaseException)
+
+  # An exception that will get raised when a test operation fails after being
+  # applied to a document.
+  #
+  # @attr [String] path A JSON pointer string representing the location to be
+  #   checked.
+  # @attr [Object] value The value that failed the comparison check.
+  class FailedTestException < BaseException
+    attr_accessor :path, :value
+
+    # Formats the exception message with the relevant information before
+    # actually raising the error.
+    #
+    # @param [String] path
+    # @param [Object] value
+    # @return [void]
+    def initialize(path, value)
+      super("Expected #{value} at #{path}")
+      @path, @value = path, value
+    end
+  end
+end
+

data/lib/object_patch/generator.rb

@@ -0,0 +1,114 @@
+
+module ObjectPatch
+
+  # This module handles the generation of patches between two objects.
+  module Generator
+
+    # Generate a series of patch operations that describe the changes from the
+    # source object to the target object.
+    #
+    # @todo This doesn't do anything yet...
+    # @param [Object] source The source document
+    # @param [Object] target The target document we'll generate the
+    #   differences for.
+    # @return [Array<Hash>]
+    def generate(source, target, current_path = [])
+      if source.class != target.class
+        # The simplest of cases is that we have incompatible types, in which
+        # case we'll full replace the root. This of course could be optimized
+        # for situations where the root as moved to a child element but that is
+        # harder to detect...
+        return [Operations::Replace.new("path" => Pointer.encode(current_path), "value" => target)]
+      end
+
+      case source.class.to_s
+      when "Hash"
+        return hash_compare(source, target, current_path)
+      when "Array"
+        return array_compare(source, target, current_path)
+      else
+        # A scaler value
+        return [] if source == target
+        return [Operations::Replace.new("path" => Pointer.encode(current_path), "value" => target)]
+      end
+    end
+
+    def hash_compare(src_hash, tgt_hash, current_path)
+      operations = []
+
+      # Keys to remove
+      (src_hash.keys - tgt_hash.keys).each do |k|
+        path = Pointer.encode(current_path + Array(k))
+        operations.push(
+          Operations::Test.new("path" => path, "value" => src_hash[k]),
+          Operations::Remove.new("path" => path)
+        )
+      end
+
+      # Missing keys to add
+      (tgt_hash.keys - src_hash.keys).each do |k|
+        path = Pointer.encode(current_path + Array(k))
+        operations.push(
+          Operations::Add.new("path" => path, "value" => tgt_hash[k])
+        )
+      end
+
+      # When both hashes share the same key we need to go deeper...
+      (src_hash.keys & tgt_hash.keys).each do |k|
+        operations += generate(src_hash[k], tgt_hash[k], current_path + Array(k))
+      end
+
+      operations
+    end
+
+    def array_compare(src_ary, tgt_ary, current_path)
+      operations = []
+
+      if src_ary.size > tgt_ary.size
+        # We'll need to remove some elements
+        base_size = tgt_ary.size
+        src_ary[base_size..-1].each_with_index do |itm, idx|
+          path = Pointer.encode(current_path + Array(base_size + idx))
+          operations.push(
+            Operations::Test.new("path" => path, "value" => src_ary[base_size + idx]),
+            Operations::Remove.new("path" => path)
+          )
+        end
+      elsif src_ary.size < tgt_ary.size
+        # We'll need to add some elements
+        base_size = tgt_ary.size
+        src_ary[base_size..-1].each_with_index do |itm, idx|
+          path = Pointer.encode(current_path + Array(base_size + idx))
+          operations.push(
+            Operations::Add.new("path" => path, "value" => tgt_ary[base_size + idx]),
+          )
+        end
+      end
+
+      # Compare the existing values in the array
+      smallest_length = (src_ary.size > tgt_ary.size) ? tgt_ary.size : src_ary.size
+      smallest_length.times do |n|
+        # Handle arrays and hashes in a special way as their values are
+        # potentially not going to be able to hold up to a comparison.
+        if src_ary[n].is_a?(Array) || src_ary[n].is_a?(Hash) || tgt_ary[n].is_a?(Array) || tgt_ary[n].is_a?(Hash)
+          operations.push(*generate(src_ary[n], tgt_ary[n], current_path + Array(n)))
+          next
+        end
+
+        # We've gotten the complicated cases out, this is a simple test and
+        # replace.
+        unless src_ary[n] == tgt_ary[n]
+          path = Pointer.encode(current_path + Array(n))
+          operations.push(
+            Operations::Test.new("path" => path, "value" => src_ary[n]),
+            Operations::Replace.new("path" => path, "value" => tgt_ary[n]),
+          )
+        end
+      end
+
+      operations
+    end
+
+    module_function :array_compare, :generate, :hash_compare
+  end
+end

data/lib/object_patch/operation_factory.rb

@@ -0,0 +1,25 @@
+
+module ObjectPatch
+
+  # A factory module used to build the appropriate operation objects.
+  module OperationFactory
+
+    # Build an operation object that matches the operation type and makes the
+    # appropriate information available to them.
+    #
+    # @param [Hash] patch
+    # @return [Object] One of the operations classes.
+    def build(patch)
+      operations = ObjectPatch::Operations.constants.map { |c| c.to_s.downcase }
+
+      unless operations.include?(patch['op'])
+        raise InvalidOperation, "Invalid operation: `#{patch['op']}`" 
+      end
+
+      Operations.const_get(patch['op'].capitalize.to_sym).new(patch)
+    end
+
+    module_function :build
+  end
+end
+

data/lib/object_patch/operations.rb

@@ -0,0 +1,79 @@
+
+require "object_patch/operations/add"
+require "object_patch/operations/copy"
+require "object_patch/operations/move"
+require "object_patch/operations/remove"
+require "object_patch/operations/replace"
+require "object_patch/operations/test"
+
+module ObjectPatch
+
+  # These operations take advantage of the fact that Pointer#eval returns the
+  # same object (obj.object_id match) and thus any changes made to the
+  # extracted object will be reflected in the original deeply nested object.
+  module Operations
+
+    # Add a value at the provided key within the provided object. This will
+    # behave differently depending on whether we're processing a hash or an
+    # array as the target destination.
+    #
+    # It is important to note that this behaves by adjusting the state of the
+    # provided object. It does not return the new object itself!
+    #
+    # @param [Array, Hash] target_obj The object that will have the value added.
+    # @param [Fixnum,String] key The index / key where the new value will be
+    #   inserted.
+    # @param [Object] new_value The value to insert at the specified location.
+    # @return [Object] The value that was added.
+    def add_op(target_obj, key, new_value)
+      if target_obj.is_a?(Array)
+        target_obj.insert(check_array_index(key, target_obj.size), new_value)
+      else
+        target_obj[key] = new_value
+      end
+    end
+
+    # Validates that the array index provided falls within the acceptable range
+    # or in the event we have received the special '-' index defined in the
+    # JSON Pointer RFC we treat it as the last element.
+    #
+    # @param [String,Fixnum] index The index value to validate
+    # @param [Fixnum] array_size The size of the array this index will be used
+    #   within (Used for bounds checking).
+    # @return [Fixnum] Valid index
+    def check_array_index(index, array_size)
+      return -1 if index == "-"
+      raise ObjectOperationOnArrayException unless index =~ /\A-?\d+\Z/
+
+      index = index.to_i
+
+      # There is a bug in the IETF tests that require us to allow patches to
+      # set a value at the end of the array. The final '<=' should actually be
+      # a '<'.
+      raise OutOfBoundsException unless (0 <= index && index <= array_size)
+
+      index
+    end
+
+    # Remove a hash key or index from the provided object.
+    #
+    # It is important to note that this behaves by adjusting the state of the
+    # provided object. It does not return the new object itself!
+    #
+    # @param [Array, Hash] target_obj The object that will have the value
+    #   removed.
+    # @return [Object] The deleted object.
+    def rm_op(target_obj, key)
+      if target_obj.is_a?(Array)
+        raise InvalidIndexError unless key =~ /\A\d+\Z/
+        target_obj.delete_at(check_array_index(key, target_obj.size))
+      else
+        raise(MissingTargetException, key) unless target_obj.has_key?(key)
+        target_obj.delete(key)
+      end
+    end
+
+    module_function :add_op, :check_array_index, :rm_op
+  end
+end
+