json_schema_tools 0.6.0 → 0.6.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWY5YzJhODNmZTc5NWFhNmI0NTM3N2I2Mzg3MzcwNGI0MDkxMTQzNg==
+    NDI3MjBjMGQ2NjA2YjJkN2Y1ZjFiN2NjZTM2NTMzMTJlYmEwNzE5Mg==
   data.tar.gz: !binary |-
-    Mzk5MmQxZGMyM2E2MDQ3MTU2MzE0ZWY3NmU1ODVmN2JjMDlhNGMzMQ==
+    YTk0Mjg5NTU4MjlkNzA5YzJlYzExNDAyNWVlNDI0MDM5ZmQ1YzI3Nw==
 SHA512:
   metadata.gz: !binary |-
-    YmYzNWEzYzI2ZjQ5ZWFmYzNhM2I5ZjA2MTk1MTZhYmJlNzlmMmU2Njk1Yzc3
-    NGVlYzFkYjJhMzc2NWQxZmVhY2E2NTgyMDUwYmU4ODljNTExOGQ5YjJiMTI0
-    MWQ3NGJmZTZmNTY1NzFmMTMzZWJmOWNkY2NkODZkMTlmYjQ3ZmQ=
+    YWZlOGQyODY4MTg0ZDBkMGYzZGFhMDlmZWMyOTE0ZTA1OTY2YTk4NWUxNTA1
+    OTIzYWYxYWEwYzJkMjI5YjY0NmM2MjIzNzczNzViMGZiODgzMTcyZTIwNTNi
+    OWM3YTdmNWRkMTRkYzBkYWJlZjMyNzJhOGY1YTA4ZjJiNmMwOTI=
   data.tar.gz: !binary |-
-    MTEwM2Q4MTU5ZWE0N2MxN2VhNTY4YWNlYTZkODdkYzZmNGZkMzZlOTk3MmM2
-    ZmM3ODE4ZjE4ZTU4ODhlNTdmZWQxMzYxYTJhOWRlODg3ZmM4NzVhZDk5ZWVh
-    NDI1ZDY5N2I1MmNkNjBiYzQ0MzdiYTY1ODQxYThhOWM5ZmRkZTQ=
+    ZDJiZGQ2NWQ5YmIxN2FjMTVmMTVhOGQxYWNhOWU5NDM5NDkxYjY2OWE3ZjJl
+    YTNkMmQ2ODFjNzI2NGU4M2U0YmIyODgzNTBlZGU4MDZlMDJmY2RhZWE3MzJk
+    MGFmZGVlNDlkMmQ1ZjA1YmEzYTAwOTAzMzYxZDdiZjgzY2NlNzI=

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog JSON Schema Tools
 
+##2015-03
+
+* allow $refs to include plain schema file name
+
 ##2015-01
 
 * add :reader option for Obj.as_schema_hash to use a custom reader instance(with its own schema registry), instead of the global one

data/lib/schema_tools/ref_resolver.rb

@@ -6,72 +6,83 @@ require 'uri'
 module SchemaTools
   class RefResolver
 
