json_skooma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1be68fa71fa29965063cf60e9bab950139b697e0222371eb8ce1eec8fc5bf95
+  data.tar.gz: 83599b9f53a2d41483f2b700200971088db482d57bccf1ce9cee91d641dc27e6
+SHA512:
+  metadata.gz: '0691050d428ab71fa386697900c51d6322a7ebb7e2086a86c45079fbae4e2d61cf53d799e504dddde6041afae2668cd792f9d0acc195168ceb7cf7eb49643f16'
+  data.tar.gz: ecfe5c2115714a08df92dd5ebcd0ddd723a3636e0fdec668d76f4b0471aab0ef3f33bf0d3ab2a8896f0d479a7f10181024b52e004d70efe26575590a97544b9a

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog],
+and this project adheres to [Semantic Versioning].
+
+## [Unreleased]
+
+## [0.1.0] - 2023-09-27
+
+### Added
+
+- Initial implementation. ([@skryukov])
+
+[@skryukov]: https://github.com/skryukov
+
+[Unreleased]: https://github.com/skryukov/json_skooma/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/skryukov/json_skooma/commits/v0.1.0
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Svyatoslav Kryukov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# JSONSkooma – Sugar for your JSONs
+
+[![Gem Version](https://badge.fury.io/rb/json_skooma.svg)](https://rubygems.org/gems/json_skooma)
+[![Ruby](https://github.com/skryukov/json_skooma/actions/workflows/main.yml/badge.svg)](https://github.com/skryukov/json_skooma/actions/workflows/main.yml)
+
+JSONSkooma is a Ruby library for validating JSONs against JSON Schemas.
+
+### Features
+
+- Supports JSON Schema 2019-09 and 2020-12
+- Supports custom dialects, vocabularies, keywords, format validators, output formatters 
+- Supports custom schema resolvers
+
+<a href="https://evilmartians.com/?utm_source=json_skooma&utm_campaign=project_page">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add json_skooma
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install json_skooma
+
+## Usage
+
+```ruby
+require "json_skooma"
+
+# Create a registry to store schemas, vocabularies, dialects, etc.
+JSONSkooma.create_registry("2020-12", assert_formats: true)
+
+# Load a schema
+schema_hash = {
+  "$schema" => "https://json-schema.org/draft/2020-12/schema",
+  "type" => "object",
+  "properties" => {
+    "name" => {"type" => "string"},
+    "race" => {"enum" => %w[Nord Khajiit Argonian Breton Redguard Dunmer Altmer Bosmer Orc Imperial]},
+    "class" => {"type" => "string"},
+    "level" => {"type" => "integer", "minimum" => 1},
+    "equipment" => {
+      "type" => "array",
+      "items" => {"type" => "string"}
+    }
+  },
+  "required" => %w[name race class level]
+}
+
+schema = JSONSkooma::JSONSchema.new(schema_hash)
+
+data_hash = {
+  name: "Matz",
+  race: "Human",
+  class: "Dragonborn",
+  level: 50,
+  equipment: %w[Ruby],
+}
+
+result = schema.evaluate(data_hash)
+
+result.valid? # => false
+
+result.output(:basic)
+# {"valid"=>false,
+#  "errors"=>
+#    [{"instanceLocation"=>"",
+#      "keywordLocation"=>"/properties",
+#      "absoluteKeywordLocation"=>"urn:uuid:f477b6ca-7308-4be6-b88c-e848b9002793#/properties",
+#      "error"=>"Properties [\"race\"] are invalid"},
+#     {"instanceLocation"=>"/race",
+#      "keywordLocation"=>"/properties/race/enum",
+#      "absoluteKeywordLocation"=>"urn:uuid:f477b6ca-7308-4be6-b88c-e848b9002793#/properties/race/enum",
+#      "error"=>
+#        "The instance value \"Human\" must be equal to one of the elements in the defined enumeration: [\"Nord\", \"Khajiit\", \"Argonian\", \"Breton\", \"Redguard\", \"Dunmer\", \"Altmer\", \"Bosmer\", \"Orc\", \"Imperial\"]"}]}
+```
+
+## Alternatives
+
+- [json_schemer](https://github.com/davishmcclurg/json_schemer) – Draft 4, 6, 7, 2019-09 and 2020-12 compliant
+- [json-schema](https://github.com/voxpupuli/json-schema) – Draft 1, 2, 3, 4 and 6 compliant
+
+## Feature plans
+
+- Custom error messages
+- EcmaScript regexp
+- Short circuit errors
+- IRI as schema identifiers
+- Relative JSONPointer
+- More unit tests
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/skryukov/json_skooma.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/data/draft-2019-09/README.md

@@ -0,0 +1,60 @@
+# Welcome to JSON Schema
+
+JSON Schema is a vocabulary that allows you to validate, annotate, and manipulate JSON documents.
+
+This repository contains the sources for the **work in progress** of the next set of JSON Schema IETF Internet Draft (I-D) documents.
+For the latest released I-Ds, please see the [Specification page](http://json-schema.org/documentation.html) on the website.
+
+## Call for contributions and feedback
+
+Reviews, comments and suggestions are most welcome!
+Please read our [guidelines for contributing](CONTRIBUTING.md).
+
+## Status
+For the current status of issues and pull requests, please see the following labels
+
+[![Available](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20Available.svg?color=brightgreen)](https://github.com/json-schema-org/json-schema-spec/issues?q=is%3Aopen+is%3Aissue+label%3A%22Status%3A+Available%22) [![In Progress](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20In%20Progress.svg)](https://github.com/json-schema-org/json-schema-spec/labels/Status:%20In%20Progress) [![Review Needed](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Status:%20Review%20Needed.svg)](https://github.com/json-schema-org/json-schema-spec/labels/Status%3A%20Review%20Needed)
+
+[![Critical](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20Critical.svg?color=critical
+)](https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Critical) [![High](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20High.svg?color=important)](https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20High) [![Medium](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20Medium.svg)](https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Medium) [![Low](https://img.shields.io/github/issues/json-schema-org/json-schema-spec/Priority:%20Low.svg)](https://github.com/json-schema-org/json-schema-spec/labels/Priority%3A%20Low) 
+
+
+Labels are assigned based on [Sensible Github Labels](https://github.com/Relequestual/sensible-github-labels).
+
+## Contents
+
+* Makefile - scripts to build the Internet-Draft txt/html
+* _Internet-Draft sources_
+    * jsonschema-core.xml - source for JSON Schema's "core" I-D
+    * jsonschema-validation.xml - source for the validation vocabulary I-D
+    * jsonschema-hyperschema.xml - source for the hyper-schema vocabulary I-D
+    * relative-json-pointer.xml - source for the Relative JSON Pointer I-D
+* _meta-schemas and recommended output formats_
+    * schema.json - JSON Schema "core" and Validation meta-schema
+    * hyper-schema.json - JSON Hyper-Schema meta-schema
+    * links.json - JSON Hyper-Schema's Link Description Object meta-schema
+    * hyper-schema-output.json - The recommended output format for JSON Hyper-Schema links
+
+Type "make" at a shell to build the .txt and .html spec files.
+
+Descriptions of the xml2rfc, I-D documents, and RFC processes:
+
+* https://xml2rfc.tools.ietf.org/authoring/draft-mrose-writing-rfcs.html
+* https://www.ietf.org/tao.html
+* https://www.ietf.org/ietf-ftp/1id-guidelines.html
+* https://www.rfc-editor.org/rfc/rfc7322.txt
+
+## Test suites
+
+Conformance tests for JSON Schema and its vocabularies may be found
+[in their own repository](https://github.com/json-schema-org/JSON-Schema-Test-Suite).
+
+## The website
+
+The JSON Schema web site is at http://json-schema.org/
+
+The source for the website is [maintained in a separate repository](https://github.com/json-schema-org/json-schema-org.github.io).
+
+## License
+
+The source material in this repository is licensed under the AFL or BSD license.

data/data/draft-2019-09/hyper-schema.json

@@ -0,0 +1,26 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/hyper-schema",
+    "$id": "https://json-schema.org/draft/2019-09/hyper-schema",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2019-09/vocab/core": true,
+        "https://json-schema.org/draft/2019-09/vocab/applicator": true,
+        "https://json-schema.org/draft/2019-09/vocab/validation": true,
+        "https://json-schema.org/draft/2019-09/vocab/meta-data": true,
+        "https://json-schema.org/draft/2019-09/vocab/format": false,
+        "https://json-schema.org/draft/2019-09/vocab/content": true,
+        "https://json-schema.org/draft/2019-09/vocab/hyper-schema": true
+    },
+    "$recursiveAnchor": true,
+
+    "title": "JSON Hyper-Schema",
+    "allOf": [
+        {"$ref": "https://json-schema.org/draft/2019-09/schema"},
+        {"$ref": "https://json-schema.org/draft/2019-09/meta/hyper-schema"}
+    ],
+    "links": [
+        {
+            "rel": "self",
+            "href": "{+%24id}"
+        }
+    ]
+}

data/data/draft-2019-09/links.json

@@ -0,0 +1,91 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://json-schema.org/draft/2019-09/links",
+    "title": "Link Description Object",
+    "allOf": [
+        { "required": [ "rel", "href" ] },
+        { "$ref": "#/$defs/noRequiredFields" }
+    ],
+    "$defs": {
+        "noRequiredFields": {
+            "type": "object",
+            "properties": {
+                "anchor": {
+                    "type": "string",
+                    "format": "uri-template"
+                },
+                "anchorPointer": {
+                    "type": "string",
+                    "anyOf": [
+                        { "format": "json-pointer" },
+                        { "format": "relative-json-pointer" }
+                    ]
+                },
+                "rel": {
+                    "anyOf": [
+                        { "type": "string" },
+                        {
+                            "type": "array",
+                            "items": { "type": "string" },
+                            "minItems": 1
+                        }
+                    ]
+                },
+                "href": {
+                    "type": "string",
+                    "format": "uri-template"
+                },
+                "hrefSchema": {
+                    "$ref": "https://json-schema.org/draft/2019-09/hyper-schema",
+                    "default": false
+                },
+                "templatePointers": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string",
+                        "anyOf": [
+                            { "format": "json-pointer" },
+                            { "format": "relative-json-pointer" }
+                        ]
+                    }
+                },
+                "templateRequired": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "uniqueItems": true
+                },
+                "title": {
+                    "type": "string"
+                },
+                "description": {
+                    "type": "string"
+                },
+                "targetSchema": {
+                    "$ref": "https://json-schema.org/draft/2019-09/hyper-schema",
+                    "default": true
+                },
+                "targetMediaType": {
+                    "type": "string"
+                },
+                "targetHints": { },
+                "headerSchema": {
+                    "$ref": "https://json-schema.org/draft/2019-09/hyper-schema",
+                    "default": true
+                },
+                "submissionMediaType": {
+                    "type": "string",
+                    "default": "application/json"
+                },
+                "submissionSchema": {
+                    "$ref": "https://json-schema.org/draft/2019-09/hyper-schema",
+                    "default": true
+                },
+                "$comment": {
+                    "type": "string"
+                }
+            }
+        }
+    }
+}

data/data/draft-2019-09/meta/applicator.json

@@ -0,0 +1,56 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://json-schema.org/draft/2019-09/meta/applicator",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2019-09/vocab/applicator": true
+    },
+    "$recursiveAnchor": true,
+
+    "title": "Applicator vocabulary meta-schema",
+    "type": ["object", "boolean"],
+    "properties": {
+        "additionalItems": { "$recursiveRef": "#" },
+        "unevaluatedItems": { "$recursiveRef": "#" },
+        "items": {
+            "anyOf": [
+                { "$recursiveRef": "#" },
+                { "$ref": "#/$defs/schemaArray" }
+            ]
+        },
+        "contains": { "$recursiveRef": "#" },
+        "additionalProperties": { "$recursiveRef": "#" },
+        "unevaluatedProperties": { "$recursiveRef": "#" },
+        "properties": {
+            "type": "object",
+            "additionalProperties": { "$recursiveRef": "#" },
+            "default": {}
+        },
+        "patternProperties": {
+            "type": "object",
+            "additionalProperties": { "$recursiveRef": "#" },
+            "propertyNames": { "format": "regex" },
+            "default": {}
+        },
+        "dependentSchemas": {
+            "type": "object",
+            "additionalProperties": {
+                "$recursiveRef": "#"
+            }
+        },
+        "propertyNames": { "$recursiveRef": "#" },
+        "if": { "$recursiveRef": "#" },
+        "then": { "$recursiveRef": "#" },
+        "else": { "$recursiveRef": "#" },
+        "allOf": { "$ref": "#/$defs/schemaArray" },
+        "anyOf": { "$ref": "#/$defs/schemaArray" },
+        "oneOf": { "$ref": "#/$defs/schemaArray" },
+        "not": { "$recursiveRef": "#" }
+    },
+    "$defs": {
+        "schemaArray": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$recursiveRef": "#" }
+        }
+    }
+}

data/data/draft-2019-09/meta/content.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://json-schema.org/draft/2019-09/meta/content",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2019-09/vocab/content": true
+    },
+    "$recursiveAnchor": true,
+
+    "title": "Content vocabulary meta-schema",
+
+    "type": ["object", "boolean"],
+    "properties": {
+        "contentMediaType": { "type": "string" },
+        "contentEncoding": { "type": "string" },
+        "contentSchema": { "$recursiveRef": "#" }
+    }
+}

data/data/draft-2019-09/meta/core.json

@@ -0,0 +1,57 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://json-schema.org/draft/2019-09/meta/core",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2019-09/vocab/core": true
+    },
+    "$recursiveAnchor": true,
+
+    "title": "Core vocabulary meta-schema",
+    "type": ["object", "boolean"],
+    "properties": {
+        "$id": {
+            "type": "string",
+            "format": "uri-reference",
+            "$comment": "Non-empty fragments not allowed.",
+            "pattern": "^[^#]*#?$"
+        },
+        "$schema": {
+            "type": "string",
+            "format": "uri"
+        },
+        "$anchor": {
+            "type": "string",
+            "pattern": "^[A-Za-z][-A-Za-z0-9.:_]*$"
+        },
+        "$ref": {
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "$recursiveRef": {
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "$recursiveAnchor": {
+            "type": "boolean",
+            "default": false
+        },
+        "$vocabulary": {
+            "type": "object",
+            "propertyNames": {
+                "type": "string",
+                "format": "uri"
+            },
+            "additionalProperties": {
+                "type": "boolean"
+            }
+        },
+        "$comment": {
+            "type": "string"
+        },
+        "$defs": {
+            "type": "object",
+            "additionalProperties": { "$recursiveRef": "#" },
+            "default": {}
+        }
+    }
+}

data/data/draft-2019-09/meta/format.json

@@ -0,0 +1,14 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://json-schema.org/draft/2019-09/meta/format",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2019-09/vocab/format": true
+    },
+    "$recursiveAnchor": true,
+
+    "title": "Format vocabulary meta-schema",
+    "type": ["object", "boolean"],
+    "properties": {
+        "format": { "type": "string" }
+    }
+}

