zip_tricks 4.5.2 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ce4c704f1804988604b5d2f284ba0c4d3bc895d
-  data.tar.gz: a552adf97b21cffa0d060fd6932d143f5a0ee7a2
+  metadata.gz: 387773a063a44c69ac3da83da89fe85731c78331
+  data.tar.gz: 96d6763cc05e7c21f206ecaa013786f822df0d42
 SHA512:
-  metadata.gz: 9292155b3b566695087807d9ca31dbc359866996c45a7467bd1e365f3eb0f1b6789990dea7eba88fe901dcade7e1874903fe467e1cc523168963b771106c8c0e
-  data.tar.gz: d5e95f1279ba5437334531ba741af474271972d256491b6ac774e4354fc28409e0bb2df033569a9ee55cbbfd8895795cee98886e24e384df277bc468b9bd2597
+  metadata.gz: 80f07ed5042f76c6e0edf5843a4b51ee468bde57d5fc4ab28b0a53f9f819a1160e339126173ebbe306add30902ac69270d271e61c81aab5a3261098b5ed79b1c
+  data.tar.gz: 8203289c9445f009f65ccaa924a7b07f1ecb5257ac9cb4d7fc6ce7a2204e49ed125cba6c4d1345a933203aa61ab562fe2d40b3bab3db074fccc5141636eb8c2e

data/.rubocop.yml

@@ -1,82 +1,10 @@
-inherit_from: .rubocop_todo.yml
-
-Metrics/LineLength:
-  Max: 120
-
-AllCops:
-  Exclude:
-    - spec/**/*.rb
-    - zip_tricks.gemspec
-    - Gemfile
-    - Rakefile
-    - vendor/**/*
-    - julik_scratchpad/**/*
-
-Style/ClassAndModuleChildren:
-  Enabled:
-    false
-
-# "begin; ... rescue; end " without saying that we only rescue StandardError and below.
-# Can be debated, but I think it is reasonable to expect any Rubyist to know what errors
-# the standard rescue clause covers.
-Lint/RescueWithoutErrorClass:
-  Enabled: false
-
-Lint/AssignmentInCondition:
-  Enabled: false
-
-# We use % all over and nothing ever came out of it
-Style/FormatString:
+inherit_gem:
+  wetransfer_style: ruby/default.yml
+Layout/FirstMethodArgumentLineBreak:
   Enabled: false
-
-# We have classes with methods having long bodies. We apply a lot of literal small
-# operations which have to be applied in one locality specifically. Additionally,
-# class length is a bit of a boilerplate metric
-Metrics/ClassLength:
+Layout/FirstMethodParameterLineBreak:
   Enabled: false
-
-# Idem. We have quite some methods that do a lot of small writes/reads in rapid
-# succession - not because those methods have high cyclomatic complexity, but
-# because they perform a single operation consisting of many sequential small
-# ones.
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Exclude:
-    - examples/rack_application.rb
-    - lib/zip_tricks/file_reader.rb
-    - lib/zip_tricks/remote_io.rb
-    - lib/zip_tricks/streamer.rb
-    - testing/support.rb
-
-Metrics/BlockLength:
-  Exclude:
-    - lib/zip_tricks/file_reader.rb
-
-Layout/MultilineOperationIndentation:
-  Exclude:
-    - lib/zip_tricks/file_reader.rb
-
-Metrics/ParameterLists:
-  Exclude:
-    - lib/zip_tricks/streamer.rb
-
 Style/GlobalVars:
   Exclude:
