json_schema_tools 0.3.2 → 0.3.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjMyMjgzZTgyMzQ3OTBlOGVlNDEzNTI0OTMwYWQxNGFkYTViNzMwMA==
+    OWMzMmM0YmMzMDY4YmVhMjQ4MjI4Nzk1MGQwNTVjYzFiYTNlM2Q0ZQ==
   data.tar.gz: !binary |-
-    YTE5ODAyMTI0YThkYzc1ZDFhYjFiMDA2ODVhZDJjZDI2MjRkMDAwNw==
+    NDU3MjkxYTUxNjNlMWNkOGE5MGJkZGNkOTUxOGE3OThjMDM3NDIzNQ==
 SHA512:
   metadata.gz: !binary |-
-    Y2YwOWZhMWEyMmZlZDdjZjlmMDA5NDhkMDNiM2RmZTJhYWIwNjM2ZDM4NGQy
-    OGE4ZGNhNjg2OGUwY2FkOWFkNmRhMWRkNzAyN2JkY2VmMmJhODliNTMxZWUz
-    ZWI0MWRmYTQ1ZTEzYWM5NzRmMGY0OWRjZTJhZTVhMzUyMzgxOWY=
+    NDBhMzllODdmMzgxOWQ3OWExM2IzZjU4YjIwYWZhODgyMzk5ZDU3NjUwNmY1
+    Mjg3ODcxZjEzMGE3N2JkODY1ZmMxOWI1MDFkMDVlODc0ODRlNDU2Mjc4NTAw
+    OGQ0NDQxOThkZGNkZjliMTYwMGY2ZDQ4ZmY2NDM3NjQ2YjU0YmI=
   data.tar.gz: !binary |-
-    MjRiYWQ5MTJkNmU2OGM3NGI0ODlkYzFjMzAzMjgyMzFmNzYzNmJjYjkwNjU1
-    NzM1ODM4NjNlZGE5Yjg2ZDNmNzIyNGZjOTkwMjE5NzQzMTBlN2IyZTI5YTA3
-    MThmODY2ZThiYjA4YzAxZDM4Mzk4NjJlY2ViMjdjM2EyZTY4YmQ=
+    NTNkOTU5YmU0OGQzNDMyYzAyZWQ1Mjc3ZGRkNWIzOGQ0MjU0NzcxOGRkODNj
+    NTcxNzEwZDAxNTAxMTk5Mzk4OGM1Y2U3NWEwMWY0NmY1NjZhZTQyNTA3ODYx
+    NDU1NWUxYzYzZWU4NTkyNjgwNzYwYzZjZDVmZGFkMjNjNWQyNjc=

data/CHANGELOG.md

@@ -1,13 +1,17 @@
 # Changelog JSON Schema Tools
 
 
+2014-10
+
+* handle circular dependencies in $ref arguments, so schema.to_h always resolves $refs properly 
+
 2014-09
 
 * add Schema class to represent a single schema, replaces simple Hash usage. Potentially breaks usage if you've gone crazy with Hash methods in your client.
 
 2014-09
 
-* refacture Reader to de-reference all pointers when initialized
+* refactor Reader to de-reference all pointers when initialized
 * remove :exclude_root option for object to schema_hash BREAKING change if you want nesting define your schema accordingly
 * add :links option for object to schema_hash, to include the links inline in an object
 * support items definition for array type properties - BREAKING you must change old simple property definitions

data/lib/schema_tools/ref_resolver.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'json'
+require 'uri'
 
 module SchemaTools
   class RefResolver
@@ -13,7 +14,7 @@ module SchemaTools
   # http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-07
   #
   # @param [String] json_pointer the JSON Pointer expression to evaluate
-  # @param [Hash] schema if the pointer refers to a local schema, this is this
+  # @param [Schema] relative_to if the pointer refers to a local schema, this is this
   # the hash to evaluate it against. If the pointer contains a uri to a
   # referenced schema, an attempt is made to load
   def self.load_json_pointer json_pointer, relative_to = nil
@@ -26,14 +27,25 @@ module SchemaTools
     uri     = $1.strip
     pointer = $2
     schema  = {}
-    if ! uri.empty?
+    unless uri.empty?
       uri = URI.parse(uri)
       raise "must currently be a relative uri: #{json_pointer}" if uri.absolute?
       # TODO use locale tools instance or base path from global SchemaTools.schema_path
