rubyzip 2.4.rc1 → 3.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49b133beda4cc25cd86964b3d7ffdd774583a75889508916ea4dab892ea9275d
-  data.tar.gz: 85c81018a61dd9592e8c7081b4c1b1d07c8f40ccea75b2466be8509925abfad6
+  metadata.gz: dd95bfed4ea9c320051f039341277893bedc591147c093a4c527082b81eb6ae3
+  data.tar.gz: ea955185220e2d566bb8c843bd76dd2b076ca1b4353f3d1c1c5910522a2e3d7c
 SHA512:
-  metadata.gz: e6b95ffa49797be6cf36f0063a2013c994e6c7332fa29742d9991d35473e48dc22db94c2840de36012040790c2cd68ca49cfaedda99f3a7c921b42480d91ab94
-  data.tar.gz: 800b81d0d1797060e6a04a87aa1cc792fa53cfa9744d6a97d77b5890d9fbe58a1b98e6fa038bb400e30b85d2d9fc0dfd115debb8c221d4c94944639b5a1271a1
+  metadata.gz: 74dc66a56c1b5e899ba2d683dd4f147be5f301f1d51d86d5d9f027c4c9a74beb48135aaec72e304dd9b8ff92d4f0f2f429d4ab0e0eb5b19c9322bdcf5b66ddea
+  data.tar.gz: 0ad96c3aa4ab42648abdfa8e60d7360a17bc0543d6116a70bd4679f7a9b5da57c1f1d3580bb5e1d7b9d9c8a87b76e084a8f759c4bfacf99e6dca8580d85bf2a7

data/Changelog.md

