json-pointer 0.0.1

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2013 Apollic Software, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Apollic Software, LLC nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,87 @@
+# JsonPointer [![Build Status](https://travis-ci.org/tent/json-pointer-ruby.png)](https://travis-ci.org/tent/json-pointer-ruby)
+
+[JSON Pointer](http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-09) implementation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'json-pointer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-pointer
+
+## Usage
+
+```ruby
+hash = { :foo => { :bar => [{ :baz => "foobar" }, { :hello => "world" }, { :baz => "water" }] } }
+
+## Simple pointer
+
+pointer = JsonPointer.new(hash, "/foo/bar", :symbolize_keys => true)
+pointer.exists? # => true
+pointer.value # => [{ :baz => "foobar" }, { :hello => "world" }, { :baz => "water" }]
+
+pointer = JsonPointer.new(hash, "/baz/bar/foo", :symbolize_keys => true)
+pointer.exists? # => false
+pointer.value = "Hello World!"
+hash[:baz] # => { :bar => { :foo => "Hello World" } }
+
+pointer = JsonPointer.new(hash, "/biz", :symbolize_keys => true)
+pointer.exists? # => false
+pointer.value # => nil
+
+## Simple pointer with Array index
+
+pointer = JsonPointer.new(hash, "/foo/bar/0/baz", :symbolize_keys => true)
+pointer.value # => "foobar"
+
+## Insert member into array specific index
+
+pointer = JsonPointer.new(hash, "/foo/bar/1", :symbolize_keys => true)
+pointer.value = { :baz => "foo" }
+hash[:foo][:bar] # => [{ :baz => "foobar" }, { :baz => "foo" }, { :hello => "world" }, { :baz => "water" }]
+
+## Append member to array
+
+pointer = JsonPointer.new(hash, "/foo/bar/-", :symbolize_keys => true)
+pointer.value = { :baz => "bar" }
+hash[:foo][:bar] # => [{ :baz => "foobar" }, { :baz => "foo" }, { :hello => "world" }, { :baz => "water" }, { :baz => "bar" }]
+
+## Delete array member
+
+pointer = JsonPointer.new(hash, "/foo/bar/1", :symbolize_keys => true)
+pointer.delete
+hash[:foo][:bar] # => [{ :baz => "foobar" }, { :hello => "world" }, { :baz => "water" }, { :baz => "bar" }]
+pointer.delete
+hash[:foo][:bar] # => [{ :baz => "foobar" }, { :baz => "water" }, { :baz => "bar" }]
+
+## Array index Wildcard (NOTE: this is not part of the spec)
+
+pointer = JsonPointer.new(hash, "/foo/bar/*/baz", :symbolize_keys => true)
+pointer.value # => ["foobar", nil, "water"]
+
+pointer = JsonPointer.new(hash, "/foo/bar/*/fire", :symbolize_keys => true)
+pointer.value = "dirt"
+pointer.value # => ["dirt", "dirt", "dirt"]
+hash[:foo][:bar] # => [{ :baz => "foobar", :fire => "dirt" }, { :baz => "water", :fire => "dirt" }, { :baz => "bar", :fire => "dirt" }]
+```
+
+### Options
+
+name | description
+---- | -----------
+symbolize_keys | Set to `true` if the hash uses symbols for keys. Default is `false`.
+
+## 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,8 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :default => :spec

data/json-pointer.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json-pointer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "json-pointer"
+  gem.version       = JsonPointer::VERSION
+  gem.authors       = ["Jesse Stuart"]
+  gem.email         = ["jesse@jessestuart.ca"]
+  gem.description   = %q{JSON Pointer implementation}
+  gem.summary       = %q{JSON Pointer implementation}
+  gem.homepage      = ""
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '~> 2.11'
+  gem.add_development_dependency 'rake'
+end

data/lib/json-pointer.rb

