LZOP::File

Ruby library for writing LZOP files.

This gem writes the binary file format for .lzo or .lz files in native Ruby code. The lzoruby gem is used to compress the data.

Known Issues

This release of lzop-file is currently not feature-complete & should be treated as a beta release! There are known issues with the current implementation with regards to output file compatibility with the lzop tool:

• CRC32 or Adler32 checksum is not currently written to the output file headers
• There may be other header bits that are incorrect
• Ruby 1.8.x is not supported due to Array#pack() not supporting the endian-ness modifiers we need.
• lzoruby version 0.1.3 does not provide LZO_VERSION constant directly from the external lzo library, instead it supplies the value of LZO_VERSION_STRING. We will attempt to remain compatible with lzoruby 0.1.3 for now, and fudge the LZO_VERSION to latest current for lzo-2.08 0x2080. Hopefully, a future release of lzopruby will contain the real external library version ;-)

Installation

Notes: This gem depends on lzoruby which uses native C extensions, and depends on the lzo library. As such, it has dependencies that should probably not be used on JRuby in production.

To install the LZO Library:

• Ubuntu/Debian: apt-get install liblzo2-dev
• RedHat/CentOS/Fedora: yum install lzo-devel
• Mac OSX: brew install lzo

Add this line to your application's Gemfile:

gem 'lzop-file'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lzop-file

Usage

Writing LZO Compressed files is simple:

require 'lzop-file'

uncompressed_file_data = "Hello World\n" * 100

my_test_file = LZOP::File.new( '/tmp/my_test_file.lzo' )
my_test_file.write( uncompressed_file_data )

Or to write just the header:

require 'lzop-file'

LZOP::File.new( '/tmp/my_test_file.lzo_header' ).write_header

Contributing

1. Fork it ( https://github.com/trinitronx/lzop-file/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request