rust_json_schema 0.1.1-x86_64-linux-musl → 0.2.1-x86_64-linux-musl

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbea30f580d213d6a069cea19b1ab7c0bce035d03c92620bc3f2ea55cca628fd
-  data.tar.gz: 5fc0aba79c39dfa1ae850f030e92f65fe83d69df80cbb9f867760261019bb21f
+  metadata.gz: b9864c3d33e8dfac3dba235e321de34d5b5f968629386822a4e6406179c03151
+  data.tar.gz: 96a13cafe91a65f3b339c01e4b27e88c4ae25719b4609a1f3c84f208d07d7332
 SHA512:
-  metadata.gz: 77017f0ffc19fd611fc34d61fed2ec33bc962c2b9861473bc78e60d8874f5912902152f6d88e7928dc8985b4ffcdaa3910dfd930b4e827e9a8d6ef9b0ccd2d29
-  data.tar.gz: 4e3323738b5247e3c78e3d5dde0e8b3319bd5920b62d6df416bee45440be2b7b73865e7c95a54d28f749170906aa31384c9e9fa4ea753b0d0014e7c9a95b54aa
+  metadata.gz: 6e1535a0374ff553c41c26d5f51466130e695f54c9a7c10a0219a4eae2106a310c50fdbb54f0ab135aed1198a2f3d872bf5c7627b112ecdc1dde4eb042bd1014
+  data.tar.gz: e5f7d8370d848272d1efffebcf7d4d2494730b95dcec331c52bc1aeb32bb1ddacbe052a74e9a1497adcac6d4e5729b89818ff7ceeeba6afb2e35d0696f4abbd2

data/README.md

@@ -1,14 +1,18 @@
 # `rust_json_schema`
 
