zip_tricks 4.8.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8147080f700510b88cb5e807e61ac71caf94e4b35af7a13162f3fcb0557b221
-  data.tar.gz: 507c345c51f13b2874577497359f49179447b494eacf55f81c6a0b182feeb97a
+  metadata.gz: 327b846ccfc7d19442d21e145a2f767da91f0547381afe52be27db6709dee4a4
+  data.tar.gz: 4d80718a715063f1cebad32471ab83e77d38a805f3ceed82793b922d0d3a877f
 SHA512:
-  metadata.gz: 328483359ec8a1ced39c3cdc4b853d0fadda7a2c66e1d36e0babc3e701648e57b212b85b5adf6cc24fc92d63eff28889216b11438252f8d1e32d9bdfbb1acaab
-  data.tar.gz: 99d3e5e9a31ab39ae1bbf39128a086373eadb29a44dee76fc4674eb73ad96ed9c190ca50d9d7227b16f6421d01b2603026386d0e16260eec33f417fd68f85e58
+  metadata.gz: 982bc310eb658d67262c28efb043f1ddd3957db197ef1bcbe9108f3572431211069843221d36cf9b28231617d899249ad06be5b9c756189e8f0d383b168a340f
+  data.tar.gz: 40fdde09881e02b5a816dae826554e14d76fb26a1bcf09cfcd053450668b34e2d3c63dc5bbf84417b6bdc44f021a35d38fdabd08d9ace5aabe1ff6c335b65e49

data/CHANGELOG.md

@@ -1,17 +1,11 @@
-## 4.8.3
-
-* Fix a leak of 1 zlib deflater object per deflated file when writing out compressed files with data descriptors. The deflater
-  needs to be closed explicitly, which we weren't previously doing.
-
-## 4.8.2
-
-* 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.
-
-## 4.8.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.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
 

data/LICENSE.txt

