zip_kit 6.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ff2f42664629263c431e566c3aacdce8172f3d2623bb5b18a0a57b8740bb600
+  data.tar.gz: '09fafbaf3a56c9200a48618fadaacbbfb44efb95cf802b089ecdd7b5de290774'
+SHA512:
+  metadata.gz: 16c5e3100a7f514212b93e4862dfd0e00da93158c251cb4e6491a56cf96769f5dee3f5cb194b0bb67e2b3ac6a62da7b2b490509225735fa3374fdeb0394da6df
+  data.tar.gz: c56e949d2a7ec86dfbbd3fbea70494756e19059cae897be417e34ee2dbb6532a203488ff5b7cb716e2dd400b2222bb3d3232743822fcef73b0ce2b3c21bcb97b

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+engines:
+  rubocop:
+    enabled: true
+    
+ratings:
+   paths:
+   - "**.rb"

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  - push
+
+env:
+  BUNDLE_PATH: vendor/bundle
+
+jobs:
+  test:
+    name: Tests and Lint
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        ruby:
+          - '2.6'
+          - '3.2'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: "Tests"
+        run: bundle exec rspec --backtrace --fail-fast
+      - name: "Lint"
+        run: bundle exec rake standard

data/.gitignore

@@ -0,0 +1,61 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# Rubocop
+rubocop.html
+
+# bundler
+.bundle
+Gemfile.lock
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+tmp
+testing/*.zip
+.ruby-version
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
+# Rubocop report
+rubocop.html
+

data/.rspec

@@ -0,0 +1 @@
+--color

data/.standard.yml

@@ -0,0 +1,8 @@
+ruby_version: 2.7
+ignore:
+  - 'spec/**/*':
+    - Lint/ConstantDefinitionInBlock
+    - Style/GlobalVars
+  - 'lib/zip_kit/rack_body.rb': # Erroneous detection
+    - Lint/OrderedMagicComments
+    - Layout/EmptyLineAfterMagicComment

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG.md

