json_schemer 2.2.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 730629a0650c643e352cd41f63ce3e41584e2a5f0a1fbf67ba2f2b4ea7f68dc0
-  data.tar.gz: 5b3718cb5e7a27d4a87592cc5ffc6573f63cef4c6be6efc5f55b2a42706d8aaf
+  metadata.gz: 04dbbf738ea9253437566fb50075ee7603fd0b536324181aebb0573c32c7f7bc
+  data.tar.gz: 29337d5892b33a2f74e435370986f059d7dd9762352bea610e7668dca3171e09
 SHA512:
-  metadata.gz: 9c8060d71e5c0d222de622780a57582d5a978bbdb84069cea6c62aee0a15713bbd82531f329559fb7613f39abf708a93c74c32404c1837026f2e3a55112d8042
-  data.tar.gz: 92d813c0738af624b6a226812eeff6aaec0898cb2e5a95d069d67fa7cd061229a960835d9def7e1528124274ff479080ff6925465056acfc6d8481d40cb4336f
+  metadata.gz: 90f1510bcc40ad9500904453dee34434b91ef45b8ab7d8be84dc728aae4d4c1a4556037f1ae8b48595198529973fe2d1e5c20a64e5aeb9871cd6fddd23636268
+  data.tar.gz: c7e8a861d8f763d5248d79d486d8b253b9f81e40952e896d53b7dad84bdd5197a70224008e79de5cf5b6e7a3e9a8e646bd8af4188ae6a87c4a7ac9011998f36f

data/.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: [2.5, 2.6, 2.7, 3.0, 3.1, 3.2, 3.3, head, jruby, jruby-head, truffleruby, truffleruby-head]
+        ruby: [2.7, 3.0, 3.1, 3.2, 3.3, 3.4, head, jruby, jruby-head, truffleruby, truffleruby-head]
         exclude:
           - os: ubuntu-latest
             ruby: head

data/CHANGELOG.md

@@ -1,8 +1,33 @@
 # Changelog
 
+## [2.4.0] - 2025-02-01
+
+### Bug Fixes
+
+- Store schema resource file URIs as strings to prevent conflicts: https://github.com/davishmcclurg/json_schemer/pull/189
+- Require OpenAPI `discriminator` instances to be objects: https://github.com/davishmcclurg/json_schemer/pull/206
+- Pass configuration options to subschemas: https://github.com/davishmcclurg/json_schemer/pull/208
+- Check applicable instance types in OpenAPI `format` extensions: https://github.com/davishmcclurg/json_schemer/pull/209
+- Use correct max values for OpenAPI `int32`/`int64` formats: https://github.com/davishmcclurg/json_schemer/commit/386c2a6fe089350c61775716643ef0600898060e
+
+[2.4.0]: https://github.com/davishmcclurg/json_schemer/releases/tag/v2.4.0
+
+## [2.3.0] - 2024-05-30
+
+### Ruby Versions
+
+- Ruby 2.5 and 2.6 are no longer supported.
+
+### Bug Fixes
+
+- Remove `base64` runtime dependency: https://github.com/davishmcclurg/json_schemer/pull/182
+- Relax `uuid` format validation: https://github.com/davishmcclurg/json_schemer/pull/183
+
+[2.3.0]: https://github.com/davishmcclurg/json_schemer/releases/tag/v2.3.0
+
 ## [2.2.0] - 2024-03-02
 
-## Bug Fixes
+### Bug Fixes
 
 - Support symbol keys when accessing original instance: https://github.com/davishmcclurg/json_schemer/commit/d52c130e9967919c6cf1c9dbc3f0babfb8b01cf8
 - Support custom keywords in nested schemas: https://github.com/davishmcclurg/json_schemer/commit/93c85a5006981347c7e9a4c11b73c6bdb65d8ba2
@@ -11,7 +36,7 @@
 - Handle parse errors during schema validation: https://github.com/davishmcclurg/json_schemer/pull/171
 - Follow refs when finding default property values: https://github.com/davishmcclurg/json_schemer/pull/175
 
