Universal Container Format (UCF) Ruby Library


Robert Haines





Source code



BSD (See Licence file or www.opensource.org/licenses/bsd-license.php)


© 2013, 2014 The University of Manchester, UK

Gem Version Build
Status Coverage Status


This is a Ruby library for working with UCF documents. See the specification for more details. UCF is a type of EPUB and very similar to the EPUB Open Container Format (OCF).

Most of this library’s API is provided by the underlying zip-container gem so you will need to consult that documentation as well in addition to this.

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.

We follow the principles of Semantic Versioning for our releases.

Files in the META-INF directory

The UCF specification requires that files in the META-INF directory are validated against a schema if they are present. If the nokogiri gem is available then this library will use it to validate the contents of the container.xml and manifest.xml files. This functionality is not enforced on the user in case they are not using the META-INF directory and so would not need the extra dependency on nokogiri.

Backwards incompatibility warning!

The UCF::Container class is deprecated in favour of UCF::File. These classes are functionally identical; it is just a change of name. The new name brings this API into closer alignment with the underlying zip-container API (ZipContainer::File).

UCF::Container is not available from version 1.0.0 onwards.

What this library can not do yet

The basic requirements of a UCF document are all implemented but there are a number of optional features that are not yet provided.