json-ref 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec764bcb2049b661551c8b11b02739eed7cbccbb
+  data.tar.gz: cba8f213b0bc0b23203d57a9d8d59c83ef9547e4
+SHA512:
+  metadata.gz: d8c0507b4098b9fa1872750b0451cd52c7309f33bf38372a7cacd3ce197898c506f40587d6af4fad524132dcb226e3445b5bb9a8357d39153100446be22b323c
+  data.tar.gz: 74b96eb1e2a910141a03f168af12af1939552899d1ec140b446124ebee85acdc1a01f69f32a87a10daf53a95ea85f81fcd22c598d17539964604be94ad838aa3

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

@@ -0,0 +1,3 @@
+.DS_Store
+.ruby-version
+*.gem

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode

data/README.md

@@ -0,0 +1,62 @@
+# JSON Ref
+
+[![Build Status](https://travis-ci.org/nmerouze/json-ref.png)](https://travis-ci.org/nmerouze/json-ref)
+[![Code Climate](https://codeclimate.com/github/nmerouze/json-ref.png)](https://codeclimate.com/github/nmerouze/json-ref)
+
+Partial implementation of [JSON Ref](http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-00) draft. The URI can only contain a fragment pointing to a value inside the document at this moment.
+
+## Install
+
+Add this line to your application's Gemfile:
+
+    gem 'json-ref'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-ref
+
+## Usage
+
+```ruby
+origin_doc = { 'title' => 'foobar', 'ref_title' => { '$ref' => '#/title' } }
+JSONRef.new(origin_doc).expand
+# => 
+{ 'title' => 'foobar', 'ref_title' => 'foobar' }
+```
+
+## 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
+
+## License
+
+Copyright (c) 2013 Nicolas Mérouze
+
+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/Rakefile

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

data/json-ref.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-ref'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-ref"
+  spec.version       = JSONRef::VERSION
+  spec.authors       = ["Nicolas Mérouze"]
+  spec.email         = ["nicolas@merouze.me"]
+  spec.description   = %q{An implementation of JSON Ref.}
+  spec.summary       = %q{An implementation of JSON Ref.}
+  spec.homepage      = "https://github.com/nmerouze/json-ref"
+  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 "rake"
+end

data/lib/json-ref.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+class JSONRef
+  VERSION = '0.1.0'
+  
+  def initialize(document)
+    @document = document
+  end
+
+  def expand
+    @document.each do |k,v|
+      if v.is_a?(Hash) && v.has_key?('$ref')
+        @document[k] = split_path(v['$ref']).inject(@document) { |doc, item| doc[item] }
+      end
+    end
+  end
+
+  def self.expand(document)
+    self.new(document).expand
+  end
+
+  private
+
+  def split_path(path)
+    escape_characters = {'^/' => '/', '^^' => '^', '~0' => '~', '~1' => '/'}
+    return [''] if path == '#/'
+
+    path.sub(/^#\//, '').split(/(?<!\^)\//).map! { |part|
+      part.gsub!(/\^[\/^]|~[01]/) { |m| escape_characters[m] }; part
+    }
+  end
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require 'minitest/autorun'
+require 'json-ref'

data/test/test_json-ref.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestJSONRef < MiniTest::Unit::TestCase
+  def test_expand_string
+    origin_doc = { 'title' => 'foobar', 'ref_title' => { '$ref' => '#/title' } }
+    result_doc = { 'title' => 'foobar', 'ref_title' => 'foobar' }
+
+    assert_equal result_doc, JSONRef.new(origin_doc).expand
+  end
+
+  def test_expand_hash
+    origin_doc = { 'title' => { 'value' => 'foobar' }, 'ref_title' => { '$ref' => '#/title' } }
+    result_doc = { 'title' => { 'value' => 'foobar' }, 'ref_title' => { 'value' => 'foobar' } }
+
+    assert_equal result_doc, JSONRef.new(origin_doc).expand
+  end
+
+  def test_expand_complex_path
+    origin_doc = { 'nested' => { 'title' => 'foobar' }, 'ref_title' => { '$ref' => '#/nested/title' } }
+    result_doc = { 'nested' => { 'title' => 'foobar' }, 'ref_title' => 'foobar' }
+
+    assert_equal result_doc, JSONRef.new(origin_doc).expand
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: json-ref
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Mérouze
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-23 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: An implementation of JSON Ref.
+email:
+- nicolas@merouze.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- .travis.yml
+- README.md
+- Rakefile
+- json-ref.gemspec
+- lib/json-ref.rb
+- test/helper.rb
+- test/test_json-ref.rb
+homepage: https://github.com/nmerouze/json-ref
+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.2
+signing_key: 
+specification_version: 4
+summary: An implementation of JSON Ref.
+test_files:
+- test/helper.rb
+- test/test_json-ref.rb