jsi-dev 0.0.0.pre.kramdown

data/lib/jsi/validation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JSI
+  module Validation
+    autoload :Error, 'jsi/validation/error'
+
+    autoload :Result, 'jsi/validation/result'
+    autoload :FullResult, 'jsi/validation/result'
+    autoload :ValidityResult, 'jsi/validation/result'
+
+    VALID = ValidityResult.new(true).freeze
+
+    INVALID = ValidityResult.new(false).freeze
+  end
+end

data/lib/jsi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JSI
+  VERSION = "0.0.0-kramdown".freeze
+end

data/lib/jsi.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "jsi/version"
+require "pp"
+require "set"
+require "json"
+require "pathname"
+require "bigdecimal"
+require "addressable/uri"
+
+module JSI
+  # generally put in code paths that are not expected to be valid control flow paths.
+  # rather a NotImplementedCorrectlyError. but that's too long.
+  #
+  # if you've found this class because JSI has raised this error, please open an issue with the backtrace
+  # and any context you can provide at https://github.com/notEthan/jsi/issues
+  class Bug < NotImplementedError
+  end
+
+  # @private TODO remove, any ruby without this is already long EOL
+  FrozenError = Object.const_defined?(:FrozenError) ? ::FrozenError : Class.new(StandardError)
+
+  # @private
+  ROOT_PATH = Pathname.new(__FILE__).dirname.parent.expand_path
+
+  # @private
+  RESOURCES_PATH = ROOT_PATH.join('{resources}')
+
+  # @private
+  SCHEMAS_PATH = RESOURCES_PATH.join('schemas')
+
+  autoload :Util, 'jsi/util'
+  autoload :Ptr, 'jsi/ptr'
+  autoload :Schema, 'jsi/schema'
+  autoload :SchemaSet, 'jsi/schema_set'
+  autoload :Base, 'jsi/base'
+  autoload :Metaschema, 'jsi/metaschema'
+  autoload :MetaschemaNode, 'jsi/metaschema_node'
+  autoload :SchemaModule, 'jsi/schema_classes'
+  autoload :SchemaClasses, 'jsi/schema_classes'
+  autoload :SchemaRegistry, 'jsi/schema_registry'
+  autoload :Validation, 'jsi/validation'
+  autoload :JSICoder, 'jsi/jsi_coder'
+
+  autoload :JSONSchemaDraft04, 'schemas/json-schema.org/draft-04/schema'
+  autoload :JSONSchemaDraft06, 'schemas/json-schema.org/draft-06/schema'
+  autoload :JSONSchemaDraft07, 'schemas/json-schema.org/draft-07/schema'
+  autoload :JSONSchemaOrgDraft04, 'schemas/json-schema.org/draft-04/schema'
+  autoload :JSONSchemaOrgDraft06, 'schemas/json-schema.org/draft-06/schema'
+  autoload :JSONSchemaOrgDraft07, 'schemas/json-schema.org/draft-07/schema'
+
+  autoload :SimpleWrap, 'jsi/simple_wrap'
+
+  # Instantiates the given schema content as a JSI Schema, passing all params to
+  # {JSI.new_schema}, and returns its {Schema#jsi_schema_module JSI Schema Module}.
+  #
+  # @return (see JSI::Schema::DescribesSchema#new_schema_module)
+  def self.new_schema_module(schema_content, **kw, &block)
+    new_schema(schema_content, **kw, &block).jsi_schema_module
+  end
+
+  # Instantiates the given document as a JSI Metaschema.
+  #
+  # @param metaschema_document an object to be instantiated as a JSI Metaschema
+  # @param schema_implementation_modules (see MetaschemaNode#initialize)
+  # @return [JSI::MetaschemaNode + JSI::DescribesSchema + JSI::Schema]
+  def self.new_metaschema(metaschema_document,
+      schema_implementation_modules:
+  )
+    MetaschemaNode.new(metaschema_document,
+      schema_implementation_modules: schema_implementation_modules,
+    )
+  end
+
+  # Instantiates the given document as a JSI Metaschema, passing all params to
+  # {new_metaschema}, and returns its {Schema#jsi_schema_module JSI Schema Module}.
+  #
+  # @return [Module + JSI::SchemaModule::DescribesSchemaModule + JSI::SchemaModule]
+  def self.new_metaschema_module(metaschema_document, **kw)
+    new_metaschema(metaschema_document, **kw).jsi_schema_module
+  end
+
+  # `JSI.schema_registry` is the default {JSI::SchemaRegistry} in which schemas are registered and from
+  # which they resolve references.
+  #
+  # @return [JSI::SchemaRegistry]
+  def self.schema_registry
+    @schema_registry
+  end
+
+  # @param schema_registry [JSI::SchemaRegistry]
+  def self.schema_registry=(schema_registry)
+    @schema_registry = schema_registry
+  end
+
+  DEFAULT_SCHEMA_REGISTRY = SchemaRegistry.new.tap do |schema_registry|
+    schema_registry.autoload_uri("http://json-schema.org/draft-04/schema") { JSI::JSONSchemaDraft04.schema }
+    schema_registry.autoload_uri("http://json-schema.org/draft-06/schema") { JSI::JSONSchemaDraft06.schema }
+    schema_registry.autoload_uri("http://json-schema.org/draft-07/schema") { JSI::JSONSchemaDraft07.schema }
+  end.freeze
+
+  self.schema_registry = DEFAULT_SCHEMA_REGISTRY.dup
+
+  Schema # trigger autoload, ensure JSI methods (new_schema etc) defined in schema.rb load
+end

