jschematic 0.0.6 → 0.0.9

data/Gemfile.lock

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

data/History.txt

@@ -1,3 +1,10 @@
+== In Git
+* Store $schema values on Schema objects if available (Mike Sassak)
+* Support divisibleBy (Mike Sassak)
+* Store unknown schema attributes on the schema, and warn when Jschematic.debug 
+  is set to true (Mike Sassak)
+* Support disallow (Mike Sassak)
+
 == 0.0.6
 * Improve and document the Context API (Mike Sassak)
 

data/README.md

@@ -1,21 +1,29 @@
 # Jschematic
 
-Jschematic is a JSON Schema v3 Validator for Ruby.
+Jschematic is a JSON Schema Validator for Ruby. Its aim is to validate
+schemas conforming to the most recent version of the JSON Schema draft
+standard, which today means v3.
 
-It is currently pre-release software. The basics work fairly well, but
-it is a work in progress.
+Supporting older versions of the standard is not out of the question,
+but it is not a primary development focus.
 
-Most of the core schema definition is supported with these exceptions:
+## Status
 
- * $schema
- * extends
- * divisibleBy
- * disallow
+Core schema: fully supported
+Hyper schema: not supported
 
-In addition to this, only DateTime, Date, IPv4, IPv6 and URI formats are currently
-implemented.
+The format attribute supports only these formats:
 
-Please report any bugs you find in the issue tracker here: 
+ * date-time
+ * date
+ * ip-address
+ * ipv6
+ * uri
+
+Adding ad-hoc support for different formats should be relatively painless.
+Look in jschematic/attributes/format.rb to get started.
+
+Please report any bugs you find in the issue tracker here:
 https://github.com/msassak/jschematic/issues.
 
 ## Basic Usage
@@ -35,9 +43,16 @@ Pass extra schemas to inform the validation context:
 
     Jschematic.validate(json, schema, :context => [cs1, cs2])
 
-Each context schema will be consulting in those cases where cross-schema
+Each context schema will be consulted in those cases where cross-schema
 referencing is allowed, e.g. $ref.
 
+To enable debugging support, set :debug to true in the options hash:
+
+    Jschematic.validate!(json, schema, :debug => true)
+
+With debugging on a warning is printed when schema contain unknown
+attributes.
+
 ## Testing
 
     $ cucumber

data/features/disallow.feature

@@ -0,0 +1,33 @@
+Feature: Core schema: disallow
+
+  Scenario: simple type
+    When the schema is:
+      """
+      {
+          "disallow": "integer"
+      }
+      """
+    Then these are valid JSON:
+      | "oh hai" |
+      | 3.14159  |
+      | [1,2,3]  |
+    But '42' is not valid JSON
+
+  Scenario: complex type
+    When the schema is:
+      """
+      {
+          "disallow": [
+              "string",
+              { "type": "float" }
+          ]
+      }
+      """
+    Then these are valid JSON:
+      | 42               |
+      | [1,2,3,4]        |
+      | { "foo": "bar" } |
+    But these are not valid JSON:
+      | "hi how are you?" |
+      | 3.14159           |
+

data/features/divisible_by.feature

@@ -0,0 +1,17 @@
+Feature: Core schema: divisibleBy
+  Scenario: No remainder
+    Given the schema is:
+      """
+      {
+          "divisibleBy": 2
+      }
+      """
+    Then these are valid JSON:
+      | 0    |
+      | 2    |
+      | 42.0 |
+    But these are not valid JSON:
+      | 0.1  |
+      | 1    |
+      | 13   |
+

data/features/extends.feature

