zip-container 3.0.2 → 4.0.1

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

@@ -30,7 +30,7 @@
 #
 # Author: Robert Haines
 
-#
+##
 module ZipContainer
 
   # The base of all exceptions raised by this library.
@@ -43,6 +43,7 @@ module ZipContainer
 
   # This exception is raised when a bad Container is detected.
   class MalformedContainerError < RuntimeError
+
     include Error
 
     # :call-seq:
@@ -54,7 +55,7 @@ module ZipContainer
     # reasons for why the Container is malformed.
     def initialize(reason = nil)
       if reason.nil? || reason.empty?
-        super("Malformed Container.")
+        super('Malformed Container.')
       elsif reason.is_a?(Array)
         reasons = reason.map { |r| " * #{r}\n" }
         super("Malformed Container:\n#{reasons}")
@@ -67,6 +68,7 @@ module ZipContainer
   # This exception is raised when a clash occurs with a reserved or managed
   # name.
   class ReservedNameClashError < RuntimeError
+
     include Error
 
     # :call-seq:

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

data/lib/zip-container/util.rb

@@ -30,7 +30,7 @@
 #
 # Author: Robert Haines
 
-#
+##
 module ZipContainer
 
   # Utility methods useful throughout the rest of the ZipContainer library.
@@ -46,10 +46,10 @@ module ZipContainer
     # In common with rubyzip this method also removes a trailing slash (/)
     # from a name if it can.
     def entry_name(entry)
-      name = entry.kind_of?(::Zip::Entry) ? 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?("/")
+        name.chop! if name.end_with?('/')
       end
 
       name

data/lib/zip-container/version.rb

@@ -37,10 +37,11 @@ module ZipContainer
   # Library version information.
   module Version
     # Version information in a Hash
-    INFO = YAML.load_file(File.join(File.dirname(__FILE__), "..", "..",
-      "version.yml"))
+    INFO = YAML.load_file(
+      File.join(File.dirname(__FILE__), '..', '..', 'version.yml')
+    )
 
     # Version number as a String
-    STRING = [:major, :minor, :patch].map {|d| INFO[d]}.compact.join('.')
+    STRING = %i[major minor patch].map { |d| INFO[d] }.compact.join('.')
   end
 end

data/version.yml

@@ -1,4 +1,4 @@
 ---
-  :major: 3
+  :major: 4
   :minor: 0
-  :patch: 2
+  :patch: 1

data/zip-container.gemspec

@@ -30,35 +30,38 @@
 #
 # Author: Robert Haines
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "zip-container/version"
+require 'zip-container/version'
 
 Gem::Specification.new do |s|
-  s.name             = "zip-container"
+  s.name             = 'zip-container'
   s.version          = ZipContainer::Version::STRING
-  s.authors          = ["Robert Haines", "Finn Bacall"]
-  s.email            = ["support@mygrid.org.uk"]
-  s.homepage         = "http://mygrid.github.io/ruby-zip-container/"
-  s.platform         = Gem::Platform::RUBY
-  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 "\
-    "for the UCF specification."
-  s.license          = "BSD"
-  s.require_path     = "lib"
-  s.files            = `git ls-files`.split($/)
-  s.test_files       = `git ls-files -- test/*`.split($/)
-  s.has_rdoc         = true
-  s.extra_rdoc_files = [ "Changes.rdoc", "Licence.rdoc", "ReadMe.rdoc" ]
-  s.rdoc_options     = [ "-N", "--tab-width=2", "--main=ReadMe.rdoc" ]
-  s.required_ruby_version = ">= 1.9.3"
-  s.add_development_dependency "bundler", "~> 1.5"
-  s.add_development_dependency "rake", "~> 10.1"
-  s.add_development_dependency "rdoc", "~> 4.1"
-  s.add_development_dependency "test-unit", "~> 3.0"
-  s.add_development_dependency "coveralls"
-  s.add_runtime_dependency "rubyzip", "~> 1.2.1"
+  s.authors          = ['Robert Haines', 'Finn Bacall']
+  s.email            = ['support@mygrid.org.uk']
+
+  s.homepage         = 'http://mygrid.github.io/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 '\
+    'for the UCF specification.'
+  s.license          = 'BSD'
+
+  s.require_path     = 'lib'
+  s.files            = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^((test|spec|features)/|\.)})
+  end
+
+  s.required_ruby_version = '>= 2.2.0'
+
+  s.add_runtime_dependency 'rubyzip', '~> 1.3.0'
+
+  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'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip-container
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.1
 platform: ruby
 authors:
 - Robert Haines
@@ -9,92 +9,106 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2019-11-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.59'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '3.0'
 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.
@@ -102,16 +116,8 @@ email:
 - support@mygrid.org.uk
 executables: []
 extensions: []
-extra_rdoc_files:
-- Changes.rdoc
-- Licence.rdoc
-- ReadMe.rdoc
+extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-env"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
 - Changes.rdoc
 - Gemfile
 - Licence.rdoc
@@ -132,28 +138,6 @@ files:
 - lib/zip-container/file.rb
 - lib/zip-container/util.rb
 - lib/zip-container/version.rb
-- test/data/compressed_mimetype.container
-- test/data/dirs/dir-mimetype/mimetype/.gitkeep
-- test/data/dirs/empty/mimetype
-- test/data/dirs/managed/dir/.gitkeep
-- test/data/dirs/managed/greeting.txt
-- test/data/dirs/managed/mimetype
-- test/data/dirs/null/.gitkeep
-- test/data/empty.container
-- test/data/empty.zip
-- test/data/example.container
-- test/data/null.file
-- test/data/subclassed.container
-- test/helpers/entry_lists.rb
-- test/tc_create_dir.rb
-- test/tc_create_file.rb
-- test/tc_exceptions.rb
-- test/tc_managed_entries.rb
-- test/tc_read_dir.rb
-- test/tc_read_file.rb
-- test/tc_reserved_names.rb
-- test/tc_util.rb
-- test/ts_container.rb
 - version.yml
 - zip-container.gemspec
 homepage: http://mygrid.github.io/ruby-zip-container/
@@ -161,48 +145,22 @@ licenses:
 - BSD
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "-N"
-- "--tab-width=2"
-- "--main=ReadMe.rdoc"
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A ZIP Container for use by OCF and UCF implementations
-test_files:
-- test/data/compressed_mimetype.container
-- test/data/dirs/dir-mimetype/mimetype/.gitkeep
-- test/data/dirs/empty/mimetype
-- test/data/dirs/managed/dir/.gitkeep
-- test/data/dirs/managed/greeting.txt
-- test/data/dirs/managed/mimetype
-- test/data/dirs/null/.gitkeep
-- test/data/empty.container
-- test/data/empty.zip
-- test/data/example.container
-- test/data/null.file
-- test/data/subclassed.container
-- test/helpers/entry_lists.rb
-- test/tc_create_dir.rb
-- test/tc_create_file.rb
-- test/tc_exceptions.rb
-- test/tc_managed_entries.rb
-- test/tc_read_dir.rb
-- test/tc_read_file.rb
-- test/tc_reserved_names.rb
-- test/tc_util.rb
-- test/ts_container.rb
+test_files: []