-    - testing/generate_test_files.rb
-    - testing/support.rb
-
-# The advice this cop gives varies depending on the Ruby version,
-# so no - I will not be following two conflicting recommendations.
-Style/MutableConstant:
-  Enabled: false
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/ZeroLengthPredicate:
-  Enabled: false # Does not work for StringIOs
+      - qa/*.rb
+      - spec/spec_helper.rb

data/.travis.yml

@@ -1,14 +1,18 @@
 rvm:
 - 2.1
-- 2.2
-- 2.3.0
-- 2.4.1
+- 2.2.10
+- 2.3.7
+- 2.4.4
+- 2.5.1
 - jruby-9.0
 sudo: false
 cache: bundler
+before_install:
+  - gem update --system
+  - gem install bundler # https://github.com/travis-ci/travis-ci/issues/9333
 matrix:
   allow_failures:
     - rvm: jruby-9.0
 script:
-  - bundle exec rubocop -c .rubocop.yml --force-exclusion
   - bundle exec rspec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 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)
@@ -83,7 +95,7 @@
   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`
@@ -129,4 +141,4 @@
 
 ## 2.0.0 (Internal rel)
 
-* Implements streaming zip based on RubyZip
+* 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 behaviors 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 julik@wetransfer.com and/or noah@wetransfer.com. 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,151 @@
+# Contributing to zip_tricks
+
+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)
+ - [rspec](http://rspec.info/) (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_tricks/blob/master/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 `master` 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_tricks/blob/master/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_tricks.git
+   # Navigate to the newly cloned directory
+   cd zip_tricks
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream git@github.com:WeTransfer/zip_tricks.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>
+   ```
+
+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](https://github.com/WeTransfer/zip_tricks/blob/master/LICENSE.txt). 

data/README.md

@@ -167,7 +167,7 @@ that have not been formally verified (ours hasn't been).
 * Commit and push until you are happy with your contribution.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-* If you alter the `ZipWriter`, please take the time to run the test in the `testing/` directory and verify the generated files do open. You will need fast storage to run those tests.
+* If you alter the `ZipWriter`, please take the time to run the test in the `qa/` directory. Ensure that the generated (large) files open manually - see README_QA for more.
 
 ## Copyright
 

data/bench/buffered_crc32_bench.rb

@@ -0,0 +1,111 @@
+require 'bundler'
+Bundler.setup
+
+require 'benchmark'
+require 'benchmark/ips'
+require_relative '../lib/zip_tricks'
+
+n_bytes = 5 * 1024 * 1024
+r = Random.new
+bytes = (0...n_bytes).map { r.bytes(1) }
+buffer_sizes = [
+  1,
+  256,
+  512,
+  1024,
+  8 * 1024,
+  16 * 1024,
+  32 * 1024,
+  64 * 1024,
+  128 * 1024,
+  256 * 1024,
+  512 * 1024,
+  1024 * 1024,
+  2 * 1024 * 1024
+]
+
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+  buffer_sizes.each do |buf_size|
+    x.report "Single-byte <<-writes of #{n_bytes} using a #{buf_size} byte buffer" do
+      crc = ZipTricks::WriteBuffer.new(ZipTricks::StreamCRC32.new, buf_size)
+      bytes.each { |b| crc << b }
+      crc.to_i
+    end
+  end
+  x.compare!
+end
+
+__END__
+
+Warming up --------------------------------------
+Single-byte <<-writes of 5242880 using a 1 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 256 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 512 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 1024 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 8192 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 16384 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 32768 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 65536 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 131072 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 262144 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 524288 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 1048576 byte buffer
+                         1.000  i/100ms
+Single-byte <<-writes of 5242880 using a 2097152 byte buffer
+                         1.000  i/100ms
+Calculating -------------------------------------
+Single-byte <<-writes of 5242880 using a 1 byte buffer
+                          0.054  (± 0.0%) i/s -      1.000  in  18.383019s
+Single-byte <<-writes of 5242880 using a 256 byte buffer
+                          0.121  (± 0.0%) i/s -      1.000  in   8.286061s
+Single-byte <<-writes of 5242880 using a 512 byte buffer
+                          0.124  (± 0.0%) i/s -      1.000  in   8.038112s
+Single-byte <<-writes of 5242880 using a 1024 byte buffer
+                          0.128  (± 0.0%) i/s -      1.000  in   7.828562s
+Single-byte <<-writes of 5242880 using a 8192 byte buffer
+                          0.123  (± 0.0%) i/s -      1.000  in   8.121586s
+Single-byte <<-writes of 5242880 using a 16384 byte buffer
+                          0.127  (± 0.0%) i/s -      1.000  in   7.872240s
+Single-byte <<-writes of 5242880 using a 32768 byte buffer
+                          0.126  (± 0.0%) i/s -      1.000  in   7.911816s
+Single-byte <<-writes of 5242880 using a 65536 byte buffer
+                          0.126  (± 0.0%) i/s -      1.000  in   7.917318s
+Single-byte <<-writes of 5242880 using a 131072 byte buffer
+                          0.127  (± 0.0%) i/s -      1.000  in   7.897223s
+Single-byte <<-writes of 5242880 using a 262144 byte buffer
+                          0.130  (± 0.0%) i/s -      1.000  in   7.675608s
+Single-byte <<-writes of 5242880 using a 524288 byte buffer
+                          0.130  (± 0.0%) i/s -      1.000  in   7.679886s
+Single-byte <<-writes of 5242880 using a 1048576 byte buffer
+                          0.128  (± 0.0%) i/s -      1.000  in   7.788439s
+Single-byte <<-writes of 5242880 using a 2097152 byte buffer
+                          0.128  (± 0.0%) i/s -      1.000  in   7.797839s
+
+Comparison:
+Single-byte <<-writes of 5242880 using a 262144 byte buffer:        0.1 i/s
+Single-byte <<-writes of 5242880 using a 524288 byte buffer:        0.1 i/s - 1.00x  slower
+Single-byte <<-writes of 5242880 using a 1048576 byte buffer:        0.1 i/s - 1.01x  slower
+Single-byte <<-writes of 5242880 using a 2097152 byte buffer:        0.1 i/s - 1.02x  slower
+Single-byte <<-writes of 5242880 using a 1024 byte buffer:        0.1 i/s - 1.02x  slower
+Single-byte <<-writes of 5242880 using a 16384 byte buffer:        0.1 i/s - 1.03x  slower
+Single-byte <<-writes of 5242880 using a 131072 byte buffer:        0.1 i/s - 1.03x  slower
+Single-byte <<-writes of 5242880 using a 32768 byte buffer:        0.1 i/s - 1.03x  slower
+Single-byte <<-writes of 5242880 using a 65536 byte buffer:        0.1 i/s - 1.03x  slower
+Single-byte <<-writes of 5242880 using a 512 byte buffer:        0.1 i/s - 1.05x  slower
+Single-byte <<-writes of 5242880 using a 8192 byte buffer:        0.1 i/s - 1.06x  slower
+Single-byte <<-writes of 5242880 using a 256 byte buffer:        0.1 i/s - 1.08x  slower
+Single-byte <<-writes of 5242880 using a 1 byte buffer:        0.1 i/s - 2.39x  slower