zip-container 2.0.0 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjRlNjYzODNiZDM4MDBjYjQyZDMyODIzODdmYjlhNzRkYTNmNjA4NQ==
+    ZmM2M2M1M2YyMWUwOTk2NWRkNjllMjU0MDc0ZjQ4NGU3OWRiNTFlMg==
   data.tar.gz: !binary |-
-    MGRmMzVkNTI4NjI0NmVhMGNmNDZiMTIwZTNjM2FlM2E3YWIxZmY4OA==
+    OWFjNzFmYjM4NTliZjc4ZGE0NTZjYzNhMjBiMjJjY2Q3NGVmZjdmMw==
 SHA512:
   metadata.gz: !binary |-
-    NTk3MzMyYjM0M2U5NDgwZTYxNjE3ZDQ5YTIxMzA5NDk0YmQxMWVlOGI4ZmI4
-    ZmI3MDFkMGNjN2NjNDZlMTA2NDk2YTIwNTU2MjA4OWNkMzBlYjRlODYyYTNk
-    YThiMjNmODA4NjU1OGMzMjgxY2U1ZDhkMjkxMTQ4YmU1NDc5YzY=
+    ZmQxZTFjNzY2NjEyZGIzM2IzOTc2ZGU1ZjlkM2IwMzljZmM4NmUyN2JmNWYx
+    ZGU4YWU0ZjYzOTU3MjU3ZWVhZjdlNzI4MjY3MzhkYTEyNmNkOGFjNWNkZjFh
+    NmE1YWU3YWFjMzM0ODI0YTM2YTc4NzU3MDYyYzE2MTVjMDZjMTc=
   data.tar.gz: !binary |-
-    NjI4YmU4MTkwY2QzNjJiYmQ5MGQ3MmJkOTA2YzRlMDc5OWQyMDA0NTBmNDcx
-    ZDAwMWVlMzk4ZGVlYWYyZmUyMjc5MmRkN2UzOTAyZGZhZmUxZDIwZmRmM2Ew
-    ZmE4Njk3YmQ2ODczMjNmZmE0OTlhNTc5MTZhMTM0YjVhOGExN2U=
+    MDBmMWJmMjE2YzY4ZjkxYWZiOWU2NzNhOTU3Njk4MDViYWIzOGYyMDEzZDlk
+    NTNiYTM4YmFmMjAwNDZmZGVlMjYxMTAxMDU3YTcyYWVmMmE1NjFjMGY5MGFm
+    YmE0MjQwOTFkZjk1MGM2ZDQyY2ZhMDViYTA0NWYyM2ZlMjk3YTU=

data/.ruby-env

@@ -0,0 +1 @@
+RUBYLIB=./lib:../lib

data/.travis.yml

@@ -1,10 +1,16 @@
 language: ruby
+
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.2
+  - 2.1.5
   - ruby-head
   - rbx-2
+
+sudo: false
+
+cache: bundler
+
 matrix:
   allow_failures:
     - rvm: ruby-head

data/Changes.rdoc

@@ -1,5 +1,22 @@
 = Changes log for the ZIP Container Ruby Gem
 
+== Version 2.1.0
+
+* Set up the Container superclass.
+* Open the container from the superclass.
+* Check and read the mimetype file in the superclass.
+* Initialize reserved names and managed entries in the superclass.
+* Refactor mimetype verification.
+* Move container verification into the superclass.
+* Update the example scripts to the new API.
+* Move ::open to the Container superclass.
+* Move ::verify and ::verify! to the superclass.
+* Add the ZipContainer::Dir class.
+* Add a test for a mimetype entry that is a directory.
+* Add a test for an unreadable mimetype file.
+* Update dependencies.
+* Disambiguate the two test classes for File and Dir.
+
 == Version 2.0.0
 
 * Change API: Container => File.

data/ReadMe.rdoc

@@ -19,16 +19,22 @@ This is a Ruby library for working with ZIP Container files. See the
 {UDF}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
 specifications for more details.
 
