This gem contains patches to the official Apache Avro Ruby gem v1.8.2.
We have attempted to follow the coding conventions used in the official avro
repo.
The following pending or unreleased changes are included:
- AVRO-1886: Add validation messages
- AVRO-1695: Ruby support for logical types revisited
- AVRO-1969: Add schema compatibility checker for Ruby
- AVRO-2039: Ruby encoding performance improvements
- AVRO-2200: Option to fail when extra fields are in the payload
- AVRO-2199: Validate that field defaults have the correct type
In addition, compatibility with Ruby 2.4 (apache/avro#191) has been integrated with the changes above.
The following Ruby changes are not included, but could be added in the future:
- AVRO-2001: Adding support for doc attribute
- AVRO-1873: Add CRC32 checksum to Snappy-compressed blocks
Add this line to your application's Gemfile:
gem 'avro-patches'And then execute:
$ bundle
Or install it yourself as:
$ gem install avro-patches
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 tags, and push the .gem file to
rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/salsify/avro-patches.
The gem is available as open source under the terms of the MIT License.