zip-container 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a530c28c4a1a55dd29e2f84a8ebafef6549271353f62f915625ae9756afbaf1
-  data.tar.gz: c26a6e991c7ddf7f1ef86542addd4a44d2ea68a3abac69b049ca21718f20ac71
+  metadata.gz: 8e69fb9eb9080e5005ca5fc86fdc0e0b969c8e8133202052f8c611d6aa464fb7
+  data.tar.gz: e8a0304bbb0a37b40db0723711d2273fee038a911a5e1e9807b6ea2fb6a3346a
 SHA512:
-  metadata.gz: e5ccf5519877655da4060b48b3084b830897c5aa51b739cf5e340a3c46c355d0bbf84adc84e638979c303d39081047b12a6dc8015c9233fb6eecabd60b63afd7
-  data.tar.gz: 04ac82e77f79d02ad2445fa92095a89eaf642f6b713f84cfc0eddcb73f0ef716663bd234afd9ac586daccfa5f5d0d347a81687d26fd85607766b3e91008fef71
+  metadata.gz: 102ab9d00ed83fb7fb2117c72995b047fbc3325a494e2b9b6887fd4138a9513e43a7e770efd46b990344a43034df9fc4e9390834e26f58aa879dfece54ee1a93
+  data.tar.gz: 88192ce0b2a3c915e936ac3b0f165c91f968edf9e343829f4ad45852d9731a46c067acda5ae034775be2655fb026f101b50934a006668ee562df4692e9a59e60

data/CHANGES.md

@@ -7,8 +7,8 @@
 * Add a code of conduct.
 * Add contributing guidelines.
 * Move to README.md (and update).
-* Update minimum ruby version required to 2.7.
-* Update RubyZip version to v2.4.
+* Update minimum ruby version required to 3.0.
+* Update RubyZip version to v3.0.
 * Ensure 'managed_directory' is required at the top-level.
 * Add note README about ruby and RubyZip versions.
 * Apply frozen_string_literal magic comment to all files.
@@ -17,6 +17,7 @@
 
 ### Internal/tooling:
 
+* Add Ruby 3.4 to the CI tests.
 * Update Rake version.
 * Update and add metadata in the gemspec.
 * Just use a constant for the gem version string.

data/README.md

@@ -22,15 +22,15 @@ If you are wanting to work with UCF files in particular, there is a Ruby Gem tha
 
 This library has two entry points.
 
