json-schema 0.1.14 → 0.2.0

data/README.textile

@@ -4,7 +4,7 @@ This library is intended to provide Ruby with an interface for validating JSON o
 
 h2. Dependencies
 
-The JSON::Schema library depends on the ruby JSON gem (json). Support for YAJL and other Ruby parsers is planned.
+The JSON::Schema library has no dependencies if the validation methods are called using Ruby objects. However, either the <code>json</code> or the <code>yajl-ruby</code> gem needs to be installed to validate JSON strings or files containing JSON data.
 
 h2. Installation
 
@@ -18,11 +18,11 @@ From the git repo:
 
 <pre>
 $ gem build json-schema.gemspec
-$ gem install json-schema-0.1.14.gem
+$ gem install json-schema-0.2.0.gem
 </pre>
 
 
-h2. Basic Usage
+h2. Usage
 
 Two base validation methods exist: <code>validate</code> and <code>validate!</code>. The first returns a boolean on whether a validation attempt passes and the latter will throw a <code>JSON::Schema::ValidationError</code> with an appropriate message/trace on where the validation failed.
 
@@ -56,7 +56,7 @@ h3. Validate a JSON string against a JSON schema file
 require 'rubygems'
 require 'json-schema'
   
-JSON::Validator.validate('schema.json', "{'a' : 5}")
+JSON::Validator.validate('schema.json', '{"a" : 5}')
 </pre>
 
 h3. Validate a list of objects against a schema that represents the individual objects
@@ -144,6 +144,16 @@ JSON::Validator.validate(schema,data) # => false
 data = {"a" => 0, "b" => "taco"}
 JSON::Validator.validate(schema,data) # => false
 </pre>
+
+h2. JSON Backends
+
+The JSON::Schema library currently supports the <code>json</code> and <code>yajl-ruby</code> backend JSON parsers. If either of these libraries are installed, they will be automatically loaded and used to parse any JSON strings supplied by the user.
+
+If more than one of the supported JSON backends are installed, the <code>yajl-ruby</code> parser is used by default. This can be changed by issuing the following before validation:
+
+<pre>
+JSON::Validator.json_backend = :json
+</pre>
   
 
 h2. Notes

data/lib/json-schema.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/json-schema"
 
+require 'rubygems'
 require 'schema'
 require 'validator'
 Dir[File.join(File.dirname(__FILE__), "json-schema/attributes/*")].each {|file| require file }

data/lib/json-schema/attributes/ref.rb

@@ -1,7 +1,7 @@
 module JSON
   class Schema
     class RefAttribute < Attribute
-      def self.validate(current_schema, data, fragments, validator, options = {})
+      def self.validate(current_schema, data, fragments, validator, options = {})        
         temp_uri = URI.parse(current_schema.schema['$ref'])
         if temp_uri.relative?
           temp_uri = current_schema.uri.clone

data/lib/json-schema/schema.rb

@@ -1,5 +1,3 @@
-require 'rubygems'
-require 'json'
 require 'pathname'
 
 module JSON
@@ -45,11 +43,7 @@ module JSON
       parts.pop
       parts.join('/') + '/'
     end
-    
-    def to_s
-      @schema.to_json
-    end
-  
+
     
   end
 end

data/lib/json-schema/validator.rb

@@ -22,6 +22,9 @@ module JSON
     class SchemaError < Exception
     end
     
+    class JsonParseError < Exception
+    end
+    
     class Attribute
       def self.validate(current_schema, data, fragments, validator, options = {})
       end
@@ -54,8 +57,8 @@ module JSON
       
       def validate(current_schema, data, fragments)
         current_schema.schema.each do |attr_name,attribute|
-          if @attributes.has_key?(attr_name)
-            @attributes[attr_name].validate(current_schema, data, fragments, self)
+          if @attributes.has_key?(attr_name.to_s)
+            @attributes[attr_name.to_s].validate(current_schema, data, fragments, self)
           end
         end
         data
@@ -73,6 +76,8 @@ module JSON
     }
     @@validators = {}
     @@default_validator = nil
+    @@available_json_backends = []
+    @@json_backend = nil
     
     def initialize(schema_data, data, opts={})
       @options = @@default_opts.clone.merge(opts)
