json_refs 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e623d13bcd51a7a1e254203e15c508065467469b
-  data.tar.gz: 3a3ad67d1afd4df069fa1f4810a0a8ed20a03232
+SHA256:
+  metadata.gz: 873527fb07ff698ff5cae1f2954cf403e876c2e6353fb5a395e7eab5517dd08a
+  data.tar.gz: d9d3c3a6b2493f1150c29a1834b72a474089690e0aab0ad4d6e32670dfa55e74
 SHA512:
-  metadata.gz: 582f64c455143f262e407f97aabf3e4223ff7d59dab9c0d5a0ff6fa2ff874b287a063a583845e3cf77749565412dc881dbfd57e0a24346dcdc6cef39023fa48d
-  data.tar.gz: d23cc3d915cadca4a3b1b70c25cd2d63fc80ddd043e4e27d66eb73d676916805f57b86f9cc8eaeec707b9dfd47569ebc1992851f1c509c86b0921d9e2e333100
+  metadata.gz: f1ef5cb22467df59eb10e0a0f4bdc5fbdcae6e6260f7d8f59a26b34447b325a8d2bb4bec2c31715c997c99a2e071c6669692fc3f8620c9495915a740cd191a4e
+  data.tar.gz: 719c2b6dd54023a0f788d30ddc3caa0526bff1c3f80bfa6c1f395b399cd11f8d77563283c03c2da42802abf49e8ca50eec602709498ee2fd95b9d3da9c718764

data/.travis.yml

@@ -1,5 +1,13 @@
 sudo: false
+
 language: ruby
+
 rvm:
-  - jruby-head
-  - 2.4.2
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+
+before_install:
+  - gem install -N bundler

data/README.md

@@ -29,6 +29,40 @@ json = { 'a' => 'foo', 'b' => { '$ref' => '#/a' } }
 JsonRefs.(json) # {"a"=>"foo", "b"=>"foo"}
 ```
 
+local path or remote url is available
+```ruby
+json = {
+  'a' => {
+    '$ref' => '/path/to/file'
+  },
+  'b' => {
+    '$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 "rake", "~> 10.0"
+  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

@@ -1,16 +1,19 @@
-require "json_refs/version"
-require 'hana'
-require 'net/http'
-require 'json'
+require 'json_refs/version'
+require 'json_refs/dereference_handler'
 
 module JsonRefs
-  def self.call(doc)
-    Dereferencer.new(doc).call
+  class << self
+    def call(doc, options = {})
+      Dereferencer.new(doc, options).call
+    end
+
+    alias_method :dereference, :call
   end
 
   class Dereferencer
-    def initialize(doc)
+    def initialize(doc, options = {})
       @doc = doc
+      @options = options
     end
 
     def call(doc = @doc, keys = [])
@@ -41,15 +44,59 @@ module JsonRefs
     end
 
     def referenced_value(referenced_path)
-      if referenced_path =~ /^#/
-        Hana::Pointer.new(referenced_path[1..-1]).eval(@doc)
-      elsif referenced_path =~ /^(http:\/\/|https:\/\/)/
-        json = Net::HTTP.get(URI.parse(referenced_path))
-        JSON.load(json)
+      if @options[:logging] == true
+        puts "De-referencing #{referenced_path}"
+      end
+
+      filepath, pointer = referenced_path.split('#')
+      pointer.prepend('#') if pointer
+      return dereference_local(pointer) if filepath.empty?
+
+      dereferenced_file = dereference_file(filepath)
+      return dereferenced_file if pointer.nil?
+
+      JsonRefs::DereferenceHandler::Local.new(
+        doc: dereferenced_file,
+        path: pointer
+      ).call
+    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
-        f = File.open(referenced_path)
-        JSON.load(f)
+        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/dereference_handler.rb

@@ -0,0 +1,27 @@
+require 'hana'
+require 'json_refs/loader'
+
+module JsonRefs
+  module DereferenceHandler
+    class File
+      def initialize(options = {})
+        @path = options.fetch(:path)
+      end
+
+      def call
+        JsonRefs::Loader.handle(@path)
+      end
+    end
+
+    class Local
+      def initialize(options = {})
+        @path = options.fetch(:path)
+        @doc = options.fetch(:doc)
+      end
+
+      def call
+        Hana::Pointer.new(@path[1..-1]).eval(@doc)
+      end
+    end
+  end
+end

data/lib/json_refs/loader.rb

@@ -0,0 +1,53 @@
+require 'open-uri'
+require 'json'
+require 'yaml'
+
+module JsonRefs
+  class Loader
+    class Json
+      def call(file)
+        JSON.load(file)
+      end
+    end
+
+    class Yaml
+      def call(file)
+        YAML.load(file)
+      end
+    end
+
+    EXTENSIONS = {
+      'json' => JsonRefs::Loader::Json,
+      'yaml' => JsonRefs::Loader::Yaml,
+      'yml' => JsonRefs::Loader::Yaml,
+    }.freeze
+
+    def self.handle(filename)
+      new.handle(filename)
+    end
+
+    def handle(filename)
+      @body = read_reference_file(filename)
+      ext = File.extname(filename)[1..-1]
+      ext ||= 'json' if json?(@body)
+      ext && EXTENSIONS.include?(ext) ? EXTENSIONS[ext].new.call(@body) : @body
+    end
+
+    def json?(file_body)
+      JSON.load(file_body)
+      true
+    rescue JSON::ParserError => e
+      false
+    end
+
+    private
+
+    def read_reference_file(filename)
+      if RUBY_VERSION >= '2.7.0'
+        URI.open(filename, 'r', &:read)
+      else
+        open(filename, 'r', &:read)
+      end
+    end
+  end
+end

data/lib/json_refs/version.rb

@@ -1,3 +1,3 @@
 module JsonRefs
-  VERSION = "0.1.1"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_refs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Makoto Tajitsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-18 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hana
@@ -30,26 +30,26 @@ 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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -84,6 +84,8 @@ files:
 - bin/setup
 - json_refs.gemspec
 - lib/json_refs.rb
+- lib/json_refs/dereference_handler.rb
+- lib/json_refs/loader.rb
 - lib/json_refs/version.rb
 homepage: https://github.com/tzmfreedom/json_refs
 licenses:
@@ -104,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