-## Features
+### Features
 
 - Global configuration with `Configuration` object: https://github.com/davishmcclurg/json_schemer/pull/170
 - Symbol key property defaults with `insert_property_defaults: :symbol`: https://github.com/davishmcclurg/json_schemer/commit/a72473dc84199107ddedc8998950e5b82273232a

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    json_schemer (2.2.1)
-      base64
+    json_schemer (2.4.0)
       bigdecimal
       hana (~> 1.3)
       regexp_parser (~> 2.0)
@@ -12,38 +11,34 @@ GEM
   remote: https://rubygems.org/
   specs:
     base64 (0.2.0)
-    bigdecimal (3.1.7)
-    bigdecimal (3.1.7-java)
-    concurrent-ruby (1.2.2)
-    csv (3.2.8)
-    docile (1.4.0)
+    bigdecimal (3.1.9)
+    bigdecimal (3.1.9-java)
+    concurrent-ruby (1.3.5)
+    csv (3.3.2)
+    docile (1.4.1)
     hana (1.3.7)
-    i18n (1.14.1)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     i18n-debug (1.2.0)
       i18n (< 2)
-    minitest (5.15.0)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
+    minitest (5.25.4)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    simpleidn (0.2.1)
-      unf (~> 0.1.4)
-    unf (0.1.4)
-      unf_ext
-    unf (0.1.4-java)
-    unf_ext (0.0.9.1)
+    simpleidn (0.2.3)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  base64
+  bundler (~> 2.4.0)
   csv
   i18n
   i18n-debug
@@ -53,4 +48,4 @@ DEPENDENCIES
   simplecov (~> 0.22)
 
 BUNDLED WITH
-   2.3.27
+   2.4.22

data/README.md

@@ -95,18 +95,6 @@ JSONSchemer.validate_schema({ '$id' => '#invalid' }).to_a
 #      "type"=>"pattern",
 #      "error"=>"string at `/$id` does not match pattern: ^[^#]*#?$"}]
 
