zip_tricks 4.5.2 → 4.6.0

data/qa/README_QA.md

@@ -0,0 +1,16 @@
+## Manual testing harness for ZipTricks
+
+These tests will generate **very large** files that test various edge cases of ZIP generation. The idea is to generate
+these files and to then try to open them with the unarchiver applications we support. The workflow is as follows:
+
+
+1. Configure your storage to have `zip_tricks` directory linked into your virtual machines and to be on a fast volume (SSD RAID0 is recommended)
+2. Run `generate_test_files.rb`. This will take some time and produce a number of large ZIP files.
+3. Open them with the following ZIP unarchivers:
+  * A recent version of `zipinfo` with the `-tlhvz` flags - to see the information about the file
+  * ArchiveUtility on OSX
+  * The Unarchiver on OSX
+  * Built-in Explorer on Windows 7
+  * 7Zip 9.20 on Windows 7
+  * Any other unarchivers you consider necessary
+* Write down your observations in `test-report.txt` and, when cutting a release, timestamp a copy of that file.

data/{testing → qa}/support.rb

@@ -40,9 +40,9 @@ def build_test(test_description)
   $tests_performed += 1
 
   test_file_base = test_description.downcase.delete('-').gsub(/[\s\:]+/, '_')
-  filename = format('%02d-%s.zip', $tests_performed, test_file_base)
+  filename = '%<tests_performed>02d-%<test_file>s.zip' % {tests_number: $tests_performed, test_file: test_file_base}
 
-  puts format('Test %02d: %s', $tests_performed, test_description)
+  puts 'Test %<tests_number>02d: %<description>s' % {tests_number: $tests_performed, description: test_description}
   puts filename
   puts ''
 
@@ -75,7 +75,7 @@ def prepare_test_protocol
       f.puts ''
       table = Terminal::Table.new title: platform_name, headings: %w[Test Outcome]
       $test_descs.each_with_index do |desc, i|
-        test_name = [desc.filename, format('%s', desc.title)].join("\n")
+        test_name = [desc.filename, '%<title>s' % {title: desc.title}].join("\n")
         outcome = ' ' * 64
         table << [test_name, outcome]
         table << :separator if i < ($test_descs.length - 1)

data/zip_tricks.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'zip_tricks/version'
@@ -41,6 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'complexity_assert'
   spec.add_development_dependency 'coderay'
+  spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'yard', '~> 0.9'
-  spec.add_development_dependency 'rubocop', '0.51.0' # No conforming to arbitrary rules that _change_ underneath you
+  spec.add_development_dependency 'wetransfer_style', '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zip_tricks
 version: !ruby/object:Gem::Version
-  version: 4.5.2
+  version: 4.6.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +165,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: wetransfer_style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.5.0
 description: Stream out ZIP files from Ruby
 email:
 - me@julik.nl
@@ -176,15 +190,17 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - IMPLEMENTATION_DETAILS.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench/buffered_crc32_bench.rb
 - examples/archive_size_estimate.rb
 - examples/config.ru
 - examples/parallel_compression_with_block_deflate.rb
@@ -209,16 +225,17 @@ files:
 - lib/zip_tricks/streamer/writable.rb
 - lib/zip_tricks/version.rb
 - lib/zip_tricks/write_and_tell.rb
+- lib/zip_tricks/write_buffer.rb
 - lib/zip_tricks/zip_writer.rb
-- testing/README_TESTING.md
-- testing/generate_test_files.rb
-- testing/in/VTYL8830.jpg
-- testing/in/war-and-peace.txt
-- testing/support.rb
-- testing/test-report-2016-07-28.txt
-- testing/test-report-2016-12-12.txt
-- testing/test-report-2017-04-2.txt
-- testing/test-report.txt
+- qa/README_QA.md
+- qa/generate_test_files.rb
+- qa/in/VTYL8830.jpg
+- qa/in/war-and-peace.txt
+- qa/support.rb
+- qa/test-report-2016-07-28.txt
+- qa/test-report-2016-12-12.txt
+- qa/test-report-2017-04-2.txt
+- qa/test-report.txt
 - zip_tricks.gemspec
 homepage: http://github.com/wetransfer/zip_tricks
 licenses: []
@@ -240,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Stream out ZIP files from Ruby

data/.rubocop_todo.yml

@@ -1,43 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-09-11 13:38:55 +0200 using RuboCop version 0.49.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 6
-Lint/UselessAssignment:
-  Exclude:
-    - 'lib/zip_tricks/streamer.rb'
-    - 'spec/zip_tricks/block_deflate_spec.rb'
-    - 'spec/zip_tricks/file_reader_spec.rb'
-    - 'spec/zip_tricks/remote_uncap_spec.rb'
-    - 'spec/zip_tricks/stream_crc32_spec.rb'
-    - 'spec/zip_tricks/streamer_spec.rb'
-
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 8
-
-# Offense count: 4
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/zip_tricks/block_deflate.rb'
-    - 'lib/zip_tricks/block_write.rb'
-    - 'lib/zip_tricks/file_reader.rb'
-    - 'lib/zip_tricks/streamer/deflated_writer.rb'
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/zip_tricks/file_reader.rb'
-
-# Offense count: 2
-Style/StructInheritance:
-  Exclude:
-    - 'lib/zip_tricks/streamer/entry.rb'
-    - 'spec/zip_tricks/zip_writer_spec.rb'

data/testing/README_TESTING.md

@@ -1,12 +0,0 @@
-## The _actual_ testing for ZipTricks
-
-Consists of a fairly straightforward procedure.
-
-1. Run `generate_test_files.rb`. This will take some time and produce a number of ZIP files.
-2. Open them with the following ZIP unarchivers:
-  * A recent version of `zipinfo` with the `-tlhvz` flags - to see the information about the file
-  * ArchiveUtility on OSX
-  * The Unarchiver on OSX
-  * Built-in Explorer on Windows 7
-  * 7Zip 9.20 on Windows 7
-* Write down your observations in `test-report.txt` and, when cutting a release, timestamp a copy of that file.