-      if relative_to
-        path = relative_to.absolute_dir + "/" + uri.path
-      else
-        path = SchemaTools.schema_path + "/" + uri.path
+      base_dir = relative_to ? relative_to.absolute_dir : SchemaTools.schema_path
+      path = File.join(base_dir, uri.path)
+      unless File.exist?(path)
+        # try to find in main-dir and subdirs of global schema path and if
+        # present a schema's absolute dir
+        filename = uri.path.split('/').last
+        search_dirs = [File.join(SchemaTools.schema_path, filename),
+                       File.join(SchemaTools.schema_path, '**/*', filename)]
+        if relative_to
+          search_dirs += [ File.join(relative_to.absolute_dir, filename),
+                           File.join(relative_to.absolute_dir, '**/*', filename) ]
+        end
+        recursive_search = Dir.glob(search_dirs)[0]
+        # if still not found keep orig path to throw error on open
+        path = recursive_search || path
       end
       open (path) {|f| schema = JSON.parse(f.read) }
     end

data/lib/schema_tools/schema.rb

@@ -1,10 +1,20 @@
+module SchemaTools
 
+  class CircularReferenceException < ::Exception
+    def initialize fn, offending_ref, stack
+      @fn            = fn
+      @stack         = stack
+      @offending_ref = offending_ref
+    end
+
+    def to_s
+      "circular reference:  #{@fn} $ref: #{@offending_ref} refers to itself:\n #{@stack.join("\n")}"
+    end
+  end
 
-module SchemaTools
   # Internal representation of a Schema. This is basically a wrapper around a
   # HashWithIndifferentAccess ( for historical purposes ) as well as information
   # concerning where the Schema was loaded from in order to resolve relative paths.
-
   class Schema
     #@param [String|Hash] name_or_hash Schema may be initialized with either a filename or a hash
     def initialize(name_or_hash)
@@ -115,31 +125,47 @@ module SchemaTools
     # "$ref" param and resolve it. Other params are checked for nested hashes
     # and those are processed.
     # @param [HashWithIndifferentAccess] schema - single schema
-    def resolve_refs schema = nil
+    def resolve_refs schema = nil, stack = []
       schema ||= @hash
-
-       def resolve_reference hash
-          json_pointer = hash["$ref"]
-          values_from_pointer = RefResolver.load_json_pointer json_pointer, self
-          hash.merge!(values_from_pointer) { |key, old, new| old }
-          hash.delete("$ref")
-        end
-
       keys = schema.keys # in case you are wondering: RuntimeError: can't add a new key into hash during iteration
       keys.each do |k|
         v = schema[k]
         if k == "$ref"
-          resolve_reference schema
-        elsif v.is_a?(ActiveSupport::HashWithIndifferentAccess)
-          resolve_refs v
+          resolve_reference schema, stack
+          #stack.clear # ref resolved, reset stack
+        elsif v.is_a?(::Hash) || v.is_a?(ActiveSupport::HashWithIndifferentAccess)
+          resolve_refs v, stack
         elsif v.is_a?(Array)
-          v.each do |i|
-            resolve_refs(i) if i.is_a?(ActiveSupport::HashWithIndifferentAccess)
+          v.each do |element|
+            case element
+              when ::Hash, ActiveSupport::HashWithIndifferentAccess, ::Array
+                resolve_refs element, stack
+            end
           end
         end
       end
+      schema
+    end
 
+    #
+    # @param [Hash] hash schema
+    def resolve_reference(hash, stack=[])
+      json_pointer = hash["$ref"]
+      if stack.include? json_pointer
+        # we should probably also have a "too many levels of $ref exception or something ..."
+        raise CircularReferenceException.new( absolute_filename, json_pointer, stack )
+      else
+        stack.push json_pointer
+      end
+      values_from_pointer = RefResolver.load_json_pointer(json_pointer, self)
+      # recurse to resolve possible refs in object properties
+      resolve_refs(values_from_pointer, stack)
+
+      hash.merge!(values_from_pointer) { |key, old, new| old }
+      hash.delete("$ref")
+      stack.pop
     end
+
   end
 end
 

data/lib/schema_tools/version.rb

@@ -1,3 +1,3 @@
 module SchemaTools
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/spec/fixtures/circular_references_twice.json

@@ -0,0 +1,10 @@
+{
+  "description" : "original impl borked when including the same ref twice in one file",
+  "type" : "object",
+  "one": {
+    "$ref":"./address.json#properties"
+  },
+  "two": {
+    "$ref":"./address.json#properties"
+  }
+}