+[![Gem Version](https://badge.fury.io/rb/rust_json_schema.svg)](https://rubygems.org/gems/rust_json_schema)
+
 `rust_json_schema` is a Ruby wrapper gem for Rust's [jsonschema-rs crate](https://github.com/Stranger6667/jsonschema-rs).
 
-## Warning
+The minimum Ruby version required by this gem is 3.0, due to the runtime Rust libraries that make the extensions possible (and easy).
+
+This gem ships with precompiled binaries for Linux and macOS. Check the available gems on [Rubygems](https://rubygems.org/gems/rust_json_schema). Precompiled binaries do not exist for non-standard rubies like JRuby or TruffleRuby, nor do they exist for Windows. I will review and accept PRs if you would like to work on adding these build targets.
 
-I do not have any significant Rust programming experience, but this gem satisifies a need for a performant JSON Schema validation tool in Ruby land. While I intend to use this gem in a production environment, consider this code and library entirely experimental, at least until a 1.0 release, if it ever comes to that.
+[rusty_json_schema](https://github.com/driv3r/rusty_json_schema) is a direct source of inspiration. Now that [bundler has explicit support for rust-backed Ruby gems](https://bundler.io/blog/2023/01/31/rust-gem-skeleton.html) as of early 2023, the Rust library code is a lot simpler that it previously needed to be, largely thanks to [magnus crate](https://github.com/matsadler/magnus) and the [rb-sys gem](https://github.com/oxidize-rb/rb-sys/tree/main/gem), and by extension, the [oxidize-rb team](https://github.com/oxidize-rb).
 
-[rusty_json_schema](https://github.com/driv3r/rusty_json_schema) is a direct source of inspiration (and in some cases, literal copy and paste, like some fixtures/specs). Now that [bundler has explicit support for rust-backed Ruby gems](https://bundler.io/blog/2023/01/31/rust-gem-skeleton.html) as of early 2023, the Rust library code is a lot simpler that it previously needed to be, largely thanks to [magnus crate](https://github.com/matsadler/magnus) and the [rb-sys gem](https://github.com/oxidize-rb/rb-sys/tree/main/gem).
+## Warning
 
-Eventually I intend to ship common platform binaries as part of this gem, eliminating the need for a Rust toolchain on client machines, but that is not yet the case.
+My experience with Rust is limited, but this gem does have tests, and it is deployed in production. Please confirm that the gem is working as expected before using it in any production-critical situation. If you are using this gem in a production environment, and have any comments or feedback, I would love to hear about it.
 
 ## Installation
 
@@ -23,17 +27,23 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 ```ruby
-validator = RustJSONSchema::Validator.new(<<~JSON)
+schema = <<~JSON
   {
     "properties": {
       "foo": { "type": "string" },
       "bar": { "type": "integer" },
-      "baz": {},
+      "baz": {}
     },
-    "required": ["foo", "baz"],
+    "required": ["foo", "baz"]
   }
 JSON
 
+validator = RustJSONSchema::Validator.new(
+  schema,
+  draft: :draft7,
+  with_meta_schemas: false
+)
+
 errors = validator.validate('{ "foo": 1, "bar": "wadus" }')
 # => [
 #   'path "/bar": "wadus" is not of type "number"',
@@ -42,15 +52,21 @@ errors = validator.validate('{ "foo": 1, "bar": "wadus" }')
 # ]
 ```
 
+### Options
+
+- `:draft` - Select the JSON schema draft number to use. Valid options are `draft4`, `draft6`, `draft7`, `draft201909`, and `draft202012`. Supported drafts are entirely determined by the `jsonschema` crate. The default draft is also determined by the crate. If new versions of the crate support additional draft versions, a code change in this gem will be required. I'm open to PRs to solve this problem - I don't know enough Rust to tell if it's easily done. *Both `draft201909` and `draft202012` are reported to have "some keywords not implemented", so use them at your own risk.*
+- `:with_meta_schemas` - See [docs.rs/jsonschema CompilationOptions with_meta_schemas](https://docs.rs/jsonschema/0.17.1/jsonschema/struct.CompilationOptions.html#method.with_meta_schemas). `false` by default.
+
+Any additional options provided by the `jsonschema` crate are options I do not understand or may not make sense to implement in a wrapper library such as this.
+
+`RustJSONSchema::Validator#options` is provided and will return a Hash containing configuration options from the underlying Rust library. While I make an effort for them to look similar, or identical, to the options passed into the `Validator` initializer, the initializer arguments and the returned Hash should not be considered one-to-one. It exists as a way to confirm the configuration of the underlying schema validator instance.
+
 ### Errors
 
 - All errors are subclasses of `RustJSONSchema::Error`.
 - Calling `RustJSONSchema::Validator#new`, `#validate` or `#valid?` with a string which is not valid JSON will raise `RustJSONSchema::JSONParseError`.
 - Calling `RustJSONSchema::Validator#new` with an invalid schema will raise `RustJSONSchema::SchemaParseError`.
-
-## TODO
-
-- Support passing options as `jsonschema-rs` does
+- Calling `RustJSONSchema::Validator#new` with an invalid draft version value will raise `RustJSONSchema::InvalidOptionsError`.
 
 ## Development
 

data/lib/rust_json_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RustJSONSchema
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/rust_json_schema.rb

@@ -2,18 +2,20 @@
 
 require_relative "rust_json_schema/version"
 
-# Tries to require the extension for the given Ruby version first
-begin
-  RUBY_VERSION =~ /(\d+\.\d+)/
-  require "rust_json_schema/#{Regexp.last_match(1)}/rust_json_schema"
-rescue LoadError
-  require_relative "rust_json_schema/rust_json_schema"
-end
-
 module RustJSONSchema
   class Error < StandardError; end
 
   class JSONParseError < Error; end
 
   class SchemaParseError < Error; end
+
+  class InvalidOptionsError < Error; end
+end
+
+# Tries to require the extension for the given Ruby version first
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "rust_json_schema/#{Regexp.last_match(1)}/rust_json_schema"
+rescue LoadError
+  require_relative "rust_json_schema/rust_json_schema"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rust_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: x86_64-linux-musl
 authors:
 - Taylor Thurlow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 2024-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler