A set of dry-types to ensure type safety for common objects.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install carb-types
Please refer to dry-types for usage. The provided types are:
Carb::Types::Procensures the object is a proc
Carb::Types::IndifferentSymbolensures the object is a symbol, even if string passed
ArrayOfIndifferentSymbolsensures the object is a valid array of
Carb::Types::StringHashensures a hash has only string keys
Carb::Types::UUIDensures a string is a valid UUID
Carb::Types::PG::StringArrayensures an array is a valid postgres text array
Carb::Types::PG::JSONBensures a hashmap, an array or an object are valid JSON for postgres.
JSONBOpare also provided, ensuring the object is an Array, hash or basic object for JSON
Carb::Types::PG::Byteaensures the object is a valid blob for postgres
JSONBHashcan be converted to/from a ruby
Carb::Types::PG::Tsvectorensures the object is a valid postgres tsvector
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.
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 tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/Carburetor/carb-types.