json_schema 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4d9fa48c12abc2fe791ec053a7069ed2dd3dbdf
-  data.tar.gz: 285f81709fce34c3422adbe16929dcdb9932fe1f
+  metadata.gz: 8dd8c031b8ddc8eab131da6a1d5872b8c3b3ac06
+  data.tar.gz: ee2287a4e2a950024e987364afcd6ee0488b0321
 SHA512:
-  metadata.gz: 859c229811d914bf648667291c952a87d3a19af4daafcf76f9e03844c511b3c818cdeb117c34673c12031a45b5e0c1e0997a2b52090ad585f8137ba972c300f3
-  data.tar.gz: 1757e0c6ef2e29ac529221f758d90ed06561614ea6c6f3539f8d4d75789c303d62f7a1445efcebbc439d3f9f86381d5d35284a7314cf25c0b59d8bdaaab94976
+  metadata.gz: d9a4e08cc35055843d3ac60d02797042258b513941ff965f653739f7f05dd4361127d83b3c1a507873b04931d2fdb3ce9565eb7c8c379e2dc4739ec48e67cf22
+  data.tar.gz: 3ddcf6d896d86616deb12746482cfdb4fd30666dbf55f0af7b1947d5dd93a4e3148b45be581db1107117d91ff9eff285529d0b0184d2cb3e6fbf71003b81ef7a

data/README.md

@@ -57,8 +57,10 @@ ruby -Ilib -Itest test/json_schema/validator_test.rb -n /anyOf/
 
 ## Release
 
