Skip to content

aaoafk/dru

Repository files navigation

Dru

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add dru

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install dru

Usage

dru is a zod schema to ruby hash converter.

It was written to address one issue: validation of a JSON shape.

Specifically, this tool was written to validate a JSON shape in a way that would make sense for a language that doesn't really rely on types.

With that understanding in place, most of the types are thrown out when we build the hash and we simply check for the existence of a value that is not nil when we're testing the backend.

Dru.configure do |config|
  config.zod_schema_directories = [""]
  config.vocabulary = []
end

Dru::Parser.call

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aaoafk/dru. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Dru project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Zod schema to ruby hash converter

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published