yaml_ref_resolver 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3bdcefb35a561156f4754b283fbcd71d7d8449d
-  data.tar.gz: 81ca97d34cecf8810c18e35997679d3306b0f4b8
+  metadata.gz: 6d4882401e5d1c715b36e46f519f6a8d515d7de0
+  data.tar.gz: 5239f1e9452262ec88db8290f386286fb2b109c2
 SHA512:
-  metadata.gz: cd321cfccdcb94e42dab3ae1fa536b9faa29d2c6df4c7fd61c186e4bdd5c06e981eafa294528a978452c814d89b4bcd3a9677b6575d05fb75ec26061fa583a52
-  data.tar.gz: 0f62c98bec120acf7ae891d1efb1319d2c9086b36b811fe80beef196ab0acfef7ed55d2cf6ebbcb5ef9f65ea00fa57c5f038e1cf20b14c113967a278c0457c3f
+  metadata.gz: b3de45170a5202ae9e3a37164e49a017b11bd8354ce2e7c17101b1be89bee460f519774d2bcb05bfdf9d0a8233a11fb4ceca008e40be1778eadb807fb9a05e07
+  data.tar.gz: ab1e5195c2737bf85d413220b979b83d1b494225f293a4d312ac92aae7c1fe7e8567f5a7f55856cabe392b8d7f920845d0de3c95df11c02a7f32ce85cb1c4e97

data/README.md

@@ -1,5 +1,8 @@
 # YamlRefResolver
 
+[![Gem Version](https://badge.fury.io/rb/yaml_ref_resolver.svg)](https://badge.fury.io/rb/yaml_ref_resolver)
+[![Build Status](https://travis-ci.org/Joe-noh/yaml_ref_resolver.svg?branch=master)](https://travis-ci.org/Joe-noh/yaml_ref_resolver)
+
 This is a gem that resolves `$ref` references to other YAML files.
 
 ## Installation
@@ -12,10 +15,34 @@ gem 'yaml_ref_resolver'
 
 ## Usage
 
+Assume that we have following yaml files.
+
+```yaml
+# index.yaml
+author:
+  $ref: './john.yaml#/profile'
+```
+
+```yaml
+# john.yaml
+profile:
+  name: John
+  age: 28
+```
+
+This gem resolves `$ref` references.
+
 ```ruby
 resolver = YamlRefResolver.new
 
-hash = resolver.resolve("index.yaml")
+hash = resolver.resolve('index.yaml')
+#=> {'author' => {'name' => "john", 'age' => 28}}
+```
+
+Optionally you can specify the key.
+
+```ruby
+resolver = YamlRefResolver.new(key: '$import')
 ```
 
 ## Contributing

data/lib/yaml_ref_resolver.rb

@@ -2,8 +2,8 @@ require "yaml_ref_resolver/version"
 require "yaml"
 
 class YamlRefResolver
-  def initialize
-    @key = '$ref'
+  def initialize(opts = {})
+    @key = opts[:key] || '$ref'
   end
 
   def resolve(path)
@@ -25,7 +25,7 @@ class YamlRefResolver
         ref_path = File.join(base, path)
         ref = self.resolve(ref_path)
 
-        pos.split('/').inject(ref) {|obj, key| obj[key] }
+        pos.split('/').reject {|e| e == "" }.inject(ref) {|obj, key| obj[key] }
       else
         Hash[k, resolve_refs(v, base)]
       end

data/lib/yaml_ref_resolver/version.rb

@@ -1,3 +1,3 @@
 class YamlRefResolver
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/yaml_ref_resolver.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml_ref_resolver
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joe-noh
@@ -96,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="