-Use the `release` task:
+1. Update the version in `json_schema.gemspec` as appropriate for [semantic
+   versioning](http://semver.org).
+2. Run the `release` task:
 
-```
-bundle exec rake release
-```
+    ```
+    bundle exec rake release
+    ```

data/lib/json_schema/configuration.rb

@@ -1,15 +1,26 @@
 module JsonSchema
   class Configuration
+    attr_reader :custom_formats
     attr_reader :validate_regex_with
 
     def validate_regex_with=(validator)
       @validate_regex_with = validator
     end
 
+    def register_format(name, validator_proc)
+      @custom_formats[name] = validator_proc
+    end
+
+    # Used for testing.
+    def reset!
+      @validate_regex_with = nil
+      @custom_formats = {}
+    end
+
     private
 
     def initialize
-      @validate_regex_with = nil
+      reset!
     end
 
   end

data/lib/json_schema/parser.rb

@@ -1,10 +1,11 @@
 require_relative "../json_reference"
+require_relative "validator"
 
 module JsonSchema
   class Parser
     ALLOWED_TYPES = %w{any array boolean integer number null object string}
     BOOLEAN = [FalseClass, TrueClass]
-    FORMATS = %w{date date-time email hostname ipv4 ipv6 regex uri uuid}
+    FORMATS = JsonSchema::Validator::DEFAULT_FORMAT_VALIDATORS.keys
     FRIENDLY_TYPES = {
       Array      => "array",
       FalseClass => "boolean",
@@ -346,9 +347,10 @@ module JsonSchema
     end
 
     def validate_format(schema, format)
-      return if FORMATS.include?(format)
+      valid_formats = FORMATS + JsonSchema.configuration.custom_formats.keys
+      return if valid_formats.include?(format)
 
-      message = %{#{format.inspect} is not a valid format, must be one of #{FORMATS.join(', ')}.}
+      message = %{#{format.inspect} is not a valid format, must be one of #{valid_formats.join(', ')}.}
       @errors << SchemaError.new(schema, message, :unknown_format)
     end
   end

data/lib/json_schema/validator.rb

@@ -184,27 +184,11 @@ module JsonSchema
 
     def validate_format(schema, data, errors, path)
       return true unless schema.format
-      valid = case schema.format
-      when "date"
-        data =~ DATE_PATTERN
-      when "date-time"
-        data =~ DATE_TIME_PATTERN
-      when "email"
-        data =~ EMAIL_PATTERN
-      when "hostname"
-        data =~ HOSTNAME_PATTERN
-      when "ipv4"
-        data =~ IPV4_PATTERN
-      when "ipv6"
-        data =~ IPV6_PATTERN
-      when "regex"
-        Regexp.new(data) rescue false
-      when "uri"
-        URI.parse(data) rescue false
-      when "uuid"
-        data =~ UUID_PATTERN
-      end
-      if valid
+      validator = (
+        JsonSchema.configuration.custom_formats[schema.format] ||
+        DEFAULT_FORMAT_VALIDATORS[schema.format]
+      )
+      if validator[data]
         true
       else
         message = %{#{data} is not a valid #{schema.format}.}
@@ -543,6 +527,18 @@ module JsonSchema
       key || fragment
     end
 
+    DEFAULT_FORMAT_VALIDATORS = {
+      "date" => ->(data) { data =~ DATE_PATTERN },
+      "date-time" => ->(data) { data =~ DATE_TIME_PATTERN },
+      "email" => ->(data) { data =~ EMAIL_PATTERN },
+      "hostname" => ->(data) { data =~ HOSTNAME_PATTERN },
+      "ipv4" => ->(data) { data =~ IPV4_PATTERN },
+      "ipv6" => ->(data) { data =~ IPV6_PATTERN },
+      "regex" => ->(data) { Regexp.new(data) rescue false },
+      "uri" => ->(data) { URI.parse(data) rescue false },
+      "uuid" => ->(data) { data =~ UUID_PATTERN },
+    }.freeze
+
     EMAIL_PATTERN = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i
 
     HOSTNAME_PATTERN = /^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$/

data/test/json_schema/parser_test.rb

@@ -4,9 +4,7 @@ require "json_schema"
 
 describe JsonSchema::Parser do
   after do
-    JsonSchema.configure do |c|
-      c.validate_regex_with = nil
-    end
+    JsonSchema.configuration.reset!
   end
 
   it "parses the basic attributes of a schema" do
@@ -288,6 +286,27 @@ describe JsonSchema::Parser do
     assert_includes error_types, :regex_failed
   end
 
+  it "parses custom formats" do
+    JsonSchema.configure do |c|
+      c.register_format 'the-answer', ->(data) { data.to_i == 42 }
+    end
+    schema_sample["format"] = "the-answer"
+    assert parse
+  end
+
+  it "rejects bad formats even when there are custom formats defined" do
+    JsonSchema.configure do |c|
+      c.register_format "the-answer", ->(data) { data.to_i == 42 }
+    end
+    schema_sample["format"] = "not-a-format"
+    refute parse
+    assert_includes error_messages, '"not-a-format" is not a valid format, ' \
+                                    'must be one of date, date-time, email, ' \
+                                    'hostname, ipv4, ipv6, regex, uri, uuid, ' \
+                                    'the-answer.'
+    assert_includes error_types, :unknown_format
+  end
+
   def error_messages
     @parser.errors.map { |e| e.message }
   end

data/test/json_schema/validator_test.rb

@@ -3,6 +3,10 @@ require "test_helper"
 require "json_schema"
 
 describe JsonSchema::Validator do
+  after do
+    JsonSchema.configuration.reset!
+  end
+
   it "can find data valid" do
     assert validate
   end
@@ -813,6 +817,30 @@ describe JsonSchema::Validator do
   end
 =end
 
+  it "validates custom formats successfully" do
+    JsonSchema.configure do |c|
+      c.register_format "the-answer", ->(data) { data.to_i == 42 }
+    end
+    pointer("#/definitions/app/definitions/owner").merge!(
+      "format" => "the-answer"
+    )
+    data_sample["owner"] = "42"
+    assert validate
+  end
+
+  it "validates custom formats unsuccessfully" do
+    JsonSchema.configure do |c|
+      c.register_format "the-answer", ->(data) { data.to_i == 42 }
+    end
+    pointer("#/definitions/app/definitions/owner").merge!(
+      "format" => "the-answer"
+    )
+    data_sample["owner"] = "43"
+    refute validate
+    assert_includes error_messages, %{43 is not a valid the-answer.}
+    assert_includes error_types, :invalid_format
+  end
+
   def data_sample
     @data_sample ||= DataScaffold.data_sample
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Brandur