-JSONSchemer.schema({ '$id' => 'valid' }).valid_schema?
-# => true
-
-JSONSchemer.schema({ '$id' => '#invalid' }).validate_schema.to_a
-# => [{"data"=>"#invalid",
-#      "data_pointer"=>"/$id",
-#      "schema"=>{"$ref"=>"#/$defs/uriReferenceString", "$comment"=>"Non-empty fragments not allowed.", "pattern"=>"^[^#]*#?$"},
-#      "schema_pointer"=>"/properties/$id",
-#      "root_schema"=>{...meta schema},
-#      "type"=>"pattern",
-#      "error"=>"string at `/$id` does not match pattern: ^[^#]*#?$"}]
-
 # subschemas
 
 schema = {

data/json_schemer.gemspec

@@ -20,9 +20,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "base64"
+  spec.add_development_dependency "bundler", "~> 2.4.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "simplecov", "~> 0.22"
@@ -30,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "i18n"
   spec.add_development_dependency "i18n-debug"
 
-  spec.add_runtime_dependency "base64"
   spec.add_runtime_dependency "bigdecimal"
   spec.add_runtime_dependency "hana", "~> 1.3"
   spec.add_runtime_dependency "regexp_parser", "~> 2.0"

data/lib/json_schemer/content.rb

@@ -2,7 +2,7 @@
 module JSONSchemer
   module ContentEncoding
     BASE64 = proc do |instance|
-      [true, Base64.strict_decode64(instance)]
+      [true, instance.unpack1("m0")]
     rescue
       [false, nil]
     end

data/lib/json_schemer/draft202012/vocab/validation.rb

@@ -4,6 +4,10 @@ module JSONSchemer
     module Vocab
       module Validation
         class Type < Keyword
+          def self.valid_integer?(instance)
+            instance.is_a?(Numeric) && (instance.is_a?(Integer) || instance.floor == instance)
+          end
+
           def error(formatted_instance_location:, **)
             case value
             when 'null'
@@ -45,7 +49,7 @@ module JSONSchemer
             when 'number'
               instance.is_a?(Numeric)
             when 'integer'
-              instance.is_a?(Numeric) && (instance.is_a?(Integer) || instance.floor == instance)
+              self.class.valid_integer?(instance)
             when 'string'
               instance.is_a?(String)
             when 'array'

data/lib/json_schemer/draft4/vocab/validation.rb

@@ -4,9 +4,8 @@ module JSONSchemer
     module Vocab
       module Validation
         class Type < Draft202012::Vocab::Validation::Type
-        private
-          def valid_type(type, instance)
-            type == 'integer' ? instance.is_a?(Integer) : super
+          def self.valid_integer?(instance)
+            instance.is_a?(Integer)
           end
         end
 

data/lib/json_schemer/format.rb

@@ -74,7 +74,7 @@ module JSONSchemer
     IP_REGEX = /\A[\h:.]+\z/.freeze
     INVALID_QUERY_REGEX = /\s/.freeze
     IRI_ESCAPE_REGEX = /[^[:ascii:]]/
-    UUID_REGEX = /\A\h{8}-\h{4}-\h{4}-[89AB]\h{3}-\h{12}\z/i
+    UUID_REGEX = /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/i
     NIL_UUID = '00000000-0000-0000-0000-000000000000'
     BINARY_TO_PERCENT_ENCODED = 256.times.each_with_object({}) do |byte, out|
       out[-byte.chr(Encoding::BINARY)] = -sprintf('%%%02X', byte)

data/lib/json_schemer/openapi30/meta.rb

@@ -4,8 +4,10 @@ module JSONSchemer
     BASE_URI = URI('json-schemer://openapi30/schema')
     # https://spec.openapis.org/oas/v3.0.3#data-types
     FORMATS = OpenAPI31::FORMATS.merge(
-      'byte' => proc { |instance, _value| ContentEncoding::BASE64.call(instance).first },
-      'binary' => proc { |instance, _value| instance.is_a?(String) && instance.encoding == Encoding::BINARY },
+      'int32' => proc { |instance, _format| !Draft4::Vocab::Validation::Type.valid_integer?(instance) || instance.floor.bit_length < 32 },
+      'int64' => proc { |instance, _format| !Draft4::Vocab::Validation::Type.valid_integer?(instance) || instance.floor.bit_length < 64 },
+      'byte' => proc { |instance, _value| !instance.is_a?(String) || ContentEncoding::BASE64.call(instance).first },
+      'binary' => proc { |instance, _value| !instance.is_a?(String) || instance.encoding == Encoding::BINARY },
       'date' => Format::DATE
     )
     SCHEMA = {

data/lib/json_schemer/openapi31/meta.rb

@@ -4,10 +4,10 @@ module JSONSchemer
     BASE_URI = URI('https://spec.openapis.org/oas/3.1/dialect/base')
     # https://spec.openapis.org/oas/v3.1.0#data-types
     FORMATS = {
-      'int32' => proc { |instance, _format| instance.is_a?(Integer) && instance.bit_length <= 32 },
-      'int64' => proc { |instance, _format| instance.is_a?(Integer) && instance.bit_length <= 64 },
-      'float' => proc { |instance, _format| instance.is_a?(Float) },
-      'double' => proc { |instance, _format| instance.is_a?(Float) },
+      'int32' => proc { |instance, _format| !Draft202012::Vocab::Validation::Type.valid_integer?(instance) || instance.floor.bit_length < 32 },
+      'int64' => proc { |instance, _format| !Draft202012::Vocab::Validation::Type.valid_integer?(instance) || instance.floor.bit_length < 64 },
+      'float' => proc { |instance, _format| !instance.is_a?(Numeric) || instance.is_a?(Float) },
+      'double' => proc { |instance, _format| !instance.is_a?(Numeric) || instance.is_a?(Float) },
       'password' => proc { |_instance, _format| true }
     }
     SCHEMA = {

data/lib/json_schemer/openapi31/vocab/base.rb

@@ -100,7 +100,7 @@ module JSONSchemer
           end
 
           def validate(instance, instance_location, keyword_location, context)
-            return result(instance, instance_location, keyword_location, true) unless instance.is_a?(Hash)
+            return result(instance, instance_location, keyword_location, false) unless instance.is_a?(Hash)
 
             property_name = value.fetch('propertyName')
 

data/lib/json_schemer/resources.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module JSONSchemer
+  class Resources
+    def initialize
+      @resources = {}
+    end
+
+    def [](uri)
+      @resources[uri.to_s]
+    end
+
+    def []=(uri, resource)
+      @resources[uri.to_s] = resource
+    end
+
+    def fetch(uri)
+      @resources.fetch(uri.to_s)
+    end
+
+    def key?(uri)
+      @resources.key?(uri.to_s)
+    end
+  end
+end

data/lib/json_schemer/schema.rb

@@ -15,6 +15,7 @@ module JSONSchemer
       end
     end
 
+    extend Forwardable
     include Output
 
     SCHEMA_KEYWORD_CLASS = Draft202012::Vocab::Core::Schema
@@ -44,7 +45,8 @@ module JSONSchemer
 
     attr_accessor :base_uri, :meta_schema, :keywords, :keyword_order
     attr_reader :value, :parent, :root, :configuration, :parsed
-    attr_reader :vocabulary, :format, :formats, :content_encodings, :content_media_types, :custom_keywords, :before_property_validation, :after_property_validation, :insert_property_defaults
+    def_delegators :@configuration, :vocabulary, :format, :formats, :content_encodings, :content_media_types, :before_property_validation, :after_property_validation, :insert_property_defaults
+    def_delegator :@configuration, :keywords, :custom_keywords
 
     def initialize(
       value,
@@ -75,24 +77,27 @@ module JSONSchemer
       @root = root
       @keyword = keyword
       @schema = self
-      @configuration = configuration
       @base_uri = base_uri
       @meta_schema = meta_schema
-      @vocabulary = vocabulary
-      @format = format
-      @formats = formats
-      @content_encodings = content_encodings
-      @content_media_types = content_media_types
-      @custom_keywords = keywords
-      @before_property_validation = Array(before_property_validation)
-      @after_property_validation = Array(after_property_validation)
-      @insert_property_defaults = insert_property_defaults
-      @property_default_resolver = property_default_resolver
-      @original_ref_resolver = ref_resolver
-      @original_regexp_resolver = regexp_resolver
-      @output_format = output_format
-      @resolve_enumerators = resolve_enumerators
-      @access_mode = access_mode
+      @configuration = Configuration.new(
+        :base_uri => base_uri,
+        :meta_schema => meta_schema,
+        :vocabulary => vocabulary,
+        :format => format,
+        :formats => formats,
+        :content_encodings => content_encodings,
+        :content_media_types => content_media_types,
+        :keywords => keywords,
+        :before_property_validation => Array(before_property_validation),
+        :after_property_validation => Array(after_property_validation),
+        :insert_property_defaults => insert_property_defaults,
+        :property_default_resolver => property_default_resolver,
+        :ref_resolver => ref_resolver,
+        :regexp_resolver => regexp_resolver,
+        :output_format => output_format,
+        :resolve_enumerators => resolve_enumerators,
+        :access_mode => access_mode
+      )
       @parsed = parse
     end
 
@@ -100,7 +105,7 @@ module JSONSchemer
       validate(instance, :output_format => 'flag', **options).fetch('valid')
     end
 
-    def validate(instance, output_format: @output_format, resolve_enumerators: @resolve_enumerators, access_mode: @access_mode)
+    def validate(instance, output_format: @configuration.output_format, resolve_enumerators: @configuration.resolve_enumerators, access_mode: @configuration.access_mode)
       instance_location = Location.root
       context = Context.new(instance, [], nil, (!insert_property_defaults && output_format == 'flag'), access_mode)
       result = validate_instance(deep_stringify_keys(instance), instance_location, root_keyword_location, context)
@@ -328,7 +333,7 @@ module JSONSchemer
     end
 
     def resources
-      @resources ||= { :lexical => {}, :dynamic => {} }
+      @resources ||= { :lexical => Resources.new, :dynamic => Resources.new }
     end
 
     def error(formatted_instance_location:, **options)
@@ -340,17 +345,17 @@ module JSONSchemer
     end
 
     def ref_resolver
-      @ref_resolver ||= @original_ref_resolver == 'net/http' ? CachedResolver.new(&NET_HTTP_REF_RESOLVER) : @original_ref_resolver
+      @ref_resolver ||= @configuration.ref_resolver == 'net/http' ? CachedResolver.new(&NET_HTTP_REF_RESOLVER) : @configuration.ref_resolver
     end
 
     def regexp_resolver
-      @regexp_resolver ||= case @original_regexp_resolver
+      @regexp_resolver ||= case @configuration.regexp_resolver
       when 'ecma'
         CachedResolver.new(&ECMA_REGEXP_RESOLVER)
       when 'ruby'
         CachedResolver.new(&RUBY_REGEXP_RESOLVER)
       else
-        @original_regexp_resolver
+        @configuration.regexp_resolver
       end
     end
 
@@ -407,7 +412,11 @@ module JSONSchemer
     end
 
     def property_default_resolver
-      @property_default_resolver ||= insert_property_defaults == :symbol ? SYMBOL_PROPERTY_DEFAULT_RESOLVER : DEFAULT_PROPERTY_DEFAULT_RESOLVER
+      @property_default_resolver ||= if @configuration.property_default_resolver
+        @configuration.property_default_resolver
+      else
+        insert_property_defaults == :symbol ? SYMBOL_PROPERTY_DEFAULT_RESOLVER : DEFAULT_PROPERTY_DEFAULT_RESOLVER
+      end
     end
 
     def resolve_enumerators!(output)

data/lib/json_schemer/version.rb

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

data/lib/json_schemer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'base64'
 require 'bigdecimal'
+require 'forwardable'
 require 'ipaddr'
 require 'json'
 require 'net/http'
@@ -60,6 +60,7 @@ require 'json_schemer/openapi30/vocab/base'
 require 'json_schemer/openapi30/vocab'
 require 'json_schemer/openapi'
 require 'json_schemer/configuration'
+require 'json_schemer/resources'
 require 'json_schemer/schema'
 
 module JSONSchemer
@@ -104,12 +105,16 @@ module JSONSchemer
 
   WINDOWS_URI_PATH_REGEX = /\A\/[a-z]:/i
 
+  # :nocov:
+  URI_PARSER = URI.const_defined?(:RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
+  # :nocov:
+
   FILE_URI_REF_RESOLVER = proc do |uri|
     raise InvalidFileURI, 'must use `file` scheme' unless uri.scheme == 'file'
     raise InvalidFileURI, 'cannot have a host (use `file:///`)' if uri.host && !uri.host.empty?
     path = uri.path
     path = path[1..-1] if path.match?(WINDOWS_URI_PATH_REGEX)
-    JSON.parse(File.read(URI::DEFAULT_PARSER.unescape(path)))
+    JSON.parse(File.read(URI_PARSER.unescape(path)))
   end
 
   class << self
@@ -247,7 +252,7 @@ module JSONSchemer
       when String
         JSON.parse(schema)
       when Pathname
-        base_uri = URI.parse(File.join('file:', URI::DEFAULT_PARSER.escape(schema.realpath.to_s)))
+        base_uri = URI.parse(File.join('file:', URI_PARSER.escape(schema.realpath.to_s)))
         options[:base_uri] = base_uri
         if options.key?(:ref_resolver)
           FILE_URI_REF_RESOLVER.call(base_uri)

metadata

@@ -1,29 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: json_schemer
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.4.0
 platform: ruby
 authors:
 - David Harsha
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2025-02-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +121,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: base64
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +177,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-description:
 email:
 - davishmcclurg@gmail.com
 executables:
@@ -246,6 +244,7 @@ files:
 - lib/json_schemer/openapi31/vocab.rb
 - lib/json_schemer/openapi31/vocab/base.rb
 - lib/json_schemer/output.rb
+- lib/json_schemer/resources.rb
 - lib/json_schemer/result.rb
 - lib/json_schemer/schema.rb
 - lib/json_schemer/version.rb
@@ -253,7 +252,6 @@ homepage: https://github.com/davishmcclurg/json_schemer
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -261,15 +259,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: JSON Schema validator. Supports drafts 4, 6, 7, 2019-09, 2020-12, OpenAPI
   3.0, and OpenAPI 3.1.