-  #
-  # super basic resolving of JSON Pointer stuff in order
-  # to be able to load $ref parameter.
-  #
-  # $refs in JSON Schema are defined in JSON Pointer syntax:
-  # http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-07
-  #
-  # @param [String] json_pointer the JSON Pointer expression to evaluate
-  # @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
-    # JSON Pointer is a big, abandoned WIP and we're going to
-    # start by only implementing the part's we need ...
-    if nil ==  (json_pointer =~ /^(.*)#(.*)/ )
-      raise "invalid json pointer: #{json_pointer}"
-    end
+    #
+    # super basic resolving of JSON Pointer stuff in order
+    # to be able to load $ref parameter.
+    #
+    # $refs in JSON Schema are defined in JSON Pointer syntax:
+    # http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-07
+    # JSON Pointer is a big, abandoned WIP and we're going to start by only
+    # implementing the part's we need ...
+    #
+    # @param [String] json_pointer the JSON Pointer expression to evaluate
+    # @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)
+
+      if json_pointer[/#/]
+        # hash-symbol syntax pointing to a property of a schema. client.json#properties
+        raise "invalid json pointer: #{json_pointer}" unless json_pointer =~ /^(.*)#(.*)/
+        uri, pointer = json_pointer.match(/^(.*)#(.*)/).captures
+      else
+        uri = json_pointer
+      end
+
+      raise "invalid uri pointer: #{json_pointer}" if uri.empty?
 
-    uri     = $1.strip
-    pointer = $2
-    schema  = {}
-    unless uri.empty?
+      schema  = {}
       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
+      # TODO use local tools instance or base path from global SchemaTools.schema_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
+      path = find_local_file_path(base_dir, uri.path, relative_to)
       open (path) {|f| schema = JSON.parse(f.read) }
-    end
-
-    return self._retrieve_pointer_from_object pointer, schema
-  end
 
+      if pointer
+        self._retrieve_pointer_from_object(pointer, schema)
+      else
+        schema
+      end
+    end
 
-  def self._retrieve_pointer_from_object pointer, object
-    # assume path to be the JSONPointer expression:
-    #  json/pointer/expression
-    # and obj to be the ruby hash representation of the json
-    path = pointer.is_a?(Array) ? pointer : pointer.split("/")
+    # @param [String] base_dir
+    # @param [String] path relative file name with optional sub-path prefix:
+    # contact.json, ./contacts/client.json
+    # @param [Schema] relative_to If the pointer contains a uri to a referenced
+    # schema, an attempt is made to load it from the relatives absolute dir
+    def self.find_local_file_path(base_dir, file_path, relative_to=nil)
+      path = File.join(base_dir, file_path)
+      return path if File.exist?(path)
 
-    while object != nil && component = path.shift
-      prev   = object
-      component = component.to_i if object.is_a?(Array) && component =~ /^\d+$/
-      object = object[component]
+      # try to find in main-dir and subdirs of global schema path and if present
+      # a schema's absolute dir
+      filename = file_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 return orig path to throw error on open
+      recursive_search || path
     end
 
-    return object
-  end
-
-  end # module
-end # module
 
+    def self._retrieve_pointer_from_object(pointer, object)
+      # assume path to be the JSONPointer expression:
+      #  json/pointer/expression
+      # and obj to be the ruby hash representation of the json
+      path = pointer.is_a?(Array) ? pointer : pointer.split("/")
 
+      while object != nil && component = path.shift
+        component = component.to_i if object.is_a?(Array) && component =~ /^\d+$/
+        object = object[component]
+      end
 
+      return object
+    end
 
+  end
+end

data/lib/schema_tools/version.rb

@@ -1,3 +1,3 @@
 module SchemaTools
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/spec/fixtures/schemata/circular_references_twice.json

@@ -6,5 +6,8 @@
   },
   "two": {
     "$ref":"./address.json#properties"
+  },
+  "three": {
+    "$ref":"./address.json"
   }
 }

data/spec/fixtures/schemata/client.json

@@ -73,7 +73,7 @@
     "work_address":{
       "description": "The work address as an example for a single nested/related object",
       "type":"object",
-      "properties" : {"$ref":"./address.json#properties"}
+      "$ref":"./address.json"
     }
   },
   "links":[

data/spec/schema_tools/ref_resolver_spec.rb

@@ -9,10 +9,6 @@ describe SchemaTools::RefResolver do
 
       pointer = "bla/blub"
       found = SchemaTools::RefResolver._retrieve_pointer_from_object pointer, obj
-      # not sure what I am doing wrong here, but:
-      #    found.should eq :success
-      # does not work because
-      #    undefined method `eq'
       found.should eq :success
 
       found = SchemaTools::RefResolver._retrieve_pointer_from_object "non/existant/path", obj
@@ -62,13 +58,19 @@ describe SchemaTools::RefResolver do
     }.to raise_error
   end
 
-  it 'should load local ref' do
+  it 'loads local ref' do
     pointer = "./basic_definitions.json#definitions"
     obj = SchemaTools::RefResolver.load_json_pointer(pointer)
     obj.length.should eq 3
   end
 
-  it 'should load the entire document' do
+  it 'loads entire document without # at the end' do
+    pointer = "./basic_definitions.json"
+    obj = SchemaTools::RefResolver.load_json_pointer(pointer)
+    obj["definitions"].keys.length.should eq 3
+  end
+
+  it 'loads the entire document' do
     pointer = "./basic_definitions.json#"
     obj = SchemaTools::RefResolver.load_json_pointer(pointer)
     obj["definitions"].keys.length.should eq 3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json