Cacofonix
Cacofonix helps you work with ONIX data in your Ruby applications. ONIX is a set of (XML-based) standards for published products. Cacofonix focuses on the ONIX for Books standard, and currently supports ONIX 2.1 (all revisions).
With Cacofonix, you can:
- Efficiently read ONIX files
- Map records in ONIX files to Ruby objects
- Write ONIX files
Cacofonix is an updated, maintained fork of James Healy's original onix gem, also incorporating Joseph Pearson's major refactorings and expanded support for the standard.
Installation
Add this line to your application's Gemfile
:
gem "cacofonix"
And then execute:
$ bundle
Or install it yourself as:
$ gem install cacofonix
Usage
See the files in the examples/ directory to get started quickly.
For more detail, view the comments in the following classes:
-
Cacofonix::Reader
- For reading ONIX files -
Cacofonix::Writer
- For writing ONIX files -
Cacofonix::Normaliser
- For normalising ONIX files before reading (Fixes encoding issues, etc.) -
Cacofonix::Lists
- For building hashes of code lists from the ONIX spec
ONIX support
Cacofonix::Reader
only handles the reference tag versions of ONIX 2.1. Use
Cacofonix::Normaliser
to convert any short tag files to reference tags.
Cacofonix::Writer
only generates reference tag ONIX files.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Cacofonix codebase, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.