Version 3.0.1

⚠️ There are breaking changes in the 3.x series ⚠️

Please see the README and Updating to version 3.x in the wiki for help upgrading from version 2.4.x to version 3.x.

Version 3.0.0

⚠️ There are breaking changes to the API in this release! ⚠️

Please see the README and Updating to version 3.x in the wiki for help upgrading from version 2.4.x to version 3.0.0.

This is a "dummy" release to warn about breaking changes coming in version 3.0.

• Fix frozen string literal error #431
• Set OutputStream.write_buffer's buffer to binmode #439
• Upgrade rubocop and fix various linting complaints #437 #440

Tooling:

• Add a bin/console script for development #420
• Update rake requirement (development dependency only) to fix a security alert.

• Add support for decompression plugin gems #427

• Fix (at least partially) the restore_times and restore_permissions options to Zip::File.new #413
  • Previously, neither option did anything, regardless of what it was set to. We have therefore defaulted them to false to preserve the current behavior, for the time being. If you have explicitly set either to true, it will now have an effect.
  • Fix handling of UniversalTime (mtime, atime, ctime) fields. #421
  • Previously, Zip::File did not pass the options to Zip::Entry in some cases. #423
  • Note that restore_times in this release does nothing on Windows and only restores mtime, not atime or ctime.
• Allow Zip::File.open to take an options hash like Zip::File.new #418
• Always print warnings with warn, instead of a mix of puts and warn #416
• Create temporary files in the system temporary directory instead of the directory of the zip file #411
• Drop unused tmpdir requirement #411

Tooling

• Move CI to xenial and include jruby on JDK11 #419

Security

• Default the validate_entry_sizes option to true, so that callers can trust an entry's reported size when using extract #403
  • This option defaulted to false in 1.3.0 for backward compatibility, but it now defaults to true. If you are using an older version of ruby and can't yet upgrade to 2.x, you can still use 1.3.0 and set the option to true.

Tooling / Documentation

• Remove test files from the gem to avoid problems with antivirus detections on the test files #405 / #384
• Drop support for unsupported ruby versions #406

Security

• Add validate_entry_sizes option so that callers can trust an entry's reported size when using extract #403
  • This option defaults to false for backward compatibility in this release, but you are strongly encouraged to set it to true. It will default to true in rubyzip 2.0.

New Feature

• Add add_stored method to simplify adding entries without compression #366

Tooling / Documentation

• Add more gem metadata links #402