@@ -0,0 +1,169 @@
+require "json-pointer/version"
+
+class JsonPointer
+
+  NotFound = Class.new
+  WILDCARD = "*".freeze
+  ARRAY_PUSH_KEY = '-'.freeze
+
+  def initialize(hash, path, options = {})
+    @hash, @path, @options = hash, path, options
+  end
+
+  def value
+    get_member_value
+  end
+
+  def value=(new_value)
+    set_member_value(new_value)
+  end
+
+  def delete
+    delete_member
+  end
+
+  def exists?
+    _exists = false
+    get_target_member(@hash, path_fragments.dup) do |target|
+      _exists = true unless NotFound === target
+    end
+    _exists
+  end
+
+  private
+
+  def get_member_value(obj = @hash, fragments = path_fragments.dup)
+    return obj if fragments.empty?
+
+    fragment = fragments.shift
+    case obj
+    when Hash
+      get_member_value(obj[fragment_to_key(fragment)], fragments)
+    when Array
+      if fragment == WILDCARD
+        obj.map { |i| get_member_value(i, fragments.dup) }
+      else
+        get_member_value(obj[fragment_to_index(fragment)], fragments)
+      end
+    end
+  end
+
+  def get_target_member(obj, fragments, options = {}, &block)
+    return yield(obj) if fragments.empty?
+
+    fragment = fragments.shift
+    case obj
+    when Hash
+      key = fragment_to_key(fragment)
+      obj = if options[:create_missing]
+        obj[key] ||= Hash.new
+      else
+        obj.has_key?(key) ? obj[key] : NotFound.new
+      end
+
+      get_target_member(obj, fragments, options, &block)
+    when Array
+      if fragment == WILDCARD
+        obj.each do |i|
+          get_target_member(i || Hash.new, fragments.dup, options, &block)
+        end
+      else
+        index = fragment_to_index(fragment)
+        obj = if options[:create_missing]
+          obj[index] ||= Hash.new
+        else
+          index >= obj.size ? NotFound.new : obj[index]
+        end
+
+        get_target_member(obj, fragments, &block)
+      end
+    else
+      NotFound.new
+    end
+  end
+
+  def set_member_value(new_value)
+    obj = @hash
+    fragments = path_fragments.dup
+
+    return if fragments.empty?
+
+    target_fragment = fragments.pop
+
+    if target_fragment == ARRAY_PUSH_KEY
+      target_parent_fragment = fragments.pop
+    end
+
+    get_target_member(obj, fragments, :create_missing => true) do |target|
+      if target_fragment == ARRAY_PUSH_KEY
+        case target
+        when Hash
+          key = fragment_to_key(target_parent_fragment)
+        when Array
+          key = fragment_to_index(target_parent_fragment)
+        end
+
+        target[key] ||= Array.new
+        if Array === target[key]
+          target[key].push(new_value)
+          return new_value
+        else
+          return
+        end
+      end
+
+      case target
+      when Hash
+        target[fragment_to_key(target_fragment)] = new_value
+      when Array
+        if target_fragment == WILDCARD
+          target.map! { new_value }
+        else
+          target.insert(fragment_to_index(target_fragment), new_value)
+        end
+      end
+    end
+  end
+
+  def delete_member
+    obj = @hash
+    fragments = path_fragments.dup
+
+    return if fragments.empty?
+
+    target_fragment = fragments.pop
+    get_target_member(obj, fragments) do |target|
+      case target
+      when Hash
+        target.delete(fragment_to_key(target_fragment))
+      when Array
+        if target_fragment == WILDCARD
+          target.replace([])
+        else
+          target.delete_at(fragment_to_index(target_fragment))
+        end
+      end
+    end
+  end
+
+  def path_fragments
+    @path_fragments ||= @path.sub(%r{\A/}, '').split("/").map { |fragment| unescape_fragment(fragment) }
+  end
+
+  def unescape_fragment(fragment)
+    fragment.gsub(/~1/, '/').gsub(/~0/, '~')
+  end
+
+  def fragment_to_key(fragment)
+    if @options[:symbolize_keys]
+      fragment.to_sym
+    else
+      fragment
+    end
+  end
+
+  def fragment_to_index(fragment)
+    fragment.to_i
+  end
+
+end

data/lib/json-pointer/version.rb

@@ -0,0 +1,3 @@
+class JsonPointer
+  VERSION = "0.0.1"
+end

data/spec/json_pointer_spec.rb