data/spec/fixtures_broken/circular_references.json

@@ -0,0 +1,9 @@
+{
+  "type" : "object",
+  "one": {
+    "$ref":"./circular_references.json#two"
+  },
+  "two": {
+    "$ref":"./circular_references.json#one"
+  }
+}

data/spec/fixtures_broken/circular_references_multi.json

@@ -0,0 +1,14 @@
+{
+  "type" : "object",
+  "one": {
+    "$ref":"./circular_references_multi.json#two"
+  },
+  "two": {
+    "$ref":"./circular_references_multi.json#three"
+  },
+  "three" : {
+    "something_else" : {
+        "$ref": "./circular_references_multi.json#one"
+    }
+  }
+}

data/spec/fixtures_broken/circular_references_multi_file_one.json

@@ -0,0 +1,14 @@
+{
+  "type" : "object",
+  "one": {
+    "$ref":"./circular_references_multi_file_two.json#one"
+  },
+  "two": {
+    "$ref":"./circular_references_multi_file_two.json#two"
+  },
+  "three" : {
+    "something_else" : {
+        "$ref": "./circular_references_multi_file_two.json#three"
+    }
+  }
+}

data/spec/fixtures_broken/circular_references_multi_file_two.json

@@ -0,0 +1,14 @@
+{
+  "type" : "object",
+  "one": {
+    "$ref":"./circular_references_multi_file_one.json#two"
+  },
+  "two": {
+    "$ref":"./circular_references_multi_file_one.json#three"
+  },
+  "three" : {
+    "something_else" : {
+        "$ref": "./circular_references_multi_file_one.json#one"
+    }
+  }
+}

data/spec/schema_tools/circuluar_ref_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe SchemaTools::Reader do
+  BROKEN_SCHEMA_PATH = File.expand_path('../../fixtures_broken', __FILE__)
+  context 'circular references' do
+    it 'should raise exception for circular $refs' do
+      expect{
+        schema = SchemaTools::Schema.new("#{BROKEN_SCHEMA_PATH}/circular_references.json")
+      }.to raise_exception(SchemaTools::CircularReferenceException)
+    end
+    it 'should raise exception for more complex circular $refs' do
+      expect{
+        schema = SchemaTools::Schema.new("#{BROKEN_SCHEMA_PATH}/circular_references_multi.json")
+      }.to raise_exception(SchemaTools::CircularReferenceException)
+    end
+    it 'should raise exception for way multi file circular $refs' do
+      expect {
+        schema = SchemaTools::Schema.new("#{BROKEN_SCHEMA_PATH}/circular_references_multi_file_one.json")
+      }.to raise_exception
+    end
+    it 'should not raise exception if same $ref is used twice in one file' do
+      expect {
+        SchemaTools::Reader.read(:circular_references_twice)
+      }.to_not raise_exception
+    end
+  end
+end
+

data/spec/schema_tools/reader_spec.rb

@@ -112,5 +112,6 @@ describe SchemaTools::Reader do
       expect { reader.read(:client, []) }.to raise_error ArgumentError
     end
   end
+
 end
 

data/spec/schema_tools/ref_resolver_spec.rb

@@ -48,7 +48,6 @@ describe SchemaTools::RefResolver do
       found.should eq 2
     end
   end
-
   it 'should throw an exception on an invalid path' do
     obj = {}
     expect {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -98,6 +98,7 @@ files:
 - lib/schema_tools/version.rb
 - spec/fixtures/address.json
 - spec/fixtures/basic_definitions.json
+- spec/fixtures/circular_references_twice.json
 - spec/fixtures/client.json
 - spec/fixtures/contact.json
 - spec/fixtures/includes_basic_definitions.json
@@ -107,6 +108,11 @@ files:
 - spec/fixtures/one_of_definition.json
 - spec/fixtures/page.json
 - spec/fixtures/relative_paths/includes_relative_path.json
+- spec/fixtures_broken/circular_references.json
+- spec/fixtures_broken/circular_references_multi.json
+- spec/fixtures_broken/circular_references_multi_file_one.json
+- spec/fixtures_broken/circular_references_multi_file_two.json
+- spec/schema_tools/circuluar_ref_spec.rb
 - spec/schema_tools/cleaner_spec.rb
 - spec/schema_tools/hash_spec.rb
 - spec/schema_tools/klass_factory_spec.rb