hana 1.0.0

data/.autotest

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib          = 'minitest/autorun'
+  at.find_directories = ARGV unless ARGV.empty?
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2012-09-05
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/hana.rb
+test/helper.rb
+test/test_hana.rb
+test/test_patch.rb

data/README.rdoc

@@ -0,0 +1,58 @@
+= hana
+
+* http://github.com/tenderlove/hana
+
+== DESCRIPTION:
+
+Implementation of JSON Patch and JSON Pointer drafts.
+
+== FEATURES/PROBLEMS:
+
+Implements draft specs of the JSON Patch and JSON pointer spec:
+
+  * http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-01
+  * http://tools.ietf.org/html/draft-ietf-appsawg-json-patch-03
+
+These are drafts, so it could change.  This works against Ruby objects, so you
+should load the JSON to Ruby, process it, then emit as JSON again.
+
+== SYNOPSIS:
+
+    patch = Hana::Patch.new [
+      { 'add' => '/baz', 'value' => 'qux' }
+    ]
+    
+    patch.apply('foo' => 'bar') # => {'baz' => 'qux', 'foo' => 'bar'}
+
+== REQUIREMENTS:
+
+* Ruby
+
+== INSTALL:
+
+* gem install hana
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Aaron Patterson
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :minitest
+Hoe.plugin :gemspec # `gem install hoe-gemspec`
+Hoe.plugin :git     # `gem install hoe-git`
+
+Hoe.spec 'hana' do
+  developer('Aaron Patterson', 'aaron@tenderlovemaking.com')
+  self.readme_file   = 'README.rdoc'
+  self.history_file  = 'CHANGELOG.rdoc'
+  self.extra_rdoc_files  = FileList['*.rdoc']
+end
+
+# vim: syntax=ruby

data/lib/hana.rb

@@ -0,0 +1,110 @@
+module Hana
+  VERSION = '1.0.0'
+
+  class Pointer
+    include Enumerable
+
+    def initialize path
+      @path = Pointer.parse path
+    end
+
+    def each
+      @path.each { |x| yield x }
+    end
+
+    def to_a
+      @path.dup
+    end
+
+    def eval object
+      Pointer.eval @path, object
+    end
+
+    def self.eval list, object
+      list.inject(object) { |o, part| o[(Array === o ? part.to_i : part)] }
+    end
+
+    def self.parse path
+      path.sub(/^\//, '').split(/(?<!\^)\//).map { |part|
+        part.gsub(/\^([\/^])/, '\1')
+      }
+    end
+  end
+
+  class Patch
+    class Exception < StandardError
+    end
+
+    def initialize is
+      @is = is
+    end
+
+    def apply doc
+      doc = doc.dup
+      @is.each { |ins|
+        send ins.keys.sort.first, ins, doc
+      }
+      doc
+    end
+
+    private
+
+    def add ins, doc
+      list = Pointer.parse ins['add']
+      key  = list.pop
+      obj  = Pointer.eval list, doc
+
+      if Array === obj
+        obj.insert key.to_i, ins['value']
+      else
+        obj[key] = ins['value']
+      end
+    end
+
+    def move ins, doc
+      from     = Pointer.parse ins['move']
+      to       = Pointer.parse ins['to']
+      from_key = from.pop
+      to_key   = to.pop
+
+      src  = Pointer.eval(from, doc)
+
+      if Array === src
+        obj = src.delete_at from_key.to_i
+      else
+        obj = src.delete from_key
+      end
+
+      dest = Pointer.eval(to, doc)
+
+      if Array === dest
+        dest.insert(to_key.to_i, obj)
+      else
+        dest[to_key] = obj
+      end
+    end
+
+    def test ins, doc
+      expected = Pointer.new(ins['test']).eval doc
+      raise Exception unless expected == ins['value']
+    end
+
+    def replace ins, doc
+      list = Pointer.parse ins['replace']
+      key  = list.pop
+      Pointer.eval(list, doc)[key] = ins['value']
+    end
+
+    def remove ins, doc
+      list = Pointer.parse ins['remove']
+      key  = list.pop
+      obj  = Pointer.eval list, doc
+
+      if Array === obj
+        obj.delete_at key.to_i
+      else
+        obj.delete key
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/autorun'
+require 'hana'
+
+module Hana
+  class TestCase < MiniTest::Unit::TestCase
+  end
+end

data/test/test_hana.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+class TestHana < Hana::TestCase
+  def test_split_many
+    pointer = Hana::Pointer.new '/foo/bar/baz'
+    assert_equal %w{ foo bar baz }, pointer.to_a
+  end
+
+  def test_root
+    pointer = Hana::Pointer.new '/'
+    assert_equal [], pointer.to_a
+  end
+
+  def test_escape
+    pointer = Hana::Pointer.new '/f^/oo/bar'
+    assert_equal ['f/oo', 'bar'], pointer.to_a
+
+    pointer = Hana::Pointer.new '/f^^oo/bar'
+    assert_equal ['f^oo', 'bar'], pointer.to_a
+  end
+
+  def test_eval_hash
+    pointer = Hana::Pointer.new '/foo'
+    assert_equal 'bar', pointer.eval('foo' => 'bar')
+
+    pointer = Hana::Pointer.new '/foo/bar'
+    assert_equal 'baz', pointer.eval('foo' => { 'bar' => 'baz' })
+  end
+
+  def test_eval_array
+    pointer = Hana::Pointer.new '/foo/1'
+    assert_equal 'baz', pointer.eval('foo' => ['bar', 'baz'])
+
+    pointer = Hana::Pointer.new '/foo/0/bar'
+    assert_equal 'omg', pointer.eval('foo' => [{'bar' => 'omg'}, 'baz'])
+  end
+
+  def test_eval_number_as_key
+    pointer = Hana::Pointer.new '/foo/1'
+    assert_equal 'baz', pointer.eval('foo' => { '1' => 'baz' })
+  end
+end