@@ -117,7 +122,7 @@ module JSON
       
       if Validator.schemas[uri.to_s].nil?
         begin
-          schema = JSON::Schema.new(JSON.parse(open(uri.to_s).read), uri)
+          schema = JSON::Schema.new(JSON::Validator.parse(open(uri.to_s).read), uri)
           Validator.add_schema(schema)
           build_schemas(schema)
         rescue JSON::ParserError
@@ -236,8 +241,45 @@ module JSON
       def register_default_validator(v)
         @@default_validator = v
       end
+      
+      def json_backend
+        @@json_backend
+      end
+      
+      def json_backend=(backend)
+        backend = backend.to_s
+        if @@available_json_backend.include?(backend)
+          @@json_backend = backend
+        else
+          raise JSON::Schema::JsonParseError.new("The JSON backend '#{backend}' could not be found.")
+        end
+      end
+      
+      def parse(s)
+        case @@json_backend.to_s
+        when 'json'
+          JSON.parse(s)
+        when 'yajl'
+          json = StringIO.new(s)
+          parser = Yajl::Parser.new
+          parser.parse(json)
+        else
+          raise JSON::Schema::JsonParseError.new("No supported JSON parsers found. The following parsers are suported:\n * yajl-ruby\n * json")
+        end
+      end
     end
   
+    if Gem.available?('json')
+      require 'json'
+      @@available_json_backends << 'json'
+      @@json_backend = 'json'
+    end
+    
+    if Gem.available?('yajl-ruby')
+      require 'yajl'
+      @@available_json_backends << 'yajl'
+      @@json_backend = 'yajl'
+    end
     
     
     private
@@ -247,7 +289,11 @@ module JSON
         begin
           # Build a fake URI for this
           schema_uri = URI.parse("file://#{Dir.pwd}/#{Digest::SHA1.hexdigest(schema)}")
-          schema = JSON::Schema.new(JSON.parse(schema),schema_uri)
+          schema = JSON::Validator.parse(schema)
+          if @options[:list]
+            schema = {"type" => "array", "items" => schema}
+          end
+          schema = JSON::Schema.new(schema,schema_uri)
           Validator.add_schema(schema)
         rescue
           # Build a uri for it
@@ -261,27 +307,26 @@ module JSON
             end
           end
           if Validator.schemas[schema_uri.to_s].nil?
-            schema = JSON::Schema.new(JSON.parse(open(schema_uri.to_s).read),schema_uri)
+            schema = JSON::Validator.parse(open(schema_uri.to_s).read)
+            if @options[:list]
+              schema = {"type" => "array", "items" => schema}
+            end
+            schema = JSON::Schema.new(schema,schema_uri)
             Validator.add_schema(schema)
           else
             schema = Validator.schemas[schema_uri.to_s]
           end
         end
       elsif schema.is_a?(Hash)
-        schema = schema.to_json
-        schema_uri = URI.parse("file://#{Dir.pwd}/#{Digest::SHA1.hexdigest(schema)}")
-        schema = JSON::Schema.new(JSON.parse(schema),schema_uri)
+        if @options[:list]
+          schema = {"type" => "array", "items" => schema}
+        end
+        schema_uri = URI.parse("file://#{Dir.pwd}/#{Digest::SHA1.hexdigest(schema.inspect)}")
+        schema = JSON::Schema.new(schema,schema_uri)
         Validator.add_schema(schema)
       else
         raise "Invalid schema - must be either a string or a hash"
-      end
-      
-      if @options[:list]
-        inter_json = {:type => "array", :items => { "$ref" => schema.uri.to_s }}.to_json
-        wrapper_schema = JSON::Schema.new(JSON.parse(inter_json),URI.parse("file://#{Dir.pwd}/#{Digest::SHA1.hexdigest(inter_json)}"))
-        build_schemas(schema)
-        schema = wrapper_schema
-      end      
+      end   
       
       schema
     end
@@ -291,7 +336,7 @@ module JSON
       # Parse the data, if any
       if data.is_a?(String)
         begin
-          data = JSON.parse(data)
+          data = JSON::Validator.parse(data)
         rescue
           json_uri = URI.parse(data)
           if json_uri.relative?
