blumquist 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c073e8fec13fe44202f842b173958cf2540c0d8c
-  data.tar.gz: 11b7507ac23839339a67acf7bfab064951fec0df
+  metadata.gz: d916de12dccf999a0a3a93ed8b1fb321230c7c29
+  data.tar.gz: bbb8e9662f65bd8ec435fc9c07632d79d7945ca4
 SHA512:
-  metadata.gz: e1f3acfa2cd6aeb66a46650e785c3c02fb91775a224cea63b557b57c8d6d5e4b5fe4551597f625475b992d5675797a1162c37e604ff894977d4a51cf8a0dbf4d
-  data.tar.gz: ebbe4c0316bb712999d5f83ddaa1bde3db6a5dd2c89c13b32e19be524ae20abf68218af7a113cc16b01da37607a5d523a89dd76dc5525a3f45c5cb2c7401b284
+  metadata.gz: d96097e7eb7bfc8915cf59d66e1ee8f5cdc1a6a917c9caf06661b9f8b9abcd877bdd880716d9e9a0234d1d8971a1167a59f18e1dfb84b21c8c5b124b32be9cc8
+  data.tar.gz: a029e3cbb688916ed4d18fe0c255a282829de0a7415f89afdcf5db6b21c9f2b095dd398b361b57092e7d44f9eb61946a02edc6bee3ffca823440629f3aabd42d

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [0.10.0] - 2017-09-05
+## Added
+- References ($ref):
+  Support for more JSON pointers formats:
+    1. #/key1/key2/.../keyN
+    2. path-to-file.json
+    3. path-to-file.json#/key1/key2/.../keyN
+
 # [0.9.1] - 2017-09-04 Alfonso Mancilla (#20)
 - Support primitive type: integer.
 

data/lib/blumquist.rb

@@ -2,9 +2,12 @@ require 'blumquist/version'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'json'
 require 'json-schema'
+require 'blumquist/json_pointer'
 require 'blumquist/errors'
 
 class Blumquist
+  PRIMITIVE_TYPES = %w{null boolean number string enum integer}.freeze
+
   attr_reader :_type
 
   def initialize(options)
@@ -61,25 +64,20 @@ class Blumquist
   end
 
   def resolve_json_pointer(type_def)
-    key = type_def[:$ref].split('/').last
-    definition = @schema[:definitions][key]
-    raise(Errors::InvalidPointer, pointer) unless definition
-    type_def.merge(definition)
+    pointer = JSONPointer.new(type_def[:$ref], document: @schema)
+
+    type_def.merge(pointer.value)
   end
 
   def resolve_json_pointer!(type_def)
-    # Should read up on how json pointers are really resolved
-    pointer = type_def.delete(:$ref)
-    key = pointer.split('/').last
-    definition = @schema[:definitions][key]
-
-    raise(Errors::InvalidPointer, pointer) unless definition
+    pointer_path = type_def.delete(:$ref)
+    pointer = JSONPointer.new(pointer_path, document: @schema)
 
-    type_def.merge! definition
+    type_def.merge!(pointer.value)
   end
 
   def primitive_type?(type)
-    %w{null boolean number string enum integer}.include?(type.to_s)
+    PRIMITIVE_TYPES.include?(type.to_s)
   end
 
   def define_getters

data/lib/blumquist/errors.rb

@@ -1,8 +1,9 @@
 require 'blumquist/error'
-require 'blumquist/errors/unsupported_schema'
-require 'blumquist/errors/unsupported_type'
 require 'blumquist/errors/invalid_pointer'
 require 'blumquist/errors/missing_array_items_type'
 require 'blumquist/errors/missing_properties'
 require 'blumquist/errors/no_compatible_one_of'
+require 'blumquist/errors/unsupported_pointer'
+require 'blumquist/errors/unsupported_schema'
+require 'blumquist/errors/unsupported_type'
 require 'blumquist/errors/validation'

data/lib/blumquist/errors/invalid_pointer.rb

@@ -1,8 +1,13 @@
 class Blumquist
   module Errors
     class InvalidPointer < Blumquist::Error
