json_schemer 0.2.11 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45e4c874bfbfd416a38a47a23cf9b5c561df5da3457b11b7cb6acc0f36a8f5d6
-  data.tar.gz: a62663e1c3f250af1b57418d666c4bbe9229212c00845dc3b5f6c34d7ab3d57c
+  metadata.gz: 0cc2fef0eeaaab0e1664a9fa5aa39c08ef2e1fbd8fb68d202bf1b50b7c0840ee
+  data.tar.gz: 438c507a7d8ffa674d34d22c647af0852eb031e02c491d274cc5d4dec5c185dd
 SHA512:
-  metadata.gz: ff9d2a99b3f964b71d1a98a9037d5465627b913616a6c0c6160d1fe71aac784891585b92339773e677fdc9637bed0e120935ad7f4c4f283dada6f96a219b2591
-  data.tar.gz: 78d254d698f87a46a1ba1737775178310d2cb0e9d25f095f2da7dede4bcfee58c62dcbd89899370c158638734041b59fe5f351156a713002ceeeca8552849638
+  metadata.gz: 84ba1ea8a43459ff6c5c835fd5f0aedaf00f8077ecd3ec0aefe88322f09ef868712702122790a56f30c33bb1ab3f2585bd7e9a57c94eb07f553d845322095ae8
+  data.tar.gz: 6709666d3f2cf98ba1b2f06712e90f564d33d6e861b15d9ff2cb3c109d9b3ca0816b456f22b837a18062824429c97b8d7ebeb9fbaaa75b67bb203dec8f56b310

data/.github/workflows/ci.yml

@@ -4,19 +4,13 @@ jobs:
   ruby:
     strategy:
       matrix:
-        ruby: [2.4.x, 2.5.x, 2.6.x]
+        ruby: [2.4, 2.5, 2.6, 2.7, truffleruby-head]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - uses: actions/setup-ruby@v1
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - uses: actions/setup-python@v1
-      with:
-        python-version: 3.x
     - run: |
-        pip install --user Flask
-        ./JSON-Schema-Test-Suite/bin/jsonschema_suite serve &
-        gem install bundler
         bundle install
         bundle exec rake test

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_schemer (0.2.11)
+    json_schemer (0.2.16)
       ecma-re-validator (~> 0.2)
       hana (~> 1.3)
       regexp_parser (~> 1.5)
@@ -10,12 +10,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ecma-re-validator (0.2.0)
+    ecma-re-validator (0.2.1)
       regexp_parser (~> 1.2)
-    hana (1.3.5)
+    hana (1.3.6)
     minitest (5.11.3)
     rake (13.0.1)
-    regexp_parser (1.7.0)
+    regexp_parser (1.8.1)
     uri_template (0.7.0)
 
 PLATFORMS

data/README.md

