zip-container 4.0.1 → 5.0.0.rc1

data/lib/zip-container/file.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,10 +30,13 @@
 #
 # Author: Robert Haines
 
+require_relative 'container'
+require_relative 'errors'
+
+require 'zip/filesystem'
 require 'forwardable'
 
 module ZipContainer
-
   # This class represents a ZipContainer file in PK Zip 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]
@@ -46,7 +49,6 @@ module ZipContainer
   #
   # There are code examples available with the source code of this library.
   class File < Container
-
     extend Forwardable
     def_delegators :@container, :comment, :comment=, :commit_required?, :each,
                    :entries, :extract, :get_input_stream, :name, :read, :size
@@ -104,7 +106,7 @@ module ZipContainer
     def self.each_entry(filename, &block)
       c = new(filename)
 
-      if block_given?
+      if block
         begin
           c.each(&block)
         ensure
@@ -138,12 +140,14 @@ module ZipContainer
     #   close -> boolean
     #
     # Commits changes that have been made since the previous commit to the
-    # ZipContainer file. Returns +true+ if anything was actually done, +false+
+    # ZipContainer file. Returns +false+ if no commit was required, +true+
     # otherwise.
     def commit
       return false unless commit_required?
 
       @container.commit if on_disk?
+
+      true
     end
 
     alias close commit
@@ -182,9 +186,7 @@ module ZipContainer
     def find_entry(entry_name, options = {})
       options = { include_hidden: false }.merge(options)
 
-      unless options[:include_hidden]
-        return if hidden_entry?(entry_name)
-      end
+      return if !options[:include_hidden] && hidden_entry?(entry_name)
 
       @container.find_entry(entry_name)
     end
@@ -199,9 +201,7 @@ module ZipContainer
     def get_entry(entry, options = {})
       options = { include_hidden: false }.merge(options)
 
-      unless options[:include_hidden]
-        raise Errno::ENOENT, entry if hidden_entry?(entry)
-      end
+      raise Errno::ENOENT, entry if !options[:include_hidden] && hidden_entry?(entry)
 
       @container.get_entry(entry)
     end
@@ -238,7 +238,7 @@ 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)
+    def glob(pattern, *params) # rubocop:disable Metrics/CyclomaticComplexity
       flags = ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH
       options = { include_hidden: false }
 
@@ -251,13 +251,13 @@ module ZipContainer
         end
       end
 
-      entries.map do |entry|
+      entries.filter_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
+      end
     end
 
     # :call-seq:
@@ -279,9 +279,7 @@ module ZipContainer
     # permissions. The default (+0755+) is owner read, write and list; group
     # read and list; and world read and list.
     def mkdir(name, permission = 0o0755)
-      if reserved_entry?(name) || managed_file?(name)
-        raise ReservedNameClashError, name
-      end
+      raise ReservedNameClashError, name if reserved_entry?(name) || managed_file?(name)
 
       @container.mkdir(name, permission)
     end
@@ -353,13 +351,12 @@ module ZipContainer
     def verify_mimetype
       # Check mimetype file is present and correct.
       entry = @container.find_entry(MIMETYPE_FILE)
-
       return "'mimetype' file is missing." if entry.nil?
+
       if entry.local_header_offset != 0
-        return "'mimetype' file is not at offset 0 in the archive."
-      end
-      if entry.compression_method != ::Zip::Entry::STORED
-        return "'mimetype' file is compressed."
+        "'mimetype' file is not at offset 0 in the archive."
+      elsif entry.compression_method != ::Zip::Entry::STORED
+        "'mimetype' file is compressed."
       end
     end
 