-      def initialize(pointer)
-        super("Could not find pointer #{pointer.to_s.to_json}")
+      def initialize(pointer:, document:)
+          msg = %{
+  Could not find pointer '#{pointer}' in the given document:\n
+  #{JSON.pretty_generate(document)}
+          }
+
+          super(msg)
       end
     end
   end

data/lib/blumquist/errors/unsupported_pointer.rb

@@ -0,0 +1,16 @@
+class Blumquist
+  module Errors
+    class UnsupportedPointer < Blumquist::Error
+      def initialize(pointer:)
+        msg = %{
+  Pointer '#{pointer}' is not supported. Current supported formats are:\n
+    1. #/key1/key2/.../keyN
+    2. path_to_file.json
+    3. path_to_file.json#/key1/key2/.../keyN
+        }
+
+        super(msg)
+      end
+    end
+  end
+end

data/lib/blumquist/errors/unsupported_type.rb

@@ -2,7 +2,7 @@ class Blumquist
   module Errors
     class UnsupportedType < Blumquist::Error
       def initialize(type)
-        super("Unsupported type '#{type.to_s}' (#{%w{null, boolean, number, string, array object}.to_json} are supported)")
+        super("Unsupported type '#{type.to_s}' (#{Blumquist::PRIMITIVE_TYPES.to_json}) are supported)")
       end
     end
   end

data/lib/blumquist/json_pointer.rb

@@ -0,0 +1,75 @@
+#
+# JSON Pointer
+# This is a VERY BASIC implementation
+# to support pointers in the form of:
+#
+#   1. #/key1/key2/.../keyN
+#   2. path_to_file.json
+#   3. path_to_file.json#/key1/key2/.../keyN
+#
+#  More about JSON Pointer & Reference Specification
+#  https://cswr.github.io/JsonSchema/spec/definitions_references/#json-pointers
+#
+
+class Blumquist
+  class JSONPointer
+    DOCUMENT_ROOT_IDENTIFIER = '#'.freeze
+    DOCUMENT_ADDRESS_IDENTIFIER = '.json'.freeze
+
+    attr_reader :uri
+
+    def initialize(uri, document: nil)
+      @uri = uri
+      validate_uri!
+      @document = document
+    end
+
+    def value
+      result = keys.any? ? document&.dig(*keys) : document
+
+      raise(Errors::InvalidPointer, pointer: uri, document: document) if result.nil?
+
+      result
+    end
+
+    private
+
+    def keys
+      return @keys if defined?(@keys)
+
+      @keys = @uri.split('#')[1]
+      @keys = @keys&.sub('/', '') if @keys&.start_with?('/')
+      @keys = @keys&.split('/') || []
+    end
+
+    def address
+      return @address if defined?(@address)
+
+      @address = uri.scan(/.*\.json/).first
+    end
+
+    def document
+      if points_to_document_address?
+        @external_document ||= JSON.parse( File.read(address) )
+      else
+        @document
+      end
+    end
+
+    def points_to_document_address?
+      !address.nil?
+    end
+
+    def validate_uri!
+      #
+      # Why only this uri formats are valid?
+      # Refer to the description on the top of this file
+      #
+
+      return if uri.start_with?(DOCUMENT_ROOT_IDENTIFIER)
+      return if uri.match(DOCUMENT_ADDRESS_IDENTIFIER)
+
+      raise(Errors::UnsupportedPointer, pointer: uri)
+    end
+  end
+end

data/lib/blumquist/version.rb

@@ -1,3 +1,3 @@
 class Blumquist
-  VERSION = "0.9.1"
+  VERSION = '0.10.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blumquist
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Jannis Hermanns
@@ -189,10 +189,12 @@ files:
 - lib/blumquist/errors/missing_array_items_type.rb
 - lib/blumquist/errors/missing_properties.rb
 - lib/blumquist/errors/no_compatible_one_of.rb
+- lib/blumquist/errors/unsupported_pointer.rb
 - lib/blumquist/errors/unsupported_schema.rb
 - lib/blumquist/errors/unsupported_type.rb
 - lib/blumquist/errors/validation.rb
 - lib/blumquist/errors/validation_error.rb
+- lib/blumquist/json_pointer.rb
 - lib/blumquist/version.rb
 homepage: https://github.com/moviepilot/blumquist
 licenses: