zip-container 2.2.0 → 4.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NmZhNWQzYmVkZGVjNDczNTNjN2M3M2Q2ZmJjYmI5YTEzMDYwZTE0Nw==
-  data.tar.gz: !binary |-
-    Mzg5YjU5ZjYyYjMzOGUyZWU1ZTk5NjI4YWRmNTQwNTk1NTU1OGJmZQ==
+SHA256:
+  metadata.gz: 840b4e7e6338a773a393a94e42f87c7bff876ab520e0361e3378ac11fd8e4741
+  data.tar.gz: c441f69cb0988145551c09f837dc0d9a287c55452b1737ec4a43bf3740939ce8
 SHA512:
-  metadata.gz: !binary |-
-    N2NjNjI1ZmJhNTQ5NzdiMGU3MjgxZTEwNjM5Zjk5NDgyMGYxYzRjZmYwMmNm
-    ODg2M2ZmZTllNjU2YjNmMWU2ZGQzOTlhYTE3ODAzNzI3NjY2YmRiY2JiYjg2
-    MjZkN2E5NTljMmIzYjIyNTcyZTE4ZDg3OGY4M2Q1NzkxOGJhZjc=
-  data.tar.gz: !binary |-
-    NzNhYjc1YmQ5MTg5YWU1ZDNlN2U0MDlkMDYxNDgxNDYxOTA2YWM5MzI2Njgz
-    MmRjOTkyNWM1NWMzZmE5ZDA1ZTBiNGJhMzRhNWZkMGU5MWEwMDBjNjcxNzUx
-    NDU2ZGMwNGEyNjBkYjFkM2Q3MzMwMzAzMzcyYjMyZTEwZjcyNjA=
+  metadata.gz: ebe9848aaa420c00e28ed4223d43ca1e186b1905ac6e3102b1ee7661f8edee5e07a68960577651d5206aa98530ea253590e9b25618b2f0aca2655bac98954b23
+  data.tar.gz: fec65830abe5391d805cfa2c3a417cfcc52cb47f1c99e5affebfb91b6262d3cd3292a39f4af5eea689cee4f4ff91568db0a797ee7dd706874e011b1e7798b297

data/Changes.rdoc

@@ -1,5 +1,27 @@
 = Changes log for the ZIP Container Ruby Gem
 
+== Version 3.0.2
+
+* Update rubyzip dependency to fix security vulnerability.
+
+== Version 3.0.1
+
+* Fix deep content verification bug.
+
+== Version 3.0.0
+
+* Refactor the malformed container error constructor.
+* Verifying entries only raises errors at the last moment.
+* Redesign the verification system.
+* Update badges to use SVG versions.
+* Fix the documentation for updated verify methods.
+* Fix Container#verify so that it returns consistent types.
+* Rename ContainerError -> Error.
+* Reword the exceptions so they don't specify "file".
+* Add ruby 2.2.0 to the Travis test matrix.
+* Add a compatibility note about ContainerError.
+* Improve the Usage information in the ReadMe.
+
 == Version 2.2.0
 
 * Fix pathname bug in ZipContainer::Dir.

data/Gemfile

@@ -30,6 +30,6 @@
 #
 # Author: Robert Haines
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/Licence.rdoc

@@ -1,4 +1,4 @@
-Copyright (c) 2013, 2014 The University of Manchester, UK.
+Copyright (c) 2013-2018 The University of Manchester, UK.
 
 All rights reserved.
 

data/Rakefile

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2018 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,24 +30,27 @@
 #
 # Author: Robert Haines
 
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rdoc/task"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rubocop/rake_task'
 
-task :default => [:test]
+task default: :test
 
 Rake::TestTask.new do |t|
-  t.libs << "test"
+  t.libs << 'test'
   t.test_files = FileList['test/ts_container.rb']
   t.verbose = true
 end
 
 RDoc::Task.new do |r|
-  r.main = "ReadMe.rdoc"
-  lib = Dir.glob("lib/**/*.rb")
-  r.rdoc_files.include("ReadMe.rdoc", "Licence.rdoc", "Changes.rdoc", lib)
-  r.options << "-t ZIP Container Format Ruby Library version " +
+  r.main = 'ReadMe.rdoc'
+  lib = Dir.glob('lib/**/*.rb')
+  r.rdoc_files.include('ReadMe.rdoc', 'Licence.rdoc', 'Changes.rdoc', lib)
+  r.options << '-t ZIP Container Format Ruby Library version ' \
     "#{ZipContainer::Version::STRING}"
-  r.options << "-N"
-  r.options << "--tab-width=2"
+  r.options << '-N'
+  r.options << '--tab-width=2'
 end
+
+RuboCop::RakeTask.new

data/ReadMe.rdoc