@@ -0,0 +1,115 @@
+Feature: Core schema: extends
+
+  Background:
+    Given the validation context contains this schema:
+      """
+      {
+          "id": "person",
+          "properties": {
+              "name": {
+                  "type": "string",
+                  "required": true
+              }
+          }
+      }
+      """
+
+  Scenario: extending a single schema by ID
+    When the schema is:
+      """
+      {
+          "properties": {
+              "age": {
+                  "type": "integer",
+                  "required": true
+              }
+          },
+          "extends": "person"
+      }
+      """
+    Then this is valid JSON:
+      """
+      {
+          "name": "Felizberto Albi Perez Fernandez Mariposa Carlos Velasquez",
+          "age": 24
+      }
+      """
+    But this is not valid JSON:
+      """
+      {
+          "age": 24
+      }
+      """
+
+  Scenario: extending a literal schema
+    When the schema is:
+      """
+      {
+          "properties": {
+              "age": {
+                  "type": "integer",
+                  "required": true
+              }
+          },
+
+          "extends": {
+              "properties": {
+                  "name": {
+                      "type": "string",
+                      "required": true
+                  }
+              }
+          }
+      }
+      """
+    Then this is valid JSON:
+      """
+      {
+          "name": "Felizberto Albi Perez Fernandez Mariposa Carlos Velasquez",
+          "age": 24
+      }
+      """
+    But this is not valid JSON:
+      """
+      {
+          "age": 24
+      }
+      """
+
+  Scenario: extending multiple schemas
+    When the schema is:
+      """
+      {
+          "properties": {
+              "age": {
+                  "type": "integer",
+                  "required": true
+              }
+          },
+          "extends": [
+              "person",
+
+              {
+                  "properties": {
+                      "height": {
+                          "type": "number",
+                          "required": true
+                      }
+                  }
+              }
+          ]
+      }
+      """
+    Then this is valid JSON:
+      """
+      {
+          "name": "Felizberto Albi Perez Fernandez Mariposa Carlos Velasquez",
+          "age": 24,
+          "height": 5.8
+      }
+      """
+    But these are not valid JSON:
+      | { "age": 24, "height": 6 } |
+      | { "name": "Foo bar" }      |
+
+

data/features/format.feature

@@ -84,6 +84,7 @@ Feature: Core schema: format
       | "2011-02-27" |
       | "1980-02-29" |
     But these are not valid JSON:
-      | "1981-02-29"       |
-      | "August 1st, 1986" |
+      | "1981-02-29"           |
+      | "August 1st, 1986"     |
+      | "1980-02-29T08:51:32Z" |
 

data/features/ref.feature

@@ -135,4 +135,3 @@ Feature: Core schema: $ref
       ]
       """
 
-  Scenario: Ref appears before the id it references

data/features/type.feature

@@ -61,12 +61,12 @@ Feature: Core Schema: type
     When the schema is '{ "type": ["string", "null"] }'
     Then 'null' is valid JSON
 
-  Scenario: union with schema element 
+  Scenario: union with schema element
     When the schema is:
       """
       {
           "type": [
-              "string", 
+              "string",
               { "type": "integer", "maximum": 2112 }
           ]
       }

data/jschematic.gemspec

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

data/lib/jschematic.rb

@@ -8,6 +8,11 @@ module Jschematic
   end
 
   def self.validate!(instance, schema, opts={})
+    self.debug = opts[:debug]
     Context.new(*opts[:context]).validate!(instance, schema)
   end
+
+  class << self
+    attr_accessor :debug
+  end
 end

data/lib/jschematic/attributes.rb

@@ -18,6 +18,9 @@ require 'jschematic/attributes/min_length'
 require 'jschematic/attributes/max_length'
 require 'jschematic/attributes/enum'
 require 'jschematic/attributes/format'
+require 'jschematic/attributes/divisible_by'
+require 'jschematic/attributes/disallow'
+require 'jschematic/attributes/extends'
 require 'jschematic/attributes/ref'
 
 module Jschematic

data/lib/jschematic/attributes/disallow.rb

@@ -0,0 +1,16 @@
+module Jschematic
+  module Attributes
+    class Disallow < Type
+      # disallow inverts the type attribute, so it succeeds if type fails
+      def accepts?(instance)
+        inverted = begin
+          super
+          false
+        rescue ValidationError
+          true
+        end
+        inverted || fail_validation!("instance not to be of type '#{type}'", instance)
+      end
+    end
+  end
+end

data/lib/jschematic/attributes/divisible_by.rb

@@ -0,0 +1,20 @@
+require 'jschematic/element'
+
+module Jschematic
+  module Attributes
+    class DivisibleBy
+      include Jschematic::Element
+
+      def initialize(divisor)
+        @divisor = divisor
+      end
+
+      def accepts?(dividend)
+        return true unless Numeric === dividend
+
+        remainder = (dividend % @divisor)
+        (remainder == 0) || fail_validation!("#{dividend} modulo #{@divisor} to have a remainder of 0", remainder)
+      end
+    end
+  end
+end