-The main `ZipContainer::File` class largely mimics the rubyzip [`Zip::File`](https://www.rubydoc.info/gems/rubyzip/2.4.1/Zip/File) and [`Zip::FileSystem`](https://www.rubydoc.info/gems/rubyzip/2.4.1/Zip/FileSystem) APIs so much of what you can do with them are supported for ZIP Containers. There is also [API documentation](http://hainesr.github.io/ruby-zip-container/) with much more detail and any differences explained.
+The main `ZipContainer::File` class largely mimics the rubyzip [`Zip::File`](https://www.rubydoc.info/gems/rubyzip/3.0.1/Zip/File) and [`Zip::FileSystem`](https://www.rubydoc.info/gems/rubyzip/3.0.1/Zip/FileSystem) APIs so much of what you can do with them are supported for ZIP Containers. There is also [API documentation](http://hainesr.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).
+The `ZipContainer::Dir` class mimics, where possible, the core ruby [`Dir` API](https://rubyapi.org/3.0/o/dir).
 
 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.
 
 #### Versions
 
-Version 5 of this library will be the last to support Ruby 2.7 and the last to support RubyZip 2.4. Version 6 will require at least Ruby 3.0 and RubyZip 3.0.
+Version 5 of this library was the last to support Ruby 2.7 and the last to support RubyZip 2.4. Version 6 requires at least Ruby 3.0 and RubyZip 3.0.
 
 ### What this library can not do yet
 

data/lib/zip-container/file.rb

@@ -66,8 +66,8 @@ module ZipContainer
       # Here we fake up the connection to the rubyzip filesystem classes so
       # that they also respect the reserved names that we define.
       mapped_zip = ::Zip::FileSystem::ZipFileNameMapper.new(self)
-      @fs_dir  = ::Zip::FileSystem::ZipFsDir.new(mapped_zip)
-      @fs_file = ::Zip::FileSystem::ZipFsFile.new(mapped_zip)
+      @fs_dir  = ::Zip::FileSystem::Dir.new(mapped_zip)
+      @fs_file = ::Zip::FileSystem::File.new(mapped_zip)
       @fs_dir.file = @fs_file
       @fs_file.dir = @fs_dir
     end
@@ -79,8 +79,13 @@ module ZipContainer
     #
     # Create a new ZipContainer file on disk with the specified mimetype.
     def self.create(filename, mimetype)
-      ::Zip::OutputStream.open(filename) do |stream|
-        stream.put_next_entry(MIMETYPE_FILE, nil, nil, ::Zip::Entry::STORED)
+      # The mimetype file must be first in the archive, and uncompressed.
+      mimetype_entry = Zip::Entry.new(
+        nil, MIMETYPE_FILE, compression_method: Zip::Entry::STORED
+      )
+
+      Zip::OutputStream.open(filename) do |stream|
+        stream.put_next_entry(mimetype_entry)
         stream.write mimetype
       end
 
@@ -155,7 +160,7 @@ module ZipContainer
     alias close commit
 
     # :call-seq:
-    #   dir -> Zip::ZipFsDir
+    #   dir -> Zip::FileSystem::Dir
     #
     # Returns an object which can be used like ruby's built in +Dir+ (class)
     # object, except that it works on the ZipContainer file on which this
@@ -167,7 +172,7 @@ module ZipContainer
     end
 
     # :call-seq:
-    #   file -> Zip::ZipFsFile
+    #   file -> Zip::FileSystem::File
     #
     # Returns an object which can be used like ruby's built in +File+ (class)
     # object, except that it works on the ZipContainer file on which this
@@ -209,8 +214,8 @@ module ZipContainer
     end
 
     # :call-seq:
-    #   get_output_stream(entry, permission = nil) -> stream
-    #   get_output_stream(entry, permission = nil) {|stream| ...}
+    #   get_output_stream(entry, permissions: nil) -> stream
+    #   get_output_stream(entry, permissions: nil) {|stream| ...}
     #
     # Returns an output stream to the specified entry. If a block is passed
     # the stream object is passed to the block and the stream is automatically
@@ -218,12 +223,12 @@ module ZipContainer
     #
     # See the rubyzip documentation for details of the +permission_int+
     # parameter.
-    def get_output_stream(entry, permission = nil, &block)
+    def get_output_stream(entry, permissions: nil, &block)
       if reserved_entry?(entry) || managed_directory?(entry)
         raise ReservedNameClashError, entry.to_s
       end
 
-      @container.get_output_stream(entry, permission, &block)
+      @container.get_output_stream(entry, permissions: permissions, &block)
     end
 
     # :call-seq:

data/lib/zip-container/util.rb

@@ -32,7 +32,7 @@
 #
 # Author: Robert Haines
 
-require 'zip' # Remove this when we update to rubyzip 3.x.
+require 'zip' # Remove this when rubyzip fixes its require tree.
 require 'zip/entry'
 
 ##

data/lib/zip-container/version.rb

@@ -32,6 +32,8 @@
 #
 # Author: Robert Haines
 
+##
 module ZipContainer
-  VERSION = '5.0.0' # :nodoc:
+  # The current version of the ZipContainer library.
+  VERSION = '6.0.0'
 end

data/lib/zip-container.rb

@@ -32,6 +32,7 @@
 #
 # Author: Robert Haines
 
+require_relative 'zip-container/version'
 require_relative 'zip-container/file'
 require_relative 'zip-container/dir'
 require_relative 'zip-container/managed_directory'

data/zip-container.gemspec

@@ -63,9 +63,9 @@ Gem::Specification.new do |s|
     'rubygems_mfa_required' => 'true'
   }
 
-  s.required_ruby_version = '>= 2.7'
+  s.required_ruby_version = '>= 3.0'
 
-  s.add_runtime_dependency 'rubyzip', '~> 2.4'
+  s.add_runtime_dependency 'rubyzip', '~> 3.0'
 
   s.add_development_dependency 'minitest', '~> 5.25'
   s.add_development_dependency 'os', '~> 1.1.4'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip-container
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Robert Haines
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-09 00:00:00.000000000 Z
+date: 2025-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -205,9 +205,9 @@ licenses:
 - BSD
 metadata:
   bug_tracker_uri: https://github.com/hainesr/ruby-zip-container/issues
-  changelog_uri: https://github.com/hainesr/ruby-zip-container/blob/v5.0.0/CHANGES.md
+  changelog_uri: https://github.com/hainesr/ruby-zip-container/blob/v6.0.0/CHANGES.md
   documentation_uri: https://hainesr.github.io/ruby-zip-container
-  source_code_uri: https://github.com/hainesr/ruby-zip-container/tree/v5.0.0
+  source_code_uri: https://github.com/hainesr/ruby-zip-container/tree/v6.0.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -217,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="