data/lib/schemas/json-schema.org/draft-04/schema.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module JSI
+  metaschema_document = ::JSON.parse(SCHEMAS_PATH.join('json-schema.org/draft-04/schema.json').read)
+  JSONSchemaDraft04 = JSI.new_metaschema_module(metaschema_document,
+    schema_implementation_modules: [JSI::Schema::Draft04],
+  )
+
+  # in draft 4, boolean schemas are not described in the root, but on anyOf schemas on
+  # properties/additionalProperties and properties/additionalItems.
+  # these still describe schemas, despite not being described by the metaschema.
+  also_describe_schemas =
+    JSONSchemaDraft04.schema["properties"]["additionalProperties"]["anyOf"] +
+    JSONSchemaDraft04.schema["properties"]["additionalItems"]["anyOf"]
+  also_describe_schemas.each do |schema|
+    schema.describes_schema!([JSI::Schema::Draft04])
+  end
+
+  # the JSI schema module for `http://json-schema.org/draft-04/schema`
+  module JSONSchemaDraft04
+    # @!parse extend JSI::SchemaModule::DescribesSchemaModule
+    # @!parse include JSI::Schema::Draft04
+
+
+    Id        = properties['id']
+    Xschema    = properties['$schema']
+    Title       = properties['title']
+    Description  = properties['description']
+    Default       = properties['default']
+    MultipleOf     = properties['multipleOf']
+    Maximum         = properties['maximum']
+    ExclusiveMaximum = properties['exclusiveMaximum']
+    Minimum          = properties['minimum']
+    ExclusiveMinimum = properties['exclusiveMinimum']
+    MaxLength       = properties['maxLength']
+    MinLength      = properties['minLength']
+    Pattern        = properties['pattern']
+    AdditionalItems = properties['additionalItems']
+    Items          = properties['items']
+    MaxItems       = properties['maxItems']
+    MinItems        = properties['minItems']
+    UniqueItems      = properties['uniqueItems']
+    MaxProperties     = properties['maxProperties']
+    MinProperties      = properties['minProperties']
+    Required            = properties['required']
+    AdditionalProperties = properties['additionalProperties']
+    Definitions         = properties['definitions']
+    Properties         = properties['properties']
+    PatternProperties = properties['patternProperties']
+    Dependencies     = properties['dependencies']
+    Enum            = properties['enum']
+    Type           = properties['type']
+    Format        = properties['format']
+    AllOf        = properties['allOf']
+    AnyOf       = properties['anyOf']
+    OneOf      = properties['oneOf']
+    Not       = properties['not']
+
+    SchemaArray           = definitions['schemaArray']
+    PositiveInteger        = definitions['positiveInteger']
+    PositiveIntegerDefault0 = definitions['positiveIntegerDefault0']
+    SimpleType             = definitions['simpleTypes']
+    StringArray           = definitions['stringArray']
+
+    module Id
+    end
+    module Xschema
+    end
+    module Title
+    end
+    module Description
+    end
+    module Default
+    end
+    module MultipleOf
+    end
+    module Maximum
+    end
+    module ExclusiveMaximum
+    end
+    module Minimum
+    end
+    module ExclusiveMinimum
+    end
+    module MaxLength
+    end
+    module MinLength
+    end
+    module Pattern
+    end
+    module AdditionalItems
+    end
+    module Items
+    end
+    module MaxItems
+    end
+    module MinItems
+    end
+    module UniqueItems
+    end
+    module MaxProperties
+    end
+    module MinProperties
+    end
+    module Required
+    end
+    module AdditionalProperties
+    end
+    module Definitions
+    end
+    module Properties
+    end
+    module PatternProperties
+    end
+    module Dependencies
+    end
+    module Enum
+    end
+    module Type
+    end
+    module Format
+    end
+    module AllOf
+    end
+    module AnyOf
+    end
+    module OneOf
+    end
+    module Not
+    end
+
+    module SchemaArray
+    end
+    module PositiveInteger
+    end
+    module PositiveIntegerDefault0
+    end
+    module SimpleType
+    end
+    module StringArray
+    end
+
+    AdditionalItems::Boolean = AdditionalItems.anyOf[0]
+    AdditionalProperties::Boolean = AdditionalProperties.anyOf[0]
+    Dependencies::Dependency = Dependencies.additionalProperties
+    Type::Array = Type.anyOf[1]
+    PositiveIntegerDefault0::Default0 = PositiveIntegerDefault0.allOf[1]
+    StringItem = StringArray.items
+
+    module AdditionalItems::Boolean
+    end
+    module AdditionalProperties::Boolean
+    end
+    module Dependencies::Dependency
+    end
+    module Type::Array
+    end
+    module PositiveIntegerDefault0::Default0
+    end
+    module StringItem
+    end
+  end
+
+  JSONSchemaOrgDraft04 = JSONSchemaDraft04
+
+  # @deprecated after v0.7.0, alias of {JSONSchemaDraft04}
+  module JSONSchemaOrgDraft04
+  end
+end