data/lib/jschematic/attributes/extends.rb

@@ -0,0 +1,30 @@
+require 'addressable/uri'
+
+require 'jschematic/element'
+
+module Jschematic
+  module Attributes
+    class Extends
+      include Jschematic::Element
+
+      def initialize(id_or_schema_or_array_of_schemas)
+        @schema = id_or_schema_or_array_of_schemas
+      end
+
+      def accepts?(instance)
+        case @schema
+        when String
+          uri = Addressable::URI.parse(@schema)
+          schema = Schema.schema_for(uri)
+          schema.accepts?(instance)
+        when Hash
+          Schema.new(@schema).accepts?(instance)
+        when Array
+          @schema.all? do |schema|
+            Extends.new(schema).accepts?(instance)
+          end
+        end || fail_validation!(@schema, instance)
+      end
+    end
+  end
+end

data/lib/jschematic/attributes/format.rb

@@ -69,6 +69,7 @@ module Jschematic
         include Jschematic::Element
 
         def accepts?(date)
+          raise ArgumentError unless date =~ /^\d{4}-\d{2}-\d{2}$/
           ::Date.strptime(date)
         rescue ArgumentError
           false

data/lib/jschematic/attributes/maximum.rb

@@ -10,10 +10,9 @@ module Jschematic
       def initialize(maximum)
         @maximum = maximum
       end
-      
+
       def accepts?(number)
-        return true unless maximum
-        return true unless (number.kind_of?(Integer) || number.kind_of?(Float))
+        return true unless Numeric === number
 
         (number <= maximum) || fail_validation!("<= #{@maximum}", number)
       end

data/lib/jschematic/attributes/minimum.rb

@@ -12,8 +12,7 @@ module Jschematic
       end
 
       def accepts?(number)
-        return true unless minimum
-        return true unless (number.kind_of?(Integer) || number.kind_of?(Float))
+        return true unless Numeric === number
 
         (number >= minimum) || fail_validation!(">= #{@minimum}", number)
       end

data/lib/jschematic/attributes/type.rb

@@ -18,7 +18,7 @@ module Jschematic
         when /^object$/
           assert_kind_of([Hash], instance)
         when /^number$/
-          assert_kind_of([Float, Integer], instance)
+          assert_kind_of([Numeric], instance)
         when /^integer$/
           assert_kind_of([Integer], instance)
         when /^boolean$/
@@ -28,7 +28,7 @@ module Jschematic
         when /^any$/
           true
         when Array # union
-          # TODO: this is gross. A specific Union type is likely called for.
+          # TODO: this is gross. A specific Union type is likely called for
           type.any? do |union_type|
             begin
               if String===union_type
@@ -39,16 +39,16 @@ module Jschematic
             rescue ValidationError
               false
             end
-          end
-        else 
-          # TODO: probably worth just putting in explicit mapping for all 
+          end || fail_validation!(type, instance)
+        else
+          # TODO: probably worth just putting in explicit mapping for all
           # JSON schema types--there are only a few left
           assert_kind_of([constantize(type)], instance)
         end
       end
 
       private
-      
+
       def assert_kind_of(klassen, instance)
         klassen.any?{ |klass| instance.kind_of?(klass) } || fail_validation!(klassen, instance)
       end

data/lib/jschematic/schema.rb

@@ -34,7 +34,7 @@ module Jschematic
       @schemas ||= {}
     end
 
-    attr_reader :default, :title, :description
+    attr_reader :default, :title, :description, :schema, :unknown_attributes
 
     attr_accessor :name
     attr_writer   :parent
@@ -45,8 +45,11 @@ module Jschematic
       @default     = @raw_schema.delete("default")
       @title       = @raw_schema.delete("title") || ""
       @description = @raw_schema.delete("description") || ""
+      @schema      = @raw_schema.delete("$schema")
       @id          = Addressable::URI.parse(@raw_schema.delete("id") || "")
 
+      @unknown_attributes = {}
+
       self.class.add_schema(@id, self) unless @id.to_s.empty?
 
       @raw_schema.each_pair do |attribute, value|
@@ -54,12 +57,8 @@ module Jschematic
           attribute = Attributes[attribute].new(value){ |dep| @raw_schema[dep] }
           add_child(attribute)
         rescue NameError => e
