json_skooma 0.1.0

data/data/draft-2020-12/output/verbose-example.json

@@ -0,0 +1,130 @@
+{
+  "valid": false,
+  "keywordLocation": "",
+  "instanceLocation": "",
+  "errors": [
+    {
+      "valid": true,
+      "keywordLocation": "/$defs",
+      "instanceLocation": ""
+    },
+    {
+      "valid": true,
+      "keywordLocation": "/type",
+      "instanceLocation": ""
+    },
+    {
+      "valid": false,
+      "keywordLocation": "/items",
+      "instanceLocation": "",
+      "errors": [
+        {
+          "valid": true,
+          "keywordLocation": "/items/$ref",
+          "absoluteKeywordLocation":
+            "https://example.com/polygon#/items/$ref",
+          "instanceLocation": "/0",
+          "annotations": [
+            {
+              "valid": true,
+              "keywordLocation": "/items/$ref",
+              "absoluteKeywordLocation":
+                "https://example.com/polygon#/$defs/point",
+              "instanceLocation": "/0",
+              "annotations": [
+                {
+                  "valid": true,
+                  "keywordLocation": "/items/$ref/type",
+                  "absoluteKeywordLocation":
+                    "https://example.com/polygon#/$defs/point/type",
+                  "instanceLocation": "/0"
+                },
+                {
+                  "valid": true,
+                  "keywordLocation": "/items/$ref/properties",
+                  "absoluteKeywordLocation":
+                    "https://example.com/polygon#/$defs/point/properties",
+                  "instanceLocation": "/0"
+                },
+                {
+                  "valid": true,
+                  "keywordLocation": "/items/$ref/required",
+                  "absoluteKeywordLocation":
+                    "https://example.com/polygon#/$defs/point/required",
+                  "instanceLocation": "/0"
+                },
+                {
+                  "valid": true,
+                  "keywordLocation": "/items/$ref/additionalProperties",
+                  "absoluteKeywordLocation":
+                    "https://example.com/polygon#/$defs/point/additionalProperties",
+                  "instanceLocation": "/0"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "valid": false,
+          "keywordLocation": "/items/$ref",
+          "absoluteKeywordLocation":
+            "https://example.com/polygon#/items/$ref",
+          "instanceLocation": "/1",
+          "errors": [
+            {
+              "valid": false,
+              "keywordLocation": "/items/$ref",
+              "absoluteKeywordLocation":
+                "https://example.com/polygon#/$defs/point",
+              "instanceLocation": "/1",
+              "errors": [
+                {
+                  "valid": true,
+                  "keywordLocation": "/items/$ref/type",
+                  "absoluteKeywordLocation":
+                    "https://example.com/polygon#/$defs/point/type",
+                  "instanceLocation": "/1"
+                },
+                {
+                  "valid": true,
+                  "keywordLocation": "/items/$ref/properties",
+                  "absoluteKeywordLocation":
+                    "https://example.com/polygon#/$defs/point/properties",
+                  "instanceLocation": "/1"
+                },
+                {
+                  "valid": false,
+                  "keywordLocation": "/items/$ref/required",
+                  "absoluteKeywordLocation":
+                    "https://example.com/polygon#/$defs/point/required",
+                  "instanceLocation": "/1"
+                },
+                {
+                  "valid": false,
+                  "keywordLocation": "/items/$ref/additionalProperties",
+                  "absoluteKeywordLocation":
+                    "https://example.com/polygon#/$defs/point/additionalProperties",
+                  "instanceLocation": "/1",
+                  "errors": [
+                    {
+                      "valid": false,
+                      "keywordLocation": "/items/$ref/additionalProperties",
+                      "absoluteKeywordLocation":
+                        "https://example.com/polygon#/$defs/point/additionalProperties",
+                      "instanceLocation": "/1/z"
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "valid": false,
+      "keywordLocation": "/minItems",
+      "instanceLocation": ""
+    }
+  ]
+}

data/data/draft-2020-12/schema.json

@@ -0,0 +1,58 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://json-schema.org/draft/2020-12/schema",
+    "$vocabulary": {
+        "https://json-schema.org/draft/2020-12/vocab/core": true,
+        "https://json-schema.org/draft/2020-12/vocab/applicator": true,
+        "https://json-schema.org/draft/2020-12/vocab/unevaluated": true,
+        "https://json-schema.org/draft/2020-12/vocab/validation": true,
+        "https://json-schema.org/draft/2020-12/vocab/meta-data": true,
+        "https://json-schema.org/draft/2020-12/vocab/format-annotation": true,
+        "https://json-schema.org/draft/2020-12/vocab/content": true
+    },
+    "$dynamicAnchor": "meta",
+
+    "title": "Core and Validation specifications meta-schema",
+    "allOf": [
+        {"$ref": "meta/core"},
+        {"$ref": "meta/applicator"},
+        {"$ref": "meta/unevaluated"},
+        {"$ref": "meta/validation"},
+        {"$ref": "meta/meta-data"},
+        {"$ref": "meta/format-annotation"},
+        {"$ref": "meta/content"}
+    ],
+    "type": ["object", "boolean"],
+    "$comment": "This meta-schema also defines keywords that have appeared in previous drafts in order to prevent incompatible extensions as they remain in common use.",
+    "properties": {
+        "definitions": {
+            "$comment": "\"definitions\" has been replaced by \"$defs\".",
+            "type": "object",
+            "additionalProperties": { "$dynamicRef": "#meta" },
+            "deprecated": true,
+            "default": {}
+        },
+        "dependencies": {
+            "$comment": "\"dependencies\" has been split and replaced by \"dependentSchemas\" and \"dependentRequired\" in order to serve their differing semantics.",
+            "type": "object",
+            "additionalProperties": {
+                "anyOf": [
+                    { "$dynamicRef": "#meta" },
+                    { "$ref": "meta/validation#/$defs/stringArray" }
+                ]
+            },
+            "deprecated": true,
+            "default": {}
+        },
+        "$recursiveAnchor": {
+            "$comment": "\"$recursiveAnchor\" has been replaced by \"$dynamicAnchor\".",
+            "$ref": "meta/core#/$defs/anchorString",
+            "deprecated": true
+        },
+        "$recursiveRef": {
+            "$comment": "\"$recursiveRef\" has been replaced by \"$dynamicRef\".",
+            "$ref": "meta/core#/$defs/uriReferenceString",
+            "deprecated": true
+        }
+    }
+}

data/lib/json_skooma/dialects/draft201909.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module JSONSkooma
+  module Dialects
+    module Draft201909
+      class << self
+        def call(registry, assert_formats: false)
+          registry.add_source(
+            "https://json-schema.org/draft/2019-09/",
+            Sources::Local.new(File.join(DATA_DIR, "draft-2019-09").to_s, suffix: ".json")
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2019-09/vocab/core",
+            Keywords::Core::Schema,
+            Keywords::Core::Vocabulary,
+            Keywords::Core::Id,
+            Keywords::Core::Ref,
+            Keywords::Core::Anchor,
+            Keywords::Draft201909::RecursiveRef,
+            Keywords::Draft201909::RecursiveAnchor,
+            Keywords::Core::Defs,
+            Keywords::Core::Comment
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2019-09/vocab/applicator",
+            Keywords::Applicator::AllOf,
+            Keywords::Applicator::AnyOf,
+            Keywords::Applicator::OneOf,
+            Keywords::Applicator::Not,
+            Keywords::Applicator::If,
+            Keywords::Applicator::Then,
+            Keywords::Applicator::Else,
+            Keywords::Applicator::DependentSchemas,
+            Keywords::Draft201909::Items,
+            Keywords::Draft201909::AdditionalItems,
+            Keywords::Draft201909::UnevaluatedItems,
+            Keywords::Applicator::Contains,
+            Keywords::Applicator::Properties,
+            Keywords::Applicator::PatternProperties,
+            Keywords::Applicator::AdditionalProperties,
+            Keywords::Unevaluated::UnevaluatedProperties,
+            Keywords::Applicator::PropertyNames
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2019-09/vocab/validation",
+            Keywords::Validation::Type,
+            Keywords::Validation::Enum,
+            Keywords::Validation::Const,
+            Keywords::Validation::MultipleOf,
+            Keywords::Validation::Maximum,
+            Keywords::Validation::ExclusiveMaximum,
+            Keywords::Validation::Minimum,
+            Keywords::Validation::ExclusiveMinimum,
+            Keywords::Validation::MaxLength,
+            Keywords::Validation::MinLength,
+            Keywords::Validation::Pattern,
+            Keywords::Validation::MaxItems,
+            Keywords::Validation::MinItems,
+            Keywords::Validation::UniqueItems,
+            Keywords::Validation::MaxContains,
+            Keywords::Validation::MinContains,
+            Keywords::Validation::MaxProperties,
+            Keywords::Validation::MinProperties,
+            Keywords::Validation::Required,
+            Keywords::Validation::DependentRequired
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2019-09/vocab/format",
+            # todo: move to legacy
+            Keywords::FormatAnnotation::Format
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2019-09/vocab/meta-data",
+            Keywords::MetaData::Title,
+            Keywords::MetaData::Description,
+            Keywords::MetaData::Default,
+            Keywords::MetaData::Deprecated,
+            Keywords::MetaData::ReadOnly,
+            Keywords::MetaData::WriteOnly,
+            Keywords::MetaData::Examples
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2019-09/vocab/content",
+            Keywords::Content::ContentMediaType,
+            Keywords::Content::ContentEncoding,
+            Keywords::Content::ContentSchema
+          )
+
+          registry.add_metaschema(
+            "https://json-schema.org/draft/2019-09/schema",
+            "https://json-schema.org/draft/2019-09/vocab/core",
+            "https://json-schema.org/draft/2019-09/vocab/applicator",
+            "https://json-schema.org/draft/2019-09/vocab/validation",
+            "https://json-schema.org/draft/2019-09/vocab/format",
+            "https://json-schema.org/draft/2019-09/vocab/meta-data",
+            "https://json-schema.org/draft/2019-09/vocab/content"
+          )
+
+          if assert_formats
+            registry.add_format("date-time", Validators::DateTime)
+            registry.add_format("date", Validators::Date)
+            registry.add_format("time", Validators::Time)
+            registry.add_format("duration", Validators::Duration)
+
+            registry.add_format("email", Validators::Email)
+            registry.add_format("idn-email", Validators::IdnEmail)
+
+            registry.add_format("hostname", Validators::Hostname)
+            registry.add_format("idn-hostname", Validators::IdnHostname)
+
+            registry.add_format("ipv4", Validators::Ipv4)
+            registry.add_format("ipv6", Validators::Ipv6)
+
+            registry.add_format("uri", Validators::Uri)
+            registry.add_format("uri-reference", Validators::UriReference)
+            registry.add_format("iri", Validators::Iri)
+            registry.add_format("iri-reference", Validators::IriReference)
+            registry.add_format("uuid", Validators::Uuid)
+
+            registry.add_format("uri-template", Validators::UriTemplate)
+
+            registry.add_format("json-pointer", Validators::JSONPointer)
+            registry.add_format("relative-json-pointer", Validators::RelativeJSONPointer)
+
+            registry.add_format("regex", Validators::Regex)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json_skooma/dialects/draft202012.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module JSONSkooma
+  module Dialects
+    module Draft202012
+      class << self
+        def call(registry, assert_formats: false)
+          registry.add_source(
+            "https://json-schema.org/draft/2020-12/",
+            Sources::Local.new(File.join(DATA_DIR, "draft-2020-12").to_s, suffix: ".json")
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2020-12/vocab/core",
+            Keywords::Core::Schema,
+            Keywords::Core::Vocabulary,
+            Keywords::Core::Id,
+            Keywords::Core::Ref,
+            Keywords::Core::Anchor,
+            Keywords::Core::DynamicRef,
+            Keywords::Core::DynamicAnchor,
+            Keywords::Core::Defs,
+            Keywords::Core::Comment
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2020-12/vocab/applicator",
+            Keywords::Applicator::AllOf,
+            Keywords::Applicator::AnyOf,
+            Keywords::Applicator::OneOf,
+            Keywords::Applicator::Not,
+            Keywords::Applicator::If,
+            Keywords::Applicator::Then,
+            Keywords::Applicator::Else,
+            Keywords::Applicator::DependentSchemas,
+            Keywords::Applicator::PrefixItems,
+            Keywords::Applicator::Items,
+            Keywords::Applicator::Contains,
+            Keywords::Applicator::Properties,
+            Keywords::Applicator::PatternProperties,
+            Keywords::Applicator::AdditionalProperties,
+            Keywords::Applicator::PropertyNames
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2020-12/vocab/unevaluated",
+            Keywords::Unevaluated::UnevaluatedItems,
+            Keywords::Unevaluated::UnevaluatedProperties
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2020-12/vocab/validation",
+            Keywords::Validation::Type,
+            Keywords::Validation::Enum,
+            Keywords::Validation::Const,
+            Keywords::Validation::MultipleOf,
+            Keywords::Validation::Maximum,
+            Keywords::Validation::ExclusiveMaximum,
+            Keywords::Validation::Minimum,
+            Keywords::Validation::ExclusiveMinimum,
+            Keywords::Validation::MaxLength,
+            Keywords::Validation::MinLength,
+            Keywords::Validation::Pattern,
+            Keywords::Validation::MaxItems,
+            Keywords::Validation::MinItems,
+            Keywords::Validation::UniqueItems,
+            Keywords::Validation::MaxContains,
+            Keywords::Validation::MinContains,
+            Keywords::Validation::MaxProperties,
+            Keywords::Validation::MinProperties,
+            Keywords::Validation::Required,
+            Keywords::Validation::DependentRequired
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2020-12/vocab/format-annotation",
+            Keywords::FormatAnnotation::Format
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2020-12/vocab/format-assertion",
+            Keywords::FormatAnnotation::Format
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2020-12/vocab/meta-data",
+            Keywords::MetaData::Title,
+            Keywords::MetaData::Description,
+            Keywords::MetaData::Default,
+            Keywords::MetaData::Deprecated,
+            Keywords::MetaData::ReadOnly,
+            Keywords::MetaData::WriteOnly,
+            Keywords::MetaData::Examples
+          )
+
+          registry.add_vocabulary(
+            "https://json-schema.org/draft/2020-12/vocab/content",
+            Keywords::Content::ContentMediaType,
+            Keywords::Content::ContentEncoding,
+            Keywords::Content::ContentSchema
+          )
+
+          registry.add_metaschema(
+            "https://json-schema.org/draft/2020-12/schema",
+            "https://json-schema.org/draft/2020-12/vocab/core",
+            "https://json-schema.org/draft/2020-12/vocab/applicator",
+            "https://json-schema.org/draft/2020-12/vocab/unevaluated",
+            "https://json-schema.org/draft/2020-12/vocab/validation",
+            "https://json-schema.org/draft/2020-12/vocab/format-annotation",
+            "https://json-schema.org/draft/2020-12/vocab/meta-data",
+            "https://json-schema.org/draft/2020-12/vocab/content"
+          )
+
+          if assert_formats
+            registry.add_format("date-time", Validators::DateTime)
+            registry.add_format("date", Validators::Date)
+            registry.add_format("time", Validators::Time)
+            registry.add_format("duration", Validators::Duration)
+
+            registry.add_format("email", Validators::Email)
+            registry.add_format("idn-email", Validators::IdnEmail)
+
+            registry.add_format("hostname", Validators::Hostname)
+            registry.add_format("idn-hostname", Validators::IdnHostname)
+
+            registry.add_format("ipv4", Validators::Ipv4)
+            registry.add_format("ipv6", Validators::Ipv6)
+
+            registry.add_format("uri", Validators::Uri)
+            registry.add_format("uri-reference", Validators::UriReference)
+            registry.add_format("iri", Validators::Iri)
+            registry.add_format("iri-reference", Validators::IriReference)
+            registry.add_format("uuid", Validators::Uuid)
+
+            registry.add_format("uri-template", Validators::UriTemplate)
+
+            registry.add_format("json-pointer", Validators::JSONPointer)
+            registry.add_format("relative-json-pointer", Validators::RelativeJSONPointer)
+
+            registry.add_format("regex", Validators::Regex)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json_skooma/formatters.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module JSONSkooma
+  module Formatters
+    class << self
+      attr_accessor :formatters
+
+      def [](name)
+        formatters.fetch(name)
+      end
+
+      def register(name, formatter)
+        formatters[name] = formatter
+      end
+    end
+    self.formatters = {}
+
+    module Flag
+      class << self
+        def call(result, **_options)
+          {"valid" => result.valid?}
+        end
+      end
+    end
+    register :flag, Flag
+
+    module Basic
+      class << self
+        def call(result, **_options)
+          valid = result.valid?
+          key = valid ? "annotations" : "errors"
+          {
+            "valid" => valid,
+            key => collect_nodes(result, valid)
+          }
+        end
+
+        private
+
+        def collect_nodes(node, valid, result = [])
+          return result if node.valid? != valid
+
+          key = valid ? "annotation" : "error"
+          result << node_data(node, key) if node.public_send(key)
+
+          node.children.each do |_, child|
+            collect_nodes(child, valid, result)
+          end
+
+          result
+        end
+
+        def node_data(node, key)
+          {
+            "instanceLocation" => node.instance.path.to_s,
+            "keywordLocation" => node.path.to_s,
+            "absoluteKeywordLocation" => node.absolute_uri.to_s,
+            key => node.public_send(key)
+          }
+        end
+      end
+    end
+    register :basic, Basic
+
+    module Detailed
+      class << self
+        def call(result, **_options)
+          valid = result.valid?
+
+          node_data(result, valid, true)
+        end
+
+        private
+
+        def node_data(node, valid, first = false)
+          data = {
+            "valid" => valid,
+            "instanceLocation" => node.instance.path.to_s,
+            "keywordLocation" => node.path.to_s,
+            "absoluteKeywordLocation" => node.absolute_uri.to_s
+          }
+
+          child_key = valid ? "annotations" : "errors"
+          msg_key = valid ? "annotation" : "error"
+
+          child_data = node.children.filter_map do |_, child|
+            node_data(child, valid) if child.valid? == valid
+          end
+
+          if first || child_data.length > 1
+            data[child_key] = child_data
+          elsif child_data.length == 1
+            data = child_data[0]
+          elsif node.public_send(msg_key)
+            data[msg_key] = node.public_send(msg_key)
+          end
+
+          data
+        end
+      end
+    end
+    register :detailed, Detailed
+
+    module Verbose
+      class << self
+        def call(result, **_options)
+          node_data(result)
+        end
+
+        private
+
+        def node_data(node)
+          valid = node.valid?
+          data = {
+            "valid" => valid,
+            "instanceLocation" => node.instance.path.to_s,
+            "keywordLocation" => node.path.to_s,
+            "absoluteKeywordLocation" => node.absolute_uri.to_s
+          }
+          msg_key = valid ? "annotation" : "error"
+          data[msg_key] = node.public_send(msg_key) if node.public_send(msg_key)
+
+          child_key = valid ? "annotations" : "errors"
+          child_data = node.children.map do |_, child|
+            node_data(child)
+          end
+          data[child_key] = child_data if child_data.length > 0
+
+          data
+        end
+      end
+    end
+    register :verbose, Verbose
+  end
+end

data/lib/json_skooma/inflector.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module JSONSkooma
+  class Inflector < Zeitwerk::Inflector
+    def camelize(basename, _abspath)
+      if basename.include?("json_")
+        super.gsub("Json", "JSON")
+      else
+        super
+      end
+    end
+  end
+end