zip-container 2.2.0 → 4.0.2

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

@@ -30,18 +30,23 @@
 #
 # Author: Robert Haines
 
-#
+##
 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.
     attr_reader :name
 
+    # Allows the object in which this entry has been registered to tell it
+    # who it is.
+    attr_writer :parent # :nodoc:
+
     # :call-seq:
     #   new(name, required) -> ManagedEntry
     #
@@ -60,7 +65,11 @@ module ZipContainer
     #
     # The fully qualified name of this ManagedEntry.
     def full_name
-      @parent.is_a?(ZipContainer::Container) ? @name : "#{@parent.full_name}/#{@name}"
+      if @parent.is_a?(ZipContainer::Container)
+        @name
+      else
+        "#{@parent.full_name}/#{@name}"
+      end
     end
 
     # :call-seq:
@@ -78,7 +87,11 @@ module ZipContainer
     # Is this ManagedEntry hidden for normal operations?
     def hidden?
       # An entry is hidden if its parent is hidden.
-      @parent.is_a?(ZipContainer::Container) ? @hidden : @hidden || @parent.hidden?
+      if @parent.is_a?(ZipContainer::Container)
+        @hidden
+      else
+        @hidden || @parent.hidden?
+      end
     end
 
     # :call-seq:
@@ -87,54 +100,51 @@ module ZipContainer
     # Does this ManagedEntry exist in the Container?
     def exists?
       container.entries.each do |entry|
-        test = (entry.ftype == :directory) ? "#{full_name}/" : full_name
+        test = entry.ftype == :directory ? "#{full_name}/" : full_name
         return true if entry.name == test
       end
 
       false
     end
 
-    # :stopdoc:
-    # Allows the object in which this entry has been registered in to tell it
-    # who it is.
-    def parent=(parent)
-      @parent = parent
+    # :call-seq:
+    #   verify -> Array
+    #
+    # Verify this ManagedEntry returning a list of reasons why it fails if it
+    # does so. The empty list is returned if verification passes.
+    #
+    # Subclasses should override this method if they require more complex
+    # verification to be done.
+    def verify
+      if @required && !exists?
+        ["Entry '#{full_name}' is required but missing."]
+      else
+        []
+      end
     end
-    # :startdoc:
 
     # :call-seq:
-    #   verify -> true or false
+    #   verify? -> true or false
     #
     # Verify this ManagedEntry by checking that it exists if it is required
     # according to its Container specification and validating its contents if
     # necessary.
-    def verify
-      begin
-        verify!
-      rescue
-        return false
-      end
-
-      true
+    def verify?
+      verify.empty?
     end
 
-    protected
-
     # :call-seq:
     #   verify!
     #
     # Verify this ManagedEntry raising a MalformedContainerError if it
     # fails.
-    #
-    # Subclasses should override this method if they require more complex
-    # verification to be done.
     def verify!
-      unless !@required || exists?
-        raise MalformedContainerError.new("Entry '#{full_name}' is required "\
-          "but missing.")
-      end
+      messages = verify
+      raise MalformedContainerError, messages unless messages.empty?
     end
 
+    protected
+
     # :call-seq:
     #   container -> Container
     #
@@ -142,6 +152,5 @@ module ZipContainer
     def container
       @parent.is_a?(ZipContainer::Container) ? @parent : @parent.container
     end
-
   end
 end

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

@@ -1,4 +1,4 @@
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,7 +30,7 @@
 #
 # Author: Robert Haines
 
-#
+##
 module ZipContainer
 
   # A ManagedFile is used to reserve a filename in a Container namespace.
@@ -57,13 +57,13 @@ module ZipContainer
     # word "Boo!".
     #
     #  valid = Proc.new { |contents| contents == "Boo!" }