@@ -0,0 +1,368 @@
+# 3.0.0 (Next)
+
+- Don't silently alter zip files opened with `Zip::sort_entries`. [#329](https://github.com/rubyzip/rubyzip/issues/329)
+- Use named parameters for optional arguments in the public API.
+- Raise an error if entry names exceed 65,535 characters. [#247](https://github.com/rubyzip/rubyzip/issues/247)
+- Remove the `ZipXError` v1 legacy classes.
+- Raise an error on reading a split archive with `InputStream`. [#349](https://github.com/rubyzip/rubyzip/issues/349)
+- Ensure `InputStream` raises `GPFBit3Error` for OSX Archive files. [#493](https://github.com/rubyzip/rubyzip/issues/493)
+- Improve documentation and error messages for `InputStream`. [#196](https://github.com/rubyzip/rubyzip/issues/196)
+- Fix zip file-level comment is not read from zip64 files. [#492](https://github.com/rubyzip/rubyzip/issues/492)
+- Fix `Zip::OutputStream.write_buffer` doesn't work with Tempfiles. [#265](https://github.com/rubyzip/rubyzip/issues/265)
+- Reinstate normalising pathname separators to /. [#487](https://github.com/rubyzip/rubyzip/pull/487)
+- Fix restore options consistency. [#486](https://github.com/rubyzip/rubyzip/pull/486)
+- View and/or preserve original date created, date modified? (Windows). [#336](https://github.com/rubyzip/rubyzip/issues/336)
+- Fix frozen string literal error. [#475](https://github.com/rubyzip/rubyzip/pull/475)
+- Set the default `Entry` time to the file's mtime on Windows. [#465](https://github.com/rubyzip/rubyzip/issues/465)
+- Ensure that `Entry#time=` sets times as `DOSTime` objects. [#481](https://github.com/rubyzip/rubyzip/issues/481)
+- Replace and deprecate `Zip::DOSTime#dos_equals`. [#464](https://github.com/rubyzip/rubyzip/pull/464)
+- Fix loading extra fields. [#459](https://github.com/rubyzip/rubyzip/pull/459)
+- Set compression level on a per-zipfile basis. [#448](https://github.com/rubyzip/rubyzip/pull/448)
+- Fix input stream partial read error. [#462](https://github.com/rubyzip/rubyzip/pull/462)
+- Fix zlib deflate buffer growth. [#447](https://github.com/rubyzip/rubyzip/pull/447)
+
+Tooling/internal:
+
+- Configure Coveralls to not report a failure on minor decreases of test coverage. [#491](https://github.com/rubyzip/rubyzip/issues/491)
+- Extract the file splitting code out into its own module.
+- Refactor, and tidy up, the `Zip::Filesystem` classes for improved maintainability.
+- Fix Windows tests. [#489](https://github.com/rubyzip/rubyzip/pull/489)
+- Refactor `assert_forwarded` so it does not need `ObjectSpace._id2ref` or `eval`. [#483](https://github.com/rubyzip/rubyzip/pull/483)
+- Add GitHub Actions CI infrastructure. [#469](https://github.com/rubyzip/rubyzip/issues/469)
+- Add Ruby 3.0 to CI. [#474](https://github.com/rubyzip/rubyzip/pull/474)
+- Fix the compression level tests to compare relative sizes. [#473](https://github.com/rubyzip/rubyzip/pull/473)
+- Simplify assertions in basic_zip_file_test. [#470](https://github.com/rubyzip/rubyzip/pull/470)
+- Remove compare_enumerables from test_helper.rb. [#468](https://github.com/rubyzip/rubyzip/pull/468)
+- Use correct SPDX license identifier. [#458](https://github.com/rubyzip/rubyzip/pull/458)
+- Enable truffle ruby in Travis CI. [#450](https://github.com/rubyzip/rubyzip/pull/450)
+- Update rubocop again and run it in CI. [#444](https://github.com/rubyzip/rubyzip/pull/444)
+- Fix a test that was incorrect on big-endian architectures. [#445](https://github.com/rubyzip/rubyzip/pull/445)
+
+# 2.3.2 (2021-07-05)
+
+- A "dummy" release to warn about breaking changes coming in version 3.0. This updated version uses the Gem `post_install_message` instead of printing to `STDERR`.
+
+# 2.3.1 (2021-07-03)
+
+- A "dummy" release to warn about breaking changes coming in version 3.0.
+
+# 2.3.0 (2020-03-14)
+
+- Fix frozen string literal error [#431](https://github.com/rubyzip/rubyzip/pull/431)
+- Set `OutputStream.write_buffer`'s buffer to binmode [#439](https://github.com/rubyzip/rubyzip/pull/439)
+- Upgrade rubocop and fix various linting complaints [#437](https://github.com/rubyzip/rubyzip/pull/437) [#440](https://github.com/rubyzip/rubyzip/pull/440)
+
+Tooling:
+
+- Add a `bin/console` script for development [#420](https://github.com/rubyzip/rubyzip/pull/420)
+- Update rake requirement (development dependency only) to fix a security alert.
+
+# 2.2.0 (2020-02-01)
+
+- Add support for decompression plugin gems [#427](https://github.com/rubyzip/rubyzip/pull/427)
+
+# 2.1.0 (2020-01-25)
+
+- Fix (at least partially) the `restore_times` and `restore_permissions` options to `Zip::File.new` [#413](https://github.com/rubyzip/rubyzip/pull/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](https://github.com/rubyzip/rubyzip/pull/421)
+  - Previously, `Zip::File` did not pass the options to `Zip::Entry` in some cases. [#423](https://github.com/rubyzip/rubyzip/pull/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](https://github.com/rubyzip/rubyzip/pull/418)
+- Always print warnings with `warn`, instead of a mix of `puts` and `warn` [#416](https://github.com/rubyzip/rubyzip/pull/416)
+- Create temporary files in the system temporary directory instead of the directory of the zip file [#411](https://github.com/rubyzip/rubyzip/pull/411)
+- Drop unused `tmpdir` requirement [#411](https://github.com/rubyzip/rubyzip/pull/411)
+
+Tooling
+
+- Move CI to xenial and include jruby on JDK11 [#419](https://github.com/rubyzip/rubyzip/pull/419/files)
+
+# 2.0.0 (2019-09-25)
+
+Security
+
+- Default the `validate_entry_sizes` option to `true`, so that callers can trust an entry's reported size when using `extract` [#403](https://github.com/rubyzip/rubyzip/pull/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](https://github.com/rubyzip/rubyzip/pull/405) / [#384](https://github.com/rubyzip/rubyzip/issues/384)
+- Drop support for unsupported ruby versions [#406](https://github.com/rubyzip/rubyzip/pull/406)
+
+# 1.3.0 (2019-09-25)
+
+Security
+
+- Add `validate_entry_sizes` option so that callers can trust an entry's reported size when using `extract` [#403](https://github.com/rubyzip/rubyzip/pull/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](https://github.com/rubyzip/rubyzip/pull/366)
+
+Tooling / Documentation
+
+- Add more gem metadata links [#402](https://github.com/rubyzip/rubyzip/pull/402)
+
+# 1.2.4 (2019-09-06)
+
+- Do not rewrite zip files opened with `open_buffer` that have not changed [#360](https://github.com/rubyzip/rubyzip/pull/360)
+
+Tooling / Documentation
+
+- Update `example_recursive.rb` in README [#397](https://github.com/rubyzip/rubyzip/pull/397)
+- Hold CI at `trusty` for now, automatically pick the latest ruby patch version, use rbx-4 and hold jruby at 9.1 [#399](https://github.com/rubyzip/rubyzip/pull/399)
+
+# 1.2.3
+
+- Allow tilde in zip entry names [#391](https://github.com/rubyzip/rubyzip/pull/391) (fixes regression in 1.2.2 from [#376](https://github.com/rubyzip/rubyzip/pull/376))
+- Support frozen string literals in more files [#390](https://github.com/rubyzip/rubyzip/pull/390)
+- Require `pathname` explicitly [#388](https://github.com/rubyzip/rubyzip/pull/388) (fixes regression in 1.2.2 from [#376](https://github.com/rubyzip/rubyzip/pull/376))
+
+Tooling / Documentation:
+
+- CI updates [#392](https://github.com/rubyzip/rubyzip/pull/392), [#394](https://github.com/rubyzip/rubyzip/pull/394)
+  - Bump supported ruby versions and add 2.6
+  - JRuby failures are no longer ignored (reverts [#375](https://github.com/rubyzip/rubyzip/pull/375) / part of [#371](https://github.com/rubyzip/rubyzip/pull/371))
+- Add changelog entry that was missing for last release [#387](https://github.com/rubyzip/rubyzip/pull/387)
+- Comment cleanup [#385](https://github.com/rubyzip/rubyzip/pull/385)
+
+# 1.2.2
+
+NB: This release drops support for extracting symlinks, because there was no clear way to support this securely. See https://github.com/rubyzip/rubyzip/pull/376#issue-210954555 for details.
+
+- Fix CVE-2018-1000544 [#376](https://github.com/rubyzip/rubyzip/pull/376) / [#371](https://github.com/rubyzip/rubyzip/pull/371)
+- Fix NoMethodError: undefined method `glob' [#363](https://github.com/rubyzip/rubyzip/pull/363)
+- Fix handling of stored files (i.e. files not using compression) with general purpose bit 3 set [#358](https://github.com/rubyzip/rubyzip/pull/358)
+- Fix `close` on StringIO-backed zip file [#353](https://github.com/rubyzip/rubyzip/pull/353)
+- Add `Zip.force_entry_names_encoding` option [#340](https://github.com/rubyzip/rubyzip/pull/340)
+- Update rubocop, apply auto-fixes, and fix regressions caused by said auto-fixes [#332](https://github.com/rubyzip/rubyzip/pull/332), [#355](https://github.com/rubyzip/rubyzip/pull/355)
+- Save temporary files to temporary directory (rather than current directory) [#325](https://github.com/rubyzip/rubyzip/pull/325)
+
+Tooling / Documentation:
+
+- Turn off all terminal output in all tests [#361](https://github.com/rubyzip/rubyzip/pull/361)
+- Several CI updates [#346](https://github.com/rubyzip/rubyzip/pull/346), [#347](https://github.com/rubyzip/rubyzip/pull/347), [#350](https://github.com/rubyzip/rubyzip/pull/350), [#352](https://github.com/rubyzip/rubyzip/pull/352)
+- Several README improvements [#345](https://github.com/rubyzip/rubyzip/pull/345), [#326](https://github.com/rubyzip/rubyzip/pull/326), [#321](https://github.com/rubyzip/rubyzip/pull/321)
+
+# 1.2.1
+
+- Add accessor to @internal_file_attributes #304
+- Extended globbing #303
+- README updates #283, #289
+- Cleanup after tests #298, #306
+- Fix permissions on new zip files #294, #300
+- Fix examples #297
+- Support cp932 encoding #308
+- Fix Directory traversal vulnerability #315
+- Allow open_buffer to work without a given block #314
+
+# 1.2.0
+
+- Don't enable JRuby objectspace #252
+- Fixes an exception thrown when decoding some weird .zip files #248
+- Use duck typing with IO methods #244
+- Added error for empty (zero bit) zip file #242
+- Accept StringIO in Zip.open_buffer #238
+- Do something more expected with new file permissions #237
+- Case insensitivity option for #find_entry #222
+- Fixes in documentation and examples
+
+# 1.1.7
+
+- Fix UTF-8 support for comments
+- `Zip.sort_entries` working for zip output
+- Prevent tempfile path from being unlinked by garbage collection
+- NTFS Extra Field (0x000a) support
+- Use String#tr instead of String#gsub
+- Ability to not show warning about incorrect date
+- Be smarter about handling buffer file modes.
+- Support for Traditional Encryption (ZipCrypto)
+
+# 1.1.6
+
+- Revert "Return created zip file from Zip::File.open when supplied a block"
+
+# 1.1.5
+
+- Treat empty file as non-exists (@layerssss)
+- Revert regression commit
+- Return created zip file from Zip::File.open when supplied a block (@tpickett66)
+- Zip::Entry::DEFLATED is forced on every file (@mehmetc)
+- Add InputStream#ungetc (@zacstewart)
+- Alias for legacy error names (@orien)
+
+# 1.1.4
+
+- Don't send empty string to stream (@mrloop)
+- Zip::Entry::DEFLATED was forced on every file (@mehmetc)
+- Alias for legacy error names (@orien)
+
+# 1.1.3
+
+- Fix compatibility of ::OutputStream::write_buffer (@orien)
+- Clean up tempfiles from output stream (@iangreenleaf)
+
+# 1.1.2
+
+- Fix compatibility of ::Zip::File.write_buffer
+
+# 1.1.1
+
+- Speedup deflater (@loadhigh)
+- Less Arrays and Strings allocations (@srawlins)
+- Fix Zip64 writing support (@mrjamesriley)
+- Fix StringIO support (@simonoff)
+- Possibility to change default compression level
+- Make Zip64 write support optional via configuration
+
+# 1.1.0
+
+- StringIO Support
+- Zip64 Support
+- Better jRuby Support
+- Order of files in the archive can be sorted
+- Other small fixes
+
+# 1.0.0
+
+- Removed support for Ruby 1.8
+- Changed the API for gem. Now it can be used without require param in Gemfile.
+- Added read-only support for Zip64 files.
+- Added support for setting Unicode file names.
+
+# 0.9.9
+
+- Added support for backslashes in zip files (generated by the default Windows zip packer for example) and comment sections with the comment length set to zero even though there is actually a comment.
+
+# 0.9.8
+
+- Fixed: "Unitialized constant NullInputStream" error
+
+# 0.9.5
+
+- Removed support for loading ruby in zip files (ziprequire.rb).
+
+# 0.9.4
+
+- Changed ZipOutputStream.put_next_entry signature (API CHANGE!). Now allows comment, extra field and compression method to be specified.
+
+# 0.9.3
+
+- Fixed: Added ZipEntry::name_encoding which retrieves the character encoding of the name and comment of the entry.
+- Added convenience methods ZipEntry::name_in(enc) and ZipEntry::comment_in(enc) for getting zip entry names and comments in a specified character encoding.
+
+# 0.9.2
+
+- Fixed: Renaming an entry failed if the entry's new name was a different length than its old name. (Diego Barros)
+
+# 0.9.1
+
+- Added symlink support and support for unix file permissions. Reduced memory usage during decompression.
+- New methods ZipFile::[follow_symlinks, restore_times, restore_permissions, restore_ownership].
+- New methods ZipEntry::unix_perms, ZipInputStream::eof?.
+- Added documentation and test for new ZipFile::extract.
+- Added some of the API suggestions from sf.net #1281314.
+- Applied patch for sf.net bug #1446926.
+- Applied patch for sf.net bug #1459902.
+- Rework ZipEntry and delegate classes.
+
+# 0.5.12
+
+- Fixed problem with writing binary content to a ZipFile in MS Windows.
+
+# 0.5.11
+
+- Fixed name clash file method copy_stream from fileutils.rb. Fixed problem with references to constant CHUNK_SIZE.
+- ZipInputStream/AbstractInputStream read is now buffered like ruby IO's read method, which means that read and gets etc can be mixed. The unbuffered read method has been renamed to sysread.
+
+# 0.5.10
+
+- Fixed method name resolution problem with FileUtils::copy_stream and IOExtras::copy_stream.
+
+# 0.5.9
+
+- Fixed serious memory consumption issue
+
+# 0.5.8
+
+- Fixed install script.
+
+# 0.5.7
+
+- install.rb no longer assumes it is being run from the toplevel source dir. Directory structure changed to reflect common ruby library project structure. Migrated from RubyUnit to Test::Unit format. Now uses Rake to build source packages and gems and run unit tests.
+
+# 0.5.6
+
+- Fix for FreeBSD 4.9 which returns Errno::EFBIG instead of Errno::EINVAL for some invalid seeks. Fixed 'version needed to extract'-field incorrect in local headers.
+
+# 0.5.5
+
+- Fix for a problem with writing zip files that concerns only ruby 1.8.1.
+
+# 0.5.4
+
+- Significantly reduced memory footprint when modifying zip files.
+
+# 0.5.3
+
+- Added optimization to avoid decompressing and recompressing individual entries when modifying a zip archive.
+
+# 0.5.2
+
+- Fixed ZipFile corruption bug in ZipFile class. Added basic unix extra-field support.
+
+# 0.5.1
+
+- Fixed ZipFile.get_output_stream bug.
+
+# 0.5.0
+
+- Ruby 1.8.0 and ruby-zlib 0.6.0 compatibility
+- Changed method names from camelCase to rubys underscore style.
+- Installs to zip/ subdir instead of directly to site_ruby
+- Added ZipFile.directory and ZipFile.file - each method return an
+  object that can be used like Dir and File only for the contents of the
+  zip file.
+- Added sample application zipfind which works like Find.find, only
+  Zip::ZipFind.find traverses into zip archives too.
+- FIX: AbstractInputStream.each_line with non-default separator
+
+# 0.5.0a
+
+Source reorganized. Added ziprequire, which can be used to load ruby modules from a zip file, in a fashion similar to jar files in Java. Added gtk_ruby_zip, another sample application. Implemented ZipInputStream.lineno and ZipInputStream.rewind
+
+Bug fixes:
+
+- Read and write date and time information correctly for zip entries.
+- Fixed read() using separate buffer, causing mix of gets/readline/read to cause problems.
+
+# 0.4.2
+
+- Performance optimizations. Test suite runs in half the time.
+
+# 0.4.1
+
+- Windows compatibility fixes.
+
+# 0.4.0
+
+- Zip::ZipFile is now mutable and provides a more convenient way of modifying zip archives than Zip::ZipOutputStream. Operations for adding, extracting, renaming, replacing and removing entries to zip archives are now available.
+- Runs without warnings with -w switch.
+- Install script install.rb added.
+
+# 0.3.1
+
+- Rudimentary support for writing zip archives.
+
+# 0.2.2
+
+- Fixed and extended unit test suite. Updated to work with ruby/zlib 0.5. It doesn't work with earlier versions of ruby/zlib.
+
+# 0.2.0
+
+- Class ZipFile added. Where ZipInputStream is used to read the individual entries in a zip file, ZipFile reads the central directory in the zip archive, so you can get to any entry in the zip archive without having to skipping through all the preceeding entries.
+
+# 0.1.0
+
+- First working version of ZipInputStream.

data/README.md

@@ -2,31 +2,29 @@
 
 [![Gem Version](https://badge.fury.io/rb/rubyzip.svg)](http://badge.fury.io/rb/rubyzip)
 [![Tests](https://github.com/rubyzip/rubyzip/actions/workflows/tests.yml/badge.svg)](https://github.com/rubyzip/rubyzip/actions/workflows/tests.yml)
+[![Linter](https://github.com/rubyzip/rubyzip/actions/workflows/lint.yml/badge.svg)](https://github.com/rubyzip/rubyzip/actions/workflows/lint.yml)
 [![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip.svg)](https://codeclimate.com/github/rubyzip/rubyzip)
 [![Coverage Status](https://img.shields.io/coveralls/rubyzip/rubyzip.svg)](https://coveralls.io/r/rubyzip/rubyzip?branch=master)
 
 Rubyzip is a ruby library for reading and writing zip files.
 
-## Important note
-
-Rubyzip 2.4 is intended to be the last release in the 2.x series. Please get ready for version 3.0.
+## Important notes
 
 ### Updating to version 3.0
 
-The public API of some classes has been modernized to use named parameters for optional arguments. Also some methods have been changed or removed. Please check your usage of the following Rubyzip classes:
+The public API of some classes has been modernized to use named parameters for optional arguments. Please check your usage of the following Rubyzip classes:
 * `File`
 * `Entry`
 * `InputStream`
 * `OutputStream`
-* `DOSTime`
 
 **Please see [Updating to version 3.x](https://github.com/rubyzip/rubyzip/wiki/Updating-to-version-3.x) in the wiki for details.**
 
 ## Requirements
 
-Version 3.x requires at least Ruby 3.0.
+Version 3.x requires at least Ruby 2.5.
 
-Version 2.x requires at least Ruby 2.4, and is known to work on Ruby 3.x.
+Version 2.x requires at least Ruby 2.4, and is known to work on Ruby 3.1.
 
 It is not recommended to use any versions of Rubyzip earlier than 2.3 due to security issues.
 
@@ -57,7 +55,7 @@ input_filenames = ['image.jpg', 'description.txt', 'stats.csv']
 
 zipfile_name = "/Users/me/Desktop/archive.zip"
 
-Zip::File.open(zipfile_name, Zip::File::CREATE) do |zipfile|
+Zip::File.open(zipfile_name, create: true) do |zipfile|
   input_filenames.each do |filename|
     # Two arguments:
     # - The name of the file as it will appear in the archive
@@ -96,7 +94,7 @@ class ZipFileGenerator
   def write
     entries = Dir.entries(@input_dir) - %w[. ..]
 
-    ::Zip::File.open(@output_file, ::Zip::File::CREATE) do |zipfile|
+    ::Zip::File.open(@output_file, create: true) do |zipfile|
       write_entries entries, '', zipfile
     end
   end
@@ -129,9 +127,9 @@ class ZipFileGenerator
 end
 ```
 
-### Save zip archive entries in sorted by name state
+### Save zip archive entries sorted by name
 
-To save zip archives in sorted order like below, you need to set `::Zip.sort_entries` to `true`
+To save zip archives with their entries sorted by name (see below), set `::Zip.sort_entries` to `true`
 
 ```
 Vegetable/
@@ -145,7 +143,7 @@ fruit/mango
 fruit/orange
 ```
 
-After this, entries in the zip archive will be saved in ordered state.
+Opening an existing zip file with this option set will not change the order of the entries automatically. Altering the zip file - adding an entry, renaming an entry, adding or changing the archive comment, etc - will cause the ordering to be applied when closing the file.
 
 ### Default permissions of zip archives
 
@@ -181,28 +179,50 @@ Zip::File.open('foo.zip') do |zip_file|
 end
 ```
 
-#### Notice about ::Zip::InputStream
+### Notes on `Zip::InputStream`
+
+`Zip::InputStream` can be used for faster reading of zip file content because it does not read the Central directory up front.
 
-`::Zip::InputStream` usable for fast reading zip file content because it not read Central directory.
+There is one exception where it can not work however, and this is if the file does not contain enough information in the local entry headers to extract an entry. This is indicated in an entry by the General Purpose Flag bit 3 being set.
 
-But there is one exception when it is not working - General Purpose Flag Bit 3.
+> If bit 3 (0x08) of the general-purpose flags field is set, then the CRC-32 and file sizes are not known when the header is written. The fields in the local header are filled with zero, and the CRC-32 and size are appended in a 12-byte structure (optionally preceded by a 4-byte signature) immediately after the compressed data.
 
-> If bit 3 (0x08) of the general-purpose flags field is set, then the CRC-32 and file sizes are not known when the header is written. The fields in the local header are filled with zero, and the CRC-32 and size are appended in a 12-byte structure (optionally preceded by a 4-byte signature) immediately after the compressed data
+If `Zip::InputStream` finds such an entry in the zip archive it will raise an exception (`Zip::StreamingError`).
 
-If `::Zip::InputStream` finds such entry in the zip archive it will raise an exception.
+`Zip::InputStream` is not designed to be used for random access in a zip file. When performing any operations on an entry that you are accessing via `Zip::InputStream.get_next_entry` then you should complete any such operations before the next call to `get_next_entry`.
+
+```ruby
+zip_stream = Zip::InputStream.new(File.open('file.zip'))
+
+while entry = zip_stream.get_next_entry
+  # All required operations on `entry` go here.
+end
+```
+
+Any attempt to move about in a zip file opened with `Zip::InputStream` could result in the incorrect entry being accessed and/or Zlib buffer errors. If you need random access in a zip file, use `Zip::File`.
 
 ### Password Protection (Experimental)
 
 Rubyzip supports reading/writing zip files with traditional zip encryption (a.k.a. "ZipCrypto"). AES encryption is not yet supported. It can be used with buffer streams, e.g.:
 
 ```ruby
-Zip::OutputStream.write_buffer(::StringIO.new, Zip::TraditionalEncrypter.new('password')) do |out|
-  out.put_next_entry("my_file.txt")
-  out.write my_data
-end.string
+# Writing.
+enc = Zip::TraditionalEncrypter.new('password')
+buffer = Zip::OutputStream.write_buffer(encrypter: enc) do |output|
+  output.put_next_entry("my_file.txt")
+  output.write my_data
+end
+
+# Reading.
+dec = Zip::TraditionalDecrypter.new('password')
+Zip::InputStream.open(buffer, decrypter: dec) do |input|
+  entry = input.get_next_entry
+  puts "Contents of '#{entry.name}':"
+  puts input.read
+end
 ```
 
-This is an experimental feature and the interface for encryption may change in future versions.
+_This is an experimental feature and the interface for encryption may change in future versions._
 
 ## Known issues
 
@@ -216,7 +236,7 @@ buffer = Zip::OutputStream.write_buffer do |out|
     unless [DOCUMENT_FILE_PATH, RELS_FILE_PATH].include?(e.name)
       out.put_next_entry(e.name)
       out.write e.get_input_stream.read
-     end
+    end
   end
 
   out.put_next_entry(DOCUMENT_FILE_PATH)
@@ -296,25 +316,35 @@ Zip.validate_entry_sizes = false
 
 Note that if you use the lower level `Zip::InputStream` interface, `rubyzip` does *not* check the entry `size`s. In this case, the caller is responsible for making sure it does not read more data than expected from the input stream.
 
-### Default Compression
+### Compression level
 
-You can set the default compression level like so:
+When adding entries to a zip archive you can set the compression level to trade-off compressed size against compression speed. By default this is set to the same as the underlying Zlib library's default (`Zlib::DEFAULT_COMPRESSION`), which is somewhere in the middle.
+
+You can configure the default compression level with:
 
 ```ruby
-Zip.default_compression = Zlib::DEFAULT_COMPRESSION
+Zip.default_compression = X
 ```
 
-It defaults to `Zlib::DEFAULT_COMPRESSION`. Possible values are `Zlib::BEST_COMPRESSION`, `Zlib::DEFAULT_COMPRESSION` and `Zlib::NO_COMPRESSION`
+Where X is an integer between 0 and 9, inclusive. If this option is set to 0 (`Zlib::NO_COMPRESSION`) then entries will be stored in the zip archive uncompressed. A value of 1 (`Zlib::BEST_SPEED`) gives the fastest compression and 9 (`Zlib::BEST_COMPRESSION`) gives the smallest compressed file size.
+
+This can also be set for each archive as an option to `Zip::File`:
+
+```ruby
+Zip::File.open('foo.zip', create:true, compression_level: 9) do |zip|
+  zip.add ...
+end
+```
 
 ### Zip64 Support
 
-By default, Zip64 support is disabled for writing. To enable it do this:
+By default, Zip64 support is enabled for writing. To disable it do this:
 
 ```ruby
-Zip.write_zip64_support = true
+Zip.write_zip64_support = false
 ```
 
-_NOTE_: If you will enable Zip64 writing then you will need zip extractor with Zip64 support to extract archive.
+_NOTE_: If Zip64 write support is enabled then any extractor subsequently used may also require Zip64 support to read from the resultant archive.
 
 ### Block Form
 
@@ -329,15 +359,47 @@ You can set multiple settings at the same time by using a block:
   end
 ```
 
+## Compatibility
+
+Rubyzip is known to run on a number of platforms and under a number of different Ruby versions.
+
+### Version 2.3.x
+
+Rubyzip 2.3 is known to work on MRI 2.4 to 3.1 on Linux and Mac, and JRuby and Truffleruby on Linux. There are known issues with Windows which have been fixed on the development branch. Please [let us know](https://github.com/rubyzip/rubyzip/pulls) if you know Rubyzip 2.3 works on a platform/Ruby combination not listed here, or [raise an issue](https://github.com/rubyzip/rubyzip/issues) if you see a failure where we think it should work.
+
+### Next (version 3.0.0)
+
+Please see the table below for what we think the current situation is. Note: an empty cell means "unknown", not "does not work".
+
+| OS/Ruby | 2.5 | 2.6 | 2.7 | 3.0 | 3.1 | 3.1 +YJIT | Head | Head +YJIT | JRuby 9.3.2.0 | JRuby Head | Truffleruby 21.3.0 | Truffleruby Head |
+|---------|-----|-----|-----|-----|-----|----------|------|-----------|----------------|------------|--------------------|------------------|
+|Ubuntu 20.04.3| CI | CI | CI | CI | CI | ci | ci | ci | CI | ci | CI | ci |
+|Mac OS 11.6.2| CI | x | x | x | x | ci |  | ci | x |  | x |  |
+|Windows 10|  |  | x |  |  |  |  |  |  |  |  |  |
+|Windows Server 2019| CI |  |  |  |  |  |  |  |  |  |  |  |
+
+Key: `CI` - tested in CI, should work; `ci` - tested in CI, might fail; `x` - known working; `o` - known failing.
+
+Please [raise a PR](https://github.com/rubyzip/rubyzip/pulls) if you know Rubyzip works on a platform/Ruby combination not listed here, or [raise an issue](https://github.com/rubyzip/rubyzip/issues) if you see a failure where we think it should work.
+
 ## Developing
 
-To run the test you need to do this:
+Install the dependencies:
 
-```
+```shell
 bundle install
+```
+
+Run the tests with `rake`:
+
+```shell
 rake
 ```
 
+Please also run `rubocop` over your changes.
+
+Our CI runs on [GitHub Actions](https://github.com/rubyzip/rubyzip/actions). Please note that `rubocop` is run as part of the CI configuration and will fail a build if errors are found.
+
 ## Website and Project Home
 
 http://github.com/rubyzip/rubyzip
@@ -346,17 +408,30 @@ http://rdoc.info/github/rubyzip/rubyzip/master/frames
 
 ## Authors
 
-Alexander Simonov ( alex at simonov.me)
+See https://github.com/rubyzip/rubyzip/graphs/contributors for a comprehensive list.
 
-Alan Harper ( alan at aussiegeek.net)
+### Current maintainers
 
-Thomas Sondergaard (thomas at sondergaard.cc)
+* Robert Haines (@hainesr)
+* John Lees-Miller (@jdleesmiller)
+* Oleksandr Simonov (@simonoff)
 
-Technorama Ltd. (oss-ruby-zip at technorama.net)
+### Original author
 
-extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)
+* Thomas Sondergaard
 
 ## License
 
 Rubyzip is distributed under the same license as ruby. See
 http://www.ruby-lang.org/en/LICENSE.txt
+
+## Research notice
+Please note that this repository is participating in a study into sustainability
+ of open source projects. Data will be gathered about this repository for
+ approximately the next 12 months, starting from June 2021.
+
+Data collected will include number of contributors, number of PRs, time taken to
+ close/merge these PRs, and issues closed.
+
+For more information, please visit
+[our informational page](https://sustainable-open-science-and-software.github.io/) or download our [participant information sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).