zip-container 5.0.0.rc2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d56e4e0c34e786a2c40592c5162bd45ca4cb642e43a78af15d06a8ce0c6aa827
-  data.tar.gz: 67fe6c6ad79a1d462ad54496c27f80607d0eb5e92f31a8468a01129ced633d58
+  metadata.gz: 8e69fb9eb9080e5005ca5fc86fdc0e0b969c8e8133202052f8c611d6aa464fb7
+  data.tar.gz: e8a0304bbb0a37b40db0723711d2273fee038a911a5e1e9807b6ea2fb6a3346a
 SHA512:
-  metadata.gz: 64bd83f999efa1b885b99d3a29f01aea5cf078cf4d5ce3d232cf0dbe342e61602c5fb8339af87e9f57d41c4e7e13bf64359889389cbc38a87d3d242f67079f28
-  data.tar.gz: e70fb9bfb934c24148b3ec88b1c6a9665ed760e2f5bfc6325c6231704e4538ce4214f9fa85ceb32515b6f9ddbb0e40a787cdda7f2a127c123d11b1ace3d55376
+  metadata.gz: 102ab9d00ed83fb7fb2117c72995b047fbc3325a494e2b9b6887fd4138a9513e43a7e770efd46b990344a43034df9fc4e9390834e26f58aa879dfece54ee1a93
+  data.tar.gz: 88192ce0b2a3c915e936ac3b0f165c91f968edf9e343829f4ad45852d9731a46c067acda5ae034775be2655fb026f101b50934a006668ee562df4692e9a59e60

data/CHANGES.md

@@ -7,14 +7,17 @@
 * 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.
+* Update OCF references in README and gemspec.
+* Add a CITATION.cff file.
 
 ### 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.
@@ -26,6 +29,8 @@
 * Skip certain tests in non-POSIX environments.
 * Fix managed directory test on Windows.
 * Ensure simplecov is required first with MiniTest.
+* Add an Action to build the latest documentation.
+* Set Rubocop output to use GitHub format.
 
 ## Version 4.0.2
 

data/CITATION.cff

@@ -0,0 +1,54 @@
+# This CITATION.cff file was created by ruby-cff (v 1.3.0).
+# Gem: https://rubygems.org/gems/cff
+# CFF: https://citation-file-format.github.io/
+
+cff-version: 1.2.0
+title: Ruby Zip Container
+message: If you use Ruby Zip Container in your work, please cite it using the following metadata
+type: software
+authors:
+  - given-names: Robert
+    family-names: Haines
+    affiliation: The University of Manchester
+    orcid: https://orcid.org/0000-0002-9538-7919
+  - given-names: Finn
+    family-names: Bacall
+    affiliation: The University of Manchester
+repository-code: https://github.com/hainesr/ruby-zip-container
+url: https://hainesr.github.io/ruby-zip-container/
+repository-artifact: https://rubygems.org/gems/zip-container
+abstract: A Ruby library for working with ZIP Container Format files.
+keywords:
+  - ruby
+  - zip
+  - EPUB
+  - OCF
+  - zip-container
+license: BSD-3-Clause
+references:
+  - title: EPUB Open Container Format (OCF) 3.0
+    authors:
+      - name: International Digital Publishing Forum (IDPF)
+    editors:
+      - given-names: James
+        family-names: Pritchett
+      - given-names: Markus
+        family-names: Gylling
+        affiliation: DAISY Consortium
+    type: standard
+    url: https://idpf.org/epub/30/spec/epub30-ocf.html
+  - title: EPUB 3.3 - Open Container Format (OCF)
+    authors:
+      - name: W3C
+    editors:
+      - given-names: Matt
+        family-names: Garrish
+        affiliation: DAISY Consortium
+      - given-names: Ivan
+        family-names: Herman
+        affiliation: W3C
+        orcid: https://orcid.org/0000-0003-0782-2704
+      - given-names: Dave
+        family-names: Cramer
+    type: standard
+    url: https://www.w3.org/TR/epub-33/#sec-ocf

data/README.md

@@ -12,7 +12,7 @@ A Ruby library for creating, editing and validating ZIP Container files.
 
 ### Synopsis
 
-This is a Ruby library for working with ZIP Container files. See the [ODF](http://www.idpf.org/epub/30/spec/epub30-ocf.html) and [UCF](https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format) specifications for more details.
+This is a Ruby library for working with ZIP Container files. See the OCF [[1](http://www.idpf.org/epub/30/spec/epub30-ocf.html), [2](https://www.w3.org/TR/epub-33/#sec-ocf)] and UCF [[3](https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format)] specifications for more details.
 
 If you are wanting to work with UCF files in particular, there is a Ruby Gem that builds on this one specifically for that. Please see:
  * [GitHub](https://github.com/hainesr/ruby-ucf)
@@ -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.rc2' # :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

@@ -44,8 +44,8 @@ Gem::Specification.new do |s|
   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 ' \
+    'Format files. See http://www.idpf.org/epub/30/spec/epub30-ocf.html and ' \
+    'https://www.w3.org/TR/epub-33/#sec-ocf for the OCF specification and ' \
     'https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format ' \
     'for the UCF specification.'
   s.license          = 'BSD'
@@ -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.rc2
+  version: 6.0.0
 platform: ruby
 authors:
 - Robert Haines
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-15 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
@@ -166,7 +166,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 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
+  and https://www.w3.org/TR/epub-33/#sec-ocf for the OCF specification and https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format
   for the UCF specification.
 email:
 - robert.haines@manchester.ac.uk
@@ -175,6 +175,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGES.md
+- CITATION.cff
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -204,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.rc2/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.rc2
+  source_code_uri: https://github.com/hainesr/ruby-zip-container/tree/v6.0.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -216,12 +217,12 @@ 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:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.1
 signing_key: