json-schema 2.7.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f440a3f87c238f6b4a3ba8fb93818ae17affd9fc
-  data.tar.gz: 910c2401bf9e11a0d57dfe8e47086c876e7e48b4
+SHA256:
+  metadata.gz: ab17ffc9133c3115ad9bb2f4b37338ee71d1994bf62849e7557b7e41a9d1d8e9
+  data.tar.gz: 3c44c431d8997fa255613bd6235fdd82b3c7c15ecc9e1077a1d41ff33b31c69b
 SHA512:
-  metadata.gz: dbf3e34a23275021b9cf6f9d9ccb5aa86956182411f55e93fa3cd29b30d24b01d18c30e191cb31dd5a1c71b780188b08cb261d7248e203bcfa74d9b1f104f273
-  data.tar.gz: a5311ed16954806392eabe157ccd92d9b54b3e20e228697c31bc0042f1455c0b7e4bff6a2b33db473a93116020fdcf9a6296e621cb55638287103142e54c3839
+  metadata.gz: 999689f22f02b64395c78b537ee86f6f0390e9cb2dc57e14293d310999bf11b5633b2fe16f1ca4c773bedb90e002452617f3df6926ff955deb84cca5446381ce
+  data.tar.gz: 71f12207a56541aab4ba1157d74e988295aff34e181daeb8937ed1e8bdc7a81025baaad536a0634da49527d63c71d341d433832cb56672b60f7fd920dcecda1a

data/README.md