-    #  ManagedFile.new("Surprize.txt", :required => false,
-    #    :validation_proc => valid)
+    #  ManagedFile.new("Surprize.txt", required: false,
+    #    validation_proc: valid)
     def initialize(name, options = {})
       options = {
-        :required => false,
-        :hidden => false,
-        :validation_proc => nil
+        required: false,
+        hidden: false,
+        validation_proc: nil
       }.merge(options)
 
       super(name, options[:required], options[:hidden])
@@ -73,18 +73,23 @@ module ZipContainer
     end
 
     # :call-seq:
-    #   verify!
+    #   verify -> Array
     #
     # Verify this ManagedFile for correctness. The contents are validated if
     # required.
     #
-    # A MalformedContainerError is raised if it does not pass verification.
-    def verify!
-      super
-      unless (exists? ? validate : true)
-        raise MalformedContainerError.new("The contents of file "\
-          "'#{full_name}' do not pass validation.")
+    # If it does not pass verification a list of reasons why it fails is
+    # returned. The empty list is returned if verification passes.
+    def verify
+      messages = super
+
+      valid = exists? ? validate : true
+      unless valid
+        messages <<
+          "The contents of file '#{full_name}' do not pass validation."
       end
+
+      messages
     end
 
     protected
@@ -107,6 +112,5 @@ module ZipContainer
     def contents
       container.read(full_name)
     end
-
   end
 end

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

@@ -30,7 +30,7 @@
 #
 # Author: Robert Haines
 
-#
+##
 module ZipContainer
 
   # This module provides support for managed file and directory entries.
@@ -49,8 +49,7 @@ module ZipContainer
       return @managed_directories if @managed_directories
 
       dirs = @directories.values
-      @managed_directories = dirs +
-        dirs.map { |d| d.managed_directories }.flatten
+      @managed_directories = dirs + dirs.map(&:managed_directories).flatten
     end
 
     # :call-seq:
@@ -58,7 +57,7 @@ module ZipContainer
     #
     # Return the list of managed directory names.
     def managed_directory_names
-      @managed_directory_names ||= managed_directories.map { |d| d.full_name }
+      @managed_directory_names ||= managed_directories.map(&:full_name)
     end
 
     # :call-seq:
@@ -91,7 +90,7 @@ module ZipContainer
     # Is the supplied entry/name a managed entry?
     def managed_entry?(entry, list = managed_entry_names)
       name = entry_name(entry)
-      list.map { |n| n.downcase }.include? name.downcase
+      list.map(&:downcase).include? name.downcase
     end
 
     # :call-seq:
@@ -133,8 +132,9 @@ module ZipContainer
     #
     # Return the list of managed files.
     def managed_files
-      @managed_files ||= @files.values +
-        @directories.values.map { |d| d.managed_files }.flatten
+      @managed_files ||=
+        @files.values +
+        @directories.values.map(&:managed_files).flatten
     end
 
     # :call-seq:
@@ -142,24 +142,36 @@ module ZipContainer
     #
     # Return the list of managed file names.
     def managed_file_names
-      @managed_file_names ||= managed_files.map { |f| f.full_name }
+      @managed_file_names ||= managed_files.map(&:full_name)
     end
 
     # :call-seq:
-    #   verify_managed_entries!
+    #   verify_managed_entries -> Array
     #
     # All managed files and directories are checked to make sure that they
-    # exist, if required.
-    def verify_managed_entries!
+    # exist and validate, if required.
+    def verify_managed_entries
+      messages = []
+
       @directories.each_value do |dir|
-        dir.verify!
+        messages += dir.verify
       end
 
       @files.each_value do |file|
-        file.verify!
+        messages += file.verify
       end
 
-      true
+      messages
+    end
+
+    # :call-seq:
+    #   verify_managed_entries!
+    #
+    # All managed files and directories are checked to make sure that they
+    # exist and validate, if required.
+    def verify_managed_entries!
+      messages = verify_managed_entries
+      raise MalformedContainerError, messages unless messages.empty?
     end
 
     protected