-          # Not finding an attribute is not necessarily an error, but this is
-          # obviously not the right way to handle it. Need to find a better way to
-          # report information.
-          # should we create accessors for property on the schema?
-          # we could have Attributes.[] raise a special exception rather than NameError
-          puts "NameError #{e} encountered... continuing"
+          warn "Attribute lookup failed for '#{attribute}' with: #{e.message}" if Jschematic.debug
+          @unknown_attributes[attribute] = value
         end
       end
     end

data/spec/jschematic/attributes/disallow_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Jschematic
+  module Attributes
+    describe Disallow do
+      subject { Disallow.new("any") }
+      it { should_not accept("a string") }
+      it { should_not accept(1234) }
+      it { should_not accept(1.234) }
+      it { should_not accept([1,2,3]) }
+      it { should_not accept({"foo" => "bar"}) }
+      it { should_not accept(true) }
+    end
+  end
+end

data/spec/jschematic/attributes/divisible_by_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+module Jschematic
+  module Attributes
+    describe DivisibleBy do
+      subject { DivisibleBy.new(2.0) }
+      it { should accept("a string") }
+      it { should accept("1.2345")   }
+      it { should accept([1,2,3])    }
+    end
+  end
+end

data/spec/jschematic/schema_spec.rb

@@ -41,5 +41,21 @@ module Jschematic
         schema.id.should == "http://www.example.com/parent/child"
       end
     end
+
+    describe "#schema" do
+      it "contains the value of the $schema property if it exists" do
+        schema = Schema.new({ "$schema" => "http://json-schema.org/draft-03/schema#" }).schema
+        schema.should == "http://json-schema.org/draft-03/schema#"
+
+        Schema.new({}).schema.should be_nil
+      end
+    end
+
+    describe "#unknown_attributes" do
+      it "contains all the unknown attributes from the input schema" do
+        schema = Schema.new({ "flarble" => [:oh, :my, :blargle], "type" => "string" })
+        schema.unknown_attributes.should == { "flarble" => [:oh, :my, :blargle] }
+      end
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Mike Sassak
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 -05:00
+date: 2011-05-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,7 +90,10 @@ files:
 - cucumber.yml
 - features/default.feature
 - features/dependencies.feature
+- features/disallow.feature
+- features/divisible_by.feature
 - features/enum.feature
+- features/extends.feature
 - features/format.feature
 - features/id.feature
 - features/items.feature
@@ -110,9 +113,12 @@ files:
 - lib/jschematic/attributes/additional_items.rb
 - lib/jschematic/attributes/additional_properties.rb
 - lib/jschematic/attributes/dependencies.rb
+- lib/jschematic/attributes/disallow.rb
+- lib/jschematic/attributes/divisible_by.rb
 - lib/jschematic/attributes/enum.rb
 - lib/jschematic/attributes/exclusive_maximum.rb
 - lib/jschematic/attributes/exclusive_minimum.rb
+- lib/jschematic/attributes/extends.rb
 - lib/jschematic/attributes/format.rb
 - lib/jschematic/attributes/items.rb
 - lib/jschematic/attributes/max_items.rb
@@ -134,6 +140,8 @@ files:
 - lib/jschematic/errors.rb
 - lib/jschematic/exceptions.rb
 - lib/jschematic/schema.rb
+- spec/jschematic/attributes/disallow_spec.rb
+- spec/jschematic/attributes/divisible_by_spec.rb
 - spec/jschematic/attributes/enum_spec.rb
 - spec/jschematic/attributes/format_spec.rb
 - spec/jschematic/attributes/max_items_spec.rb
@@ -177,11 +185,14 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: jschematic 0.0.6
+summary: jschematic 0.0.9
 test_files: 
 - features/default.feature
 - features/dependencies.feature
+- features/disallow.feature
+- features/divisible_by.feature
 - features/enum.feature
+- features/extends.feature
 - features/format.feature
 - features/id.feature
 - features/items.feature
@@ -195,6 +206,8 @@ test_files:
 - features/step_definitions/jschematic_steps.rb
 - features/support/env.rb
 - features/type.feature
+- spec/jschematic/attributes/disallow_spec.rb
+- spec/jschematic/attributes/divisible_by_spec.rb
 - spec/jschematic/attributes/enum_spec.rb
 - spec/jschematic/attributes/format_spec.rb
 - spec/jschematic/attributes/max_items_spec.rb