jschematic 0.0.2 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jschematic (0.0.1)
+    jschematic (0.0.2)
       addressable
 
 GEM

data/History.txt

@@ -1,3 +1,9 @@
+== 0.0.5
+* Initial support for validation contexts (Mike Sassak)
+* $ref support (Mike Sassak)
+* Basic DateTime, Date support (Mike Sassak)
+* Separate IPv4 and IPv6 classes (Mike Sassak)
+
 == 0.0.2
 * Refactored Properties and PatternProperties so the latter inherits from the former (Mike Sassak)
 * Simple IPv4 CIDR format support (Mike Sassak)

data/README.md

@@ -2,24 +2,23 @@
 
 Jschematic is a JSON Schema v3 Validator for Ruby.
 
-It is currently incomplete, alpha quality software.
+It is currently pre-release software. The basics work fairly well, but
+it is a work in progress.
 
-Having said that, most of the core schema definition is supported
-with these exceptions:
+Most of the core schema definition is supported with these exceptions:
 
- * $ref
  * $schema
  * extends
  * divisibleBy
  * disallow
 
-In addition to this, only IPv4, IPv6 and URI formats are currently
+In addition to this, only DateTime, Date, IPv4, IPv6 and URI formats are currently
 implemented.
 
-Please report any bugs you find (and you will find bugs) at the issue
-tracker here: https://github.com/msassak/jschematic/issues.
+Please report any bugs you find in the issue tracker here: 
+https://github.com/msassak/jschematic/issues.
 
-## Usage
+## Basic Usage
 
     require 'jschematic'
     Jschematic.validate(json, schema)  # => true or false
@@ -30,6 +29,10 @@ tracker here: https://github.com/msassak/jschematic/issues.
 Jschematic doesn't care how you turn JSON into Ruby (though we use the
 fine yajl-ruby gem for testing).
 
+## Advanced Usage
+
+Hasn't been documented yet.
+
 ## Testing
 
     $ cucumber
@@ -42,6 +45,7 @@ Or `rake` if you want to run both.
 * http://tools.ietf.org/html/draft-zyp-json-schema-03
 * https://github.com/kriszyp/json-schema
 * http://tools.ietf.org/html/rfc3986
+* https://groups.google.com/d/topic/json-schema/lftABvH5KkA/discussion
 
 ## Copyright
 

data/features/format.feature

@@ -53,3 +53,37 @@ Feature: Core schema: format
     But these are not valid JSON:
       | ""          |
       | "127.0.0.1" |
+
+  Scenario: Date-Time
+    When the schema is:
+      """
+      {
+          "type": "string",
+          "format": "date-time"
+      }
+      """
+    Then these are valid JSON:
+      | "1999-12-31T23:59:59Z" |
+      | "2011-02-27T10:12:13Z" |
+      | "1980-02-29T08:51:32Z" |
+    But these are not valid JSON:
+      | "1999-12-31"           |
+      | "1981-02-29T01:01:01Z" |
+      | "August 1st, 1986"     |
+
+  Scenario: Date
+    When the schema is:
+      """
+      {
+          "type": "string",
+          "format": "date"
+      }
+      """
+    Then these are valid JSON:
+      | "1999-12-31" |
+      | "2011-02-27" |
+      | "1980-02-29" |
+    But these are not valid JSON:
+      | "1981-02-29"       |
+      | "August 1st, 1986" |
+

data/features/id.feature

@@ -1,4 +1,10 @@
 Feature: Core schema: id