@@ -193,8 +205,8 @@ module ZipContainer
     # managed files within it.
     def register_managed_entry(entry)
       unless entry.is_a?(ManagedDirectory) || entry.is_a?(ManagedFile)
-        raise ArgumentError.new("The supplied entry must be of type "\
-          "ManagedDirectory or ManagedFile or a subclass of either.")
+        raise ArgumentError, 'The supplied entry must be of type '\
+          'ManagedDirectory or ManagedFile or a subclass of either.'
       end
 
       entry.parent = self

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

@@ -30,7 +30,7 @@
 #
 # Author: Robert Haines
 
-#
+##
 module ZipContainer
 
   # This module provides support for reserved names.
@@ -70,7 +70,7 @@ module ZipContainer
     # Zip::Entry object can be passed in here.
     def reserved_entry?(entry)
       name = entry_name(entry)
-      reserved_names.map { |n| n.downcase }.include? name.downcase
+      reserved_names.map(&:downcase).include? name.downcase
     end
 
     protected

data/lib/zip-container/exceptions.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,31 +30,37 @@
 #
 # Author: Robert Haines
 
-#
+##
 module ZipContainer
 
   # The base of all exceptions raised by this library.
-  module ContainerError
+  module Error
   end
 
   # Shadow Zip::Error so the rubyzip API doesn't leak out.
   ZipError = ::Zip::Error
-  ZipError.send(:include, ContainerError)
+  ZipError.send(:include, Error)
 
   # This exception is raised when a bad Container is detected.
   class MalformedContainerError < RuntimeError
-    include ContainerError
+
+    include Error
 
     # :call-seq:
-    #   new(reason = "")
+    #   new
+    #   new(reason)
+    #   new(reason_list)
     #
-    # Create a new MalformedContainerError with an optional reason for why
-    # the Container file is malformed.
+    # Create a new MalformedContainerError with an optional reason or list of
+    # reasons for why the Container is malformed.
     def initialize(reason = nil)
-      if reason.nil?
-        super("Malformed Container File.")
+      if reason.nil? || reason.empty?
+        super('Malformed Container.')
+      elsif reason.is_a?(Array)
+        reasons = reason.map { |r| " * #{r}\n" }
+        super("Malformed Container:\n#{reasons}")
       else
-        super("Malformed Container File: #{reason}")
+        super("Malformed Container: #{reason}")
       end
     end
   end
@@ -62,14 +68,15 @@ module ZipContainer
   # This exception is raised when a clash occurs with a reserved or managed
   # name.
   class ReservedNameClashError < RuntimeError
-    include ContainerError
+
+    include Error
 
     # :call-seq:
     #   new(name)
     #
     # Create a new ReservedNameClashError with the name of the clash supplied.
     def initialize(name)
-      super("'#{name}' is reserved for internal use in this ZipContainer file.")
+      super("'#{name}' is reserved for internal use in this ZipContainer.")
     end
   end
 

data/lib/zip-container/file.rb

@@ -49,7 +49,7 @@ module ZipContainer
 
     extend Forwardable
     def_delegators :@container, :comment, :comment=, :commit_required?, :each,
-      :entries, :extract, :get_input_stream, :name, :read, :size
+                   :entries, :extract, :get_input_stream, :name, :read, :size
 
     private_class_method :new
 
@@ -74,7 +74,7 @@ module ZipContainer
     #   File.create(filename, mimetype) {|container| ...}
     #
     # Create a new ZipContainer file on disk with the specified mimetype.
-    def self.create(filename, mimetype, &block)
+    def self.create(filename, mimetype)
       ::Zip::OutputStream.open(filename) do |stream|
         stream.put_next_entry(MIMETYPE_FILE, nil, nil, ::Zip::Entry::STORED)
         stream.write mimetype
@@ -127,7 +127,7 @@ module ZipContainer
     # +continue_on_exists_proc+ parameter.
     def add(entry, src_path, &continue_on_exists_proc)
       if reserved_entry?(entry) || managed_directory?(entry)
