schemurai 2.0.0 → 2.2.0

data/lib/schemurai.rb

@@ -34,10 +34,13 @@ module Schemurai
     end
   end
 
-  # Describes one failed JSON Schema assertion.
+  # Public value type describing one failed JSON Schema assertion.
   #
-  # +instance_path+ and +schema_path+ are JSON Pointers. An empty string points
-  # to the root instance or schema.
+  # +keyword+ identifies the failed keyword. +instance_path+ and +schema_path+
+  # are JSON Pointers; an empty string points to the root instance or schema.
+  # +message+ is a human-readable String. Its presence and type are public API,
+  # but its exact wording is not. Use +keyword+ and the paths for programmatic
+  # error handling.
   class ValidationError < Data.define(:keyword, :instance_path, :schema_path, :message)
     # Returns the error fields as a Hash.
     def to_h

data/sig/schemurai.rbs

@@ -0,0 +1,157 @@
+module Schemurai
+  # A JSON-shaped Ruby value accepted as a schema value or validation instance.
+  type json_value =
+    nil
+    | bool
+    | Integer
+    | Float
+    | String
+    | Array[json_value]
+    | Hash[String, json_value]
+
+  # A JSON Schema root.
+  type schema = bool | Hash[String, json_value]
+
+  # External schemas indexed by their absolute URI.
+  type schemas = Hash[String, schema]
+
+  # A resolved evaluator backend.
+  type backend = :ruby | :vm
+
+  # A backend accepted when configuring a validator.
+  type backend_selection = backend | :default
+
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class ResolutionError < Error
+  end
+
+  class UnsupportedFormatError < Error
+  end
+
+  class InvalidSchemaError < Error
+    attr_reader result: Result
+
+    def initialize: (Result result) -> void
+  end
+
+  class ValidationError < Data
+    attr_reader keyword: String
+    attr_reader instance_path: String
+    attr_reader schema_path: String
+    attr_reader message: String
+
+    def self.new: (String keyword, String instance_path, String schema_path, String message) -> ValidationError
+                | (keyword: String, instance_path: String, schema_path: String, message: String) -> ValidationError
+
+    def self.[]: (String keyword, String instance_path, String schema_path, String message) -> ValidationError
+               | (keyword: String, instance_path: String, schema_path: String, message: String) -> ValidationError
+
+    def to_h: () -> {
+      keyword: String,
+      instance_path: String,
+      schema_path: String,
+      message: String
+    }
+  end
+
+  class Result
+    attr_reader errors: Array[ValidationError]
+
+    def initialize: (Array[ValidationError] errors) -> void
+    def valid?: () -> bool
+    alias success? valid?
+  end
+
+  interface _Evaluator
+    def backend: () -> backend
+    def validate: (json_value instance) -> Result
+    def valid?: (json_value instance) -> bool
+  end
+
+  class Validator
+    def initialize: (_Evaluator evaluator) -> void
+    def backend: () -> backend
+    def validate: (json_value instance) -> Result
+    def valid?: (json_value instance) -> bool
+  end
+
+  class SchemaRegistry
+    attr_reader backend: backend
+
+    def initialize: (
+      ?schemas: schemas,
+      ?validate_schema: bool,
+      ?backend: backend_selection
+    ) -> void
+
+    def validate_schema?: () -> bool
+
+    def compile: (
+      schema schema,
+      ?base_uri: String?,
+      ?content: bool,
+      ?format: bool
+    ) -> Validator
+
+    def validate_schema: (schema schema) -> Result
+    def valid_schema?: (schema schema) -> bool
+    def make_shareable: () -> self
+    def shareable?: () -> bool
+
+    def validator_for: (
+      String uri,
+      ?content: bool,
+      ?format: bool
+    ) -> Validator
+  end
+
+  def self.backend: () -> backend
+
+  def self.compile: (
+    schema schema,
+    ?schemas: schemas,
+    ?base_uri: String?,
+    ?content: bool,
+    ?format: bool,
+    ?validate_schema: bool,
+    ?backend: backend_selection
+  ) -> Validator
+
+  def self.validate_schema: (
+    schema schema,
+    ?schemas: schemas,
+    ?backend: backend_selection
+  ) -> Result
+
+  def self.valid_schema?: (
+    schema schema,
+    ?schemas: schemas,
+    ?backend: backend_selection
+  ) -> bool
+
+  def self.validate: (
+    schema schema,
+    json_value instance,
+    ?schemas: schemas,
+    ?base_uri: String?,
+    ?content: bool,
+    ?format: bool,
+    ?validate_schema: bool,
+    ?backend: backend_selection
+  ) -> Result
+
+  def self.valid?: (
+    schema schema,
+    json_value instance,
+    ?schemas: schemas,
+    ?base_uri: String?,
+    ?content: bool,
+    ?format: bool,
+    ?validate_schema: bool,
+    ?backend: backend_selection
+  ) -> bool
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schemurai
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Kuya KOHARA (oakcask)
@@ -42,6 +42,7 @@ files:
 - lib/schemurai/dialects/draft2019_09.rb
 - lib/schemurai/dialects/draft2020_12.rb
 - lib/schemurai/dialects/draft7.rb
+- lib/schemurai/error_message.rb
 - lib/schemurai/evaluation.rb
 - lib/schemurai/evaluator.rb
 - lib/schemurai/formats.rb
@@ -55,13 +56,14 @@ files:
 - lib/schemurai/version.rb
 - lib/schemurai/vm/compiler.rb
 - lib/schemurai/vm/evaluator.rb
+- sig/schemurai.rbs
 homepage: https://github.com/oakcask/schemurai
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/oakcask/schemurai
   source_code_uri: https://github.com/oakcask/schemurai/tree/main
-  documentation_uri: https://rubydoc.info/gems/schemurai/2.0.0
+  documentation_uri: https://rubydoc.info/gems/schemurai/2.2.0
   rubygems_mfa_required: 'true'
 rdoc_options:
 - "--main"