rust_json_schema 0.1.1-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed875d1520e782d339da205e717e3096608c3c72b3cbebd9a2804d2a6e4fda27
+  data.tar.gz: 9374e434c3546812b2681bb6d13997e95602d5270f05ff98062fb572a4a9a386
+SHA512:
+  metadata.gz: 12719f58bf15a60bdf26a581f8ae86910d14b1ea4da98a8a743b0f6f7ce71afdab3cb231017a27bccafb80829ed2833c374e0c1b36e15855182ef1f943dad9cc
+  data.tar.gz: 9f611191c75f6d9a4f421c9fe5acbbe910b0fb15b64e2aa2ec47ce338b2c7a5fa125f1cf657c4f07ed2f675b06ffb9f5cc216a19f9ccb82c5bd46dbaff54e8a1

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Taylor Thurlow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# `rust_json_schema`
+
+`rust_json_schema` is a Ruby wrapper gem for Rust's [jsonschema-rs crate](https://github.com/Stranger6667/jsonschema-rs).
+
+## 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.
+
+[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).
+
+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.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rust_json_schema
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rust_json_schema
+
+## Usage
+
+```ruby
+validator = RustJSONSchema::Validator.new(<<~JSON)
+  {
+    "properties": {
+      "foo": { "type": "string" },
+      "bar": { "type": "integer" },
+      "baz": {},
+    },
+    "required": ["foo", "baz"],
+  }
+JSON
+
+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'
+# ]
+```
+
+### 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
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+require "rb_sys/extensiontask"
+
+task build: :compile
+
+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/lib/rust_json_schema/version.rb

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

data/lib/rust_json_schema.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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
+end

data/sig/rust_json_schema.rbs

@@ -0,0 +1,4 @@
+module RustJSONSchema
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rust_json_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: x86_64-linux
+authors:
+- Taylor Thurlow
+autorequire: 
+bindir: exe
+cert_chain: []
+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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rust_json_schema.rb
+- lib/rust_json_schema/3.0/rust_json_schema.so
+- lib/rust_json_schema/3.1/rust_json_schema.so
+- lib/rust_json_schema/3.2/rust_json_schema.so
+- lib/rust_json_schema/3.3/rust_json_schema.so
+- lib/rust_json_schema/version.rb
+- sig/rust_json_schema.rbs
+homepage: https://github.com/taylorthurlow/rust_json_schema
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.4.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.11
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for jsonschema-rs
+test_files: []