-        raise ReservedNameClashError.new(entry.to_s)
+        raise ReservedNameClashError, entry.to_s
       end
 
       @container.add(entry, src_path, &continue_on_exists_proc)
@@ -143,12 +143,10 @@ module ZipContainer
     def commit
       return false unless commit_required?
 
-      if on_disk?
-        @container.commit
-      end
+      @container.commit if on_disk?
     end
 
-    alias :close :commit
+    alias close commit
 
     # :call-seq:
     #   dir -> Zip::ZipFsDir
@@ -182,7 +180,7 @@ module ZipContainer
     # can specify <tt>:include_hidden => true</tt> to include hidden entries
     # in the search.
     def find_entry(entry_name, options = {})
-      options = {:include_hidden => false}.merge(options)
+      options = { include_hidden: false }.merge(options)
 
       unless options[:include_hidden]
         return if hidden_entry?(entry_name)
@@ -199,7 +197,7 @@ module ZipContainer
     # can specify <tt>:include_hidden => true</tt> to include hidden entries
     # in the search.
     def get_entry(entry, options = {})
-      options = {:include_hidden => false}.merge(options)
+      options = { include_hidden: false }.merge(options)
 
       unless options[:include_hidden]
         raise Errno::ENOENT, entry if hidden_entry?(entry)
@@ -220,7 +218,7 @@ module ZipContainer
     # parameter.
     def get_output_stream(entry, permission = nil, &block)
       if reserved_entry?(entry) || managed_directory?(entry)
-        raise ReservedNameClashError.new(entry.to_s)
+        raise ReservedNameClashError, entry.to_s
       end
 
       @container.get_output_stream(entry, permission, &block)
@@ -240,9 +238,9 @@ module ZipContainer
     #   <tt>::File::FNM_PATHNAME | ::File::FNM_DOTMATCH</tt>
     # * +options+ - <tt>:include_hidden => true</tt> will include hidden
     #   entries in the search.
-    def glob(pattern, *params, &block)
+    def glob(pattern, *params)
       flags = ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH
-      options = { :include_hidden => false }
+      options = { include_hidden: false }
 
       params.each do |param|
         case param
@@ -256,6 +254,7 @@ module ZipContainer
       entries.map do |entry|
         next if !options[:include_hidden] && hidden_entry?(entry)
         next unless ::File.fnmatch(pattern, entry.name.chomp('/'), flags)
+
         yield(entry) if block_given?
         entry
       end.compact
@@ -279,9 +278,9 @@ module ZipContainer
     # The new directory will be created with the supplied unix-style
     # permissions. The default (+0755+) is owner read, write and list; group
     # read and list; and world read and list.
-    def mkdir(name, permission = 0755)
+    def mkdir(name, permission = 0o0755)
       if reserved_entry?(name) || managed_file?(name)
-        raise ReservedNameClashError.new(name)
+        raise ReservedNameClashError, name
       end
 
       @container.mkdir(name, permission)
@@ -303,6 +302,7 @@ module ZipContainer
     # method will do nothing.
     def remove(entry)
       return if reserved_entry?(entry)
+
       @container.remove(entry)
     end
 
@@ -318,7 +318,7 @@ module ZipContainer
     # +continue_on_exists_proc+ parameter.
     def rename(entry, new_name, &continue_on_exists_proc)
       return if reserved_entry?(entry)
-      raise ReservedNameClashError.new(new_name) if reserved_entry?(new_name)
+      raise ReservedNameClashError, new_name if reserved_entry?(new_name)
 
       @container.rename(entry, new_name, &continue_on_exists_proc)
     end
@@ -332,6 +332,7 @@ module ZipContainer
     # nothing.
     def replace(entry, src_path)
       return if reserved_entry?(entry)
+
       @container.replace(entry, src_path)
     end
 
@@ -479,6 +480,5 @@ module ZipContainer
     #   size -> int
     #
     # Returns the number of entries in the ZipContainer file.
-
   end
 end