@@ -5,12 +5,12 @@ Contact::     mailto:support@mygrid.org.uk
 Homepage::    http://mygrid.github.io/ruby-zip-container
 Source code:: https://github.com/myGrid/ruby-zip-container
 Licence::     BSD (See Licence file or http://www.opensource.org/licenses/bsd-license.php)
-Copyright::   (c) 2013, 2014 The University of Manchester, UK
+Copyright::   (c) 2013-2015 The University of Manchester, UK
 
-{<img src="https://badge.fury.io/rb/zip-container.png" alt="Gem Version" />}[http://badge.fury.io/rb/zip-container]
-{<img src="https://codeclimate.com/github/myGrid/ruby-zip-container.png" />}[https://codeclimate.com/github/myGrid/ruby-zip-container]
+{<img src="https://badge.fury.io/rb/zip-container.svg" alt="Gem Version" />}[http://badge.fury.io/rb/zip-container]
+{<img src="https://codeclimate.com/github/myGrid/ruby-zip-container.svg" />}[https://codeclimate.com/github/myGrid/ruby-zip-container]
 {<img src="https://travis-ci.org/myGrid/ruby-zip-container.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/myGrid/ruby-zip-container]
-{<img src="https://coveralls.io/repos/myGrid/ruby-zip-container/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myGrid/ruby-zip-container?branch=master]
+{<img src="https://coveralls.io/repos/myGrid/ruby-zip-container/badge.svg?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myGrid/ruby-zip-container?branch=master]
 
 == Synopsis
 
@@ -36,6 +36,11 @@ underlying rubyzip API (Zip::File) and allows this library to work with
 ZipContainer::Container should not be used directly from version 2.0.0
 onwards.
 
+=== ContainerError
+
+This class has been renamed in version 3.0.0. It is now simply called Error so
+that its fully qualified name is the more sensible ZipContainer::Error.
+
 === Rubyzip
 
 Version 1.0.0 and up of this gem uses version 1.0.0 and up of the
@@ -46,10 +51,17 @@ in the rubyzip readme for a workaround.
 
 == Usage
 
-This library largely mimics the rubyzip Zip::File API so much of what you can
-do with that is supported for ZIP Containers. There is also
-{API documentation}[http://mygrid.github.io/ruby-zip-container/] with much more
-detail and any differences explained.
+This library has two entry points.
+
+The main ZipContainer::File class largely mimics the rubyzip
+{Zip::File}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/File] and
+{Zip::FileSystem}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/FileSystem]
+APIs so much of what you can do with them are supported for ZIP Containers.
+There is also {API documentation}[http://mygrid.github.io/ruby-zip-container/]
+with much more detail and any differences explained.
+
+The ZipContainer::Dir class mimics, where possible, the core ruby
+{Dir API}[http://ruby-doc.org/core-1.9.3/Dir.html].
 
 There are some examples of how to use the library provided in the examples
 directory. See the contents of the tests directory for even more.

data/examples/create-zip-container

@@ -43,27 +43,26 @@ usage unless ARGV.length == 1
 
 container_file = ARGV[0]
 
-if File.exists?(container_file)
+if File.exist?(container_file)
   puts "File '#{container_file}' already exists. Exiting."
   exit 1
 end
 
 begin
-  ZipContainer::File.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|
-      f.puts "Hello, World!"
+    c.file.open('greeting.txt', 'w') do |f|
+      f.puts 'Hello, World!'
     end
 
     # Create a subdirectory.
-    c.dir.mkdir("dir")
+    c.dir.mkdir('dir')
 
     # Copy this example code in straight from a file.
-    c.add("dir/code.rb", __FILE__)
+    c.add('dir/code.rb', __FILE__)
 
     # Add a explanation of this file.
-    c.comment = "This is an example Container file!"
+    c.comment = 'This is an example Container file!'
   end
 rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
   puts err.to_s

data/examples/zip-container-info

@@ -50,7 +50,7 @@ rescue ZipContainer::MalformedContainerError, ZipContainer::ZipError => err
   exit 1
 end
 
-puts "Archive: #{container.to_s}"
+puts "Archive: #{container}"
 puts "Container file size: #{File.size(container_file)} bytes, "\
   "number of entries: #{container.size}"
 
@@ -60,11 +60,11 @@ total_comp = 0
 container.each do |entry|
   total_size += entry.size
   total_comp += entry.compressed_size
-  comp = entry.compression_method == 0 ? "stor" : "defN"
+  comp = entry.compression_method.zero? ? 'stor' : 'defN'
   size = entry.size.to_s.rjust(8)
   puts "#{size} #{comp} #{entry.time} #{entry.name}"
 end
 
 ratio = ((total_size - total_comp) / total_size.to_f) * 100
-puts "%d files, %d bytes uncompressed, %d bytes compressed: %.1f%%" %
-  [container.size, total_size, total_comp, ratio]
+puts "#{container.size} files, #{total_size} bytes uncompressed, "\
+  "#{total_comp} bytes compressed: #{ratio.round(1)}%"

data/lib/zip-container/container.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014 The University of Manchester, UK.
+# Copyright (c) 2014, 2015 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,13 +30,14 @@
 #
 # 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
 
@@ -47,13 +48,13 @@ module ZipContainer
 
     # :stopdoc:
     # The reserved mimetype file name for standard ZipContainers.
-    MIMETYPE_FILE = "mimetype"
+    MIMETYPE_FILE = 'mimetype'.freeze
 
     def initialize(location)
       @container = open_container(location)
 
-      check_mimetype!
-      @mimetype = read_mimetype
+      @mimetype_error = verify_mimetype
+      @mimetype = read_mimetype if @mimetype_error.nil?
 
       # Reserved entry names. Just the mimetype file by default.
       register_reserved_name(MIMETYPE_FILE)
@@ -69,7 +70,7 @@ module ZipContainer
     #
     # Open an existing ZipContainer. It will be checked for conformance upon
     # first access.
-    def self.open(filename, &block)
+    def self.open(filename)
       c = new(filename)
 
       if block_given?
@@ -84,19 +85,26 @@ module ZipContainer
     end
 
     # :call-seq:
-    #   verify(filename) -> boolean
+    #   verify(filename) -> Array
     #
     # 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).
+    # This method returns a list of problems with the container.
+    #
+    # Exceptions are still raised for fundamental file system errors.
     def self.verify(filename)
-      begin
-        new(filename).verify!
-      rescue
-        return false
-      end
+      new(filename).verify
+    end
 
-      true
+    # :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.
+    #
+    # Exceptions are still raised for fundamental file system errors.
+    def self.verify?(filename)
+      new(filename).verify?
     end
 
     # :call-seq:
@@ -111,21 +119,39 @@ module ZipContainer
     end
 
     # :call-seq:
-    #   verify!
+    #   verify -> Array
     #
     # 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!
+    def verify
+      @mimetype_error.nil? ? verify_managed_entries : [@mimetype_error]
     end
 
-    private
-
-    def check_mimetype!
-      message = verify_mimetype
-      raise MalformedContainerError.new(message) unless message.nil?
+    # :call-seq:
+    #   verify? -> true or false
+    #
+    # Verify the contents of this ZipContainer file. All managed files and
+    # directories are checked to make sure that they exist, if required.
+    #
+    # This method returns +false+ if there are any problems at all with the
+    # container.
+    def verify?
+      verify.empty? ? true : false
     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.
+    #
+    # This method raises a MalformedContainerError if there are any problems
+    # with the container.
+    def verify!
+      raise MalformedContainerError, @mimetype_error unless @mimetype_error.nil?
+
+      verify_managed_entries!
+    end
   end
 
 end

data/lib/zip-container/dir.rb

@@ -49,7 +49,7 @@ module ZipContainer
 
     extend Forwardable
     def_delegators :@container, :close, :each, :path, :pos, :pos=, :rewind,
-      :seek, :tell
+                   :seek, :tell
 
     private_class_method :new
 
@@ -65,7 +65,7 @@ module ZipContainer
     #
     # Create a new (or convert an existing) directory as a ZipContainer with
     # the specified mimetype.
-    def self.create(pathname, mimetype, &block)
+    def self.create(pathname, mimetype)
       ::Dir.mkdir(pathname) unless ::File.directory?(pathname)
       ::File.write(::File.join(pathname, MIMETYPE_FILE), mimetype)
 
@@ -108,7 +108,8 @@ module ZipContainer
       Entries.new(@container)
     end
 
-    class Entries
+    class Entries # :nodoc:
+
       include Enumerable
 
       Entry = Struct.new(:name, :ftype)
@@ -122,7 +123,7 @@ module ZipContainer
         end
       end
 
-      def each(&block)
+      def each
         @entries.each do |entry|
           yield entry
         end
@@ -145,12 +146,9 @@ module ZipContainer
 
     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
+      return "'mimetype' file is missing." unless ::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)
     end
 
     def read_mimetype
@@ -225,7 +223,6 @@ module ZipContainer
     #
     # Equal to
     # {::Dir.tell}[http://ruby-doc.org/core-1.9.3/Dir.html#method-i-tell]
-
   end
 
 end

data/lib/zip-container/entries/directory.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 ManagedDirectory acts as the interface to a set of (possibly) managed
@@ -40,6 +40,7 @@ module ZipContainer
   # Once a ManagedDirectory is registered in a Container then only it can be
   # used to write to its contents.
   class ManagedDirectory < ManagedEntry
+
     include ReservedNames
     include ManagedEntries
 
@@ -55,9 +56,9 @@ module ZipContainer
     #   that are within this directory (default []).
     def initialize(name, options = {})
       options = {
-        :required => false,
-        :hidden => false,
-        :entries => []
+        required: false,
+        hidden: false,
+        entries: []
       }.merge(options)
 
       super(name, options[:required], options[:hidden])
@@ -66,16 +67,19 @@ module ZipContainer
     end
 
     # :call-seq:
-    #   verify!
+    #   verify -> Array
     #
     # Verify this ManagedDirectory for correctness. ManagedFiles registered
     # within it are verified recursively.
     #
-    # A MalformedContainerError is raised if it does not pass verification.
-    def verify!
-      super
-      @files.values.each { |f| f.verify! }
-    end
+    # 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
 
+      @files.values.each { |f| messages += f.verify }
+
+      messages
+    end
   end
 end