data/lib/schemas/json-schema.org/draft-06/schema.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module JSI
+  metaschema_document = ::JSON.parse(SCHEMAS_PATH.join('json-schema.org/draft-06/schema.json').read)
+  JSONSchemaDraft06 = JSI.new_metaschema_module(metaschema_document,
+    schema_implementation_modules: [JSI::Schema::Draft06],
+  )
+
+  # the JSI schema module for `http://json-schema.org/draft-06/schema`
+  module JSONSchemaDraft06
+    # @!parse extend JSI::SchemaModule::DescribesSchemaModule
+    # @!parse include JSI::Schema::Draft06
+
+
+    Id      = properties['$id']
+    Xschema  = properties['$schema']
+    Ref       = properties['$ref']
+    Title      = properties['title']
+    Description = properties['description']
+    Default      = properties['default']
+    Examples      = properties['examples']
+    MultipleOf     = properties['multipleOf']
+    Maximum         = properties['maximum']
+    ExclusiveMaximum = properties['exclusiveMaximum']
+    Minimum          = properties['minimum']
+    ExclusiveMinimum = properties['exclusiveMinimum']
+    MaxLength       = properties['maxLength']
+    MinLength      = properties['minLength']
+    Pattern        = properties['pattern']
+    AdditionalItems = properties['additionalItems']
+    Items          = properties['items']
+    MaxItems      = properties['maxItems']
+    MinItems       = properties['minItems']
+    UniqueItems     = properties['uniqueItems']
+    Contains         = properties['contains']
+    MaxProperties     = properties['maxProperties']
+    MinProperties      = properties['minProperties']
+    Required            = properties['required']
+    AdditionalProperties = properties['additionalProperties']
+    Definitions         = properties['definitions']
+    Properties         = properties['properties']
+    PatternProperties = properties['patternProperties']
+    Dependencies     = properties['dependencies']
+    PropertyNames   = properties['propertyNames']
+    Const          = properties['const']
+    Enum          = properties['enum']
+    Type         = properties['type']
+    Format      = properties['format']
+    AllOf      = properties['allOf']
+    AnyOf     = properties['anyOf']
+    OneOf    = properties['oneOf']
+    Not     = properties['not']
+
+    SchemaArray              = definitions['schemaArray']
+    NonNegativeInteger        = definitions['nonNegativeInteger']
+    NonNegativeIntegerDefault0 = definitions['nonNegativeIntegerDefault0']
+    SimpleType                = definitions['simpleTypes']
+    StringArray              = definitions['stringArray']
+
+    module Id
+    end
+    module Xschema
+    end
+    module Ref
+    end
+    module Title
+    end
+    module Description
+    end
+    module Default
+    end
+    module Examples
+    end
+    module MultipleOf
+    end
+    module Maximum
+    end
+    module ExclusiveMaximum
+    end
+    module Minimum
+    end
+    module ExclusiveMinimum
+    end
+    module MaxLength
+    end
+    module MinLength
+    end
+    module Pattern
+    end
+    module AdditionalItems
+    end
+    module Items
+    end
+    module MaxItems
+    end
+    module MinItems
+    end
+    module UniqueItems
+    end
+    module Contains
+    end
+    module MaxProperties
+    end
+    module MinProperties
+    end
+    module Required
+    end
+    module AdditionalProperties
+    end
+    module Definitions
+    end
+    module Properties
+    end
+    module PatternProperties
+    end
+    module Dependencies
+    end
+    module PropertyNames
+    end
+    module Const
+    end
+    module Enum
+    end
+    module Type
+    end
+    module Format
+    end
+    module AllOf
+    end
+    module AnyOf
+    end
+    module OneOf
+    end
+    module Not
+    end
+
+    module SchemaArray
+    end
+    module NonNegativeInteger
+    end
+    module NonNegativeIntegerDefault0
+    end
+    module SimpleType
+    end
+    module StringArray
+    end
+
+    Example = Examples.items
+    Dependencies::Dependency = Dependencies.additionalProperties
+    Type::Array = Type.anyOf[1]
+    NonNegativeIntegerDefault0::Default0 = NonNegativeIntegerDefault0.allOf[1]
+    StringItem = StringArray.items
+
+    module Example
+    end
+    module Dependencies::Dependency
+    end
+    module Type::Array
+    end
+    module NonNegativeIntegerDefault0::Default0
+    end
+    module StringItem
+    end
+  end
+
+  JSONSchemaOrgDraft06 = JSONSchemaDraft06
+
+  # @deprecated after v0.7.0, alias of {JSONSchemaDraft06}
+  module JSONSchemaOrgDraft06
+  end
+end