+We follow the principles of {Semantic Versioning}[http://semver.org/] for our
+releases.
+
 == Backwards incompatibility warnings!
 
 === ZipContainer
 
-The ZipContainer::Container class is deprecated in favour of
-ZipContainer::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 rubyzip API (Zip::File).
+The ZipContainer::Container class is now a common superclass of
+ZipContainer::Dir and ZipContainer::File. You can use ZipContainer::File as a
+direct replacement for ZipContainer::Container as the functionality is
+preserved. The new names bring this API into closer alignment with the
+underlying rubyzip API (Zip::File) and allows this library to work with
+"exploded" or unpacked containers directly.
 
-ZipContainer::Container is unavailable from version 2.0.0 onwards.
+ZipContainer::Container should not be used directly from version 2.0.0
+onwards.
 
 === Rubyzip
 

data/examples/create-zip-container

@@ -49,7 +49,7 @@ if File.exists?(container_file)
 end
 
 begin
-  ZipContainer::Container.create(container_file, "application/epub+zip") do |c|
+  ZipContainer::File.create(container_file, "application/epub+zip") do |c|
 
     # Add a cheery greeting file from a string.
     c.file.open("greeting.txt", "w") do |f|

data/examples/verify-zip-container

@@ -44,7 +44,7 @@ usage unless ARGV.length == 1
 container_file = ARGV[0]
 
 begin
-  ZipContainer::Container.verify!(container_file)
+  ZipContainer::File.verify!(container_file)
 rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
   puts err.to_s
   exit 1

data/examples/zip-container-info

@@ -44,7 +44,7 @@ usage unless ARGV.length == 1
 container_file = ARGV[0]
 
 begin
-  container = ZipContainer::Container.open(container_file)
+  container = ZipContainer::File.open(container_file)
 rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
   puts err.to_s
   exit 1

data/lib/zip-container.rb

@@ -43,7 +43,9 @@ require 'zip-container/entries/managed'
 require 'zip-container/entries/entry'
 require 'zip-container/entries/file'
 require 'zip-container/entries/directory'
+require 'zip-container/container'
 require 'zip-container/file'
+require 'zip-container/dir'
 
 # This is a ruby library to read and write ZIP Container Format files. See the
 # ZipContainer::Container class for more information.

data/lib/zip-container/container.rb

@@ -0,0 +1,131 @@
+# 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
+
+#
+module ZipContainer
+
+  # The superclass of anything that represents a Zip Container. That
+  # representation could be as a Zip file (most commonly), as a directory or
+  # something else.
+  class Container
+    include ReservedNames
+    include ManagedEntries
+
+    private_class_method :new
+
+    # The mime-type of this ZipContainer.
+    attr_reader :mimetype
+
+    # :stopdoc:
+    # The reserved mimetype file name for standard ZipContainers.
+    MIMETYPE_FILE = "mimetype"
+
+    def initialize(location)
+      @container = open_container(location)
+
+      check_mimetype!
+      @mimetype = read_mimetype
+
+      # Reserved entry names. Just the mimetype file by default.
+      register_reserved_name(MIMETYPE_FILE)
+
+      # Initialize the managed entry tables.
+      initialize_managed_entries
+    end
+    # :startdoc:
+
+    # :call-seq:
+    #   open(filename) -> container
+    #   open(filename) {|container| ...}
+    #
+    # Open an existing ZipContainer. It will be checked for conformance upon
+    # first access.
+    def self.open(filename, &block)
+      c = new(filename)
+
+      if block_given?
+        begin
+          yield c
+        ensure
+          c.close
+        end
+      end
+
+      c
+    end
+
+    # :call-seq:
+    #   verify(filename) -> boolean
+    #
+    # Verify that the specified ZipContainer conforms to the specification.
+    # This method returns +false+ if there are any problems at all with the
+    # container (including if it cannot be found).
+    def self.verify(filename)
+      begin
+        new(filename).verify!
+      rescue
+        return false
+      end
+
+      true
+    end
+
+    # :call-seq:
+    #   verify!(filename)
+    #
+    # Verify that the specified ZipContainer conforms to the specification.
+    # This method raises exceptions when errors are found or if there is
+    # something fundamental wrong with the container itself (e.g. it cannot be
+    # found).
+    def self.verify!(filename)
+      new(filename).verify!
+    end
+
+    # :call-seq:
+    #   verify!
+    #
+    # Verify the contents of this ZipContainer file. All managed files and
+    # directories are checked to make sure that they exist, if required.
+    def verify!
+      verify_managed_entries!
+    end
+
+    private
+
+    def check_mimetype!
+      message = verify_mimetype
+      raise MalformedContainerError.new(message) unless message.nil?
+    end
+
+  end
+
+end

data/lib/zip-container/dir.rb

@@ -0,0 +1,192 @@
+# 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 'forwardable'
+
+module ZipContainer
+
+  # This class represents a ZipContainer in directory format. See the
+  # {OCF}[http://www.idpf.org/epub/30/spec/epub30-ocf.html] and
+  # {UCF}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format]
+  # specifications for more details.
+  #
+  # This class provides most of the facilities of the standard <tt>::Dir</tt>
+  # class. Please also consult the
+  # {ruby Dir documentation}[http://ruby-doc.org/core-1.9.3/Dir.html]
+  # alongside these pages.
+  #
+  # There are code examples available with the source code of this library.
+  class Dir < Container
+
+    extend Forwardable
+    def_delegators :@container, :close, :each, :path, :pos, :pos=, :read,
+      :rewind, :seek, :tell
+
+    private_class_method :new
+
+    # :stopdoc:
+    def initialize(location)
+      super(location)
+    end
+    # :startdoc:
+
+    # :call-seq:
+    #   create(pathname, mimetype) -> document
+    #   create(pathname, mimetype) {|document| ...}
+    #
+    # Create a new (or convert an existing) directory as a ZipContainer with
+    # the specified mimetype.
+    def self.create(pathname, mimetype, &block)
+      ::Dir.mkdir(pathname) unless ::File.directory?(pathname)
+      ::File.write(full_path(MIMETYPE_FILE), mimetype)
+
+      # Now open the newly created container.
+      c = new(pathname)
+
+      if block_given?
+        begin
+          yield c
+        ensure
+          c.close
+        end
+      end
+
+      c
+    end
+
+    private
+
+    # Prepend the full path of the directory name to whatever is passed in
+    # here. This is for internal use to ensure we are always operating on
+    # files within our container directory.
+    def full_path(path)
+      ::File.join(@container.path, path)
+    end
+
+    def open_container(location)
+      ::Dir.new(location)
+    end
+
+    def verify_mimetype
+      mime_path = full_path(MIMETYPE_FILE)
+      if ::File.exist?(mime_path)
+        return "'mimetype' is not a regular file" unless ::File.file?(mime_path)
+        return "'mimetype' is not readable." unless ::File.readable?(mime_path)
+      else
+        return "'mimetype' file is missing."
+      end
+    end
+
+    def read_mimetype
+      ::File.read(full_path(MIMETYPE_FILE))
+    end
+
+    public
+
+    # Lots of extra docs out of the way at the end here...
+
+    ##
+    # :method: close
+    # :call-seq:
+    #   close -> nil
+    #
+    # Equal to
+    # {::Dir.close}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-close]
+
+    ##
+    # :method: each
+    # :call-seq:
+    #   each { |filename| ... } -> dir
+    #   each -> an_enumerator
+    #
+    # Equal to
+    # {::Dir.each}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-each]
+
+    ##
+    # :method: path
+    # :call-seq:
+    #   path -> string or nil
+    #
+    # Equal to
+    # {::Dir.path}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-path]
+
+    ##
+    # :method: pos
+    # :call-seq:
+    #   pos -> integer
+    #
+    # Equal to
+    # {::Dir.pos}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-pos]
+
+    ##
+    # :method: pos=
+    # :call-seq:
+    #   pos = integer -> integer
+    #
+    # Equal to
+    # {::Dir.pos=}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-pos-3D]
+
+    ##
+    # :method: read
+    # :call-seq:
+    #   read -> string or nil
+    #
+    # Equal to
+    # {::Dir.read}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-read]
+
+    ##
+    # :method: rewind
+    # :call-seq:
+    #   rewind -> dir
+    #
+    # Equal to
+    # {::Dir.rewind}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-rewind]
+
+    ##
+    # :method: seek
+    # :call-seq:
+    #   seek(integer) -> dir
+    #
+    # Equal to
+    # {::Dir.seek}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-seek]
+
+    ##
+    # :method: tell
+    # :call-seq:
+    #   tell -> integer
+    #
+    # Equal to
+    # {::Dir.tell}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-tell]
+
+  end
+
+end

data/lib/zip-container/file.rb

@@ -45,36 +45,20 @@ module ZipContainer
   # alongside these pages.
   #
   # There are code examples available with the source code of this library.
-  class File
-    include ReservedNames
-    include ManagedEntries
+  class File < Container
 
     extend Forwardable
-    def_delegators :@zipfile, :comment, :comment=, :commit_required?, :each,
+    def_delegators :@container, :comment, :comment=, :commit_required?, :each,
       :entries, :extract, :get_input_stream, :name, :read, :size
 
     private_class_method :new
 
-    # The mime-type of this ZipContainer file.
-    attr_reader :mimetype
-
     # :stopdoc:
-    # The reserved mimetype file name for standard ZipContainer documents.
-    MIMETYPE_FILE = "mimetype"
-
-    def initialize(document)
-      @zipfile = open_document(document)
-      check_mimetype!
+    def initialize(location)
+      super(location)
 
-      @mimetype = read_mimetype
       @on_disk = true
 
-      # Reserved entry names. Just the mimetype file by default.
-      register_reserved_name(MIMETYPE_FILE)
-
-      # Initialize the managed entry tables.
-      initialize_managed_entries
-
       # Here we fake up the connection to the rubyzip filesystem classes so
       # that they also respect the reserved names that we define.
       mapped_zip = ::Zip::FileSystem::ZipFileNameMapper.new(self)
@@ -131,53 +115,6 @@ module ZipContainer
       c.each
     end
 
-    # :call-seq:
-    #   File.open(filename) -> document
-    #   File.open(filename) {|document| ...}
-    #
-    # Open an existing ZipContainer file from disk. It will be checked for
-    # conformance upon first access.
-    def self.open(filename, &block)
-      c = new(filename)
-
-      if block_given?
-        begin
-          yield c
-        ensure
-          c.close
-        end
-      end
-
-      c
-    end
-
-    # :call-seq:
-    #   File.verify(filename) -> boolean
-    #
-    # Verify that the specified ZipContainer file conforms to the
-    # specification. This method returns +false+ if there are any problems at
-    # all with the file (including if it cannot be found).
-    def self.verify(filename)
-      begin
-        new(filename).verify!
-      rescue
-        return false
-      end
-
-      true
-    end
-
-    # :call-seq:
-    #   File.verify!(filename)
-    #
-    # Verify that the specified ZipContainer file conforms to the
-    # specification. This method raises exceptions when errors are found or if
-    # there is something fundamental wrong with the file itself (e.g. it
-    # cannot be found).
-    def self.verify!(filename)
-      new(filename).verify!
-    end
-
     # :call-seq:
     #   add(entry, src_path, &continue_on_exists_proc)
     #
@@ -193,7 +130,7 @@ module ZipContainer
         raise ReservedNameClashError.new(entry.to_s)
       end
 
-      @zipfile.add(entry, src_path, &continue_on_exists_proc)
+      @container.add(entry, src_path, &continue_on_exists_proc)
     end
 
     # :call-seq:
@@ -207,7 +144,7 @@ module ZipContainer
       return false unless commit_required?
 
       if on_disk?
-        @zipfile.commit
+        @container.commit
       end
     end
 
@@ -251,7 +188,7 @@ module ZipContainer
         return if hidden_entry?(entry_name)
       end
 
-      @zipfile.find_entry(entry_name)
+      @container.find_entry(entry_name)
     end
 
     # :call-seq:
@@ -268,7 +205,7 @@ module ZipContainer
         raise Errno::ENOENT, entry if hidden_entry?(entry)
       end
 
-      @zipfile.get_entry(entry)
+      @container.get_entry(entry)
     end
 
     # :call-seq:
@@ -286,7 +223,7 @@ module ZipContainer
         raise ReservedNameClashError.new(entry.to_s)
       end
 
-      @zipfile.get_output_stream(entry, permission, &block)
+      @container.get_output_stream(entry, permission, &block)
     end
 
     # :call-seq:
@@ -347,7 +284,7 @@ module ZipContainer
         raise ReservedNameClashError.new(name)
       end
 
-      @zipfile.mkdir(name, permission)
+      @container.mkdir(name, permission)
     end
 
     # :call-seq:
@@ -366,7 +303,7 @@ module ZipContainer
     # method will do nothing.
     def remove(entry)
       return if reserved_entry?(entry)
-      @zipfile.remove(entry)
+      @container.remove(entry)
     end
 
     # :call-seq:
@@ -383,7 +320,7 @@ module ZipContainer
       return if reserved_entry?(entry)
       raise ReservedNameClashError.new(new_name) if reserved_entry?(new_name)
 
-      @zipfile.rename(entry, new_name, &continue_on_exists_proc)
+      @container.rename(entry, new_name, &continue_on_exists_proc)
     end
 
     # :call-seq:
@@ -395,7 +332,7 @@ module ZipContainer
     # nothing.
     def replace(entry, src_path)
       return if reserved_entry?(entry)
-      @zipfile.replace(entry, src_path)
+      @container.replace(entry, src_path)
     end
 
     # :call-seq:
@@ -403,41 +340,30 @@ module ZipContainer
     #
     # Return a textual summary of this ZipContainer file.
     def to_s
-      @zipfile.to_s + " - #{@mimetype}"
-    end
-
-    # :call-seq:
-    #   verify!
-    #
-    # Verify the contents of this ZipContainer file. All managed files and
-    # directories are checked to make sure that they exist, if required.
-    def verify!
-      verify_managed_entries!
+      @container.to_s + " - #{@mimetype}"
     end
 
     private
 
-    def open_document(document)
+    def open_container(document)
       ::Zip::File.new(document)
     end
 
-    def check_mimetype!
+    def verify_mimetype
       # Check mimetype file is present and correct.
-      entry = @zipfile.find_entry(MIMETYPE_FILE)
+      entry = @container.find_entry(MIMETYPE_FILE)
 
-      raise MalformedContainerError.new("'mimetype' file is missing.") if entry.nil?
+      return "'mimetype' file is missing." if entry.nil?
       if entry.local_header_offset != 0
-        raise MalformedContainerError.new("'mimetype' file is not at offset 0 in the archive.")
+        return "'mimetype' file is not at offset 0 in the archive."
       end
       if entry.compression_method != ::Zip::Entry::STORED
-        raise MalformedContainerError.new("'mimetype' file is compressed.")
+        return "'mimetype' file is compressed."
       end
-
-      true
     end
 
     def read_mimetype
-      @zipfile.read(MIMETYPE_FILE)
+      @container.read(MIMETYPE_FILE)
     end
 
     public

data/test/data/dirs/dir-mimetype/mimetype/.gitkeep

@@ -0,0 +1 @@
+This "mimetype" directory needs to be preserved by git.

data/test/data/dirs/empty/mimetype

@@ -0,0 +1 @@
+application/epub+zip

data/test/data/dirs/null/.gitkeep

@@ -0,0 +1 @@
+This dir should be "empty", which in this case just means no "mimetype" file.

data/test/tc_create_dir.rb

@@ -0,0 +1,59 @@
+# 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 'test/unit'
+require 'tmpdir'
+require 'zip-container'
+
+class TestCreateDir < Test::Unit::TestCase
+
+  # Check that a mimetype which is not readable does not verify. We have to
+  # build this fixture programmatically as there's no way to add a file
+  # without read permissions into git.
+  def test_verify_unreadable_mimetype
+    Dir.mktmpdir do |dir|
+      container = File.join(dir, "unreadable")
+      Dir.mkdir(container)
+      mime_path = File.join(container, ZipContainer::Container::MIMETYPE_FILE)
+      File.open(mime_path, "w") { |file| file.write "MIMETYPE" }
+      File.chmod(0000, mime_path)
+
+      refute File.readable?(mime_path)
+      assert_raise(ZipContainer::MalformedContainerError) do
+        ZipContainer::Dir.verify!(container)
+      end
+
+      refute(ZipContainer::Dir.verify(container))
+    end
+  end
+
+end

data/test/{tc_create.rb → tc_create_file.rb}

@@ -34,7 +34,7 @@ require 'test/unit'
 require 'tmpdir'
 require 'zip-container'
 
-class TestCreation < Test::Unit::TestCase
+class TestCreateFile < Test::Unit::TestCase
 
   # Check creation of standard empty container files.
   def test_create_standard_file

data/test/tc_read_dir.rb

@@ -0,0 +1,65 @@
+# 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 'test/unit'
+require 'zip-container'
+
+class TestReadDir < Test::Unit::TestCase
+
+  # Check that the empty directory does not verify.
+  def test_verify_empty_directory
+    assert_raise(ZipContainer::MalformedContainerError) do
+      ZipContainer::Dir.verify!($dir_null)
+    end
+
+    refute(ZipContainer::Dir.verify($dir_null))
+  end
+
+  # Check that the empty container directory does verify.
+  def test_verify_empty_container
+    assert_nothing_raised(ZipContainer::MalformedContainerError) do
+      ZipContainer::Dir.verify!($dir_empty)
+    end
+
+    assert(ZipContainer::Dir.verify($dir_empty))
+  end
+
+  # Check that a mimetype entry that is a directory does not verify.
+  def test_verify_mimetype_directory
+    assert_raise(ZipContainer::MalformedContainerError) do
+      ZipContainer::Dir.verify!($dir_dir_mimetype)
+    end
+
+    refute(ZipContainer::Dir.verify($dir_dir_mimetype))
+  end
+
+end

data/test/{tc_read.rb → tc_read_file.rb}

@@ -33,7 +33,7 @@
 require 'test/unit'
 require 'zip-container'
 
-class TestRead < Test::Unit::TestCase
+class TestReadFile < Test::Unit::TestCase
 
   # Check that the null file does not verify.
   def test_verify_null_file

data/test/ts_container.rb

@@ -37,6 +37,9 @@ Coveralls.wear!
 $mimetype = "application/epub+zip"
 
 # Example data files
+$dir_null = "test/data/dirs/null"
+$dir_empty = "test/data/dirs/empty"
+$dir_dir_mimetype = "test/data/dirs/dir-mimetype"
 $file_null = "test/data/null.file"
 $empty = "test/data/empty.container"
 $empty_zip = "test/data/empty.zip"
@@ -47,7 +50,9 @@ $subclass = "test/data/subclassed.container"
 # Run test cases.
 require 'tc_util'
 require 'tc_exceptions'
-require 'tc_create'
-require 'tc_read'
+require 'tc_create_dir'
+require 'tc_create_file'
+require 'tc_read_dir'
+require 'tc_read_file'
 require 'tc_reserved_names'
 require 'tc_managed_entries'

data/version.yml

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

data/zip-container.gemspec

@@ -55,10 +55,10 @@ Gem::Specification.new do |s|
   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_runtime_dependency("rubyzip", "~> 1.1.6")
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rake", "~> 10.1"
+  s.add_development_dependency "rdoc", "~> 4.1"
+  s.add_development_dependency "test-unit", "~> 3.0"
+  s.add_development_dependency "coveralls"
+  s.add_runtime_dependency "rubyzip", "~> 1.1.6"
 end
-

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: zip-container
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +107,7 @@ extra_rdoc_files:
 - ReadMe.rdoc
 files:
 - .gitignore
+- .ruby-env
 - .ruby-gemset
 - .ruby-version
 - .travis.yml
@@ -105,6 +120,8 @@ files:
 - examples/verify-zip-container
 - examples/zip-container-info
 - lib/zip-container.rb
+- lib/zip-container/container.rb
+- lib/zip-container/dir.rb
 - lib/zip-container/entries/directory.rb
 - lib/zip-container/entries/entry.rb
 - lib/zip-container/entries/file.rb
@@ -115,16 +132,21 @@ files:
 - lib/zip-container/util.rb
 - lib/zip-container/version.rb
 - test/data/compressed_mimetype.container
+- test/data/dirs/dir-mimetype/mimetype/.gitkeep
+- test/data/dirs/empty/mimetype
+- test/data/dirs/null/.gitkeep
 - test/data/empty.container
 - test/data/empty.zip
 - test/data/example.container
 - test/data/null.file
 - test/data/subclassed.container
 - test/helpers/entry_lists.rb
-- test/tc_create.rb
+- test/tc_create_dir.rb
+- test/tc_create_file.rb
 - test/tc_exceptions.rb
 - test/tc_managed_entries.rb
-- test/tc_read.rb
+- test/tc_read_dir.rb
+- test/tc_read_file.rb
 - test/tc_reserved_names.rb
 - test/tc_util.rb
 - test/ts_container.rb
@@ -159,16 +181,21 @@ specification_version: 4
 summary: A ZIP Container for use by OCF and UCF implementations
 test_files:
 - test/data/compressed_mimetype.container
+- test/data/dirs/dir-mimetype/mimetype/.gitkeep
+- test/data/dirs/empty/mimetype
+- test/data/dirs/null/.gitkeep
 - test/data/empty.container
 - test/data/empty.zip
 - test/data/example.container
 - test/data/null.file
 - test/data/subclassed.container
 - test/helpers/entry_lists.rb
-- test/tc_create.rb
+- test/tc_create_dir.rb
+- test/tc_create_file.rb
 - test/tc_exceptions.rb
 - test/tc_managed_entries.rb
-- test/tc_read.rb
+- test/tc_read_dir.rb
+- test/tc_read_file.rb
 - test/tc_reserved_names.rb
 - test/tc_util.rb
 - test/ts_container.rb