@@ -8,8 +8,28 @@ distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+* The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+* No Harm: The software may not be used by anyone for systems or
+  activities that actively and knowingly endanger, harm, or otherwise
+  threaten the physical, mental, economic, or general well-being of
+  other individuals or groups, in violation of the United Nations
+  Universal Declaration of Human Rights
+  (https://www.un.org/en/universal-declaration-human-rights/).
+
+* Services: If the Software is used to provide a service to others, the
+  licensee shall, as a condition of use, require those others not to use
+  the service in any way that violates the No Harm clause above.
+
+* Enforceability: If any portion or provision of this License shall to
+  any extent be declared illegal or unenforceable by a court of
+  competent jurisdiction, then the remainder of this License, or the
+  application of such portion or provision in circumstances other than
+  those as to which it is so declared illegal or unenforceable, shall
+  not be affected thereby, and each portion and provision of this
+  Agreement shall be valid and enforceable to the fullest extent
+  permitted by law.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
@@ -18,3 +38,7 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This Hippocratic License is an Ethical Source license
+(https://ethicalsource.dev) derived from the MIT License, amended to
+limit the impact of the unethical use of open source software.

data/README.md

@@ -1,6 +1,7 @@
 # zip_tricks
 
-[![Build Status](https://travis-ci.org/WeTransfer/zip_tricks.svg?branch=backports-v4)](https://travis-ci.org/WeTransfer/zip_tricks)
+[![Build Status](https://travis-ci.org/WeTransfer/zip_tricks.svg?branch=master)](https://travis-ci.org/WeTransfer/zip_tricks)
+[![Gem Version](https://badge.fury.io/rb/zip_tricks.svg)](https://badge.fury.io/rb/zip_tricks)
 
 Allows streaming, non-rewinding ZIP file output from Ruby.
 
@@ -177,4 +178,5 @@ that have not been formally verified (ours hasn't been).
 
 ## Copyright
 
-Copyright (c) 2019 WeTransfer. See LICENSE.txt for further details.
+Copyright (c) 2019 WeTransfer. `zip_tricks` is distributed under the conditions of the [Hippocratic License](https://firstdonoharm.dev/version/1/2/license.html)
+ - See LICENSE.txt for further details.

data/lib/zip_tricks/streamer.rb

@@ -141,11 +141,9 @@ class ZipTricks::Streamer
   # @param writer[ZipTricks::ZipWriter] the object to be used as the writer.
   #    Defaults to an instance of ZipTricks::ZipWriter, normally you won't need to override it
   # @param auto_rename_duplicate_filenames[Boolean] whether duplicate filenames, when encountered,
-  #    should be suffixed with (1), (2) etc. Default value is `true` since it
-  #    used to be the default behavior.
-  #
-  # **DEPRECATION NOTICE** In ZipTricks version 5 `auto_rename_duplicate_filenames` will default to `false`
-  def initialize(stream, writer: create_writer, auto_rename_duplicate_filenames: true)
+  #    should be suffixed with (1), (2) etc. Default value is `false` - if
+  #    dupliate names are used an exception will be raised
+  def initialize(stream, writer: create_writer, auto_rename_duplicate_filenames: false)
     raise InvalidOutput, 'The stream must respond to #<<' unless stream.respond_to?(:<<)
 
     @dedupe_filenames = auto_rename_duplicate_filenames

data/lib/zip_tricks/streamer/deflated_writer.rb

@@ -50,8 +50,6 @@ class ZipTricks::Streamer::DeflatedWriter
   def finish
     @compressed_io << @deflater.finish until @deflater.finished?
     {crc32: @crc.to_i, compressed_size: @compressed_io.tell, uncompressed_size: @uncompressed_size}
-  ensure
-    @deflater.close
   end
 
   private

data/lib/zip_tricks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipTricks
-  VERSION = '4.8.3'
+  VERSION = '5.0.0'
 end

data/lib/zip_tricks/zip_writer.rb

@@ -57,7 +57,7 @@ class ZipTricks::ZipWriter
   C_UINT2 = 'v'    # Encode a 2-byte unsigned little-endian uint
   C_UINT8 = 'Q<'  # Encode an 8-byte unsigned little-endian uint
   C_CHAR = 'C' # For bit-encoded strings
-  C_INT4 = 'l<' # Encode a 4-byte signed little-endian int
+  C_INT4 = 'N' # Encode a 4-byte signed little-endian int
 
   private_constant :FOUR_BYTE_MAX_UINT,
                    :TWO_BYTE_MAX_UINT,
@@ -118,7 +118,7 @@ class ZipTricks::ZipWriter
     if requires_zip64
       extra_fields << zip_64_extra_for_local_file_header(compressed_size: compressed_size, uncompressed_size: uncompressed_size)
     end
-    extra_fields << timestamp_extra_for_local_file_header(mtime)
+    extra_fields << timestamp_extra(mtime)
 
     io << [extra_fields.size].pack(C_UINT2)                # extra field length              2 bytes
 
@@ -182,7 +182,7 @@ class ZipTricks::ZipWriter
                                                                      compressed_size: compressed_size,
                                                                      uncompressed_size: uncompressed_size)
     end
-    extra_fields << timestamp_extra_for_central_directory_entry(mtime)
+    extra_fields << timestamp_extra(mtime)
 
     io << [extra_fields.size].pack(C_UINT2)                 # extra field length              2 bytes
 
@@ -345,14 +345,12 @@ class ZipTricks::ZipWriter
     pack_array(data_and_packspecs)
   end
 
-  # Writes the extended timestamp information field for local headers.
-  #
-  # The spec defines 2
+  # Writes the extended timestamp information field. The spec defines 2
   # different formats - the one for the local file header can also accomodate the
   # atime and ctime, whereas the one for the central directory can only take
   # the mtime - and refers the reader to the local header extra to obtain the
   # remaining times
-  def timestamp_extra_for_local_file_header(mtime)
+  def timestamp_extra(mtime)
     #         Local-header version:
     #
     #         Value         Size        Description
@@ -380,21 +378,16 @@ class ZipTricks::ZipWriter
     #       bit 1           if set, access time is present
     #       bit 2           if set, creation time is present
     #       bits 3-7        reserved for additional timestamps; not set
-    flags = 0b00000001 # Set the lowest bit only, to indicate that only mtime is present
+    flags = 0b10000000 # Set bit 1 only to indicate only mtime is present
     data_and_packspecs = [
       0x5455, C_UINT2,  # tag for this extra block type ("UT")
-      (1 + 4), C_UINT2, # the size of this block (1 byte used for the Flag + 3 longs used for the timestamp)
+      (1 + 4), C_UINT2, # the size of this block (1 byte used for the Flag + 1 long used for the timestamp)
       flags, C_CHAR,   # encode a single byte
-      mtime.utc.to_i, C_INT4, # Use a signed int, not the unsigned one used by the rest of the ZIP spec.
+      mtime.utc.to_i, C_INT4, # Use a signed long, not the unsigned one used by the rest of the ZIP spec.
     ]
-    # The atime and ctime can be omitted if not present
     pack_array(data_and_packspecs)
   end
 
-  # Since we do not supply atime or ctime, the contents of the two extra fields (central dir and local header)
-  # is exactly the same, so we can use a method alias.
-  alias_method :timestamp_extra_for_central_directory_entry, :timestamp_extra_for_local_file_header
-
   # Writes the Zip64 extra field for the central directory header.It differs from the extra used in the local file header because it
   # also contains the location of the local file header in the ZIP as an 8-byte int.
   #

data/zip_tricks.gemspec

@@ -5,9 +5,10 @@ require 'zip_tricks/version'
 Gem::Specification.new do |spec|
   spec.name           = 'zip_tricks'
   spec.version        = ZipTricks::VERSION
-  spec.authors        = ['Julik Tarkhanov']
+  spec.authors        = ['Julik Tarkhanov', 'Noah Berman', 'Dmitry Tymchuk', 'David Bosveld']
   spec.email          = ['me@julik.nl']
 
+  spec.licenses       = ['MIT (Hippocratic)']
   spec.summary        = 'Stream out ZIP files from Ruby'
   spec.description    = 'Stream out ZIP files from Ruby'
   spec.homepage       = 'http://github.com/wetransfer/zip_tricks'

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: zip_tricks
 version: !ruby/object:Gem::Version
-  version: 4.8.3
+  version: 5.0.0
 platform: ruby
 authors:
 - Julik Tarkhanov
+- Noah Berman
+- Dmitry Tymchuk
+- David Bosveld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -256,7 +259,8 @@ files:
 - qa/test-report.txt
 - zip_tricks.gemspec
 homepage: http://github.com/wetransfer/zip_tricks
-licenses: []
+licenses:
+- MIT (Hippocratic)
 metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: 
@@ -274,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Stream out ZIP files from Ruby