data/lib/zip-container/{entries/directory.rb → managed_directory.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,9 +30,12 @@
 #
 # Author: Robert Haines
 
+require_relative 'managed_entries'
+require_relative 'managed_entry'
+require_relative 'reserved_names'
+
 ##
 module ZipContainer
-
   # A ManagedDirectory acts as the interface to a set of (possibly) managed
   # files within it and also reserves the directory name in the Container
   # namespace.
@@ -40,7 +43,6 @@ 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
 
@@ -77,7 +79,7 @@ module ZipContainer
     def verify
       messages = super
 
-      @files.values.each { |f| messages += f.verify }
+      @files.each_value { |f| messages += f.verify }
 
       messages
     end

data/lib/zip-container/{entries/managed.rb → managed_entries.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,23 +30,25 @@
 #
 # Author: Robert Haines
 
+require_relative 'errors'
+require_relative 'managed_entry'
+require_relative 'managed_file'
+require_relative 'util'
+
 ##
 module ZipContainer
-
   # This module provides support for managed file and directory entries.
   #
   # <b>Note!</b> If you mix this module in you *must* call
   # +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
-      return @managed_directories if @managed_directories
+      return @managed_directories if defined?(@managed_directories)
 
       dirs = @directories.values
       @managed_directories = dirs + dirs.map(&:managed_directories).flatten
@@ -89,7 +91,7 @@ module ZipContainer
     #
     # Is the supplied entry/name a managed entry?
     def managed_entry?(entry, list = managed_entry_names)
-      name = entry_name(entry)
+      name = Util.entry_name(entry)
       list.map(&:downcase).include? name.downcase
     end
 
@@ -106,7 +108,7 @@ module ZipContainer
     #
     # Is the supplied entry/name a hidden directory?
     def hidden_directory?(entry)
-      name = entry_name(entry)
+      name = Util.entry_name(entry)
       managed_directory?(name) ? all_managed_entries[name].hidden? : false
     end
 
@@ -115,7 +117,7 @@ module ZipContainer
     #
     # Is the supplied entry/name a hidden file?
     def hidden_file?(entry)
-      name = entry_name(entry)
+      name = Util.entry_name(entry)
       managed_file?(name) ? all_managed_entries[name].hidden? : false
     end
 
@@ -204,25 +206,28 @@ module ZipContainer
     # the container namespace and act as an interface to the (possibly)
     # managed files within it.
     def register_managed_entry(entry)
-      unless entry.is_a?(ManagedDirectory) || entry.is_a?(ManagedFile)
-        raise ArgumentError, 'The supplied entry must be of type '\
-          'ManagedDirectory or ManagedFile or a subclass of either.'
+      unless entry.is_a?(ManagedEntry)
+        raise ArgumentError,
+              'The supplied entry must be of type ' \
+              'ManagedDirectory or ManagedFile or a subclass of either.'
       end
 
       entry.parent = self
-      @directories[entry.name] = entry if entry.is_a? ManagedDirectory
-      @files[entry.name] = entry if entry.is_a? ManagedFile
+      if entry.is_a?(ManagedFile)
+        @files[entry.name] = entry
+      else
+        @directories[entry.name] = entry
+      end
     end
 
-    # :stopdoc:
+    private
+
     def all_managed_entries
-      return @entries unless @entries.nil?
+      return @entries if defined?(@entries) && !@entries.nil?
 
       all = {}
       managed_entries.each { |e| all[e.full_name] = e }
       @entries = all
     end
-    # :startdoc:
-
   end
 end

data/lib/zip-container/{entries/entry.rb → managed_entry.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2013 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -32,13 +32,9 @@
 
 ##
 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

data/lib/zip-container/{entries/file.rb → managed_file.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2015 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,12 +30,12 @@
 #
 # Author: Robert Haines
 
+require_relative 'managed_entry'
+
 ##
 module ZipContainer
-
   # A ManagedFile is used to reserve a filename in a Container namespace.
   class ManagedFile < ManagedEntry
-
     # :call-seq:
     #   new(name, required = false, validation_proc = nil) -> ManagedFile
     #

data/lib/zip-container/{entries/reserved.rb → reserved_names.rb}

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,13 +30,12 @@
 #
 # Author: Robert Haines
 
+require_relative 'util'
+
 ##
 module ZipContainer
-
   # This module provides support for reserved names.
   module ReservedNames
-    include Util
-
     # :call-seq:
     #   reserved_names -> Array
     #
@@ -69,7 +68,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_name(entry)
+      name = Util.entry_name(entry)
       reserved_names.map(&:downcase).include? name.downcase
     end
 

data/lib/zip-container/util.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014 The University of Manchester, UK.
+# Copyright (c) 2014-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,11 +30,14 @@
 #
 # Author: Robert Haines
 
+require 'zip' # Remove this when we update to rubyzip 3.x.
+require 'zip/entry'
+
 ##
 module ZipContainer
-
   # Utility methods useful throughout the rest of the ZipContainer library.
   module Util
+    module_function
 
     # :call-seq:
     #   entry_name(entry) -> String
@@ -48,12 +51,9 @@ module ZipContainer
     def entry_name(entry)
       name = entry.is_a?(::Zip::Entry) ? entry.name : entry
 
-      if name.respond_to?(:end_with?) && name.respond_to?(:chop!)
-        name.chop! if name.end_with?('/')
-      end
+      name.chomp!('/') if name.respond_to?(:chomp!)
 
       name
     end
-
   end
 end

data/lib/zip-container/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2014 The University of Manchester, UK.
+# Copyright (c) 2014-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,18 +30,6 @@
 #
 # Author: Robert Haines
 
-require 'yaml'
-
 module ZipContainer
-
-  # Library version information.
-  module Version
-    # Version information in a Hash
-    INFO = YAML.load_file(
-      File.join(File.dirname(__FILE__), '..', '..', 'version.yml')
-    )
-
-    # Version number as a String
-    STRING = %i[major minor patch].map { |d| INFO[d] }.compact.join('.')
-  end
+  VERSION = '5.0.0.rc1' # :nodoc:
 end

data/lib/zip-container.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014 The University of Manchester, UK.
+# Copyright (c) 2013-2024 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,20 +30,6 @@
 #
 # Author: Robert Haines
 
-require 'rubygems'
-require 'bundler/setup'
-
-require 'zip/filesystem'
-
-require 'zip-container/util'
-require 'zip-container/version'
-require 'zip-container/exceptions'
-require 'zip-container/entries/reserved'
-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'
 

data/zip-container.gemspec

@@ -1,4 +1,4 @@
-# Copyright (c) 2013, 2014, 2018 The University of Manchester, UK.
+# Copyright (c) 2013-2025 The University of Manchester, UK.
 #
 # All rights reserved.
 #
@@ -30,22 +30,21 @@
 #
 # Author: Robert Haines
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'zip-container/version'
+require_relative 'lib/zip-container/version'
 
 Gem::Specification.new do |s|
   s.name             = 'zip-container'
-  s.version          = ZipContainer::Version::STRING
+  s.version          = ZipContainer::VERSION
   s.authors          = ['Robert Haines', 'Finn Bacall']
-  s.email            = ['support@mygrid.org.uk']
+  s.email            = ['robert.haines@manchester.ac.uk']
 
-  s.homepage         = 'http://mygrid.github.io/ruby-zip-container/'
+  s.homepage         = 'https://github.com/hainesr/ruby-zip-container'
   s.summary          = 'A ZIP Container for use by OCF and UCF implementations'
-  s.description      = 'A Ruby library for working with ZIP Container '\
-    'Format files. See http://www.idpf.org/epub/30/spec/epub30-ocf.html for '\
-    'the OCF specification and '\
-    'https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format '\
+  s.description      =
+    'A Ruby library for working with ZIP Container ' \
+    'Format files. See http://www.idpf.org/epub/30/spec/epub30-ocf.html for ' \
+    'the OCF specification and ' \
+    'https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format ' \
     'for the UCF specification.'
   s.license          = 'BSD'
 
@@ -54,14 +53,26 @@ Gem::Specification.new do |s|
     f.match(%r{^((test|spec|features)/|\.)})
   end
 
-  s.required_ruby_version = '>= 2.2.0'
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/hainesr/ruby-zip-container/issues',
+    'changelog_uri' => "https://github.com/hainesr/ruby-zip-container/blob/v#{s.version}/CHANGES.md",
+    'documentation_uri' => 'https://hainesr.github.io/ruby-zip-container',
+    'source_code_uri' => "https://github.com/hainesr/ruby-zip-container/tree/v#{s.version}",
+    'rubygems_mfa_required' => 'true'
+  }
 
-  s.add_runtime_dependency 'rubyzip', '~> 1.3.0'
+  s.required_ruby_version = '>= 2.7'
 
-  s.add_development_dependency 'bundler', '~> 1.16'
-  s.add_development_dependency 'coveralls', '~> 0.8'
-  s.add_development_dependency 'rake', '~> 10.1'
-  s.add_development_dependency 'rdoc', '~> 4.1'
-  s.add_development_dependency 'rubocop', '~> 0.59'
-  s.add_development_dependency 'test-unit', '~> 3.0'
+  s.add_runtime_dependency 'rubyzip', '~> 2.4'
+
+  s.add_development_dependency 'minitest', '~> 5.25'
+  s.add_development_dependency 'os', '~> 1.1.4'
+  s.add_development_dependency 'rake', '~> 13.2'
+  s.add_development_dependency 'rdoc', '~> 6.11'
+  s.add_development_dependency 'rubocop', '~> 1.50.0'
+  s.add_development_dependency 'rubocop-minitest', '~> 0.30.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.17.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'simplecov', '0.22.0'
+  s.add_development_dependency 'simplecov-lcov', '~> 0.8'
 end