zip-container 1.1.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Njc2NTMxMjAwYTcyYjA2NzA0YTEzMTI5MjgxODhlNTg5ODJlNjY4Nw==
+    YjRlNjYzODNiZDM4MDBjYjQyZDMyODIzODdmYjlhNzRkYTNmNjA4NQ==
   data.tar.gz: !binary |-
-    MWJkMDk3ZTM2NGYwYzVkY2I5NjljYzIxNzU2MzUyNGIxMjk0MzhmYg==
+    MGRmMzVkNTI4NjI0NmVhMGNmNDZiMTIwZTNjM2FlM2E3YWIxZmY4OA==
 SHA512:
   metadata.gz: !binary |-
-    MDVmN2MxZjZkYzQzNWQ4OWE1NGM1OGQwMDNhZWQ1ZjkyOTAyOGUyYzBkNTYz
-    OGRhYjA4ZTQwNGQzMzYyOGNkYTNkYWZhYWZlM2U1MzZhMDA1ODVlYTc2MTdl
-    YmM2MTZiYTNkMjc4NDJmYjM2MTgyMzA5ZDQ3MTQ4ODVjNGIzN2M=
+    NTk3MzMyYjM0M2U5NDgwZTYxNjE3ZDQ5YTIxMzA5NDk0YmQxMWVlOGI4ZmI4
+    ZmI3MDFkMGNjN2NjNDZlMTA2NDk2YTIwNTU2MjA4OWNkMzBlYjRlODYyYTNk
+    YThiMjNmODA4NjU1OGMzMjgxY2U1ZDhkMjkxMTQ4YmU1NDc5YzY=
   data.tar.gz: !binary |-
-    ODAwMGIxYjBkZTRkY2FmNTUxNWY2MjA0ZTk5YTFkOTA1OGY4MGYwNzIxM2Zm
-    OTdmZTI5ZTdhMjE4MDNmZjRmMTQ4NTcxMjBiNWJlMTc3NzIxMmZjZWI4ZTBi
-    NzJjYTk2MDBhMDA0NjYzNzQwMTczNjQ4YWU5MWQxN2MxN2QxOTI=
+    NjI4YmU4MTkwY2QzNjJiYmQ5MGQ3MmJkOTA2YzRlMDc5OWQyMDA0NTBmNDcx
+    ZDAwMWVlMzk4ZGVlYWYyZmUyMjc5MmRkN2UzOTAyZGZhZmUxZDIwZmRmM2Ew
+    ZmE4Njk3YmQ2ODczMjNmZmE0OTlhNTc5MTZhMTM0YjVhOGExN2U=

data/.travis.yml

@@ -3,3 +3,9 @@ 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,28 @@
 = Changes log for the ZIP Container Ruby Gem
 
+== Version 2.0.0
+
+* Change API: Container => File.
+* Refactor exceptions so we can shadow rubyzip exceptions.
+* Use the shadowed ZipError in the tests.
+* Use the shadowed ZipError in the example scripts.
+* Update the exceptions to use Zip::Error.
+* Refactor managed file and directory initializers.
+* Add the new Util module with a helper method.
+* Toggle managed files as hidden in normal use.
+* Update find_entry to take hidden files into account.
+* Fix the managed files and directories lists.
+* Update the hidden file detection code.
+* Cache managed entry lists.
+* Split up the hidden entry/find_entry tests.
+* Update get_entry to take hidden files into account.
+* Mixin the Util module to the ManagedEntry class.
+* Update glob to take hidden files into account.
+* Improve Util::entry_name to be more robust.
+* Remove old Container compatibility.
+* Document removal of ZipContainer::Container in the ReadMe.
+* Update rubyzip version to latest (1.1.6).
+
 == Version 1.1.0
 
 * Bump version of rubyzip to 1.1.4.

data/ReadMe.rdoc

@@ -19,7 +19,18 @@ 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.
 
