json_refs 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f0bcdbaa895884700d53a32dcc4422c0e6618f17
-  data.tar.gz: 9f8f74e7311da94f83fc899bcff9fc92c173d4a2
+SHA256:
+  metadata.gz: afda1a9f8de85cb20c9baadba689f01b21a664a16d5c47e405c3c2dffc7f8203
+  data.tar.gz: db450eb89016442f61af6325fc7f66dc1e642bb70420a087277d5172025469ac
 SHA512:
-  metadata.gz: 6c3efed79a7b6a767270220a648fb98f36f112453f0d6c1c134ceb2d0c40a1b5ade83c5bd1cf0a8063e8f87dd879eef181bdfa662131791e7bcc78b7cf59cca8
-  data.tar.gz: 4001d016043bd9dee2c4c299ac5c7578a1efa84b101d91ff86e578aed7cabc6722f192803b13e29fab0cf3fe12ecbda3ed81a3200620fde8a1b3d34b2646af2c
+  metadata.gz: c90414cb7617ebf433c1a05079600032f692136bcca25ae3388b21ff27c8764750cdcf82d69f300d159fef97f629b1147de36c81d84334735c8af20df8643deb
+  data.tar.gz: 02c43b3dc1aa1737050b863b591b7c03d4acf9f8ef54885643cfe2d19c4aa37d11e77422a7baf047bda8db83dc46d9e77101417a90b6ab32eff12c95256fd8ac

data/.travis.yml

@@ -1,5 +1,13 @@
 sudo: false
+
 language: ruby
+
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.4
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+
+before_install:
+  - gem install -N bundler

data/README.md

@@ -1,8 +1,10 @@
+[![Build Status](https://travis-ci.org/tzmfreedom/json_refs.svg?branch=master)](https://travis-ci.org/tzmfreedom/json_refs)
+
 # JsonRefs
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_refs`. To experiment with that code, run `bin/console` for an interactive prompt.
+Dereference JSON reference with JSON Pointer.
 
-TODO: Delete this and the text above, and describe your gem
+'$refs' value is replaced with referenced value.
 
 ## Installation
 
@@ -22,7 +24,44 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+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
 
@@ -32,7 +71,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_refs.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tzmfreedom/json_refs.
 
 ## License
 

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,14 +1,19 @@
-require "json_refs/version"
-require 'hana'
+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 = [])
@@ -35,7 +40,57 @@ module JsonRefs
       target = paths.inject(@doc) do |obj, key|
         obj[key]
       end
-      target[key] = Hana::Pointer.new(referenced_path[1..-1]).eval(@doc)
+      target[key] = referenced_value(referenced_path)
+    end
+
+    def referenced_value(referenced_path)
+      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/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.0"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_refs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Makoto Tajitsu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2020-10-04 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