ZIP Container Ruby Library¶ ↑

Robert Haines¶ ↑

A Ruby library for creating, editing and validating ZIP Container files.

Synopsis¶ ↑

This is a Ruby library for working with ZIP Container files. See the OCF [1, 2] and UCF [3] specifications for more details.

If you are wanting to work with UCF files in particular, there is a Ruby Gem that builds on this one specifically for that. Please see: * GitHub * Rubygems

Usage¶ ↑

This library has two entry points.

The main ZipContainer::File class largely mimics the rubyzip {Zip::File} and {Zip::FileSystem} APIs so much of what you can do with them are supported for ZIP Containers. There is also API documentation with much more detail and any differences explained.

The ZipContainer::Dir class mimics, where possible, the core ruby {Dir API}[http://ruby-doc.org/core-1.9.3/Dir.html].

There are some examples of how to use the library provided in the examples directory. See the contents of the tests directory for even more.

Versions¶ ↑

Version 5 of this library will be the last to support Ruby 2.7 and the last to support RubyZip 2.4. Version 6 will require at least Ruby 3.0 and RubyZip 3.0.

What this library can not do yet¶ ↑

The basic requirements of a ZIP Container are all implemented but memory resident ZIP Container files are not yet supported. Presently all operations are performed on files that are resident on disk.

Developing ZIP Container Ruby Library¶ ↑

Please see our Code of Conduct and our contributor guidelines.

Licence¶ ↑

3-Clause BSD Licence. See LICENCE for details.