-== Backwards incompatibility warning!
+== 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).
+
+ZipContainer::Container is unavailable from version 2.0.0 onwards.
+
+=== Rubyzip
 
 Version 1.0.0 and up of this gem uses version 1.0.0 and up of the
 {rubyzip}[https://rubygems.org/gems/rubyzip] library. This has a backwards

data/examples/create-zip-container

@@ -65,7 +65,7 @@ begin
     # Add a explanation of this file.
     c.comment = "This is an example Container file!"
   end
-rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
+rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
   puts err.to_s
   exit 1
 end

data/examples/verify-zip-container

@@ -45,7 +45,7 @@ container_file = ARGV[0]
 
 begin
   ZipContainer::Container.verify!(container_file)
-rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
+rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
   puts err.to_s
   exit 1
 end

data/examples/zip-container-info

@@ -45,7 +45,7 @@ container_file = ARGV[0]
 
 begin
   container = ZipContainer::Container.open(container_file)
-rescue ZipContainer::MalformedContainerError, Zip::ZipError => err
+rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
   puts err.to_s
   exit 1
 end

data/lib/zip-container.rb

@@ -35,6 +35,7 @@ require 'bundler/setup'
 
 require 'zip/filesystem'
 
+require 'zip-container/util'
 require 'zip-container/version'
 require 'zip-container/exceptions'
 require 'zip-container/entries/reserved'
@@ -42,7 +43,7 @@ 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'
 
 # 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/entries/directory.rb

@@ -44,15 +44,25 @@ module ZipContainer
     include ManagedEntries
 
     # :call-seq:
-    #   new(name, required = false) -> ManagedDirectory
+    #   new(name, options = {}) -> ManagedDirectory
     #
-    # Create a new ManagedDirectory with the supplied name and whether it is
-    # required to exist or not. Any ManagedFile or ManagedDirectory objects
-    # that are within this directory can also be given if required.
-    def initialize(name, required = false, entries = [])
-      super(name, required)
+    # Create a new ManagedDirectory with the supplied name. Options that can
+    # be passed in are:
+    # * <tt>:required</tt> whether it is required to exist or not (default
+    #   false).
+    # * <tt>:hidden</tt> whether it is hidden for normal operations.
+    # * <tt>:entries</tt> a list of ManagedFile and ManagedDirectory objects
+    #   that are within this directory (default []).
+    def initialize(name, options = {})
+      options = {
+        :required => false,
+        :hidden => false,
+        :entries => []
+      }.merge(options)
 
-      initialize_managed_entries(entries)
+      super(name, options[:required], options[:hidden])
+
+      initialize_managed_entries(options[:entries])
     end
 
     # :call-seq:

data/lib/zip-container/entries/entry.rb

@@ -36,6 +36,7 @@ module ZipContainer
   # ManagedEntry is the superclass of ManagedDirectory and ManagedFile. It
   # should not be used directly but may be subclassed if necessary.
   class ManagedEntry
+    include Util
 
     # The name of the ManagedEntry. For the full path name of this entry use
     # full_name.
@@ -45,11 +46,13 @@ module ZipContainer
     #   new(name, required) -> ManagedEntry
     #
     # Create a new ManagedEntry with the supplied name. The entry should also
-    # be marked as required or not.
-    def initialize(name, required)
+    # be marked as required or not and whether it is hidden for normal
+    # operations.
+    def initialize(name, required, hidden)
       @parent = nil
       @name = name
       @required = required
+      @hidden = hidden
     end
 
     # :call-seq:
@@ -57,7 +60,7 @@ module ZipContainer
     #
     # The fully qualified name of this ManagedEntry.
     def full_name
-      @parent.is_a?(Container) ? @name : "#{@parent.name}/#{@name}"
+      @parent.is_a?(ZipContainer::File) ? @name : "#{@parent.full_name}/#{@name}"
     end
 
     # :call-seq:
@@ -69,6 +72,15 @@ module ZipContainer
       @required
     end
 
+    # :call-seq:
+    #   hidden? -> true or false
+    #
+    # Is this ManagedEntry hidden for normal operations?
+    def hidden?
+      # An entry is hidden if its parent is hidden.
+      @parent.is_a?(ZipContainer::File) ? @hidden : @hidden || @parent.hidden?
+    end
+
     # :call-seq:
     #   exists? -> true or false
     #
@@ -128,7 +140,7 @@ module ZipContainer
     #
     # Return the Container that this ManagedEntry resides in.
     def container
-      @parent.is_a?(Container) ? @parent : @parent.container
+      @parent.is_a?(ZipContainer::File) ? @parent : @parent.container
     end
 
   end

data/lib/zip-container/entries/file.rb

@@ -39,12 +39,15 @@ module ZipContainer
     # :call-seq:
     #   new(name, required = false, validation_proc = nil) -> ManagedFile
     #
-    # Create a new ManagedFile with the supplied name and whether it is
-    # required to exist or not.
-    #
-    # If supplied <tt>validation_proc</tt> should be a Proc that takes a
-    # single parameter and returns +true+ or +false+ depending on whether the
-    # contents of the file were validated or not.
+    # Create a new ManagedFile with the supplied name. Options that can
+    # be passed in are:
+    # * <tt>:required</tt> whether it is required to exist or not (default
+    #   false).
+    # * <tt>:hidden</tt> whether it is hidden for normal operations.
+    # * <tt>:validation_proc</tt> should be a Proc that takes a single
+    #   parameter, to which will be supplied the contents of the file, and
+    #   returns +true+ or +false+ depending on whether the contents of the
+    #   file were validated or not (default nil).
     #
     # For more complex content validation subclasses may override the validate
     # method.
@@ -54,11 +57,19 @@ module ZipContainer
     # word "Boo!".
     #
     #  valid = Proc.new { |contents| contents == "Boo!" }
-    #  ManagedFile.new("Surprize.txt", false, valid)
-    def initialize(name, required = false, validation_proc = nil)
-      super(name, required)
+    #  ManagedFile.new("Surprize.txt", :required => false,
+    #    :validation_proc => valid)
+    def initialize(name, options = {})
+      options = {
+        :required => false,
+        :hidden => false,
+        :validation_proc => nil
+      }.merge(options)
+
+      super(name, options[:required], options[:hidden])
 
-      @validation_proc = validation_proc.is_a?(Proc) ? validation_proc : nil
+      @validation_proc =
+        options[:validation_proc].is_a?(Proc) ? options[:validation_proc] : nil
     end
 
     # :call-seq:

data/lib/zip-container/entries/managed.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.
 #
@@ -39,13 +39,18 @@ module ZipContainer
   # +initialize_managed_entries+ in your constructor to ensure that the
   # internal lists of managed entries are correctly assigned.
   module ManagedEntries
+    include Util
 
     # :call-seq:
     #   managed_directories -> Array
     #
     # Return the list of managed directories.
     def managed_directories
-      @directories.values
+      return @managed_directories if @managed_directories
+
+      dirs = @directories.values
+      @managed_directories = dirs +
+        dirs.map { |d| d.managed_directories }.flatten
     end
 
     # :call-seq:
@@ -53,7 +58,7 @@ module ZipContainer
     #
     # Return the list of managed directory names.
     def managed_directory_names
-      expand_names(@directories.keys)
+      @managed_directory_names ||= managed_directories.map { |d| d.full_name }
     end
 
     # :call-seq:
@@ -69,7 +74,7 @@ module ZipContainer
     #
     # Return the list of managed files and directories.
     def managed_entries
-      managed_files + managed_directories
+      @managed_entries ||= managed_files + managed_directories
     end
 
     # :call-seq:
@@ -77,7 +82,7 @@ module ZipContainer
     #
     # Return the list of managed file and directory names.
     def managed_entry_names
-      managed_file_names + managed_directory_names
+      @managed_entry_names ||= managed_file_names + managed_directory_names
     end
 
     # :call-seq:
@@ -85,8 +90,7 @@ module ZipContainer
     #
     # Is the supplied entry/name a managed entry?
     def managed_entry?(entry, list = managed_entry_names)
-      name = entry.kind_of?(::Zip::Entry) ? entry.name : entry
-      name.chop! if name.end_with? "/"
+      name = entry_name(entry)
       list.map { |n| n.downcase }.include? name.downcase
     end
 
@@ -98,12 +102,39 @@ module ZipContainer
       managed_entry?(entry, managed_file_names)
     end
 
+    # :call-seq:
+    #   hidden_directory?(entry) -> boolean
+    #
+    # Is the supplied entry/name a hidden directory?
+    def hidden_directory?(entry)
+      name = entry_name(entry)
+      managed_directory?(name) ? all_managed_entries[name].hidden? : false
+    end
+
+    # :call-seq:
+    #   hidden_file?(entry) -> boolean
+    #
+    # Is the supplied entry/name a hidden file?
+    def hidden_file?(entry)
+      name = entry_name(entry)
+      managed_file?(name) ? all_managed_entries[name].hidden? : false
+    end
+
+    # :call-seq:
+    #   hidden_entry?(entry) -> boolean
+    #
+    # Is the supplied entry/name a hidden?
+    def hidden_entry?(entry)
+      hidden_directory?(entry) || hidden_file?(entry)
+    end
+
     # :call-seq:
     #   managed_files -> Array
     #
     # Return the list of managed files.
     def managed_files
-      @files.values + managed_directories.map { |d| d.managed_files }.flatten
+      @managed_files ||= @files.values +
+        @directories.values.map { |d| d.managed_files }.flatten
     end
 
     # :call-seq:
@@ -111,8 +142,7 @@ module ZipContainer
     #
     # Return the list of managed file names.
     def managed_file_names
-      expand_names(@files.keys) +
-        managed_directories.map { |d| d.managed_file_names }.flatten
+      @managed_file_names ||= managed_files.map { |f| f.full_name }
     end
 
     # :call-seq:
@@ -172,11 +202,15 @@ module ZipContainer
       @files[entry.name] = entry if entry.is_a? ManagedFile
     end
 
-    private
+    # :stopdoc:
+    def all_managed_entries
+      return @entries unless @entries.nil?
 
-    def expand_names(names)
-      names.map { |n| self.is_a?(Container) ? n : "#{name}/#{n}" }
+      all = {}
+      managed_entries.each { |e| all[e.full_name] = e }
+      @entries = all
     end
+    # :startdoc:
 
   end
 end

data/lib/zip-container/entries/reserved.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.
 #
@@ -35,6 +35,7 @@ module ZipContainer
 
   # This module provides support for reserved names.
   module ReservedNames
+    include Util
 
     # :call-seq:
     #   reserved_names -> Array
@@ -68,8 +69,7 @@ module ZipContainer
     # Is the given entry in the reserved list of names? A String or a
     # Zip::Entry object can be passed in here.
     def reserved_entry?(entry)
-      name = entry.kind_of?(::Zip::Entry) ? entry.name : entry
-      name.chop! if name.end_with? "/"
+      name = entry_name(entry)
       reserved_names.map { |n| n.downcase }.include? name.downcase
     end
 

data/lib/zip-container/exceptions.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.
 #
@@ -33,12 +33,17 @@
 #
 module ZipContainer
 
-  # The base class of all other exceptions raised by this library.
-  class ContainerError < RuntimeError
+  # The base of all exceptions raised by this library.
+  module ContainerError
   end
 
+  # Shadow Zip::Error so the rubyzip API doesn't leak out.
+  ZipError = ::Zip::Error
+  ZipError.send(:include, ContainerError)
+
   # This exception is raised when a bad Container is detected.
-  class MalformedContainerError < ContainerError
+  class MalformedContainerError < RuntimeError
+    include ContainerError
 
     # :call-seq:
     #   new(reason = "")
@@ -56,7 +61,8 @@ module ZipContainer
 
   # This exception is raised when a clash occurs with a reserved or managed
   # name.
-  class ReservedNameClashError < ContainerError
+  class ReservedNameClashError < RuntimeError
+    include ContainerError
 
     # :call-seq:
     #   new(name)