@@ -0,0 +1,255 @@
+## 6.0
+
+* Remove `RackBody` because it is just `OutputEnumerator`. Add a convenience method for Rack response generation.
+* Rebirth as zip_kit
+* Adopt MIT license. The changes from 5.x get grandfathered in. The base for the fork is the 4.x version which was still MIT-licensed.
+* Bump minimum Ruby version to 2.6
+* Respond to `#write` in all objects that respond to `#<<`, because they should be usable with `IO.copy_stream`
+* Allow the last file to be suppressed in the central directory via Streamer#rollback!
+* Allow heuristic compression. Use `Streamer#write_file` to let zip_kit pick the right compression method for you. If a file will benefit from
+  compression, it is going to be written deflated. If it will not - it will be written stored. Evaluation is based on the first 128KB of the file contents.
+* Make RackBody future-proof for Rack 3.x by adding a chunked body encoder
+* Fix Rails buffering the response unexpectedly, which could happen due to either of wrong content encoding, HTTP/1.0 protocol being requested or the Rack::ETag
+* Allow objects that only respond to `#write` as streaming destination. The Rails `stream` object in ActionController::Live is like that.
+* Fix uses of `Time.now` in tests for Ruby 3 compatibility
+
+# zip_tricks version history
+
+## 5.6.0
+
+* Add customisable `unix_permissions` to Streamer and ZipWriter. Beware that customising these permissions can lead to the archive failing to expand with some unarchiving applications, and is especially sensitive for directories.
+
+## 5.5.0
+
+* In `OutputEnumerator` apply some amount of buffering to be within a UNIX socket size for metatada writes. This
+  speeds up usage with Puma by about 20 percent, as there won't be as many `syswrite` calls on the socket.
+* Make `StoredWriter` and `DeflatedWriter` public constants so that standalone tests can be written for them
+
+## 5.4.0
+
+* Use block form for zlib Deflater calls to conserve memory
+* Do not change string encoding in writer wrappers (avoid extra work)
+* Fix a zlib deflater object being leaked per archived file
+* Speed up streaming CRC32 computation
+* When running tests, assign the port for the Puma server dynamically
+* Reduce string allocations in the block deflate spec
+* Make sure RemoteUncap specs run under JRuby correctly
+* Replace Rails::Live streaming with iterable body streaming to avoid issues with Rails::Live across the board
+* Remove `qa/` directory and scripts, as the tests for the library proper should now be sufficient
+* Fix some documentation and sample code omissions and inconsistencies.
+
+## 5.3.1
+
+* Fix extended timestamp timestamp value encoding. Previously we would use an incorrect encoding for the timestamp value, which would output correct but nonsensical timestamps. The pack specifier is now changed to output the correct value.
+
+## 5.3.0
+
+* Raise in `Streamer#close` when the IO offset of the Streamer does not match the size of the written entries. This is a situation which
+  can occur if one adds the local headers, writes the bodies of the files to the socket/output directly, and forgets to adjust the internal
+  Streamer offset. The unadjusted offset would then produce incorrect values in both the local headers which come after the missing
+  offset adjustment _and_ in the central directory headers. Some ZIP unarchivers are able to recover from this (ones that read
+  files "straight-ahead" but others aren't - if the ZIP unarchiver uses central directory entries it would be using incorrect offsets.
+  Instead of producing an invalid ZIP, raise an exception which explains what happened and how it can be resolved.
+
+## 5.2.0
+
+* Remove `Streamer#add_compressed_entry` and `SizeEstimator#add_compressed_entry`
+
+## 5.1.1
+
+* Fix extended timestamp extra field output. The first bit of the flag would be set instead of the last bit of
+  the flag, which made it impossible for Rubyzip to read the timestamp of the entry - and it would also make
+  the extra field useless for most reading applications.
+
+## 5.1.0
+
+* Slightly rework `RemoteIO` and `RemoteUncap` and make sure they work correctly by spinning up a test webserver
+  to verify their operation. The changes to the documented API are fairly small so this is still marked as a minor
+  release.
+
+## 5.0.0
+
+* Disable automatic filename deduplication by default, because it does not play nice with file/directory
+  clobbering. The option can still be enabled by passing `auto_rename_duplicate_filenames: true` to the Streamer
+  and all modules that use it
+* Adopt [Hippocratic license v. 1.2](https://firstdonoharm.dev/version/1/2/license.html)
+  Note that this might make the license conditions unacceptable for your project. If that is the case,
+  you can use the 4.x branch of the library which stays under the original, exact MIT license.
+
+## 4.8.0
+
+* Make sure that when directories clobber files and vice versa we raise a clear error. Add `PathSet` which keeps track of entries
+  and all the directories needed to create them, document `PathSet`
+* Move the `uniquify_filenames` function into a module for easier removal later
+* Add the `auto_rename_duplicate_filenames` parameter to `Streamer` constructor. We need to make this optional
+  because making filenames unique can be very tricky when subdirectories are involved, and strictly
+  speaking we should not be applying this transformation at all - there should be no output of
+  duplicate filenames by the caller. So making the filenames should be available, but optional.
+
+## 4.7.4
+
+* Use a single fixed capacity string in `StreamCRC32.from_io` to avoid unnecessary allocations
+* Fix a few tests that were calling out to external binaries
+
+## 4.7.3
+
+* Fix `RemoteUncap#request_object_size` to function correctly
+
+## 4.7.2
+
+* Relax bundler dependency so that both bundler 1.x and 2.x are supported cleanly
+
+## 4.7.1
+
+* Bump rubyzip to 1.2.2 to mitigate CVE-2018-1000544
+
+## 4.7.0
+
+* Replace `RackBody` with `OutputEnumerator` since we want to provide a generic way of deferring ZIP output, also when using enumerators.
+* Remove `RackBody#close` since we got nothing to close 🤷‍♂️
+* Hint nginx that response buffering should be disabled when using Rails zip streaming
+
+## 4.6.0
+
+* Add `mtime:` option to all Streamer methods for adding files and directories, to permit setting modification time per-entry
+* Optimize EOCD signature lookup when reading archives
+* Reformat using the [we_transfer_style](https://rubygems.org/gems/we_transfer_style) Rubocop rules and conventions
+* Add code of conduct and contribution guidelines
+* Reduce the size of the CRC32 buffer to 64KB (backed by a benchmark), extract buffering into a wrapper proxy
+
+## 4.5.2
+
+* Replace the incorrectly used `file` type for empty directory entries with the appropriate `directory` type
+
+## 4.5.1
+
+* Speed up CRC32 calculation using a buffer of 5MB (have to combine CRCs less often)
+
+## 4.5.0
+
+* Rename `Streamer#add_compressed_entry` and `SizeEstimator#add_compressed_entry` to `add_deflated_entry`
+  to indicate the type of compression that is going to get used.
+* Make  `Streamer#write_(deflated|stored)_file` return a writable object that can be `.close`d, to
+  permit usage of those methods in situations where suspending a block is inconvenient (make deferred writing possible).
+* Fix CRC32 checksums in `Streamer#write_deflated_file`
+* Add `Streamer#update_last_entry_and_write_data_descriptor` to permit externally-driven flows that use data descriptors
+
+## 4.4.2
+
+* Add 2.4 to Travis rubies
+* Fix a severe performance degradation in Streamer with large file counts (https://github.com/WeTransfer/zip_kit/pull/14)
+
+## 4.4.1
+
+* Tweak documentation a little
+
+## 4.4.0
+
+* Add `Streamer#add_empty_directory_entry` for writing empty directories/folders into the ZIP
+
+## 4.3.0
+
+* Add a native Rails streaming module for easier integration of ZipKit into Rails controllers
+
+## 4.2.4
+
+* Get rid of Jeweler in favor of the standard Bundler/rubygems gem tasks
+
+## 4.2.3
+
+* Instead of BlockWrite, use intrim flushes of the same zlib Deflater
+
+## 4.2.2
+
+* Rewrite small data writes to perform less calls to `pack`
+
+## 4.2.1
+
+* Uniquify filenames during writes, so that the caller doesn't have to.
+
+## 4.2.0
+
+* Make it possible to swap the destination for Streamer writes, to improve `Range` support in the
+  download server. Sometimes it might be useful to actually "redirect" the output to a different IO
+  or buffer, without having to provide our own implementation of this switching.
+
+## 4.1.0
+
+* Implement brute-force straight-ahead reading of local file headers, for damaged or
+  incomplete ZIP files
+
+## 4.0.0
+
+* Make reading local headers optional, since we need it but we don't have to use it for all archives. Ideally
+  we should only do it when a reasonable central directory cannot be found. This can also happen under normal
+  usage, when we are dealing with a ZIP-within-a-ZIP or when the end of the ZIP file has been truncated on
+  write.
+* Make sure `Writable#write` returns the number of bytes written (fix `IO.copy_stream` compatibility)
+
+## 3.1.1
+
+* Fix reading Zip64 extra fields. Only read fields that have corresponding "normal" fields set to overflow value.
+
+## 3.1.0
+
+* Fix `FileReader` failing where the EOCD marker would be detected multiple times at the end of a ZIP, which
+  is something that _can_ happen during normal usage - a byte pattern has to appear twice to trigger the bug.
+* Add support for archive comment customization
+
+## 2.8.1
+
+* Fix the bug with older versions of The Unarchiver refusing to open our Zip64 files
+
+## 2.8.0
+
+* Replace RubyZip with a clean-room ZIP writer, due to the overly elaborate Java-esque structure of RubyZip being hostile
+  to modifications. The straw that broke the camel's back in this case is the insistence of RubyZip on writing out padding
+  for the Zip64 extra fields in the local entries that it would never replace with useful data, which was breaking unarchiving
+  when using Windows Explorer.
+
+## 2.7.0
+
+* Add `Streamer#write` so that the Streamer can be used as argument to `IO.copy_stream`
+
+## 2.6.1
+
+* Fi 0-byte reads in RemoteIO of RemoteUncap
+
+## 2.6.0
+
+* Set up open-source facilities (Github, Travis CI...)
+* Add RemoteUncap for listing ZIP archives located on HTTP servers without having to download them.
+  RemoteUncap downloads the central directory only using HTTP `Range` headers.
+
+## 2.5.0
+
+* Add Manifest for building a map of the ZIP file (for later Range support)
+
+## 2.4.3  (Internal rel)
+
+* Extract [very_tiny_state_machine](https://rubygems.org/gems/very_tiny_state_machine) gem from ZipKit
+
+## 2.4.1  (Internal rel)
+
+* Include StreamCRC32 in the README
+
+## 2.3.1  (Internal rel)
+
+* Restore a streaming CRC facility
+
+## 2.2.1  (Internal rel)
+
+* Ensure WriteAndTell plays nice with strings in other encodings than BINARY
+
+## 2.2.0  (Internal rel)
+
+* Fix bytes_written return from deflate_in_blocks
+* Raise on invalid Streamer IO arguments
+* Set the EFS flag for UTF-8 filenames
+* Add a RackBody object for plugging ZipKit into Rack
+* Add an offset wrapper for IOs given to Streamer, to support size estimation
+* Ensure the given compression level is supported
+
+## 2.0.0 (Internal rel)
+
+* Implements streaming zip based on RubyZip

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at me@julik.nl. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,153 @@
+# Contributing to zip_kit
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of
+the developers managing and developing this open source project. In return,
+they should reciprocate that respect in addressing your issue or assessing
+patches and features.
+
+## What do I need to know to help?
+
+If you are already familiar with the [Ruby Programming Language](https://www.ruby-lang.org/) you can start contributing code right away, otherwise look for issues labeled with *documentation* or *good first issue* to get started.
+
+If you are interested in contributing code and would like to learn more about the technologies that we use, check out the (non-exhaustive) list below. You can also get in touch with us via an issue or email to get additional information.
+
+ - [ruby](https://ruby-doc.org)
+ - [rubyzip](https://github.com/rubyzip/rubyzip) as we like to test "our implementation against theirs"
+ - [rspec](http://rspec.info/) and [appraisal]() https://github.com/thoughtbot/appraisal) for testing
+ - [zip files](https://en.wikipedia.org/wiki/Zip_(file_format))
+
+# How do I make a contribution?
+
+## Using the issue tracker
+
+The issue tracker is the preferred channel for [bug reports](#bug-reports),
+[feature requests](#feature-requests) and [submitting pull
+requests](#pull-requests), but please respect the following restrictions:
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. Adhere to the principles set out in the [Code of Conduct](https://github.com/WeTransfer/zip_kit/blob/main/CODE_OF_CONDUCT.md).
+
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by code in the repository.
+
+Good bug reports are extremely helpful-thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** — check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** — try to reproduce it using the
+   latest `main` branch in the repository.
+
+3. **Isolate the problem** — create a [reduced test
+   case](http://css-tricks.com/reduced-test-cases/) and a live example.
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What tool(s) or OS will
+experience the problem? What would you expect to be the outcome? All these
+details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the OS environment in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` - a link to the reduced test case, if possible. Feel free to use a [Gist](https://gist.github.com).
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's developers of the merits of this feature. Please
+provide as much detail and context as possible.
+
+
+## Pull requests
+
+Good pull requests-patches, improvements, new features-are a fantastic
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code, porting to a different language),
+otherwise you risk spending a lot of time working on something that the
+project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout the project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+The project uses Rubocop which can be run using `bundle exec rubocop`. The test
+suite can be run with `bundle exec rspec`. You are also encouraged to use the
+script in the `testing` directory to create test files that you can then verify
+with various zip/unzip utilities. Further instructions are [here](https://github.com/WeTransfer/zip_kit/blob/main/testing/README_TESTING.md).  
+
+Follow this process if you'd like your work considered for inclusion in the
+project:
+
+1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone git@github.com:WeTransfer/zip_kit.git
+   # Navigate to the newly cloned directory
+   cd zip_kit
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream git@github.com:WeTransfer/zip_kit.git
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout <dev-branch>
+   git pull upstream <dev-branch>
+   ```
+
+3. Create a new topic branch (off the main project development branch) to
+   contain your feature, change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks and/or squash them for readability and
+   conciseness. Check out [this post](https://chris.beams.io/posts/git-commit/) or
+   [this other post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for some tips re: writing good commit messages.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream <dev-branch>
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+   Make sure to run `bundle exec appraisal rspec` to make sure your changes are compatible with all the Rails versions we support.
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project, which you
+can see by clicking [here](LICENSE.txt). 

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zip_kit.gemspec
+gemspec