corvus_json_schema 0.1.0-aarch64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 443950b015479a8a501b4464ce3b0e8dcbcaf2d8287ff2738a08d5f6ad1aabea
+  data.tar.gz: a83908134aaaf7160c817645b767737fa30149f66657e41199435dfd57ff9286
+SHA512:
+  metadata.gz: 37f32043d8b9fb5d40e2be22f742aa3851364b872486d3b9a157ce4576c7bdeff512de9122e64f3ce3ed33206726da5c14a6159b890dc02a39ce917c5160b63b
+  data.tar.gz: a18454dae5c6481545988f2cba2c1466c0bbfe01a79e49c2eed3f5a6f18467faa30339652fa1e80a93347b5ca68a10733e7357dd40c9eecfa7d4815f073aed44

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,111 @@
+# corvus_json_schema
+
+A JSON Schema evaluator for Ruby (draft 4, 6, 7, 2019-09 and 2020-12), a native extension over the
+[corvus-json-schema](https://crates.io/crates/corvus-json-schema) Rust crate, the Rust port of the Corvus.Text.Json V5
+standalone evaluator.
+
+- **Conformant**: passes the JSON-Schema-Test-Suite (required, optional and `optional/format`, every draft) except
+  `draft4/optional/zeroTerminatedFloats.json`, which the other Corvus evaluators also exclude (a JSON parser reads
+  `1.0` as an integer).
+- **Fast**: values are read in place from Ruby's own objects (nothing is converted or copied), and JSON text is
+  validated without creating Ruby objects for it.
+- **Precompiled**: native gems for Linux (x86_64 and aarch64, glibc and musl), macOS (x86_64 and arm64) and Windows
+  (x64), for Ruby 3.3, 3.4 and 4.0. On other platforms the source gem builds the extension, which needs a Rust
+  toolchain (1.85 or later) and libclang.
+
+## Install
+
+```sh
+gem install corvus_json_schema
+```
+
+## Usage
+
+```ruby
+require "corvus_json_schema"
+
+validator = CorvusJsonSchema.compile({
+  "type" => "object", "required" => ["id"], "properties" => { "id" => { "type" => "integer" } }
+})
+validator.valid?({ "id" => 3 })           # => true: a Hash, read in place
+validator.valid?({ id: "3" })             # => false: Symbol keys are read as their names
+validator.valid_json?('{"id": 3}')        # => true: JSON text, parsed in Rust
+
+collector = CorvusJsonSchema::Collector.new(:detailed)
+validator.evaluate({ "id" => "3" }, collector)  # => false
+collector.results
+# => [..., { is_match: false, message: "The value was expected to be of type 'integer'",
+#             evaluation_location: "/properties/id/type", schema_location: "/properties/id/type",
+#             instance_location: "/id" }, ...]
+```
+
+`CorvusJsonSchema.compile(schema, **options)` takes the schema as a Hash, an Array, `true` or `false`, or JSON text.
+Its options:
+
+| Option | Default | Meaning |
+| --- | --- | --- |
+| `default_dialect` | `:draft202012` | The dialect of a schema without `$schema`: `:draft4`, `:draft6`, `:draft7`, `:draft201909` or `:draft202012`. |
+| `assert_format` | `nil` | Whether `format` is asserted; `nil` follows the schema's vocabularies. |
+| `assert_format_in_legacy_drafts` | `false` | Assert `format` in drafts 4 to 7 when `assert_format` is `nil`. |
+| `assert_content` | `true` | Assert `contentEncoding` and `contentMediaType` in drafts 4 to 7. |
+| `formats` | `nil` | A Hash of format name to a callable that takes the string and returns whether it is valid. |
+| `resolver` | `nil` | A callable that takes an absolute URI and returns the document (a Hash or JSON text), or `nil` when it has none. |
+| `base_uri` | `nil` | The schema's base URI, when it has no `$id`. |
+| `entry_point` | `nil` | A reference to the subschema to validate against, such as `"#/$defs/item"`. |
+| `max_depth` | `128` | The deepest the evaluator recurses in place before it raises `DepthError`. |
+
+A `Validator` is immutable and can be shared between threads.
+
+- `valid?(value)` and `valid_json?(text)` return whether the instance is valid, evaluating only as far as the answer
+  needs.
+- `evaluate(value, collector)` evaluates every keyword and replaces the collector's results with this evaluation's.
+  `Collector.new(level)` takes `:basic` (the failures, without messages), `:detailed` (the failures, with messages)
+  or `:verbose` (every result, and annotations); at every level the root's own result is the last row. `results`
+  returns its rows and `annotations` the annotations of a verbose evaluation, grouped by instance location, keyword and
+  schema location.
+
+Errors are subclasses of `CorvusJsonSchema::Error`: `CompilationError` (an invalid schema, or a reference that cannot
+be resolved), `DepthError` and `InvalidJsonError` (for `valid_json?`). An error raised by a format or resolver callable
+propagates.
+
+## Values
+
+A value is read as its JSON kind: a `Hash` (String or Symbol keys) is an object, an `Array` an array, a `String` (UTF-8
+or US-ASCII) or `Symbol` a string, an `Integer` or `Float` a number, and `true`, `false` and `nil` themselves. An
+Integer beyond 64 bits is compared as the nearest double, as by a JSON parser without arbitrary precision.
+
+Values are read only as the schema examines them, so a value the schema never looks at is not checked: with
+`{"type" => "object"}`, `{ "a" => Object.new }` is valid. A value the schema does examine that is none of the kinds
+above raises `TypeError` (`ArgumentError` for a NaN or infinite Float, `EncodingError` for a String that is not valid
+UTF-8).
+
+## How it works
+
+The crate compiles the schema once into its node graph and fail-fast plans (see
+[src-rs/corvus-json-schema](../../src-rs/corvus-json-schema/README.md)). Its evaluator is generic over an `Instance`
+trait (a value shown as one of the six JSON kinds, with arrays and objects read in place), which this extension
+implements over Ruby values: arrays are read by index, strings as the bytes Ruby holds, and a Hash's pairs are gathered
+(with `rb_hash_foreach`) into a buffer reused across evaluations when the evaluator first reads that object.
+Evaluation allocates no Ruby objects, so Ruby's garbage collector cannot run, and so cannot move a value, while it
+reads them; when custom formats (Ruby code, which can allocate) are in use, the instance is first converted to the
+crate's own form instead.
+
+`valid_json?` parses into the crate's `JsonDocument`, whose buffers are reused for each thread: in the steady state a
+validation of JSON text allocates nothing.
+
+## Building from source
+
+In this repository, with Ruby 3.3 or later, a Rust toolchain and libclang:
+
+```sh
+bundle install
+bundle exec rake compile test
+```
+
+The Rakefile copies the crate from `src-rs/corvus-json-schema` into `ext/corvus_json_schema/vendor` whenever it loads,
+so the source gem carries the crate's sources and builds on its own. The tests run the JSON-Schema-Test-Suite from the
+repository's submodule (or `JSON_SCHEMA_TEST_SUITE`).
+
+## License
+
+Apache-2.0

data/VERSIONHISTORY.md

@@ -0,0 +1,7 @@
+# Version History
+
+The version history of the `corvus_json_schema` Ruby gem. It is versioned independently of the Corvus NuGet packages and of the [corvus-json-schema](../../src-rs/corvus-json-schema/VERSIONHISTORY.md) Rust crate it is built on.
+
+## V0.1.0
+
+The first release: a native extension over the corvus-json-schema Rust crate (0.1.3), for drafts 4, 6, 7, 2019-09 and 2020-12. It reads Ruby values in place, validates JSON text without creating Ruby objects for it, and collects results (Basic, Detailed and Verbose) and annotations. It passes the whole JSON-Schema-Test-Suite, read in place, as JSON text and through a collector.

data/lib/corvus_json_schema/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CorvusJsonSchema
+  VERSION = "0.1.0"
+end

data/lib/corvus_json_schema.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# A high-performance JSON Schema evaluator (draft 4, 6, 7, 2019-09 and 2020-12) for Ruby, backed by the
+# corvus-json-schema Rust crate, with results collection and annotations.
+#
+#   validator = CorvusJsonSchema.compile({ "type" => "object", "required" => ["id"] })
+#   validator.valid?({ "id" => 3 })        # => true
+#   validator.valid_json?('{"id": 3}')     # => true, parsed in Rust
+#
+# Values are read in place: Hash (String or Symbol keys), Array, String, Symbol (as its name), Integer, Float, true,
+# false and nil. Integers beyond 64 bits become the nearest double. A value the schema examines that is none of these
+# raises (TypeError; ArgumentError for NaN and infinities; EncodingError for a String that is not valid UTF-8); values
+# are read only as the schema examines them.
+require_relative "corvus_json_schema/version"
+
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require_relative "corvus_json_schema/#{Regexp.last_match(1)}/corvus_json_schema"
+rescue LoadError
+  require_relative "corvus_json_schema/corvus_json_schema"
+end
+
+module CorvusJsonSchema
+  DIALECTS = {
+    draft4: 4, draft6: 6, draft7: 7, draft201909: 2019, draft202012: 2020
+  }.freeze
+
+  RESULTS_LEVELS = { basic: 0, detailed: 1, verbose: 2 }.freeze
+
+  # Compiles a schema (a Hash or Array, true or false, or JSON text) into a Validator.
+  #
+  # Options: default_dialect (:draft4, :draft6, :draft7, :draft201909, :draft202012; the dialect of schemas without
+  # $schema), assert_format (nil follows the vocabularies), assert_format_in_legacy_drafts, assert_content, formats (a
+  # Hash of format name to a callable returning whether a string is valid), resolver (a callable from an absolute URI
+  # to the document, as a Hash or JSON text, or nil when unknown), base_uri, entry_point (a reference such as
+  # "#/$defs/item") and max_depth (of in-place recursion, default 128).
+  def self.compile(schema, default_dialect: :draft202012, assert_format: nil, assert_format_in_legacy_drafts: false,
+                   assert_content: true, formats: nil, resolver: nil, base_uri: nil, entry_point: nil, max_depth: 128)
+    dialect = DIALECTS.fetch(default_dialect) { raise ArgumentError, "unknown dialect #{default_dialect.inspect}" }
+    Native.compile(schema, dialect, assert_format, assert_format_in_legacy_drafts, assert_content, formats, resolver,
+                   base_uri, entry_point, Integer(max_depth))
+  end
+
+  # The version of the corvus-json-schema crate the extension was built from.
+  def self.crate_version
+    Native.crate_version
+  end
+
+  # A compiled schema: valid?(value), valid_json?(text) and evaluate(value, collector).
+  class Validator
+    # Evaluates the value, replacing the collector's results with this evaluation's (every keyword is evaluated and
+    # reported at the collector's level). Returns whether the value is valid.
+    def evaluate(value, collector)
+      native_evaluate(value, collector)
+    end
+  end
+
+  # The results of the latest evaluation into it: results (rows as Hashes) and annotations (from a :verbose
+  # evaluation, grouped by instance location, keyword and schema location).
+  class Collector
+    def self.new(level = :basic)
+      native_new(RESULTS_LEVELS.fetch(level) { raise ArgumentError, "unknown results level #{level.inspect}" })
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: corvus_json_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: aarch64-linux
+authors:
+- endjin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-10-02 00:00:00.000000000 Z
+dependencies: []
+description: 'JSON Schema validation for Ruby with the corvus-json-schema Rust crate:
+  drafts 4, 6, 7, 2019-09 and 2020-12, results and annotations, Ruby values read in
+  place.'
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSIONHISTORY.md
+- lib/corvus_json_schema.rb
+- lib/corvus_json_schema/3.3/corvus_json_schema.so
+- lib/corvus_json_schema/3.4/corvus_json_schema.so
+- lib/corvus_json_schema/4.0/corvus_json_schema.so
+- lib/corvus_json_schema/version.rb
+homepage: https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/src-rb/corvus-json-schema
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/corvus-dotnet/Corvus.JsonSchema
+  bug_tracker_uri: https://github.com/corvus-dotnet/Corvus.JsonSchema/issues
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 4.1.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: A high-performance JSON Schema evaluator (draft 4 to 2020-12), backed by
+  Rust.
+test_files: []