@@ -0,0 +1,303 @@
+require "spec_helper"
+require "json-pointer"
+
+describe JsonPointer do
+  let(:hash) do
+    {
+      :water => ["river", "lake", "ocean", "pond", "everything else"],
+      :fire => {
+        :water => {
+          :wind => "earth"
+        },
+        :dirt => [
+          { :foo => "bar", :hello => "world" },
+          { :baz => "biz" }
+        ]
+      }
+    }
+  end
+
+  let(:path) { "" }
+  let(:path_fragments) { path.split('/') }
+  let(:pointer) { described_class.new(hash, path, :symbolize_keys => true) }
+  let(:parent_pointer) {
+    described_class.new(hash, path_fragments[0..-2].join('/'), :symbolize_keys => true)
+  }
+  let(:expected_parent_value) {}
+
+  describe "#exists?" do
+    shared_examples "a checker method" do
+      context "when member exists" do
+        it "returns true" do
+          expect(pointer.exists?).to be_true
+        end
+      end
+
+      context "when member exists and is nil" do
+        it "returns true" do
+          pointer.value = nil
+          expect(pointer.exists?).to be_true
+        end
+      end
+
+      context "when member doesn't exist" do
+        let(:hash) { Hash.new }
+
+        it "returns false" do
+          expect(pointer.exists?).to be_false
+          expect(hash).to eq(Hash.new)
+        end
+      end
+    end
+
+    context "when array index" do
+      let(:path) { %(/water/2) }
+
+      it_behaves_like "a checker method"
+    end
+
+    context "when in member of array index" do
+      let(:path) { %(/fire/dirt/0/hello) }
+
+      it_behaves_like "a checker method"
+    end
+
+    context "when array wildcard" do
+      let(:path) { %(/fire/dirt/*) }
+
+      it_behaves_like "a checker method"
+    end
+
+    context "when in member of array windcard" do
+      let(:path) { %(/fire/dirt/*/hello) }
+
+      it_behaves_like "a checker method"
+    end
+
+    context "when object member" do
+      let(:path) { %(/fire/water/wind) }
+
+      it_behaves_like "a checker method"
+
+      context "when not existant" do
+        let(:path) { %(/foo) }
+
+        it "returns false" do
+          expect(pointer.exists?).to be_false
+        end
+      end
+    end
+  end
+
+  describe "#value" do
+    shared_examples "a getter method" do
+      context "when member exists" do
+        it "returns value of referenced member" do
+          expect(pointer.value).to eql(expected_value)
+        end
+      end
+
+      context "when member doesn't exist" do
+        let(:hash) { Hash.new }
+
+        it "returns nil" do
+          expect(pointer.value).to be_nil
+        end
+      end
+    end
+
+    context "when array index" do
+      let(:path) { %(/water/2) }
+      let(:expected_value) { hash[:water][2] }
+
+      it_behaves_like "a getter method"
+    end
+
+    context "when in member of array index" do
+      let(:path) { %(/fire/dirt/0/hello) }
+      let(:expected_value) { hash[:fire][:dirt][0][:hello] }
+
+      it_behaves_like "a getter method"
+    end
+
+    context "when array wildcard" do
+      let(:path) { %(/fire/dirt/*) }
+      let(:expected_value) { hash[:fire][:dirt] }
+
+      it_behaves_like "a getter method"
+    end
+
+    context "when in member of array windcard" do
+      let(:path) { %(/fire/dirt/*/hello) }
+      let(:expected_value) { ["world", nil] }
+
+      it_behaves_like "a getter method"
+    end
+
+    context "when object member" do
+      let(:path) { %(/fire/water/wind) }
+      let(:expected_value) { hash[:fire][:water][:wind] }
+
+      it_behaves_like "a getter method"
+    end
+  end
+
+  describe "#value=" do
+    let(:asymmetric) { false }
+
+    shared_examples "a setter method" do
+      context "when parent member exists" do
+        it "sets referenced member value" do
+          pointer.value = value
+
+          unless asymmetric
+            expect(pointer.value).to eql(value)
+          end
+
+          if expected_parent_value
+            expect(parent_pointer.value).to eql(expected_parent_value)
+          end
+        end
+      end
+
+      context "when parent member doesn't exist" do
+        let(:hash) { Hash.new }
+
+        it "sets referenced member value" do
+          pointer.value = value
+          expect(pointer.value).to eql(value)
+        end
+      end
+    end
+
+    context "when array index" do
+      let(:path) { %(/water/2) }
+      let(:value) { "swamp" }
+      let(:expected_parent_value) { ["river", "lake", value, "ocean", "pond", "everything else"] }
+
+      it_behaves_like "a setter method"
+
+      context "when appending to array" do
+        let(:path) { %(/water/-) }
+        let(:expected_parent_value) { ["river", "lake", "ocean", "pond", "everything else", value] }
+      end
+
+      context "when array doesn't exist" do
+        let(:path) { %(/water/-) }
+        let(:hash) { Hash.new }
+        let(:expected_parent_value) { [value] }
+
+        it_behaves_like "a setter method"
+      end
+    end
+
+    context "when in member of array index" do
+      let(:path) { %(/fire/dirt/0/biz) }
+      let(:value) { "baz" }
+      let(:expected_parent_value) { { :foo => "bar", :hello => "world", :biz => value } }
+
+      it_behaves_like "a setter method"
+    end
+
+    context "when array wildcard" do
+      let(:path) { %(/water/*) }
+      let(:value) { "baz" }
+      let(:asymmetric) { true }
+      let(:expected_parent_value) { [value, value, value, value, value] }
+
+      it_behaves_like "a setter method"
+    end
+
+    context "when in member of array windcard" do
+      let(:path) { %(/fire/dirt/*/gash) }
+      let(:value) { "very deep!" }
+      let(:asymmetric) { true }
+      let(:expected_parent_value) {
+        [
+          { :gash => value, :foo => "bar", :hello => "world" },
+          { :gash => value, :baz => "biz" }
+        ]
+      }
+
+      it_behaves_like "a setter method"
+    end
+
+    context "when object member" do
+      let(:path) { %(fire/water/foo) }
+      let(:value) { "Foo Bar!" }
+
+      it_behaves_like "a setter method"
+    end
+  end
+
+  describe "#delete" do
+    let(:asymmetric) { false }
+
+    shared_examples "a delete method" do
+      context "when parent member exists" do
+        it "deletes referenced member" do
+          pointer.delete
+
+          unless asymmetric
+            expect(pointer.value).to be_nil
+          end
+
+          if expected_parent_value
+            expect(parent_pointer.value).to eql(expected_parent_value)
+          end
+        end
+      end
+
+      context "when parent member doesn't exist" do
+        let(:hash) { Hash.new }
+
+        it "does nothing" do
+          pointer.delete
+          expect(pointer.value).to be_nil
+        end
+      end
+    end
+
+    context "when array index" do
+      let(:path) { %(/water/2) }
+      let(:asymmetric) { true }
+      let(:expected_parent_value) { ["river", "lake", "pond", "everything else"] }
+
+      it_behaves_like "a delete method"
+    end
+
+    context "when in member of array index" do
+      let(:path) { %(/fire/dirt/0/foo) }
+      let(:expected_parent_value) { { :hello => "world" } }
+
+      it_behaves_like "a delete method"
+    end
+
+    context "when array wildcard" do
+      let(:path) { %(/water/*) }
+      let(:asymmetric) { true }
+      let(:expected_parent_value) { [] }
+
+      it_behaves_like "a delete method"
+    end
+
+    context "when in member of array windcard" do
+      let(:path) { %(/fire/dirt/*/foo) }
+      let(:asymmetric) { true }
+      let(:expected_parent_value) {
+        [
+          { :hello => "world" },
+          { :baz => "biz" }
+        ]
+      }
+
+      it_behaves_like "a delete method"
+    end
+
+    context "when object member" do
+      let(:path) { %(fire/water/foo) }
+
+      it_behaves_like "a delete method"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: json-pointer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jesse Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: JSON Pointer implementation
+email:
+- jesse@jessestuart.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- json-pointer.gemspec
+- lib/json-pointer.rb
+- lib/json-pointer/version.rb
+- spec/json_pointer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: JSON Pointer implementation
+test_files:
+- spec/json_pointer_spec.rb
+- spec/spec_helper.rb