@@ -92,6 +92,20 @@ JSONSchemer.schema(
   # default: false
   insert_property_defaults: true,
 
+  # modify properties during validation. You can pass one Proc or a list of Procs to modify data.
+  # Proc/[Proc]
+  # default: nil
+  before_property_validation: proc do |data, property, property_schema, _parent|
+    data[property] ||= 42
+  end,
+
+  # modify properties after validation. You can pass one Proc or a list of Procs to modify data.
+  # Proc/[Proc]
+  # default: nil
+  after_property_validation: proc do |data, property, property_schema, _parent|
+    data[property] = Date.iso8601(data[property]) if property_schema.is_a?(Hash) && property_schema['format'] == 'date'
+  end,
+
   # resolve external references
   # 'net/http'/proc/lambda/respond_to?(:call)
   # 'net/http': proc { |uri| JSON.parse(Net::HTTP.get(uri)) }

data/lib/json_schemer.rb

@@ -14,6 +14,7 @@ require 'uri_template'
 
 require 'json_schemer/version'
 require 'json_schemer/format'
+require 'json_schemer/errors'
 require 'json_schemer/cached_ref_resolver'
 require 'json_schemer/schema/base'
 require 'json_schemer/schema/draft4'

data/lib/json_schemer/errors.rb

@@ -0,0 +1,31 @@
+# Based on code from @robacarp found in issue 48:
+# https://github.com/davishmcclurg/json_schemer/issues/48
+#
+module JSONSchemer
+  module Errors
+    class << self
+      def pretty(error)
+        data_pointer, type, schema = error.values_at('data_pointer', 'type', 'schema')
+        location = data_pointer.empty? ? 'root' : "property '#{data_pointer}'"
+
+        case type
+        when 'required'
+          keys = error.fetch('details').fetch('missing_keys').join(', ')
+          "#{location} is missing required keys: #{keys}"
+        when 'null', 'string', 'boolean', 'integer', 'number', 'array', 'object'
+          "#{location} is not of type: #{type}"
+        when 'pattern'
+          "#{location} does not match pattern: #{schema.fetch('pattern')}"
+        when 'format'
+          "#{location} does not match format: #{schema.fetch('format')}"
+        when 'const'
+          "#{location} is not: #{schema.fetch('const').inspect}"
+        when 'enum'
+          "#{location} is not one of: #{schema.fetch('enum')}"
+        else
+          "#{location} is invalid: error_type=#{type}"
+        end
+      end
+    end
+  end
+end

data/lib/json_schemer/format.rb

@@ -3,7 +3,7 @@ module JSONSchemer
   module Format
     # this is no good
     EMAIL_REGEX = /\A[^@\s]+@([\p{L}\d-]+\.)+[\p{L}\d\-]{2,}\z/i.freeze
-    LABEL_REGEX_STRING = '\p{L}([\p{L}\p{N}\-]*[\p{L}\p{N}])?'
+    LABEL_REGEX_STRING = '[\p{L}\p{N}]([\p{L}\p{N}\-]*[\p{L}\p{N}])?'
     HOSTNAME_REGEX = /\A(#{LABEL_REGEX_STRING}\.)*#{LABEL_REGEX_STRING}\z/i.freeze
     JSON_POINTER_REGEX_STRING = '(\/([^~\/]|~[01])*)*'
     JSON_POINTER_REGEX = /\A#{JSON_POINTER_REGEX_STRING}\z/.freeze

data/lib/json_schemer/schema/base.rb

@@ -4,16 +4,17 @@ module JSONSchemer
     class Base
       include Format
 
-      Instance = Struct.new(:data, :data_pointer, :schema, :schema_pointer, :parent_uri, :insert_property_defaults) do
+      Instance = Struct.new(:data, :data_pointer, :schema, :schema_pointer, :parent_uri, :before_property_validation, :after_property_validation) do
         def merge(
           data: self.data,
           data_pointer: self.data_pointer,
           schema: self.schema,
           schema_pointer: self.schema_pointer,
           parent_uri: self.parent_uri,
-          insert_property_defaults: self.insert_property_defaults
+          before_property_validation: self.before_property_validation,
+          after_property_validation: self.after_property_validation
         )
-          self.class.new(data, data_pointer, schema, schema_pointer, parent_uri, insert_property_defaults)
+          self.class.new(data, data_pointer, schema, schema_pointer, parent_uri, before_property_validation, after_property_validation)
         end
       end
 
@@ -29,10 +30,18 @@ module JSONSchemer
         :eol => '\z'
       }.freeze
 
+      INSERT_DEFAULT_PROPERTY = proc do |data, property, property_schema, _parent|
+        if !data.key?(property) && property_schema.is_a?(Hash) && property_schema.key?('default')
+          data[property] = property_schema.fetch('default').clone
+        end
+      end
+
       def initialize(
         schema,
         format: true,
         insert_property_defaults: false,
+        before_property_validation: nil,
+        after_property_validation: nil,
         formats: nil,
         keywords: nil,
         ref_resolver: DEFAULT_REF_RESOLVER
@@ -40,18 +49,20 @@ module JSONSchemer
         raise InvalidSymbolKey, 'schemas must use string keys' if schema.is_a?(Hash) && !schema.empty? && !schema.first.first.is_a?(String)
         @root = schema
         @format = format
-        @insert_property_defaults = insert_property_defaults
+        @before_property_validation = [*before_property_validation]
+        @before_property_validation.unshift(INSERT_DEFAULT_PROPERTY) if insert_property_defaults
+        @after_property_validation = [*after_property_validation]
         @formats = formats
         @keywords = keywords
         @ref_resolver = ref_resolver == 'net/http' ? CachedRefResolver.new(&NET_HTTP_REF_RESOLVER) : ref_resolver
       end
 
       def valid?(data)
-        valid_instance?(Instance.new(data, '', root, '', nil, !!@insert_property_defaults))
+        valid_instance?(Instance.new(data, '', root, '', nil, @before_property_validation, @after_property_validation))
       end
 
       def validate(data)
-        validate_instance(Instance.new(data, '', root, '', nil, !!@insert_property_defaults))
+        validate_instance(Instance.new(data, '', root, '', nil, @before_property_validation, @after_property_validation))
       end
 
     protected
@@ -101,7 +112,7 @@ module JSONSchemer
         if keywords
           keywords.each do |keyword, callable|
             if schema.key?(keyword)
-              result = callable.call(data, schema, instance.pointer)
+              result = callable.call(data, schema, instance.data_pointer)
               if result.is_a?(Array)
                 result.each(&block)
               elsif !result
@@ -119,7 +130,8 @@ module JSONSchemer
             subinstance = instance.merge(
               schema: subschema,
               schema_pointer: "#{instance.schema_pointer}/allOf/#{index}",
-              insert_property_defaults: false
+              before_property_validation: false,
+              after_property_validation: false
             )
             validate_instance(subinstance, &block)
           end
@@ -130,7 +142,8 @@ module JSONSchemer
             subinstance = instance.merge(
               schema: subschema,
               schema_pointer: "#{instance.schema_pointer}/anyOf/#{index}",
-              insert_property_defaults: false
+              before_property_validation: false,
+              after_property_validation: false
             )
             validate_instance(subinstance)
           end
@@ -142,7 +155,8 @@ module JSONSchemer
             subinstance = instance.merge(
               schema: subschema,
               schema_pointer: "#{instance.schema_pointer}/oneOf/#{index}",
-              insert_property_defaults: false
+              before_property_validation: false,
+              after_property_validation: false
             )
             validate_instance(subinstance)
           end
@@ -158,12 +172,13 @@ module JSONSchemer
           subinstance = instance.merge(
             schema: not_schema,
             schema_pointer: "#{instance.schema_pointer}/not",
-            insert_property_defaults: false
+            before_property_validation: false,
+            after_property_validation: false
           )
           yield error(subinstance, 'not') if valid_instance?(subinstance)
         end
 
-        if if_schema && valid_instance?(instance.merge(schema: if_schema, insert_property_defaults: false))
+        if if_schema && valid_instance?(instance.merge(schema: if_schema, before_property_validation: false, after_property_validation: false))
           validate_instance(instance.merge(schema: then_schema, schema_pointer: "#{instance.schema_pointer}/then"), &block) unless then_schema.nil?
         elsif if_schema
           validate_instance(instance.merge(schema: else_schema, schema_pointer: "#{instance.schema_pointer}/else"), &block) unless else_schema.nil?
@@ -487,10 +502,10 @@ module JSONSchemer
         dependencies = schema['dependencies']
         property_names = schema['propertyNames']
 
-        if instance.insert_property_defaults && properties
+        if instance.before_property_validation && properties
           properties.each do |property, property_schema|
-            if !data.key?(property) && property_schema.is_a?(Hash) && property_schema.key?('default')
-              data[property] = property_schema.fetch('default').clone
+            instance.before_property_validation.each do |hook|
+              hook.call(data, property, property_schema, schema)
             end
           end
         end
@@ -565,15 +580,21 @@ module JSONSchemer
             validate_instance(subinstance, &block)
           end
         end
+
+        if instance.after_property_validation && properties
+          properties.each do |property, property_schema|
+            instance.after_property_validation.each do |hook|
+              hook.call(data, property, property_schema, schema)
+            end
+          end
+        end
       end
 
       def safe_strict_decode64(data)
-        begin
-          Base64.strict_decode64(data)
-        rescue ArgumentError => e
-          raise e unless e.message == 'invalid base64'
-          nil
-        end
+        Base64.strict_decode64(data)
+      rescue ArgumentError => e
+        raise e unless e.message == 'invalid base64'
+        nil
       end
 
       def ecma_262_regex(pattern)
@@ -615,16 +636,15 @@ module JSONSchemer
         if schema.is_a?(Array)
           schema.each_with_index { |subschema, index| resolve_ids(subschema, ids, parent_uri, "#{pointer}/#{index}") }
         elsif schema.is_a?(Hash)
-          id = schema[id_keyword]
-          uri = join_uri(parent_uri, id)
-          unless uri == parent_uri
-            ids[uri.to_s] = {
-              schema: schema,
-              pointer: pointer
-            }
-          end
-          if definitions = schema['definitions']
-            definitions.each { |key, subschema| resolve_ids(subschema, ids, uri, "#{pointer}/definitions/#{key}") }
+          uri = join_uri(parent_uri, schema[id_keyword])
+          schema.each do |key, value|
+            if key == id_keyword && uri != parent_uri
+              ids[uri.to_s] = {
+                schema: schema,
+                pointer: pointer
+              }
+            end
+            resolve_ids(value, ids, uri, "#{pointer}/#{key}")
           end
         end
         ids

data/lib/json_schemer/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module JSONSchemer
-  VERSION = '0.2.11'
+  VERSION = '0.2.16'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schemer
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.16
 platform: ruby
 authors:
 - David Harsha
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2020-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,6 +127,7 @@ files:
 - json_schemer.gemspec
 - lib/json_schemer.rb
 - lib/json_schemer/cached_ref_resolver.rb
+- lib/json_schemer/errors.rb
 - lib/json_schemer/format.rb
 - lib/json_schemer/schema/base.rb
 - lib/json_schemer/schema/draft4.rb
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: JSON Schema validator. Supports drafts 4, 6, and 7.