data/lib/schemas/json-schema.org/draft-07/schema.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module JSI
+  metaschema_document = ::JSON.parse(SCHEMAS_PATH.join('json-schema.org/draft-07/schema.json').read)
+  JSONSchemaDraft07 = JSI.new_metaschema_module(metaschema_document,
+    schema_implementation_modules: [JSI::Schema::Draft07],
+  )
+
+  # the JSI schema module for `http://json-schema.org/draft-07/schema`
+  module JSONSchemaDraft07
+    # @!parse extend JSI::SchemaModule::DescribesSchemaModule
+    # @!parse include JSI::Schema::Draft07
+
+
+    Id     = properties['$id']
+    Xschema = properties['$schema']
+    Ref      = properties['$ref']
+    Comment   = properties['$comment']
+    Title      = properties['title']
+    Description = properties['description']
+    Default     = properties['default']
+    ReadOnly     = properties['readOnly']
+    Examples      = properties['examples']
+    MultipleOf     = properties['multipleOf']
+    Maximum         = properties['maximum']
+    ExclusiveMaximum = properties['exclusiveMaximum']
+    Minimum          = properties['minimum']
+    ExclusiveMinimum = properties['exclusiveMinimum']
+    MaxLength       = properties['maxLength']
+    MinLength      = properties['minLength']
+    Pattern        = properties['pattern']
+    AdditionalItems = properties['additionalItems']
+    Items          = properties['items']
+    MaxItems      = properties['maxItems']
+    MinItems       = properties['minItems']
+    UniqueItems     = properties['uniqueItems']
+    Contains         = properties['contains']
+    MaxProperties     = properties['maxProperties']
+    MinProperties      = properties['minProperties']
+    Required            = properties['required']
+    AdditionalProperties = properties['additionalProperties']
+    Definitions         = properties['definitions']
+    Properties         = properties['properties']
+    PatternProperties = properties['patternProperties']
+    Dependencies     = properties['dependencies']
+    PropertyNames   = properties['propertyNames']
+    Const          = properties['const']
+    Enum          = properties['enum']
+    Type           = properties['type']
+    Format          = properties['format']
+    ContentMediaType = properties['contentMediaType']
+    ContentEncoding = properties['contentEncoding']
+    If             = properties['if']
+    Then          = properties['then']
+    Else         = properties['else']
+    AllOf       = properties['allOf']
+    AnyOf      = properties['anyOf']
+    OneOf     = properties['oneOf']
+    Not      = properties['not']
+
+    SchemaArray              = definitions['schemaArray']
+    NonNegativeInteger        = definitions['nonNegativeInteger']
+    NonNegativeIntegerDefault0 = definitions['nonNegativeIntegerDefault0']
+    SimpleType                = definitions['simpleTypes']
+    StringArray              = definitions['stringArray']
+
+    module Id
+    end
+    module Xschema
+    end
+    module Ref
+    end
+    module Comment
+    end
+    module Title
+    end
+    module Description
+    end
+    module Default
+    end
+    module ReadOnly
+    end
+    module Examples
+    end
+    module MultipleOf
+    end
+    module Maximum
+    end
+    module ExclusiveMaximum
+    end
+    module Minimum
+    end
+    module ExclusiveMinimum
+    end
+    module MaxLength
+    end
+    module MinLength
+    end
+    module Pattern
+    end
+    module AdditionalItems
+    end
+    module Items
+    end
+    module MaxItems
+    end
+    module MinItems
+    end
+    module UniqueItems
+    end
+    module Contains
+    end
+    module MaxProperties
+    end
+    module MinProperties
+    end
+    module Required
+    end
+    module AdditionalProperties
+    end
+    module Definitions
+    end
+    module Properties
+    end
+    module PatternProperties
+    end
+    module Dependencies
+    end
+    module PropertyNames
+    end
+    module Const
+    end
+    module Enum
+    end
+    module Type
+    end
+    module Format
+    end
+    module ContentMediaType
+    end
+    module ContentEncoding
+    end
+    module If
+    end
+    module Then
+    end
+    module Else
+    end
+    module AllOf
+    end
+    module AnyOf
+    end
+    module OneOf
+    end
+    module Not
+    end
+
+    module SchemaArray
+    end
+    module NonNegativeInteger
+    end
+    module NonNegativeIntegerDefault0
+    end
+    module SimpleType
+    end
+    module StringArray
+    end
+
+    Example = Examples.items
+    PatternPropertyPattern = PatternProperties.propertyNames
+    Dependencies::Dependency = Dependencies.additionalProperties
+    Enum::Item = Enum.items
+    Type::Array = Type.anyOf[1]
+    NonNegativeIntegerDefault0::Default0 = NonNegativeIntegerDefault0.allOf[1]
+    StringItem = StringArray.items
+
+    module Example
+    end
+    module PatternPropertyPattern
+    end
+    module Dependencies::Dependency
+    end
+    module Enum::Item
+    end
+    module Type::Array
+    end
+    module NonNegativeIntegerDefault0::Default0
+    end
+    module StringItem
+    end
+  end
+
+  JSONSchemaOrgDraft07 = JSONSchemaDraft07
+
+  # @deprecated after v0.7.0, alias of {JSONSchemaDraft07}
+  module JSONSchemaOrgDraft07
+  end
+end