json_refs 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4f17701df4b9c089a11c31f6bde308873931802
-  data.tar.gz: 6f581341bdf53bf52e6b27ce88a774a805ad8e66
+SHA256:
+  metadata.gz: f9d9b14ec87e1407d7d3b00072fb482411ca869be27fb0a0834b318f36fe67bf
+  data.tar.gz: a2da652fad017f11c8351cea424d5bf9771e1d316fb23c953f28d7f2d34601d9
 SHA512:
-  metadata.gz: 4f29bdc8161c0a125a6875e3171cbaa6519c57027eeb28ab4a6be3f22fe7374917b9e0ce2fb323c56b8e13bdcd0509f36e1373425d3e9a98233df638fb70ccbd
-  data.tar.gz: cfc0d80386cde5a632ca668011c94aefcebca2e62fe81c355533a0584199ef35e48111ec866e4e289a22a7ebbe08d4deec44850852548cb4ee9d319d8524d706
+  metadata.gz: 227cfbe8ae21a70547f77dd3985b6d7f2213d053e9691edf025cedb884f1a810a019399ab6ec0bba649370ce1da21490f102ceb4977643f968112f558ac671e8
+  data.tar.gz: 9022c0601623fe3c21cfafe5b480ae5c2feeefd2dff89cc6a436b54d0087ab275aaee11c683af8aa1239abdef21baec7476fe3d93743a322272ee24b9ab8c998

data/.travis.yml

@@ -1,7 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.1.10
-  - 2.2.8
   - 2.3.5
   - 2.4.2
+  - 2.5.1

data/README.md

@@ -39,8 +39,30 @@ json = {
     '$ref' => 'http://httpbin.org/user-agent'
   }
 }
+JsonRefs.(json)
 ```
 
+YAML is also available for file format.
+```ruby
+json = {
+  'a' => {
+    '$ref' => '/path/to/yaml.yml'
+  },
+  'b' => {
+    '$ref' => '/path/to/yaml.yaml'
+  }
+}
+JsonRefs.(json)
+```
+
+In case you don't want to resolve local references or file references, you have the following options 
+to pass down when you initialize the JSONRefs. If you don't pass the following, both references will be resolved.
+```ruby
+JsonRefs.(json, { resolve_local_ref: false, resolve_file_ref: true })
+```
+
+JSONRef supports recursive reference resolving. If one the files that you reference have another reference in it, JSONRef will try to automatically resolve that.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/json_refs.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "hana"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/json_refs.rb

@@ -2,13 +2,14 @@ require 'json_refs/version'
 require 'json_refs/dereference_handler'
 
 module JsonRefs
-  def self.call(doc)
-    Dereferencer.new(doc).call
+  def self.call(doc, options = {})
+    Dereferencer.new(doc, options).call
   end
 
   class Dereferencer
-    def initialize(doc)
+    def initialize(doc, options = {})
       @doc = doc
+      @options = options
     end
 
     def call(doc = @doc, keys = [])
@@ -39,8 +40,53 @@ module JsonRefs
     end
 
     def referenced_value(referenced_path)
-      klass = referenced_path =~ /^#/ ? JsonRefs::DereferenceHandler::Local : JsonRefs::DereferenceHandler::File
+      if @options[:logging] == true
+        puts "De-referencing #{referenced_path}"
+      end
+
+      if referenced_path =~ /^#/
+        dereference_local(referenced_path)
+      else
+        dereference_file(referenced_path)
+      end
+    end
+
+    def dereference_local(referenced_path)
+      if @options[:resolve_local_ref] === false
+        return { '$ref': referenced_path }
+      end
+
+      klass = JsonRefs::DereferenceHandler::Local
       klass.new(path: referenced_path, doc: @doc).call
     end
+
+    def dereference_file(referenced_path)
+      if @options[:resolve_file_ref] === false
+        return { '$ref': referenced_path }
+      end
+
+      klass = JsonRefs::DereferenceHandler::File
+
+      # Checking for "://" in a URL like http://something.com so as to determine if it's a remote URL
+      remote_uri = referenced_path =~ /:\/\//
+
+      if remote_uri
+        klass.new(path: referenced_path, doc: @doc).call
+      else
+        recursive_dereference(referenced_path, klass)
+      end
+    end
+
+    def recursive_dereference(referenced_path, klass)
+      directory = File.dirname(referenced_path)
+      filename = File.basename(referenced_path)
+      
+      dereferenced_doc = {}
+      Dir.chdir(directory) do
+        referenced_doc = klass.new(path: filename, doc: @doc).call
+        dereferenced_doc = Dereferencer.new(referenced_doc, @options).call
+      end
+      dereferenced_doc
+    end
   end
 end

data/lib/json_refs/version.rb

@@ -1,3 +1,3 @@
 module JsonRefs
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_refs
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Makoto Tajitsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-19 00:00:00.000000000 Z
+date: 2020-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -106,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Dereference JSON Pointer