@@ -1,8 +1,11 @@
-[![Travis](https://travis-ci.org/ruby-json-schema/json-schema.svg?branch=master)](https://travis-ci.org/ruby-json-schema/json-schema)
-[![Code Climate](https://codeclimate.com/github/ruby-json-schema/json-schema/badges/gpa.svg)](https://codeclimate.com/github/ruby-json-schema/json-schema)
+# Ruby JSON Schema Validator
 
-Ruby JSON Schema Validator
-==========================
+[![License](https://img.shields.io/github/license/voxpupuli/json-schema.svg)](https://github.com/voxpupuli/json-schema/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/json-schema/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/json-schema/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/json-schema/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/json-schema/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/json-schema.svg)](https://rubygems.org/gems/json-schema)
+[![RubyGem Downloads](https://img.shields.io/gem/dt/json-schema.svg)](https://rubygems.org/gems/json-schema)
+[![Donated by Iain Beeston](https://img.shields.io/badge/donated%20by-Iain%20Beeston-fb7047.svg)](#transfer-notice)
 
 This library is intended to provide Ruby with an interface for validating JSON
 objects against a JSON schema conforming to [JSON Schema Draft
@@ -16,7 +19,7 @@ Additional Resources
 --------------------
 
 - [Google Groups](https://groups.google.com/forum/#!forum/ruby-json-schema)
-- #ruby-json-schema on chat.freenode.net
+- #voxpupuli on irc.libera.chat
 
 Version 2.0.0 Upgrade Notes
 ---------------------------
@@ -26,6 +29,14 @@ default**, so schemas that do not declare a validator using the `$schema`
 keyword will use Draft-04 now instead of Draft-03. This is the reason for the
 major version upgrade.
 
+Version 3.0.0 Upgrade Notes
+---------------------------
+
+All individual changes are documented in the CHANGELOG.md. The biggest change
+is that the new version only supports Ruby 2.5 and newer. Take a look into the
+gemspec file to see the currently supported Ruby version and also
+`.github/workflows/test.yml` to see the Ruby versions we test on.
+
 Installation
 ------------
 
@@ -38,8 +49,8 @@ gem install json-schema
 From the git repo:
 
 ```sh
-$ gem build json-schema.gemspec
-$ gem install json-schema-2.5.2.gem
+gem build json-schema.gemspec
+gem install json-schema-*.gem
 ```
 
 Validation
@@ -165,7 +176,7 @@ JSON::Validator.validate(schema, [{"a" => 1}, {"a" => 2}, {"a" => 3}])
 JSON::Validator.fully_validate(schema, { "a" => "taco" }, :errors_as_objects => true)
 
 #
-# with the `:strict` option, all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`
+# with the `:strict` option, all properties are considered to have `"required": true` and all objects `"additionalProperties": false`
 #
 
 # => true
@@ -290,17 +301,17 @@ class BitwiseAndAttribute < JSON::Schema::Attribute
   def self.validate(current_schema, data, fragments, processor, validator, options = {})
     if data.is_a?(Integer) && data & current_schema.schema['bitwise-and'].to_i == 0
       message = "The property '#{build_fragment(fragments)}' did not evaluate  to true when bitwise-AND'd with  #{current_schema.schema['bitwise-or']}"
-      raise JSON::Schema::ValidationError.new(message, fragments, current_schema)
+      validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
     end
   end
 end
 
-class ExtendedSchema < JSON::Schema::Validator
+class ExtendedSchema < JSON::Schema::Draft3
   def initialize
     super
-    extend_schema_definition("http://json-schema.org/draft-03/schema#")
     @attributes["bitwise-and"] = BitwiseAndAttribute
-    @uri = URI.parse("http://test.com/test.json")
+    @uri = JSON::Util::URI.parse("http://test.com/test.json")
+    @names = ["http://test.com/test.json"]
   end
 
   JSON::Validator.register_validator(self.new)
@@ -374,6 +385,33 @@ schema = {
 errors = JSON::Validator.fully_validate(schema, {"a" => "23"})
 ```
 
+Validating a JSON Schema
+------------------------
+
+To validate that a JSON Schema conforms to the JSON Schema standard,
+you need to validate your schema against the metaschema for the appropriate
+JSON Schema Draft. All of the normal validation methods can be used
+for this. First retrieve the appropriate metaschema from the internal
+cache (using `JSON::Validator.validator_for_name()` or
+`JSON::Validator.validator_for_uri()`) and then simply validate your
+schema against it.
+
+
+```ruby
+require "json-schema"
+
+schema = {
+  "type" => "object",
+  "properties" => {
+    "a" => {"type" => "integer"}
+  }
+}
+
+metaschema = JSON::Validator.validator_for_name("draft4").metaschema
+# => true
+JSON::Validator.validate(metaschema, schema)
+```
+
 Controlling Remote Schema Reading
 ---------------------------------
 
@@ -444,3 +482,23 @@ value is of the correct datatype (e.g., an instance value is validated to be an
 integer or a float in the case of 'utc-millisec').
 
 Additionally, JSON::Validator does not handle any json hyperschema attributes.
+
+# Transfer Notice
+
+This plugin was originally authored by [Iain Beeston](https://github.com/iainbeeston).
+The maintainer preferred that [Vox Pupuli](https://voxpupuli.org/) take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred, please fork and continue to contribute [here](https://github.com/voxpupuli/json-schema).
+
+# License
+
+This gem is licensed unter the [MIT license](LICENSE.md).
+
+## Release information
+
+To make a new release, please do:
+* update the version in VERSION.yml
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Check if the new version matches the closed issues/PRs in the changelog
+* Create a PR with it
+* After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages

data/lib/json-schema/attribute.rb

@@ -38,6 +38,16 @@ module JSON
         valid_classes = TYPE_CLASS_MAPPINGS.fetch(type) { return true }
         Array(valid_classes).any? { |c| data.is_a?(c) }
       end
+
+      # Lookup Schema type of given class instance
+      def self.type_of_data(data)
+        type, _ = TYPE_CLASS_MAPPINGS.map { |k,v| [k,v] }.sort_by { |(_, v)|
+          -Array(v).map { |klass| klass.ancestors.size }.max
+        }.find { |(_, v)|
+          Array(v).any? { |klass| data.kind_of?(klass) }
+        }
+        type
+      end
     end
   end
 end

data/lib/json-schema/attributes/allof.rb

@@ -29,7 +29,7 @@ module JSON
         end
 
         if !valid || !errors.empty?
-          message = "The property '#{build_fragment(fragments)}' of type #{data.class} did not match all of the required schemas"
+          message = "The property '#{build_fragment(fragments)}' of type #{type_of_data(data)} did not match all of the required schemas"
           validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
           validation_errors(processor).last.sub_errors = errors
         end

data/lib/json-schema/attributes/anyof.rb

@@ -37,7 +37,7 @@ module JSON
         end
 
         if !valid
-          message = "The property '#{build_fragment(fragments)}' of type #{data.class} did not match one or more of the required schemas"
+          message = "The property '#{build_fragment(fragments)}' of type #{type_of_data(data)} did not match one or more of the required schemas"
           validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
           validation_errors(processor).last.sub_errors = errors
         end

data/lib/json-schema/attributes/const.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attribute'
+
+module JSON
+  class Schema
+    class ConstAttribute < Attribute
+      def self.validate(current_schema, data, fragments, processor, validator, options = {})
+        const_value = current_schema.schema['const']
+        unless const_value == data
+          message = "The property '#{build_fragment(fragments)}' value #{data.inspect} did not match constant '#{const_value}'"
+          validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
+        end
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/dependencies.rb

@@ -34,11 +34,5 @@ module JSON
         value.is_a?(String) || value.is_a?(Array) || value.is_a?(Hash)
       end
     end
-
-    class DependenciesV4Attribute < DependenciesAttribute
-      def self.accept_value?(value)
-        value.is_a?(Array) || value.is_a?(Hash)
-      end
-    end
   end
 end

data/lib/json-schema/attributes/dependencies_v4.rb

@@ -0,0 +1,11 @@
+require 'json-schema/attributes/dependencies'
+
+module JSON
+  class Schema
+    class DependenciesV4Attribute < DependenciesAttribute
+      def self.accept_value?(value)
+        value.is_a?(Array) || value.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/divisibleby.rb

@@ -12,7 +12,7 @@ module JSON
 
         factor = current_schema.schema[keyword]
 
-        if factor == 0 || factor == 0.0 || (BigDecimal.new(data.to_s) % BigDecimal.new(factor.to_s)).to_f != 0
+        if factor == 0 || factor == 0.0 || (BigDecimal(data.to_s) % BigDecimal(factor.to_s)).to_f != 0
           message = "The property '#{build_fragment(fragments)}' was not divisible by #{factor}"
           validation_error(processor, message, fragments, current_schema, self, options[:record_errors])
         end

data/lib/json-schema/attributes/formats/custom.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 require 'json-schema/errors/custom_format_error'
 
 module JSON

data/lib/json-schema/attributes/formats/date.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 
 module JSON
   class Schema

data/lib/json-schema/attributes/formats/date_time.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 
 module JSON
   class Schema

data/lib/json-schema/attributes/formats/date_time_v4.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 
 module JSON
   class Schema

data/lib/json-schema/attributes/formats/ip.rb

@@ -11,7 +11,7 @@ module JSON
         begin
           ip = IPAddr.new(data)
         rescue ArgumentError => e
-          raise e unless e.message == 'invalid address'
+          raise e unless e.message.start_with?('invalid address')
         end
 
         family = ip_version == 6 ? Socket::AF_INET6 : Socket::AF_INET

data/lib/json-schema/attributes/formats/time.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 
 module JSON
   class Schema

data/lib/json-schema/attributes/formats/uri.rb

@@ -1,4 +1,4 @@
-require 'json-schema/attribute'
+require 'json-schema/attributes/format'
 require 'json-schema/errors/uri_error'
 
 module JSON

data/lib/json-schema/attributes/limit.rb

@@ -48,132 +48,5 @@ module JSON
         raise NotImplementedError
       end
     end
-
-    class MinLengthAttribute < LimitAttribute
-      def self.acceptable_type
-        String
-      end
-
-      def self.limit_name
-        'minLength'
-      end
-
-      def self.error_message(schema)
-        "was not of a minimum string length of #{limit(schema)}"
-      end
-
-      def self.value(data)
-        data.length
-      end
-    end
-
-    class MaxLengthAttribute < MinLengthAttribute
-      def self.limit_name
-        'maxLength'
-      end
-
-      def self.error_message(schema)
-        "was not of a maximum string length of #{limit(schema)}"
-      end
-    end
-
-    class MinItemsAttribute < LimitAttribute
-      def self.acceptable_type
-        Array
-      end
-
-      def self.value(data)
-        data.length
-      end
-
-      def self.limit_name
-        'minItems'
-      end
-
-      def self.error_message(schema)
-        "did not contain a minimum number of items #{limit(schema)}"
-      end
-    end
-
-    class MaxItemsAttribute < MinItemsAttribute
-      def self.limit_name
-        'maxItems'
-      end
-
-      def self.error_message(schema)
-        "had more items than the allowed #{limit(schema)}"
-      end
-    end
-
-    class MinPropertiesAttribute < LimitAttribute
-      def self.acceptable_type
-        Hash
-      end
-
-      def self.value(data)
-        data.size
-      end
-
-      def self.limit_name
-        'minProperties'
-      end
-
-      def self.error_message(schema)
-        "did not contain a minimum number of properties #{limit(schema)}"
-      end
-    end
-
-    class MaxPropertiesAttribute < MinPropertiesAttribute
-      def self.limit_name
-        'maxProperties'
-      end
-
-      def self.error_message(schema)
-        "had more properties than the allowed #{limit(schema)}"
-      end
-    end
-
-    class NumericLimitAttribute < LimitAttribute
-      def self.acceptable_type
-        Numeric
-      end
-
-      def self.error_message(schema)
-        exclusivity = exclusive?(schema) ? 'exclusively' : 'inclusively'
-        format("did not have a %s value of %s, %s", limit_name, limit(schema), exclusivity)
-      end
-    end
-
-    class MaximumAttribute < NumericLimitAttribute
-      def self.limit_name
-        'maximum'
-      end
-
-      def self.exclusive?(schema)
-        schema['exclusiveMaximum']
-      end
-    end
-
-    class MaximumInclusiveAttribute < MaximumAttribute
-      def self.exclusive?(schema)
-        schema['maximumCanEqual'] == false
-      end
-    end
-
-    class MinimumAttribute < NumericLimitAttribute
-      def self.limit_name
-        'minimum'
-      end
-
-      def self.exclusive?(schema)
-        schema['exclusiveMinimum']
-      end
-    end
-
-    class MinimumInclusiveAttribute < MinimumAttribute
-      def self.exclusive?(schema)
-        schema['minimumCanEqual'] == false
-      end
-    end
   end
 end

data/lib/json-schema/attributes/limits/items.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limit'
+
+module JSON
+  class Schema
+    class ItemsLimitAttribute < LimitAttribute
+      def self.acceptable_type
+        Array
+      end
+
+      def self.value(data)
+        data.length
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/length.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limit'
+
+module JSON
+  class Schema
+    class LengthLimitAttribute < LimitAttribute
+      def self.acceptable_type
+        String
+      end
+
+      def self.value(data)
+        data.length
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/max_items.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limits/items'
+
+module JSON
+  class Schema
+    class MaxItemsAttribute < ItemsLimitAttribute
+      def self.limit_name
+        'maxItems'
+      end
+
+      def self.error_message(schema)
+        "had more items than the allowed #{limit(schema)}"
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/max_length.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limits/length'
+
+module JSON
+  class Schema
+    class MaxLengthAttribute < LengthLimitAttribute
+      def self.limit_name
+        'maxLength'
+      end
+
+      def self.error_message(schema)
+        "was not of a maximum string length of #{limit(schema)}"
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/max_properties.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limits/properties'
+
+module JSON
+  class Schema
+    class MaxPropertiesAttribute < PropertiesLimitAttribute
+      def self.limit_name
+        'maxProperties'
+      end
+
+      def self.error_message(schema)
+        "had more properties than the allowed #{limit(schema)}"
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/maximum.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limits/numeric'
+
+module JSON
+  class Schema
+    class MaximumAttribute < NumericLimitAttribute
+      def self.limit_name
+        'maximum'
+      end
+
+      def self.exclusive?(schema)
+        schema['exclusiveMaximum']
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/maximum_inclusive.rb

@@ -0,0 +1,11 @@
+require 'json-schema/attributes/limits/maximum'
+
+module JSON
+  class Schema
+    class MaximumInclusiveAttribute < MaximumAttribute
+      def self.exclusive?(schema)
+        schema['maximumCanEqual'] == false
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/min_items.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limits/items'
+
+module JSON
+  class Schema
+    class MinItemsAttribute < ItemsLimitAttribute
+      def self.limit_name
+        'minItems'
+      end
+
+      def self.error_message(schema)
+        "did not contain a minimum number of items #{limit(schema)}"
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/min_length.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limits/length'
+
+module JSON
+  class Schema
+    class MinLengthAttribute < LengthLimitAttribute
+      def self.limit_name
+        'minLength'
+      end
+
+      def self.error_message(schema)
+        "was not of a minimum string length of #{limit(schema)}"
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/min_properties.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limits/properties'
+
+module JSON
+  class Schema
+    class MinPropertiesAttribute < PropertiesLimitAttribute
+      def self.limit_name
+        'minProperties'
+      end
+
+      def self.error_message(schema)
+        "did not contain a minimum number of properties #{limit(schema)}"
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/minimum.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limits/numeric'
+
+module JSON
+  class Schema
+    class MinimumAttribute < NumericLimitAttribute
+      def self.limit_name
+        'minimum'
+      end
+
+      def self.exclusive?(schema)
+        schema['exclusiveMinimum']
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/minimum_inclusive.rb

@@ -0,0 +1,11 @@
+require 'json-schema/attributes/limits/minimum'
+
+module JSON
+  class Schema
+    class MinimumInclusiveAttribute < MinimumAttribute
+      def self.exclusive?(schema)
+        schema['minimumCanEqual'] == false
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/numeric.rb

@@ -0,0 +1,16 @@
+require 'json-schema/attributes/limit'
+
+module JSON
+  class Schema
+    class NumericLimitAttribute < LimitAttribute
+      def self.acceptable_type
+        Numeric
+      end
+
+      def self.error_message(schema)
+        exclusivity = exclusive?(schema) ? 'exclusively' : 'inclusively'
+        format("did not have a %s value of %s, %s", limit_name, limit(schema), exclusivity)
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/limits/properties.rb

@@ -0,0 +1,15 @@
+require 'json-schema/attributes/limit'
+
+module JSON
+  class Schema
+    class PropertiesLimitAttribute < LimitAttribute
+      def self.acceptable_type
+        Hash
+      end
+
+      def self.value(data)
+        data.size
+      end
+    end
+  end
+end

data/lib/json-schema/attributes/not.rb

@@ -14,7 +14,7 @@ module JSON
           if options[:record_errors] && errors_copy.length != processor.validation_errors.length
             processor.validation_errors.replace(errors_copy)
           else
-            message = "The property '#{build_fragment(fragments)}' of type #{data.class} matched the disallowed schema"
+            message = "The property '#{build_fragment(fragments)}' of type #{type_of_data(data)} matched the disallowed schema"
             failed = false
           end
         rescue ValidationError