@@ -301,7 +346,7 @@ module JSON
               schema_uri = URI.parse("file://#{Dir.pwd}/#{data}")
             end
           end
-          data = JSON.parse(open(json_uri.to_s).read)
+          data = JSON::Validator.parse(open(json_uri.to_s).read)
         end
       end
       data

data/test/test_files.rb

@@ -2,43 +2,42 @@ require 'test/unit'
 require File.dirname(__FILE__) + '/../lib/json-schema'
 
 class JSONSchemaTest < Test::Unit::TestCase
-  def test_schema_from_file
-    data = {"a" => 5}
-    assert(JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),data))
-    data = {"a" => "bad"}
-    assert(!JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),data))
-  end
   
-  def test_data_from_file
-    schema = {"type" => "object", "properties" => {"a" => {"type" => "integer"}}}
-    assert(JSON::Validator.validate(schema,File.join(File.dirname(__FILE__),"data/good_data_1.json")))
-    assert(!JSON::Validator.validate(schema,File.join(File.dirname(__FILE__),"data/bad_data_1.json")))
-  end
+  #
+  # These tests are ONLY run if there is an appropriate JSON backend parser available
+  #
   
-  def test_both_from_file
-    assert(JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),File.join(File.dirname(__FILE__),"data/good_data_1.json")))
-    assert(!JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),File.join(File.dirname(__FILE__),"data/bad_data_1.json")))
+  def test_schema_from_file
+    if JSON::Validator.json_backend != nil
+      data = {"a" => 5}
+      assert(JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),data))
+      data = {"a" => "bad"}
+      assert(!JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),data))
+    end
   end
   
-  def test_invalid_schema
-    data = {}
-    assert_raise JSON::ParserError do
-      assert(JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/invalid_schema_1.json"),data))
+  def test_data_from_file
+    if JSON::Validator.json_backend != nil
+      schema = {"type" => "object", "properties" => {"a" => {"type" => "integer"}}}
+      assert(JSON::Validator.validate(schema,File.join(File.dirname(__FILE__),"data/good_data_1.json")))
+      assert(!JSON::Validator.validate(schema,File.join(File.dirname(__FILE__),"data/bad_data_1.json")))
     end
   end
   
-  def test_invalid_data
-    schema = {}
-    assert_raise JSON::ParserError do
-      assert(JSON::Validator.validate(schema,File.join(File.dirname(__FILE__),"data/invalid_data_1.json")))
+  def test_both_from_file
+    if JSON::Validator.json_backend != nil
+      assert(JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),File.join(File.dirname(__FILE__),"data/good_data_1.json")))
+      assert(!JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),File.join(File.dirname(__FILE__),"data/bad_data_1.json")))
     end
   end
-  
+    
   def test_file_ref
-    data = {"b" => {"a" => 5}}
-    assert(JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_2.json"),data))
+    if JSON::Validator.json_backend != nil
+      data = {"b" => {"a" => 5}}
+      assert(JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_2.json"),data))
     
-    data = {"b" => {"a" => "boo"}}
-    assert(!JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),data))
+      data = {"b" => {"a" => "boo"}}
+      assert(!JSON::Validator.validate(File.join(File.dirname(__FILE__),"schemas/good_schema_1.json"),data))
+    end
   end
 end

data/test/test_jsonschema_draft3.rb

@@ -759,12 +759,11 @@ class JSONSchemaDraft3Test < Test::Unit::TestCase
     assert(JSON::Validator.validate(schema,data,:list => true))
     assert(!JSON::Validator.validate(schema,data))    
     
-    data = [{"a" => 1},{"b" => 2},{"a" => 3}]
-    assert(!JSON::Validator.validate(schema,data,:list => true))
-    
     data = {"a" => 1}
     assert(!JSON::Validator.validate(schema,data,:list => true))
     
+    data = [{"a" => 1},{"b" => 2},{"a" => 3}]
+    assert(!JSON::Validator.validate(schema,data,:list => true))
   end
   
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: json-schema
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 14
-  version: 0.1.14
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kenny Hoxworth
@@ -15,23 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-08 00:00:00 -05:00
+date: 2011-03-09 00:00:00 -05:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id001
+dependencies: []
+
 description: 
 email: hoxworth@gmail.com
 executables: []