rust_json_schema 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36da1bdb6ca6d908935441ca01210ba49b7cfc5427643f0ac0d83893962cfb7
-  data.tar.gz: 424d5b0cd197dacfe27be70c9c7466f44e3b39724450721d2fd90cf0418cf1eb
+  metadata.gz: 64fe337a421bd1dc7c86285685347052694d0277ec43517e575a0d18abe53a19
+  data.tar.gz: 64840e47fb7a9f03b8a40bb626b227f465a956e1b34c4f3247a0ec9c19894c48
 SHA512:
-  metadata.gz: 66a8095e957af413791c3f56c773045ff5ece4fa6f6ce2d4d82fe1aadc8e74b753f9ad216f6c19fef49529322516a9377bbcf004f16962f00c972dc97065f4c8
-  data.tar.gz: 1690fe5ba55f3a2c1cceaf676e71580b42352679b280b1a44d346bedd8fc20be419738d00379badedf659ab87d9b71b0e79b9da898e59d0f2afdf3c4c6bbe10d
+  metadata.gz: 2f91e752ffd9b53875f496e1872ef155428901fe080cfcae390be74074ddc4b642936886d80d23624c35924b53557a8eaee3a4a9bd49a73cd8202ca7719ecf1b
+  data.tar.gz: fce2704fcbfcc943b1c4013a67a2a4b30313695fe9be6f7787c8fbd1db3b6c16aca54bfff0612edf7f6b44828d2a70f0aba90c0c083c7fe3d8df9823a186478d

data/Cargo.lock

@@ -992,6 +992,7 @@ version = "0.1.0"
 dependencies = [
  "jsonschema",
  "magnus",
+ "rb-sys",
  "serde_json",
 ]
 

data/README.md

@@ -1,34 +1,66 @@
-# RustJSONSchema
+# `rust_json_schema`
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/rust_json_schema.svg)](https://rubygems.org/gems/rust_json_schema)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rust_json_schema`. To experiment with that code, run `bin/console` for an interactive prompt.
+`rust_json_schema` is a Ruby wrapper gem for Rust's [jsonschema-rs crate](https://github.com/Stranger6667/jsonschema-rs).
 
-## Installation
+This gem ships with precompiled binaries for Linux and macOS. Check the available gems on [Rubygems](https://rubygems.org/gems/rust_json_schema).
+
+## Warning
+
+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.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+[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), and by extension, the [oxidize-rb team](https://github.com/oxidize-rb).
+
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add rust_json_schema
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install rust_json_schema
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+validator = RustJSONSchema::Validator.new(<<~JSON)
+  {
+    "properties": {
+      "foo": { "type": "string" },
+      "bar": { "type": "integer" },
+      "baz": {}
+    },
+    "required": ["foo", "baz"]
+  }
+JSON
 
-## Development
+errors = validator.validate('{ "foo": 1, "bar": "wadus" }')
+# => [
+#   'path "/bar": "wadus" is not of type "number"',
+#   'path "/foo": 1 is not of type "string"',
+#   'path "/": "baz" is a required property'
+# ]
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### 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
+
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+TODO
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rust_json_schema.
+Bug reports and pull requests are welcome.
 
 ## License
 

data/Rakefile

@@ -11,8 +11,14 @@ require "rb_sys/extensiontask"
 
 task build: :compile
 
-RbSys::ExtensionTask.new("rust_json_schema") do |ext|
+rubies = ["3.3.0", "3.2.0", "3.1.0", "3.0.0"]
+ENV["RUBY_CC_VERSION"] ||= rubies.join(":")
+
+spec = Bundler::GemHelper.gemspec
+RbSys::ExtensionTask.new("rust_json_schema", spec) do |ext|
   ext.lib_dir = "lib/rust_json_schema"
+
+  ext.cross_compile = true
 end
 
 task default: %i[compile spec standard]

data/ext/rust_json_schema/Cargo.toml

@@ -13,3 +13,4 @@ crate-type = ["cdylib"]
 jsonschema = "0.17.1"
 magnus = "0.6"
 serde_json = "1.0"
+rb-sys = { version = "*", default-features = false, features = ["ruby-static"] }

data/lib/rust_json_schema/version.rb

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

data/lib/rust_json_schema.rb

@@ -1,11 +1,19 @@
 # frozen_string_literal: true
 
 require_relative "rust_json_schema/version"
-require_relative "rust_json_schema/rust_json_schema"
+
+# 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
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rust_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Taylor Thurlow
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
-dependencies: []
+date: 2024-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler-dock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby wrapper for jsonschema-rs
 email:
 - thurlow@hey.com
@@ -53,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for jsonschema-rs