data/data/draft-2019-09/meta/hyper-schema.json

@@ -0,0 +1,29 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/hyper-schema",
+    "$id": "https://json-schema.org/draft/2019-09/meta/hyper-schema",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2019-09/vocab/hyper-schema": true
+    },
+    "$recursiveAnchor": true,
+
+    "title": "JSON Hyper-Schema Vocabulary Schema",
+    "type": ["object", "boolean"],
+    "properties": {
+        "base": {
+            "type": "string",
+            "format": "uri-template"
+        },
+        "links": {
+            "type": "array",
+            "items": {
+                "$ref": "https://json-schema.org/draft/2019-09/links"
+            }
+        }
+    },
+    "links": [
+        {
+            "rel": "self",
+            "href": "{+%24id}"
+        }
+    ]
+}

data/data/draft-2019-09/meta/meta-data.json

@@ -0,0 +1,37 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://json-schema.org/draft/2019-09/meta/meta-data",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2019-09/vocab/meta-data": true
+    },
+    "$recursiveAnchor": true,
+
+    "title": "Meta-data vocabulary meta-schema",
+
+    "type": ["object", "boolean"],
+    "properties": {
+        "title": {
+            "type": "string"
+        },
+        "description": {
+            "type": "string"
+        },
+        "default": true,
+        "deprecated": {
+            "type": "boolean",
+            "default": false
+        },
+        "readOnly": {
+            "type": "boolean",
+            "default": false
+        },
+        "writeOnly": {
+            "type": "boolean",
+            "default": false
+        },
+        "examples": {
+            "type": "array",
+            "items": true
+        }
+    }
+}