data/test/test_patch.rb

@@ -0,0 +1,153 @@
+require 'helper'
+
+module Hana
+  class TestPatch < TestCase
+    def test_add_member
+      patch = Hana::Patch.new [
+        { 'add' => '/baz', 'value' => 'qux' }
+      ]
+
+      result = patch.apply('foo' => 'bar')
+      assert_equal({'baz' => 'qux', 'foo' => 'bar'}, result)
+    end
+
+    def test_add_array
+      patch = Hana::Patch.new [
+        { "add" => "/foo/1", "value" => "qux" }
+      ]
+
+      result = patch.apply({ "foo" => [ "bar", "baz" ] })
+
+      assert_equal({ "foo" => [ "bar", "qux", "baz" ] }, result)
+    end
+
+    def test_remove_object_member
+      patch = Hana::Patch.new [ { "remove" => "/baz" } ]
+
+      result = patch.apply({ 'baz' => 'qux', 'foo' => 'bar' })
+
+      assert_equal({ "foo" => 'bar' }, result)
+    end
+
+    def test_remove_array_element
+      patch = Hana::Patch.new [ { "remove" => "/foo/1" } ]
+      result = patch.apply({ "foo" => [ "bar", "qux", "baz" ] })
+      assert_equal({ "foo" => [ "bar", "baz" ] }, result)
+    end
+
+    def test_replace_value
+      patch = Hana::Patch.new [ { "replace" => "/baz", "value" => "boo" } ]
+      result = patch.apply({ "baz" => "qux", "foo" => "bar" })
+      assert_equal({ "baz" => "boo", "foo" => "bar" }, result)
+    end
+
+    def test_moving_a_value
+      doc = {
+        "foo" => {
+          "bar"   => "baz",
+          "waldo" => "fred"
+        },
+        "qux" => {
+          "corge" => "grault"
+        }
+      }
+
+      patch = [ { "move" => "/foo/waldo", 'to' => "/qux/thud" } ]
+
+      expected = {
+        "foo" =>  {
+          "bar" =>  "baz"
+        },
+        "qux" =>  {
+          "corge" =>  "grault",
+          "thud" =>  "fred"
+        }
+      }
+
+      patch = Hana::Patch.new patch
+      result = patch.apply doc
+      assert_equal expected, result
+    end
+
+    def test_move_an_array_element
+      # An example target JSON document:
+      doc = {
+        "foo" => [ "all", "grass", "cows", "eat" ]
+      }
+
+      # A JSON Patch document:
+      patch = [
+        { "move" => "/foo/1", "to" => "/foo/3" }
+      ]
+
+      # The resulting JSON document:
+      expected = {
+        "foo" => [ "all", "cows", "eat", "grass" ]
+      }
+
+      patch = Hana::Patch.new patch
+      result = patch.apply doc
+      assert_equal expected, result
+    end
+
+    def test_testing_a_value_success
+      # An example target JSON document:
+      doc = {
+        "baz" => "qux",
+        "foo" => [ "a", 2, "c" ]
+      }
+
+      # A JSON Patch document that will result in successful evaluation:
+      patch = [
+          { "test" => "/baz", "value" => "qux" },
+          { "test" => "/foo/1", "value" => 2 },
+          { "add" => "/bar", "value" => 2 },
+      ]
+
+      expected = {
+        "baz" => "qux",
+        "foo" => [ "a", 2, "c" ],
+        'bar' => 2
+      }
+
+      patch = Hana::Patch.new patch
+      result = patch.apply doc
+      assert_equal expected, result
+    end
+
+    def test_testing_a_value_error
+      # An example target JSON document:
+      doc = { "baz" => "qux" }
+
+      # A JSON Patch document that will result in an error condition:
+      patch = [
+        { "test" => "/baz", "value" => "bar" }
+      ]
+
+      patch = Hana::Patch.new patch
+
+      assert_raises(Hana::Patch::Exception) do
+        patch.apply doc
+      end
+    end
+
+    def test_add_nested_member_object
+      # An example target JSON document:
+      doc = { "foo" => "bar" }
+      # A JSON Patch document:
+      patch = [
+        { "add" => "/child", "value" => { "grandchild" => { } } }
+      ]
+
+      # The resulting JSON document:
+      expected = {
+        "foo" => "bar",
+        "child" => { "grandchild" => { } }
+      }
+
+      patch = Hana::Patch.new patch
+      result = patch.apply doc
+      assert_equal expected, result
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: hana
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Implementation of JSON Patch and JSON Pointer drafts.
+email:
+- aaron@tenderlovemaking.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/hana.rb
+- test/helper.rb
+- test/test_hana.rb
+- test/test_patch.rb
+- .gemtest
+homepage: http://github.com/tenderlove/hana
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+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: hana
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Implementation of JSON Patch and JSON Pointer drafts.
+test_files:
+- test/test_hana.rb
+- test/test_patch.rb