corvus_json_schema 0.1.0

data/ext/corvus_json_schema/vendor/corvus-json-schema/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/ext/corvus_json_schema/vendor/corvus-json-schema/README.md

@@ -0,0 +1,139 @@
+# corvus-json-schema (Rust)
+
+A JSON Schema evaluator for Rust (draft 4, 6, 7, 2019-09 and 2020-12), ported from the Corvus.Text.Json V5 runtime
+evaluator (`Corvus.Text.Json.RuntimeEvaluator`) and its TypeScript port (`src-ts/corvus-json-schema`).
+
+A schema is compiled once into a node graph with pre-digested keyword data (resolved `$ref`/`$dynamicRef` targets,
+compiled patterns, format kinds, exact numeric bounds, oneOf/anyOf discriminators, evaluated-property analyses). Any
+number of `serde_json::Value` instances can then be evaluated against it:
+
+- **fail-fast** with `Validator::is_valid` / `Validator::validate`, which does no reporting;
+- **exhaustively** with `Validator::evaluate` and a `JsonSchemaResultsCollector` at `Basic`, `Detailed` or `Verbose`
+  level. This gives the same rows (evaluation paths, schema locations, instance locations, messages and order) as the C#
+  collector, plus annotations (`collect_annotations`, `enumerate_annotations`).
+
+```sh
+cargo add corvus-json-schema serde_json
+```
+
+```rust
+use serde_json::json;
+
+let validator = corvus_json_schema::compile(&json!({
+    "type": "object",
+    "properties": { "id": { "type": "integer", "minimum": 1 } },
+    "required": ["id"]
+}))
+.unwrap();
+assert!(validator.is_valid(&json!({ "id": 3 })));
+assert!(!validator.is_valid(&json!({ "id": 0 })));
+```
+
+`CompileOptions` covers the same ground as the C# and TypeScript options:
+- the default dialect;
+- format assertion, including custom format validators;
+- content assertion;
+- a document resolver for remote references;
+- a base URI and an entry point;
+- the maximum in-place recursion depth.
+
+The standard metaschemas are embedded.
+
+### JSON text
+
+`JsonDocument::parse` parses JSON text into a document that the evaluator reads in place: one flat array of values,
+with strings borrowed from the text where they have no escapes. That is about a quarter of the time of parsing into a
+`serde_json::Value`, and validation reads it at least as fast.
+
+```rust
+let validator = corvus_json_schema::compile(&serde_json::json!({ "type": "array", "items": { "type": "integer" } }))
+    .unwrap();
+let document = corvus_json_schema::JsonDocument::parse("[1, 2, 3]").unwrap();
+assert!(validator.validate_instance(document.root()).unwrap());
+```
+
+It accepts what serde_json accepts: nesting up to 127 levels, no lone surrogates in `\u` escapes, numbers within the
+range of a double. Of duplicate property names, the last value is kept at the position of the first. Doubles are
+correctly rounded, as serde_json's are with its `float_roundtrip` feature, which this crate turns on: a number in a
+schema and the same number in an instance are the same double, whichever parser read each.
+
+### Other instance types
+
+The evaluator reads instances through the `Instance` trait: a value shown as one of the six JSON kinds (`Instance::view`,
+and `Instance::kind` for type tests), with arrays and objects read in place through `ArrayView` and `ObjectView`.
+`&serde_json::Value` implements it. `Validator::validate_instance` and `Validator::evaluate_instance` take any
+implementation, so a host language's own values can be validated without converting them to `serde_json::Value`
+first. The Python package [corvus-json-schema-rs](../../src-py/corvus-json-schema-rs/README.md) reads Python objects
+this way, through CPython's C API.
+
+## Behaviour
+
+- **Numbers:** compared exactly. Integers are compared as integers and doubles against integers without rounding.
+  `multipleOf` is decided on decimal forms, so `0.0075` is a multiple of `0.0001`.
+- **Patterns:** use ECMA-262 semantics with the `u` flag. Common shapes (class sequences, literals and their
+  alternatives, separated lists, line lengths) get dedicated matchers, as in the C# evaluator. Patterns within the
+  common subset of ECMA-262 and the [`regex`](https://crates.io/crates/regex) crate's syntax are translated and run by
+  `regex`, and anything else by [`regress`](https://crates.io/crates/regress).
+- **Formats:** are annotations unless asserted by the vocabulary or by `CompileOptions::assert_format`. The format
+  validators follow the C# implementations (RFC 3339 dates and times, IDN hostnames, IRIs, and so on).
+
+## Benchmarks
+
+### Comparison with other Rust validators
+
+[`corvus-json-schema-bench`](https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/src-rs/corvus-json-schema-bench) validates the corpora of
+[jsonschema-benchmark](https://github.com/sourcemeta-research/jsonschema-benchmark) with this crate,
+[boon](https://crates.io/crates/boon) and [jsonschema](https://crates.io/crates/jsonschema), in one process. The
+engines' passes are interleaved, so drift in the machine's speed affects them alike.
+
+```sh
+git clone --depth 1 https://github.com/sourcemeta-research/jsonschema-benchmark.git ../../../jsonschema-benchmark
+cd ../corvus-json-schema-bench
+cargo run --release -- --schemas ../../../jsonschema-benchmark/schemas [--only a,b] [--engines corvus,boon] \
+  [--budget-ms 1000] [--json results/run.json]
+```
+
+`--profile N` runs N passes of the first engine and nothing else, for use under a profiler.
+
+### jsonschema-benchmark
+
+[`corvus-json-schema-bench/jsonschema-benchmark`](https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/src-rs/corvus-json-schema-bench/jsonschema-benchmark) is this crate's implementation of the benchmark's protocol. It
+parses every instance, compiles, validates once cold, warms up, and validates once warm. It prints
+`cold,warm,compile,parse` in nanoseconds and exits non-zero if an instance is invalid. To add it to a
+jsonschema-benchmark checkout:
+- copy the directory to `implementations/corvus-rs`;
+- add the rules from `Makefile.fragment` to the Makefile;
+- add `corvus-rs` to the README's list of implementations.
+
+Until the crate is published to crates.io, the image builds it from this repository at the `CORVUS_REF` build
+argument (default `main`).
+
+To run it locally, the binary expects this repository at `/corvus`:
+
+```sh
+ln -s "$(git rev-parse --show-toplevel)" /corvus
+cd ../corvus-json-schema-bench/jsonschema-benchmark
+cargo run --release -- <schema-noformat.json> <instances.jsonl>
+```
+
+## Bowtie
+
+[`corvus-json-schema-bowtie`](https://github.com/corvus-dotnet/Corvus.JsonSchema/tree/main/src-rs/corvus-json-schema-bowtie) is a [Bowtie](https://github.com/bowtie-json-schema/bowtie) harness for this crate. See
+its README.
+
+## Testing
+
+```sh
+cargo test
+```
+
+This runs:
+- **`tests/suite.rs`:** the full [JSON-Schema-Test-Suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite)
+  from the repository's submodule, covering required and optional tests plus `optional/format` with format asserted.
+  Every case runs fail-fast and through a collector at each level, and the verdicts must agree. Exclusions match the
+  C# runner: `draft4/optional/zeroTerminatedFloats.json` and leap seconds in the format run. Use `SUITE_DRAFT` and
+  `SUITE_FILTER` to narrow the run.
+- **`tests/annotations.rs`:** the suite's annotation tests.
+- **`tests/results.rs`:** the results-collection expectations shared with the C# and TypeScript evaluators.
+- **`tests/metaschemas.rs`:** checks that `src/metaschemas.rs` matches `src/Corvus.Text.Json/metaschema`.
+  Regenerate it with `UPDATE_METASCHEMAS=1 cargo test --test metaschemas`.