data/data/draft-2019-09/meta/validation.json

@@ -0,0 +1,98 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://json-schema.org/draft/2019-09/meta/validation",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2019-09/vocab/validation": true
+    },
+    "$recursiveAnchor": true,
+
+    "title": "Validation vocabulary meta-schema",
+    "type": ["object", "boolean"],
+    "properties": {
+        "multipleOf": {
+            "type": "number",
+            "exclusiveMinimum": 0
+        },
+        "maximum": {
+            "type": "number"
+        },
+        "exclusiveMaximum": {
+            "type": "number"
+        },
+        "minimum": {
+            "type": "number"
+        },
+        "exclusiveMinimum": {
+            "type": "number"
+        },
+        "maxLength": { "$ref": "#/$defs/nonNegativeInteger" },
+        "minLength": { "$ref": "#/$defs/nonNegativeIntegerDefault0" },
+        "pattern": {
+            "type": "string",
+            "format": "regex"
+        },
+        "maxItems": { "$ref": "#/$defs/nonNegativeInteger" },
+        "minItems": { "$ref": "#/$defs/nonNegativeIntegerDefault0" },
+        "uniqueItems": {
+            "type": "boolean",
+            "default": false
+        },
+        "maxContains": { "$ref": "#/$defs/nonNegativeInteger" },
+        "minContains": {
+            "$ref": "#/$defs/nonNegativeInteger",
+            "default": 1
+        },
+        "maxProperties": { "$ref": "#/$defs/nonNegativeInteger" },
+        "minProperties": { "$ref": "#/$defs/nonNegativeIntegerDefault0" },
+        "required": { "$ref": "#/$defs/stringArray" },
+        "dependentRequired": {
+            "type": "object",
+            "additionalProperties": {
+                "$ref": "#/$defs/stringArray"
+            }
+        },
+        "const": true,
+        "enum": {
+            "type": "array",
+            "items": true
+        },
+        "type": {
+            "anyOf": [
+                { "$ref": "#/$defs/simpleTypes" },
+                {
+                    "type": "array",
+                    "items": { "$ref": "#/$defs/simpleTypes" },
+                    "minItems": 1,
+                    "uniqueItems": true
+                }
+            ]
+        }
+    },
+    "$defs": {
+        "nonNegativeInteger": {
+            "type": "integer",
+            "minimum": 0
+        },
+        "nonNegativeIntegerDefault0": {
+            "$ref": "#/$defs/nonNegativeInteger",
+            "default": 0
+        },
+        "simpleTypes": {
+            "enum": [
+                "array",
+                "boolean",
+                "integer",
+                "null",
+                "number",
+                "object",
+                "string"
+            ]
+        },
+        "stringArray": {
+            "type": "array",
+            "items": { "type": "string" },
+            "uniqueItems": true,
+            "default": []
+        }
+    }
+}