rust_json_schema 0.2.0 → 0.3.0

data/README.md

@@ -4,6 +4,9 @@
 
 `rust_json_schema` is a Ruby wrapper gem for Rust's [jsonschema-rs crate](https://github.com/Stranger6667/jsonschema-rs).
 
+> [!IMPORTANT]
+> This gem is built with `json_schema` crate version `0.19.1`, and therefore does not support any features for any potential future versions of the crate. I will review and accept PRs if you would like to work on adding support for newer versions of the crate. I generally am trying to keep things up to date but I am not cutting new releases for each new patch version of the crate.
+
 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.
@@ -38,11 +41,7 @@ schema = <<~JSON
   }
 JSON
 
-validator = RustJSONSchema::Validator.new(
-  schema,
-  draft: :draft7,
-  with_meta_schemas: false
-)
+validator = RustJSONSchema::Validator.new(schema, draft: :draft7)
 
 errors = validator.validate('{ "foo": 1, "bar": "wadus" }')
 # => [
@@ -54,8 +53,7 @@ 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.
+- `: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._
 
 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.
 
@@ -70,7 +68,11 @@ Any additional options provided by the `jsonschema` crate are options I do not u
 
 ## Development
 
-TODO
+The rust extension is located at `ext/rust_json_schema`, and can be compiled using the `rake-compiler` tasks, usually `bin/rake compile`. Don't attempt to `cargo build` the extension separately, that typically doesn't work. View other rake tasks with `bin/rake --tasks`.
+
+You can run the tests with `bin/rspec`, but ensure any changes to the rust extension are compiled first.
+
+To release a new version, update the version number in `version.rb`, tag the new commit with the version number, and push the tag to GitHub. The gem will be built and pushed to Rubygems automatically. This will also automatically build the platform-specific binaries and attach them to the release.
 
 ## Contributing
 

data/ext/rust_json_schema/Cargo.toml

@@ -10,8 +10,7 @@ publish = false
 crate-type = ["cdylib"]
 
 [dependencies]
-jsonschema = { version = "0.17.1", features = ["draft201909", "draft202012"] }
-reqwest = { version = "*", features = ["rustls-tls"] }
-magnus = "0.6"
+jsonschema = "0.19"
+magnus = "0.7"
 serde_json = "1.0"
 rb-sys = { version = "*", default-features = false, features = ["ruby-static"] }

data/ext/rust_json_schema/src/lib.rs

@@ -16,19 +16,14 @@ use magnus::{
 struct Validator {
     schema: JSONSchema,
     draft: Draft,
-    with_meta_schemas: bool,
 }
 
 impl Validator {
     fn new(args: &[Value]) -> Result<Validator, Error> {
         let args = scan_args::<_, (), (), (), _, ()>(args)?;
         let (json,): (String,) = args.required;
-        let kwargs = get_kwargs::<_, (), (Option<Value>, Option<bool>), ()>(
-            args.keywords,
-            &[],
-            &["draft", "with_meta_schemas"],
-        )?;
-        let (draft_arg, with_meta_schemas_arg): (Option<Value>, Option<bool>) = kwargs.optional;
+        let kwargs = get_kwargs::<_, (), (Option<Value>,), ()>(args.keywords, &[], &["draft"])?;
+        let (draft_arg,): (Option<Value>,) = kwargs.optional;
 
         let draft = match draft_arg {
             Some(draft) => match draft.to_string().to_lowercase().as_str() {
@@ -47,11 +42,6 @@ impl Validator {
             None => jsonschema::Draft::default(),
         };
 
-        let with_meta_schemas = match with_meta_schemas_arg {
-            Some(with_meta_schemas) => with_meta_schemas,
-            None => false,
-        };
-
         let value: serde_json::Value = match serde_json::from_str(&json) {
             Ok(value) => value,
             Err(error) => {
@@ -65,10 +55,6 @@ impl Validator {
         let mut schema = JSONSchema::options();
         schema.with_draft(draft);
 
-        if with_meta_schemas {
-            schema.with_meta_schemas();
-        }
-
         let schema = match schema.compile(&value) {
             Ok(schema) => schema,
             Err(error) => {
@@ -79,11 +65,7 @@ impl Validator {
             }
         };
 
-        Ok(Validator {
-            schema,
-            draft,
-            with_meta_schemas,
-        })
+        Ok(Validator { schema, draft })
     }
 
     fn is_valid(&self, json: String) -> Result<bool, Error> {
@@ -110,13 +92,6 @@ impl Validator {
             )
             .unwrap();
 
-        options
-            .aset(
-                StaticSymbol::new("with_meta_schemas"),
-                self.with_meta_schemas,
-            )
-            .unwrap();
-
         Ok(options)
     }
 

data/lib/rust_json_schema/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rust_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Taylor Thurlow
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -59,13 +59,13 @@ files:
 - lib/rust_json_schema.rb
 - lib/rust_json_schema/version.rb
 - sig/rust_json_schema.rbs
-homepage: https://github.com/taylorthurlow/rust_json_schema
+homepage: https://github.com/taylorthurlow/rust_json_schema-rb
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/taylorthurlow/rust_json_schema
-  source_code_uri: https://github.com/taylorthurlow/rust_json_schema
-  changelog_uri: https://github.com/taylorthurlow/rust_json_schema/releases
+  homepage_uri: https://github.com/taylorthurlow/rust_json_schema-rb
+  source_code_uri: https://github.com/taylorthurlow/rust_json_schema-rb
+  changelog_uri: https://github.com/taylorthurlow/rust_json_schema-rb/releases
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for jsonschema-rs