ucf 0.7.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTZhODA5Mzk1MDg1NWRlNzI4ZDk1M2IzZTEyNjAyNjVlNjYyYzNiZg==
+  data.tar.gz: !binary |-
+    YzBlMWZkNmI5M2M1MzgzOTAzYTYxYTBmOTZhZjZkNmYwOGExNTdjOA==
+SHA512:
+  metadata.gz: !binary |-
+    ZDc2YTAxOGUwMTc2N2ZhZTg2ZjJjNzUxMjJmNWJjOGJhOTJhZTRkMDFjY2M2
+    YjExZTIwMzIyZThhMjY5NmExYjE5MmYzMWIxNzZjYWFhN2YwMGVlNWM1NWQ3
+    YmNlOTAyMTUwNmQ4MjNjY2NlOWVkYzFlZDdhZTI0MTE2YmZhMDM=
+  data.tar.gz: !binary |-
+    ZGNlZmI1ZTBlNjNkMWZmOTEyYzFlNWUzZGFiZDU2NmJhMjFkMDdlMGM1NmY4
+    YzQzMjI1NjA3MzFhYjk1Njc3Yjg4MDA3NGQyYTAyMDQ5OWU4OTkyMjRlOTY1
+    ZTY3MDUyOWM2ZDI3ZTNjNjkxYjllZmIyM2E4Y2Q5YzU5YmU4MmY=

data/.gitignore

@@ -0,0 +1,9 @@
+pkg/
+html/
+coverage/
+.buildpath
+.project
+.idea
+.rvmrc
+Gemfile.lock
+example.zip

data/.ruby-gemset

@@ -0,0 +1,2 @@
+ucf
+

data/.ruby-version

@@ -0,0 +1,2 @@
+ruby-1.9.3
+

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - ruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-2

data/Changes.rdoc

@@ -1,5 +1,11 @@
 = Changes log for the UCF Ruby Gem
 
+== Version 1.0.0
+
+* Rename UCF::Container to UCF::File.
+* Use released zip-container 2.0 gem.
+* Remove UCF::Container compatibility.
+
 == Version 0.7.0
 
 * Update to be able to use the newer zip-container gem.

data/Gemfile

@@ -0,0 +1,35 @@
+# Copyright (c) 2014 The University of Manchester, UK.
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  * Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  * Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  * Neither the names of The University of Manchester nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# Author: Robert Haines
+
+source "https://rubygems.org"
+
+gemspec

data/Rakefile

@@ -30,45 +30,12 @@
 #
 # Author: Robert Haines
 
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rdoc/task'
-require 'jeweler'
-
-# we need to add lib to the path because we're not installed yet!
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "lib")
-require 'ucf'
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
 
 task :default => [:test]
 
-Jeweler::Tasks.new do |s|
-  s.name             = "ucf"
-  s.version          = UCF::Version::STRING
-  s.authors          = ["Robert Haines"]
-  s.email            = ["support@mygrid.org.uk"]
-  s.homepage         = "http://mygrid.github.io/ruby-ucf/"
-  s.platform         = Gem::Platform::RUBY
-  s.summary          = "Universal Container Format (UCF) Ruby Library"
-  s.description      = "A Ruby library for working with Universal Container "\
-    "Format files - a type of EPUB document. See the UCF specification "\
-    "(https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format)"\
-    " for details. They are very similar, although not as restrictive, as "\
-    "the EPUB Open Container Format (OCF) "\
-    "(http://www.idpf.org/epub/30/spec/epub30-ocf.html)."
-  s.require_path     = "lib"
-  s.test_file        = "test/ts_ucf.rb"
-  s.has_rdoc         = true
-  s.extra_rdoc_files = ["ReadMe.rdoc", "Licence.rdoc", "Changes.rdoc"]
-  s.rdoc_options     = ["-N", "--tab-width=2", "--main=ReadMe.rdoc"]
-  s.add_development_dependency('rake', '~> 10.0.4')
-  s.add_development_dependency('rdoc', '~> 4.0.1')
-  s.add_development_dependency('jeweler', '~> 1.8.4')
-  s.add_development_dependency('nokogiri', '~> 1.6')
-  s.add_runtime_dependency('zip-container', '>= 0.9.0')
-end
-
 Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/ts_ucf.rb']