+
+  See: https://groups.google.com/d/msg/json-schema/lftABvH5KkA/KW93ZX-JdpsJ
+  for an explanation. The relevant part is "URIs, not URLs", i.e. id attributes
+  are for *identifying* schemas, not for *locating* them. No retrieval is
+  necessary.
+
   Scenario: absolute URI, single schema
     When the schema is:
       """
@@ -10,17 +16,6 @@ Feature: Core schema: id
     Then the id of "Test Schema" is "http://www.example.com/schemas/json"
 
   Scenario: relative URI, single schema
-    I-D says: "If this schema is not contained in any parent schema, the 
-    current URI of the parent schema is held to be the URI under which 
-    this schema was addressed."
-
-    I think this means that the id of the root schema is taken to be the 
-    URI from which the schema was retrieved, i.e. schema validators are
-    supposed to include an HTTP client, which seems a bit bonkers to me,
-    or the client passes in the URI from where the schema was retrieved, 
-    which is weird, but more palatable. The current implementation does
-    neither of these, but I don't think it's too important at this point. 
-
     When the schema is:
       """
       {

data/features/ref.feature

@@ -0,0 +1,138 @@
+Feature: Core schema: $ref
+  Scenario: Ref resolves to the same schema
+    When the schema is:
+      """
+      {
+          "id": "http://www.example.com/schemas/person",
+          "title": "The Best Person Schema Ever",
+          "properties": {
+              "name": { "type": "string" },
+              "age": { "type": "integer" },
+              "favorite_person": { "$ref": "http://www.example.com/schemas/person" }
+          }
+      }
+      """
+    Then this is valid JSON:
+      """
+      {
+          "name": "Felizberto Albi",
+          "age": 24,
+          "favorite_person": {
+              "name": "Lil Wayne Pangles",
+              "age": 52,
+              "favorite_person": {
+                  "name": "Birdman Pangles",
+                  "age": 71,
+                  "favorite_person": {
+                      "name": "Best here to be silent",
+                      "age": 105
+                  }
+              }
+          }
+      }
+      """
+    But this is not valid JSON:
+      """
+      {
+          "name": "Felizberto Albi",
+          "age": 24,
+          "favorite_person": {
+              "name": "Lil Wayne Pangles",
+              "age": "At least a billion. At least."
+          }
+      }
+      """
+
+  Scenario: Ref with relative path resolves to the same schema
+    TODO: This scenario shares too much information with the one above it.
+
+    When the schema is:
+      """
+      {
+          "id": "http://www.example.com/schemas/person",
+          "title": "The Best Person Schema Ever",
+          "properties": {
+              "name": { "type": "string" },
+              "age": { "type": "integer" },
+              "favorite_person": { "$ref": "/schemas/person" }
+          }
+      }
+      """
+    Then this is valid JSON:
+      """
+      {
+          "name": "Felizberto Albi",
+          "age": 24,
+          "favorite_person": {
+              "name": "Lil Wayne Pangles",
+              "age": 52,
+              "favorite_person": {
+                  "name": "Birdman Pangles",
+                  "age": 71,
+                  "favorite_person": {
+                      "name": "Best here to be silent",
+                      "age": 105
+                  }
+              }
+          }
+      }
+      """
+    But this is not valid JSON:
+      """
+      {
+          "name": "Felizberto Albi",
+          "age": 24,
+          "favorite_person": {
+              "name": "Lil Wayne Pangles",
+              "age": "At least a billion. At least."
+          }
+      }
+      """
+
+  Scenario: Ref resolves to different schema
+    Given this schema:
+      """
+      {
+          "id": "http://www.example.com/schemas/person",
+          "title": "The Best Person Schema Ever",
+          "properties": {
+              "name": { "type": "string" },
+              "age": { "type": "integer" }
+          }
+      }
+      """
+    And this schema:
+      """
+      {
+          "title": "A Happy Family Much Like All Other Happy Families",
+          "type": "array",
+          "items": {
+              "$ref": "http://www.example.com/schemas/person"
+          }
+      }
+      """
+    Then this is valid JSON:
+      """
+      [
+          {
+              "name": "Anna Arkadyevna Karenina",
+              "age": 18
+          },
+
+          {
+              "name": "Count Alexei Kirillovich Vronsky",
+              "age": 25
+          }
+      ]
+      """
+    But this is not valid JSON:
+      """
+      [
+          {
+              "name": "The Underground Man",
+              "age": "timeless"
+          }
+      ]
+      """
+
+  Scenario: Ref appears before the id it references

data/features/step_definitions/jschematic_steps.rb

@@ -1,36 +1,40 @@
+Given "this schema:" do |schema|
+  add_schema(parse(schema))
+end
+
 When /^the schema is '(.+)'$/ do |schema|
-  @schema = parse(schema)
+  add_schema(parse(schema))
 end
 
 When "the schema is:" do |schema|
-  @schema = parse(schema)
+  add_schema(parse(schema))
 end
 
 Then /^'(.+)' is valid JSON$/ do |json|
-  assert_valid(parse(json), @schema)
+  assert_valid(parse(json), all_schemas)
 end
 
 Then /^'(.+)' is not valid JSON$/ do |json|
-  assert_invalid(parse(json), @schema)
+  assert_invalid(parse(json), all_schemas)
 end
 
 Then "this is valid JSON:" do |json|
-  assert_valid(parse(json), @schema)
+  assert_valid(parse(json), all_schemas)
 end
 
 Then "this is not valid JSON:" do |json|
-  assert_invalid(parse(json), @schema)
+  assert_invalid(parse(json), all_schemas)
 end
 
 Then "these are valid JSON:" do |instances|
   instances.raw.each do |row|
-    assert_valid(parse(row[0]), @schema)
+    assert_valid(parse(row[0]), all_schemas)
   end
 end
 
 Then "these are not valid JSON:" do |instances|
   instances.raw.each do |row|
-    assert_invalid(parse(row[0]), @schema)
+    assert_invalid(parse(row[0]), all_schemas)
   end
 end
 
@@ -46,16 +50,25 @@ module JschematicWorld
     raise "Parsing '#{json}' failed with #{e.to_s}"
   end
 
-  def assert_valid(json, raw_schema)
-    Jschematic.validate(json, raw_schema).should be_true
+  def assert_valid(json, raw_schemas)
+    Jschematic.validate(json, *raw_schemas).should be_true
   end
 
-  def assert_invalid(json, raw_schema)
-    Jschematic.validate(json, raw_schema).should be_false
+  def assert_invalid(json, raw_schemas)
+    Jschematic.validate(json, *raw_schemas).should be_false
   end
 
   def build_schema
-    @_schema ||= Jschematic::Schema.new(@schema)
+    @_schema ||= Jschematic::Schema.new(all_schemas.first)
+  end
+
+  def add_schema(schema)
+    @_schemas ||= []
+    @_schemas << schema
+  end
+
+  def all_schemas
+    @_schemas ||= []
   end
 end
 

data/jschematic.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'jschematic'
-  s.version     = '0.0.2'
+  s.version     = '0.0.5'
   s.authors     = ["Mike Sassak"]
   s.description = "JSON Schema v3 Validator"
   s.summary     = "jschematic #{s.version}"

data/lib/jschematic/attributes/format.rb

@@ -1,20 +1,18 @@
 require 'ipaddr'
 require 'addressable/uri'
+require 'date'
 
 module Jschematic
   module Attributes
     module Format
       def self.new(format)
-        case format
-        when "uri"
-          Uri.new
-        when "ip-address", "ipv6"
-          Ip.new(format)
-        when "cidr"
-          Cidr.new(format)
-        else
-          NullFormat.new
+        format_class = format.split(/[^\w\d]/).inject("") do |name, part|
+          name << part.capitalize
         end
+
+        const_get(format_class).new
+      rescue NameError
+        NullFormat.new(format)
       end
 
       class Uri
@@ -27,20 +25,21 @@ module Jschematic
         end
       end
 
-      class Ip
+      class IpAddress
         include Jschematic::Element
 
-        def initialize(version)
-          @method = case version
-          when "ip-address"
-            :ipv4?
-          when "ipv6"
-            :ipv6?
-          end
+        def accepts?(addr)
+          IPAddr.new(addr).ipv4?
+        rescue ArgumentError
+          false
         end
+      end
+
+      class Ipv6
+        include Jschematic::Element
 
         def accepts?(addr)
-          IPAddr.new(addr).send(@method)
+          IPAddr.new(addr).ipv6?
         rescue ArgumentError
           false
         end
@@ -52,12 +51,37 @@ module Jschematic
         def accepts?(addr_with_cidr)
           addr, cidr = addr_with_cidr.split("/")
           return false unless cidr && (1..32).include?(cidr.to_i)
-          Ip.new("ip-address").accepts?(addr)
+          IpAddress.new.accepts?(addr)
+        end
+      end
+
+      class DateTime
+        include Jschematic::Element
+
+        def accepts?(date_time)
+          ::DateTime.strptime(date_time)
+        rescue ArgumentError
+          false
+        end
+      end
+
+      class Date
+        include Jschematic::Element
+
+        def accepts?(date)
+          ::Date.strptime(date)
+        rescue ArgumentError
+          false
         end
       end
 
       class NullFormat
         include Jschematic::Element
+        attr_reader :format
+
+        def initialize(format)
+          @format = format
+        end
 
         def accepts?(instance)
           true

data/lib/jschematic/attributes/ref.rb

@@ -0,0 +1,20 @@
+require 'addressable/uri'
+
+require 'jschematic/element'
+
+module Jschematic
+  module Attributes
+    class Ref
+      include Jschematic::Element
+
+      def initialize(uri)
+        @uri = Addressable::URI.parse(uri)
+      end
+
+      def accepts?(instance)
+        schema = Schema.schema_for(@uri) || raise(SchemaNotFoundError.new(@uri))
+        schema.accepts?(instance)
+      end
+    end
+  end
+end

data/lib/jschematic/attributes.rb

@@ -18,11 +18,13 @@ require 'jschematic/attributes/min_length'
 require 'jschematic/attributes/max_length'
 require 'jschematic/attributes/enum'
 require 'jschematic/attributes/format'
+require 'jschematic/attributes/ref'
 
 module Jschematic
   module Attributes
     def self.[](name)
-      const_get(name[0].chr.capitalize + name[1..-1])
+      name_without_meta = name.gsub(/^\$/, '')
+      const_get(name_without_meta[0].chr.capitalize + name_without_meta[1..-1])
     end
   end
 end

data/lib/jschematic/context.rb

@@ -0,0 +1,13 @@
+require 'jschematic/schema'
+
+module Jschematic
+  class Context
+    def initialize(*schemas)
+      @schemas = schemas.collect{ |raw_schema| Schema.new(raw_schema) }
+    end
+
+    def validate!(instance)
+      @schemas.last.accepts?(instance)
+    end
+  end
+end

data/lib/jschematic/element.rb

@@ -1,8 +1,9 @@
-require 'jschematic/validation_error'
+require 'jschematic/exceptions'
 
 module Jschematic
   module Element
     attr_accessor :parent
+    attr_writer   :id
 
     def required?
       false
@@ -12,6 +13,14 @@ module Jschematic
       nil
     end
 
+    def id
+      if @parent
+        @parent.id + @id
+      else
+        @id
+      end
+    end
+
     def to_s
       self.class.to_s
     end

data/lib/jschematic/{validation_error.rb → exceptions.rb}

@@ -10,4 +10,16 @@ module Jschematic
       "#{what} expected #{expected} but found #{actual}"
     end
   end
+
+  class SchemaNotFoundError < StandardError
+    attr_reader :uri
+
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def to_s
+      "Cannot find schema for reference '#{uri}'"
+    end
+  end
 end

data/lib/jschematic/schema.rb

@@ -15,7 +15,26 @@ module Jschematic
       schema
     end
 
-    attr_reader :default, :title, :description, :id
+    def self.schema_for(ref)
+      if ref.relative?
+        rel = ref.omit(:scheme, :host, :port)
+        if match = schemas.find{ |ref, _| rel == ref.omit(:scheme, :host, :port) }
+          match[-1]
+        end
+      else
+        schemas[ref]
+      end
+    end
+
+    def self.add_schema(id, schema)
+      schemas[id] = schema
+    end
+
+    def self.schemas
+      @schemas ||= {}
+    end
+
+    attr_reader :default, :title, :description
 
     attr_accessor :name
     attr_writer   :parent
@@ -28,6 +47,8 @@ module Jschematic
       @description = @raw_schema.delete("description") || ""
       @id          = Addressable::URI.parse(@raw_schema.delete("id") || "")
 
+      self.class.add_schema(@id, self) unless @id.to_s.empty?
+
       @raw_schema.each_pair do |attribute, value|
         begin
           attribute = Attributes[attribute].new(value){ |dep| @raw_schema[dep] }
@@ -51,14 +72,6 @@ module Jschematic
       children.any?{ |child| child.required? }
     end
 
-    def id
-      if @parent
-        @parent.id + @id
-      else
-        @id
-      end
-    end
-
     private
 
     def add_default(instance)

data/lib/jschematic.rb

@@ -1,13 +1,13 @@
-require 'jschematic/schema'
+require 'jschematic/context'
 
 module Jschematic
-  def self.validate(instance, schema)
-    validate!(instance, schema)
+  def self.validate(instance, *schemas)
+    validate!(instance, *schemas)
   rescue ValidationError
     false
   end
 
-  def self.validate!(instance, schema)
-    Schema.new(schema).accepts?(instance)
+  def self.validate!(instance, *schemas)
+    Context.new(*schemas).validate!(instance)
   end
 end

data/spec/jschematic/attributes/enum_spec.rb

@@ -1,5 +1,31 @@
 require 'spec_helper'
 
+shared_examples_for "an element" do |args|
+  let(:parent) { double("a parent element") }
+  let(:good)   { args[:good] }
+  let(:bad)    { args[:bad] }
+
+  it "has a parent" do
+    element.parent = parent
+    element.parent.should === parent
+  end
+
+  it "accepts good instance values" do
+    element.should accept(good)
+  end
+
+  it "does not accept bad instance values" do
+    element.should_not accept(bad)
+  end
+
+  xit "adds errors to its parent" do
+    parent = Parent.new
+    element.parent = parent
+    element.validate(:garbage)
+    parent.errors.should include(some_stuff)
+  end
+end
+
 module Jschematic
   module Attributes
     describe Enum do
@@ -9,6 +35,10 @@ module Jschematic
         expect { subject.new("this is allowed, right?") }.to raise_error
         expect { subject.new(["not", "really"]) }.to_not raise_error
       end
+
+      it_should_behave_like "an element", good: 1, bad: 2 do
+        let(:element) { subject.new([1]) }
+      end
     end
   end
 end

data/spec/jschematic/attributes/format_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module Jschematic
+  module Attributes
+    describe Format do
+      it "returns a NullFormat when the format is not found" do
+        format = Format.new("i-don't-exist")
+        format.should be_an_instance_of(Format::NullFormat)
+        format.format.should == "i-don't-exist"
+      end
+    end
+  end
+end

data/spec/jschematic/attributes/ref_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Jschematic
+  module Attributes
+    describe Ref do
+      describe "#accepts?" do
+        it "fails when the references schema does not exist" do
+          Schema.schemas.should be_empty
+          ref = Ref.new("does_not_exist")
+          expect { ref.accepts?({}) }.to raise_error(Jschematic::SchemaNotFoundError)
+        end
+      end
+    end
+  end
+end

data/spec/jschematic/attributes_spec.rb

@@ -7,6 +7,11 @@ module Jschematic
         Attributes::ExclusiveMaximum.should_receive(:new).with(1, 2)
         subject["exclusiveMaximum"].new(1, 2)
       end
+
+      it "strips leading '$'" do
+        Attributes::Ref.should_receive(:new).with("foo")
+        subject["$ref"].new("foo")
+      end
     end
   end
 end

data/spec/jschematic/schema_spec.rb

@@ -32,27 +32,14 @@ module Jschematic
         description.should == ""
       end
     end
-  end
-
-  class Parent
-    attr_reader :id
-    def initialize(opts)
-      @id = opts["id"]
-      @children = []
-    end
 
-    def add_child(child)
-      child.parent = self
-      @children << child
-    end
-  end
-
-  describe Schema, "as a child element" do
-    it "builds its id from its parent" do
-      parent = Parent.new("id" => "http://www.example.com/parent/")
-      schema = Schema.new("id" => "child")
-      parent.add_child(schema)
-      schema.id.should == "http://www.example.com/parent/child"
+    describe "#id" do
+      it "is built from the parent's id" do
+        parent = Parent.new("id" => "http://www.example.com/parent/")
+        schema = Schema.new("id" => "child")
+        parent.add_child(schema)
+        schema.id.should == "http://www.example.com/parent/child"
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -14,3 +14,20 @@ RSpec::Matchers.define :accept do |instance_value|
   end
 end
 
+module Jschematic
+  class Parent
+    include Jschematic::Composite
+
+    def initialize(opts)
+      self.id = opts["id"]
+    end
+  end
+
+  class Child
+    include Jschematic::Element
+
+    def accepts?(instance)
+      !!instance
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Mike Sassak
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-22 00:00:00 -06:00
+date: 2011-03-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,6 +99,7 @@ files:
 - features/pattern.feature
 - features/pattern_properties.feature
 - features/properties.feature
+- features/ref.feature
 - features/required.feature
 - features/step_definitions/jschematic_steps.rb
 - features/support/env.rb
@@ -123,18 +124,22 @@ files:
 - lib/jschematic/attributes/pattern.rb
 - lib/jschematic/attributes/pattern_properties.rb
 - lib/jschematic/attributes/properties.rb
+- lib/jschematic/attributes/ref.rb
 - lib/jschematic/attributes/required.rb
 - lib/jschematic/attributes/type.rb
 - lib/jschematic/attributes/unique_items.rb
 - lib/jschematic/composite.rb
+- lib/jschematic/context.rb
 - lib/jschematic/element.rb
 - lib/jschematic/errors.rb
+- lib/jschematic/exceptions.rb
 - lib/jschematic/schema.rb
-- lib/jschematic/validation_error.rb
 - spec/jschematic/attributes/enum_spec.rb
+- spec/jschematic/attributes/format_spec.rb
 - spec/jschematic/attributes/max_items_spec.rb
 - spec/jschematic/attributes/min_items_spec.rb
 - spec/jschematic/attributes/minimum_maximum_spec.rb
+- spec/jschematic/attributes/ref_spec.rb
 - spec/jschematic/attributes/required_spec.rb
 - spec/jschematic/attributes/type_spec.rb
 - spec/jschematic/attributes_spec.rb
@@ -172,7 +177,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: jschematic 0.0.2
+summary: jschematic 0.0.5
 test_files: 
 - features/default.feature
 - features/dependencies.feature
@@ -185,14 +190,17 @@ test_files:
 - features/pattern.feature
 - features/pattern_properties.feature
 - features/properties.feature
+- features/ref.feature
 - features/required.feature
 - features/step_definitions/jschematic_steps.rb
 - features/support/env.rb
 - features/type.feature
 - spec/jschematic/attributes/enum_spec.rb
+- spec/jschematic/attributes/format_spec.rb
 - spec/jschematic/attributes/max_items_spec.rb
 - spec/jschematic/attributes/min_items_spec.rb
 - spec/jschematic/attributes/minimum_maximum_spec.rb
+- spec/jschematic/attributes/ref_spec.rb
 - spec/jschematic/attributes/required_spec.rb
 - spec/jschematic/attributes/type_spec.rb
 - spec/jschematic/attributes_spec.rb