zip-container 3.0.2 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4e7102a2cca8e5b0fd4ea9b7ae9a5f11115d918a
-  data.tar.gz: c1b9b91071dad1589bfb2dafba598e9a1ab11567
+SHA256:
+  metadata.gz: 40f261a3985bb13d5eef74340722d167ce5b2addcd0754756ddb00f120bf817e
+  data.tar.gz: 027d0a9ec9fe5372be16f3a4e1016625c5bb1e471d3951e7906707eba44c0cbf
 SHA512:
-  metadata.gz: db8900129dca6d58d515f68632c19f84fb240041ae31c0e730443ff6d1e6398abeb81aca19abfbf404da6ac3e2905ccef46a72b91e38436b44569df3ebbfc0c0
-  data.tar.gz: d03bcd00ebc54e52f2aa4646e4e000b9c02d4dd647d37919de624192ee189403969cd108cbebf5035a4694cdeee2b58cff9a0874a488b92305284021a32e29bf
+  metadata.gz: 63b164f87290014a514377e2be895ef1c00e8154a668ec977b88a19b1d353046bb39cb6e7d34709107da8a3846e1caf92a787b2ebb8d15c454ddc152c0ad8924
+  data.tar.gz: 05450730a60b22f18759a457d942de14c8d8fd571b048e47843beb14a02e075c4db083bd779ee7e6cc4130069ef83f6a54c3ea3d6b09b2172df5f88150ffd2c7

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-2015 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/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

@@ -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,7 +48,7 @@ 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)
@@ -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?
@@ -147,13 +148,10 @@ module ZipContainer
     # This method raises a MalformedContainerError if there are any problems
     # with the container.
     def verify!
-      unless @mimetype_error.nil?
-        raise MalformedContainerError.new(@mimetype_error)
-      end
+      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

@@ -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])
@@ -80,6 +81,5 @@ module ZipContainer
 
       messages
     end
-
   end
 end

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,21 +100,13 @@ 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
-    end
-    # :startdoc:
-
     # :call-seq:
     #   verify -> Array
     #
@@ -111,7 +116,7 @@ module ZipContainer
     # Subclasses should override this method if they require more complex
     # verification to be done.
     def verify
-      unless !@required || exists?
+      if @required && !exists?
         ["Entry '#{full_name}' is required but missing."]
       else
         []
@@ -135,7 +140,7 @@ module ZipContainer
     # fails.
     def verify!
       messages = verify
-      raise MalformedContainerError.new(messages) unless messages.empty?
+      raise MalformedContainerError, messages unless messages.empty?
     end
 
     protected
@@ -147,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

@@ -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])
@@ -83,8 +83,10 @@ module ZipContainer
     def verify
       messages = super
 
-      unless (exists? ? validate : true)
-        messages << "The contents of file '#{full_name}' do not pass validation."
+      valid = exists? ? validate : true
+      unless valid
+        messages <<
+          "The contents of file '#{full_name}' do not pass validation."
       end
 
       messages
@@ -110,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,7 +142,7 @@ 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:
@@ -171,7 +171,7 @@ module ZipContainer
     # exist and validate, if required.
     def verify_managed_entries!
       messages = verify_managed_entries
-      raise MalformedContainerError.new(messages) unless messages.empty?
+      raise MalformedContainerError, messages unless messages.empty?
     end
 
     protected
@@ -205,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