data/ReadMe.rdoc

@@ -9,6 +9,8 @@ Copyright::   (c) 2013, 2014 The University of Manchester, UK
 
 {<img src="https://badge.fury.io/rb/ucf.png" alt="Gem Version" />}[http://badge.fury.io/rb/ucf]
 {<img src="https://codeclimate.com/github/myGrid/ruby-ucf.png" />}[https://codeclimate.com/github/myGrid/ruby-ucf]
+{<img src="https://travis-ci.org/myGrid/ruby-ucf.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/myGrid/ruby-ucf]
+{<img src="https://coveralls.io/repos/myGrid/ruby-ucf/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myGrid/ruby-ucf?branch=master]
 
 == Synopsis
 
@@ -42,6 +44,16 @@ library will use it to validate the contents of the <tt>container.xml</tt> and
 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}[http://mygrid.github.io/ruby-zip-container/]
+(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

data/examples/create-ucf

@@ -32,6 +32,7 @@
 # Author: Robert Haines
 
 require 'rubygems'
+require 'bundler/setup'
 require 'ucf'
 
 def usage

data/examples/ucfinfo

@@ -32,6 +32,7 @@
 # Author: Robert Haines
 
 require 'rubygems'
+require 'bundler/setup'
 require 'ucf'
 
 def usage

data/examples/verify-ucf

@@ -32,6 +32,7 @@
 # Author: Robert Haines
 
 require 'rubygems'
+require 'bundler/setup'
 require 'ucf'
 
 def usage

data/lib/ucf.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013, 2014 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,28 +30,20 @@
 #
 # Author: Robert Haines
 
-require 'yaml'
+require 'rubygems'
+require 'bundler/setup'
+
 require 'zip-container'
 
+require 'ucf/version'
 require 'ucf/meta-inf'
-require 'ucf/container'
+require 'ucf/file'
 
 # This is a ruby library to read and write UCF files in PK Zip format. See the
-# UCF::Container class for more information.
+# UCF::File class for more information.
 #
 # See
 # {the UCF specification}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
 # for more details.
 module UCF
-
-  # Library version information.
-  module Version
-    # Version information in a Hash
-    INFO = YAML.load_file(File.join(File.dirname(__FILE__), "..",
-      "version.yml"))
-
-    # Version number as a String
-    STRING = [:major, :minor, :patch].map {|d| INFO[d]}.compact.join('.')
-  end
-
 end

data/lib/ucf/{container.rb → file.rb}

@@ -33,20 +33,20 @@
 #
 module UCF
 
-  # This class represents a UCF document - also known as an EPUB and very
+  # This class represents a UCF document file - also known as an EPUB and very
   # similar to the
   # {EPUB Open Container Format (OCF)}[http://www.idpf.org/epub/30/spec/epub30-ocf.html].
   # See the
   # {UCF specification}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
   # for more details.
   #
-  # This class is a specialization of ZipContainer so you should see the
+  # This class is a specialization of ZipContainer::File so you should see the
   # {ZipContainer documentation}[http://mygrid.github.io/ruby-zip-container/]
   # for much more information and a list of all the other methods available in
   # this class. RDoc does not list inherited methods, unfortunately.
   #
   # There are code examples available with the source code of this library.
-  class Container < ZipContainer::Container
+  class File < ZipContainer::File
 
     private_class_method :new
 
@@ -62,12 +62,12 @@ module UCF
     # :startdoc:
 
     # :call-seq:
-    #   Container.create(filename) -> Container
-    #   Container.create(filename, mimetype) -> Container
-    #   Container.create(filename) {|container| ...}
-    #   Container.create(filename, mimetype) {|container| ...}
+    #   create(filename) -> UCF::File
+    #   create(filename, mimetype) -> UCF::FILE
+    #   create(filename) {|file| ...}
+    #   create(filename, mimetype) {|file| ...}
     #
-    # Create a new UCF document on disk and open it for editing. A custom
+    # Create a new UCF document file on disk and open it for editing. A custom
     # mimetype for the container may be specified but if not the default,
     # "application/epub+zip", will be used.
     #
@@ -75,7 +75,7 @@ module UCF
     # {ZipContainer documentation}[http://mygrid.github.io/ruby-zip-container/]
     # for much more information and a list of all the other methods available
     # in this class. RDoc does not list inherited methods, unfortunately.
-    def Container.create(filename, mimetype = DEFAULT_MIMETYPE, &block)
+    def self.create(filename, mimetype = DEFAULT_MIMETYPE, &block)
       super(filename, mimetype, &block)
     end
 

data/lib/ucf/meta-inf.rb

@@ -51,7 +51,7 @@ module UCF
     #
     # Create a standard META-INF ManagedDirectory.
     def initialize
-      super("META-INF", false,
+      super("META-INF", :required => false, :entries =>
         [
           File.new("container.xml", CONTAINER_SCHEMA),
           File.new("manifest.xml", MANIFEST_SCHEMA),
@@ -66,7 +66,7 @@ module UCF
     class File < ZipContainer::ManagedFile
 
       def initialize(name, schema = nil)
-        super(name, false)
+        super(name, :required => false)
 
         @schema = nil
         if defined?(::Nokogiri)

data/lib/ucf/version.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2014 The University of Manchester, UK.
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  * Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  * Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  * Neither the names of The University of Manchester nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# Author: Robert Haines
+
+require 'yaml'
+
+module UCF
+
+  # Library version information.
+  module Version
+    # Version information in a Hash
+    INFO = YAML.load_file(File.join(File.dirname(__FILE__), "..", "..",
+      "version.yml"))
+
+    # Version number as a String
+    STRING = [:major, :minor, :patch].map {|d| INFO[d]}.compact.join('.')
+  end
+end

data/test/tc_create.rb

@@ -42,7 +42,7 @@ class TestCreation < Test::Unit::TestCase
       filename = File.join(dir, "test.ucf")
 
       assert_nothing_raised do
-        UCF::Container.create(filename) do |c|
+        UCF::File.create(filename) do |c|
           assert(c.on_disk?)
           refute(c.in_memory?)
 
@@ -57,7 +57,7 @@ class TestCreation < Test::Unit::TestCase
       end
 
       assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
-        UCF::Container.verify!(filename)
+        UCF::File.verify!(filename)
       end
     end
   end
@@ -70,7 +70,7 @@ class TestCreation < Test::Unit::TestCase
       filename = File.join(dir, "test.ucf")
 
       assert_nothing_raised do
-        UCF::Container.create(filename, mimetype) do |c|
+        UCF::File.create(filename, mimetype) do |c|
           assert(c.on_disk?)
           refute(c.in_memory?)
 
@@ -87,7 +87,7 @@ class TestCreation < Test::Unit::TestCase
       end
 
       assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
-        UCF::Container.verify!(filename)
+        UCF::File.verify!(filename)
       end
     end
   end
@@ -99,7 +99,7 @@ class TestCreation < Test::Unit::TestCase
       filename = File.join(dir, "test.ucf")
 
       assert_nothing_raised do
-        UCF::Container.create(filename) do |ucf|
+        UCF::File.create(filename) do |ucf|
           assert(ucf.on_disk?)
           refute(ucf.in_memory?)
 
@@ -130,7 +130,7 @@ class TestCreation < Test::Unit::TestCase
       end
 
       assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
-        UCF::Container.open(filename) do |ucf|
+        UCF::File.open(filename) do |ucf|
           assert(ucf.on_disk?)
           refute(ucf.in_memory?)
 

data/test/tc_managed_entries.rb

@@ -35,33 +35,37 @@ require 'tmpdir'
 require 'ucf'
 
 # Classes to test managed entries.
-class ManagedUCF < UCF::Container
+class ManagedUCF < UCF::File
 
   private_class_method :new
 
   def initialize(filename)
     super(filename)
-    register_managed_entry(ZipContainer::ManagedDirectory.new("src", true))
+    register_managed_entry(ZipContainer::ManagedDirectory.new("src",
+      :required => true))
     register_managed_entry(ZipContainer::ManagedDirectory.new("test"))
     register_managed_entry(ZipContainer::ManagedDirectory.new("lib"))
-    register_managed_entry(ZipContainer::ManagedFile.new("index.html", true))
+    register_managed_entry(ZipContainer::ManagedFile.new("index.html",
+      :required => true))
   end
 
 end
 
-class ExampleUCF < UCF::Container
+class ExampleUCF < UCF::File
 
   private_class_method :new
 
   def initialize(filename)
     super(filename)
-    register_managed_entry(ZipContainer::ManagedDirectory.new("dir", true))
-    register_managed_entry(ZipContainer::ManagedFile.new("greeting.txt", true))
+    register_managed_entry(ZipContainer::ManagedDirectory.new("dir",
+      :required => true))
+    register_managed_entry(ZipContainer::ManagedFile.new("greeting.txt",
+      :required => true))
   end
 
 end
 
-class ExampleUCF2 < UCF::Container
+class ExampleUCF2 < UCF::File
 
   private_class_method :new
 
@@ -70,7 +74,7 @@ class ExampleUCF2 < UCF::Container
 
     valid = Proc.new { |contents| contents.match(/[Hh]ello/) }
     register_managed_entry(ZipContainer::ManagedFile.new("greeting.txt",
-      true, valid))
+       :required => true, :validation_proc => valid))
   end
 
 end
@@ -111,7 +115,7 @@ class TestManagedEntries < Test::Unit::TestCase
       filename = File.join(dir, "test.ucf")
 
       assert_nothing_raised do
-        UCF::Container.create(filename) do |c|
+        UCF::File.create(filename) do |c|
           c.mkdir("META-INF")
           assert(c.file.exists?("META-INF"))
 
@@ -124,7 +128,7 @@ class TestManagedEntries < Test::Unit::TestCase
       end
 
       assert_nothing_raised(ZipContainer::MalformedContainerError) do
-        UCF::Container.verify!(filename)
+        UCF::File.verify!(filename)
       end
     end
   end
@@ -176,7 +180,7 @@ class TestManagedEntries < Test::Unit::TestCase
     Dir.mktmpdir do |dir|
       filename = File.join(dir, "test.ucf")
 
-      assert_nothing_raised do
+      #assert_nothing_raised do
         ExampleUCF2.create(filename) do |c|
           assert_raises(ZipContainer::MalformedContainerError) do
             c.verify!
@@ -198,7 +202,7 @@ class TestManagedEntries < Test::Unit::TestCase
             c.verify!
           end
         end
-      end
+      #end
 
       assert(ExampleUCF2.verify(filename))
       assert_nothing_raised(ZipContainer::MalformedContainerError) do

data/test/tc_read.rb

@@ -38,46 +38,46 @@ class TestRead < Test::Unit::TestCase
   # Check that the null file does not verify.
   def test_verify_null_file
     assert_raise(Zip::ZipError) do
-      UCF::Container.verify!($file_null)
+      UCF::File.verify!($file_null)
     end
 
-    refute(UCF::Container.verify($file_null))
+    refute(UCF::File.verify($file_null))
   end
 
   # Check that the empty ucf file does verify.
   def test_verify_empty_ucf
     assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
-      UCF::Container.verify!($ucf_empty)
+      UCF::File.verify!($ucf_empty)
     end
 
-    assert(UCF::Container.verify($ucf_empty))
+    assert(UCF::File.verify($ucf_empty))
   end
 
   # Check that the example ucf file does verify.
   def test_verify_example_ucf
     assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
-      UCF::Container.verify!($ucf_example)
+      UCF::File.verify!($ucf_example)
     end
 
-    assert(UCF::Container.verify($ucf_example))
+    assert(UCF::File.verify($ucf_example))
   end
 
   # Check that the empty zip file does not verify.
   def test_verify_empty_zip
     assert_raise(ZipContainer::MalformedContainerError) do
-      UCF::Container.verify!($zip_empty)
+      UCF::File.verify!($zip_empty)
     end
 
-    refute(UCF::Container.verify($zip_empty))
+    refute(UCF::File.verify($zip_empty))
   end
 
   # Check that a compressed mimetype file is detected.
   def test_verify_compressed_mimetype
     assert_raise(ZipContainer::MalformedContainerError) do
-      UCF::Container.verify!($ucf_compressed_mimetype)
+      UCF::File.verify!($ucf_compressed_mimetype)
     end
 
-    refute(UCF::Container.verify($ucf_compressed_mimetype))
+    refute(UCF::File.verify($ucf_compressed_mimetype))
   end
 
   # Check the raw mimetype bytes
@@ -92,7 +92,7 @@ class TestRead < Test::Unit::TestCase
   # Check reading files out of a ucf file and make sure we don't change it.
   def test_read_files_from_ucf
     assert_nothing_raised(ZipContainer::MalformedContainerError, Zip::ZipError) do
-      UCF::Container.open($ucf_example) do |ucf|
+      UCF::File.open($ucf_example) do |ucf|
         assert(ucf.on_disk?)
         refute(ucf.in_memory?)
 

data/test/tc_reserved_names.rb

@@ -34,7 +34,7 @@ require 'test/unit'
 require 'ucf'
 
 # A class to test the overriding of reserved and managed names.
-class NewUCF < UCF::Container
+class NewUCF < UCF::File
 
   private_class_method :new
 
@@ -64,7 +64,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check the reserved names stuff all works correctly, baring in mind that
   # such comparisons for UCF documents should be case sensitive.
   def test_reserved_names
-    UCF::Container.open($ucf_example) do |ucf|
+    UCF::File.open($ucf_example) do |ucf|
       assert_equal(1, ucf.reserved_names.length)
       assert_equal(["mimetype"], ucf.reserved_names)
       assert_equal(6, ucf.managed_files.length)
@@ -148,7 +148,7 @@ class TestReservedNames < Test::Unit::TestCase
 
   # Check that nothing happens when trying to delete the mimetype file.
   def test_delete_mimetype
-    UCF::Container.open($ucf_example) do |ucf|
+    UCF::File.open($ucf_example) do |ucf|
       assert(ucf.file.exists?("mimetype"))
       assert_nil(ucf.remove("mimetype"))
       assert(ucf.file.exists?("mimetype"))
@@ -157,7 +157,7 @@ class TestReservedNames < Test::Unit::TestCase
 
   # Check that nothing happens when trying to rename the mimetype file.
   def test_rename_mimetype
-    UCF::Container.open($ucf_example) do |ucf|
+    UCF::File.open($ucf_example) do |ucf|
       assert(ucf.file.exists?("mimetype"))
       assert_nil(ucf.rename("mimetype", "something-else"))
       assert(ucf.file.exists?("mimetype"))
@@ -168,7 +168,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that nothing happens when trying to replace the contents of the
   # mimetype file.
   def test_replace_mimetype
-    UCF::Container.open($ucf_example) do |ucf|
+    UCF::File.open($ucf_example) do |ucf|
       assert(ucf.file.exists?("mimetype"))
       assert_nil(ucf.replace("mimetype", $zip_empty))
       assert_equal("application/epub+zip", ucf.file.read("mimetype"))
@@ -178,7 +178,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that an exception is raised when trying to add file with a reserved
   # name.
   def test_add_reserved
-    UCF::Container.open($ucf_empty) do |ucf|
+    UCF::File.open($ucf_empty) do |ucf|
       assert_raises(ZipContainer::ReservedNameClashError) do
         ucf.add("META-INF", $zip_empty)
       end
@@ -210,7 +210,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that the META-INF directory is detected as non-existent when trying
   # to delete it.
   def test_delete_metainf
-    UCF::Container.open($ucf_example) do |ucf|
+    UCF::File.open($ucf_example) do |ucf|
       assert_raises(Errno::ENOENT) do
         ucf.remove("META-INF")
       end
@@ -220,7 +220,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that the META-INF directory is detected as non-existent when trying
   # to rename it.
   def test_rename_metainf
-    UCF::Container.open($ucf_example) do |ucf|
+    UCF::File.open($ucf_example) do |ucf|
       assert_raises(Errno::ENOENT) do
         ucf.rename("META-INF", "something-else")
       end
@@ -230,7 +230,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that an exception is raised when trying to create a directory with a
   # reserved name.
   def test_mkdir_reserved
-    UCF::Container.open($ucf_empty) do |ucf|
+    UCF::File.open($ucf_empty) do |ucf|
       assert_raises(ZipContainer::ReservedNameClashError) do
         ucf.mkdir("mimetype")
       end
@@ -269,7 +269,7 @@ class TestReservedNames < Test::Unit::TestCase
 
   # Check that a file cannot be renamed to one of the reserved names.
   def test_rename_to_reserved
-    UCF::Container.open($ucf_example) do |ucf|
+    UCF::File.open($ucf_example) do |ucf|
       assert_raises(ZipContainer::ReservedNameClashError) do
         ucf.rename("dir/code.rb", "mimetype")
       end
@@ -293,7 +293,7 @@ class TestReservedNames < Test::Unit::TestCase
   # Check that the ruby-like File and Dir classes respect reserved and managed
   # names.
   def test_file_dir_ops_reserved
-    UCF::Container.open($ucf_empty) do |ucf|
+    UCF::File.open($ucf_empty) do |ucf|
       assert_raises(ZipContainer::ReservedNameClashError) do
         ucf.file.open("META-INF", "w") do |f|
           f.puts "TESTING"

data/test/ts_ucf.rb

@@ -30,6 +30,9 @@
 #
 # Author: Robert Haines
 
+require "coveralls"
+Coveralls.wear!
+
 # Example data files.
 $file_null = "test/data/null.file"
 $ucf_empty = "test/data/empty.ucf"

data/ucf.gemspec

@@ -1,79 +1,65 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# Copyright (c) 2013, 2014 The University of Manchester, UK.
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#  * Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+#
+#  * Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+#  * Neither the names of The University of Manchester nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# Author: Robert Haines
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ucf/version"
 
 Gem::Specification.new do |s|
   s.name = "ucf"
-  s.version = "0.7.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.version = UCF::Version::STRING
   s.authors = ["Robert Haines"]
-  s.date = "2014-01-03"
-  s.description = "A Ruby library for working with Universal Container Format files - a type of EPUB document. See the UCF specification (https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format) for details. They are very similar, although not as restrictive, as the EPUB Open Container Format (OCF) (http://www.idpf.org/epub/30/spec/epub30-ocf.html)."
   s.email = ["support@mygrid.org.uk"]
-  s.extra_rdoc_files = [
-    "Changes.rdoc",
-    "Licence.rdoc",
-    "ReadMe.rdoc"
-  ]
-  s.files = [
-    "Changes.rdoc",
-    "Licence.rdoc",
-    "Rakefile",
-    "ReadMe.rdoc",
-    "examples/create-ucf",
-    "examples/ucfinfo",
-    "examples/verify-ucf",
-    "lib/ucf.rb",
-    "lib/ucf/container.rb",
-    "lib/ucf/meta-inf.rb",
-    "lib/ucf/schema/OpenDocument-manifest-schema-v1.0-os.rng",
-    "lib/ucf/schema/container.rng",
-    "test/data/META-INF/container.xml",
-    "test/data/META-INF/manifest.xml",
-    "test/data/compressed_mimetype.ucf",
-    "test/data/empty.ucf",
-    "test/data/empty.zip",
-    "test/data/example.ucf",
-    "test/data/null.file",
-    "test/tc_create.rb",
-    "test/tc_managed_entries.rb",
-    "test/tc_read.rb",
-    "test/tc_reserved_names.rb",
-    "test/ts_ucf.rb",
-    "ucf.gemspec",
-    "version.yml"
-  ]
   s.homepage = "http://mygrid.github.io/ruby-ucf/"
-  s.rdoc_options = ["-N", "--tab-width=2", "--main=ReadMe.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.21"
+  s.platform         = Gem::Platform::RUBY
   s.summary = "Universal Container Format (UCF) Ruby Library"
-  s.test_files = ["test/ts_ucf.rb"]
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rake>, ["~> 10.0.4"])
-      s.add_development_dependency(%q<rdoc>, ["~> 4.0.1"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
-      s.add_development_dependency(%q<nokogiri>, ["~> 1.6"])
-      s.add_runtime_dependency(%q<zip-container>, [">= 0.9.0"])
-    else
-      s.add_dependency(%q<rake>, ["~> 10.0.4"])
-      s.add_dependency(%q<rdoc>, ["~> 4.0.1"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-      s.add_dependency(%q<nokogiri>, ["~> 1.6"])
-      s.add_dependency(%q<zip-container>, [">= 0.9.0"])
-    end
-  else
-    s.add_dependency(%q<rake>, ["~> 10.0.4"])
-    s.add_dependency(%q<rdoc>, ["~> 4.0.1"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-    s.add_dependency(%q<nokogiri>, ["~> 1.6"])
-    s.add_dependency(%q<zip-container>, [">= 0.9.0"])
-  end
+  s.description = "A Ruby library for working with Universal Container "\
+    "Format files - a type of EPUB document. See the UCF specification "\
+    "(https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format) "\
+    "for details. They are very similar, although not as restrictive, as "\
+    "the EPUB Open Container Format (OCF) "\
+    "(http://www.idpf.org/epub/30/spec/epub30-ocf.html)."
+  s.license          = "BSD"
+  s.require_path     = "lib"
+  s.files            = `git ls-files`.split($/)
+  s.test_files       = `git ls-files -- test/*`.split($/)
+  s.has_rdoc         = true
+  s.extra_rdoc_files = [ "Changes.rdoc", "Licence.rdoc", "ReadMe.rdoc" ]
+  s.rdoc_options = ["-N", "--tab-width=2", "--main=ReadMe.rdoc"]
+  s.required_ruby_version = ">= 1.9.3"
+  s.add_development_dependency("rake", "~> 10.0.4")
+  s.add_development_dependency("bundler", "~> 1.5")
+  s.add_development_dependency("rdoc", "~> 4.0.1")
+  s.add_development_dependency("coveralls")
+  s.add_development_dependency("nokogiri", "~> 1.6")
+  s.add_runtime_dependency("zip-container", "~> 2.0")
 end
-

data/version.yml

@@ -1,4 +1,4 @@
 ---
-  :major: 0
-  :minor: 7
+  :major: 1
+  :minor: 0
   :patch: 0

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: ucf
 version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,15 +20,27 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,31 +48,27 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.1
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,19 +83,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: zip-container
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '2.0'
 description: A Ruby library for working with Universal Container Format files - a
   type of EPUB document. See the UCF specification (https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format)
   for details. They are very similar, although not as restrictive, as the EPUB Open
@@ -104,7 +107,12 @@ extra_rdoc_files:
 - Licence.rdoc
 - ReadMe.rdoc
 files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
 - Changes.rdoc
+- Gemfile
 - Licence.rdoc
 - Rakefile
 - ReadMe.rdoc
@@ -112,10 +120,11 @@ files:
 - examples/ucfinfo
 - examples/verify-ucf
 - lib/ucf.rb
-- lib/ucf/container.rb
+- lib/ucf/file.rb
 - lib/ucf/meta-inf.rb
 - lib/ucf/schema/OpenDocument-manifest-schema-v1.0-os.rng
 - lib/ucf/schema/container.rng
+- lib/ucf/version.rb
 - test/data/META-INF/container.xml
 - test/data/META-INF/manifest.xml
 - test/data/compressed_mimetype.ucf
@@ -131,7 +140,9 @@ files:
 - ucf.gemspec
 - version.yml
 homepage: http://mygrid.github.io/ruby-ucf/
-licenses: []
+licenses:
+- BSD
+metadata: {}
 post_install_message: 
 rdoc_options:
 - -N
@@ -140,22 +151,31 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Universal Container Format (UCF) Ruby Library
 test_files:
+- test/data/META-INF/container.xml
+- test/data/META-INF/manifest.xml
+- test/data/compressed_mimetype.ucf
+- test/data/empty.ucf
+- test/data/empty.zip
+- test/data/example.ucf
+- test/data/null.file
+- test/tc_create.rb
+- test/tc_managed_entries.rb
+- test/tc_read.rb
+- test/tc_reserved_names.rb
 - test/ts_ucf.rb