zip_tricks will not receive further updates or support, and will no longer be maintained. The story of zip_tricks continues in zip_kit which is going to be receiving regular updates and supports all of the zip_tricks functionality (and more). Thank you for being part of the zip_tricks community!
Allows streaming, non-rewinding ZIP file output from Ruby.
Initially written and as a spiritual successor to zipline and now proudly powering it under the hood.
Allows you to write a ZIP archive out to a File, Socket, String or Array without having to rewind it at any point. Usable for creating very large ZIP archives for immediate sending out to clients, or for writing large ZIP archives without memory inflation.
zip_tricks currently handles all our zipping needs (millions of ZIP files generated per day), so we are pretty confident it is widely compatible with a large number of unarchiving end-user applications.
Ruby 2.1+ syntax support (keyword arguments with defaults) and a working zlib (all available to jRuby as well).
jRuby might experience problems when using the reader methods due to the argument of IO#seek
being limited
to 32 bit sizes.
The easiest is to include the ZipTricks::RailsStreaming
module into your
controller.
class ZipsController < ActionController::Base
include ZipTricks::RailsStreaming
def download
zip_tricks_stream do |zip|
zip.write_deflated_file('report1.csv') do |sink|
CSV(sink) do |csv_write|
csv_write << Person.column_names
Person.all.find_each do |person|
csv_write << person.attributes.values
end
end
end
zip.write_deflated_file('report2.csv') do |sink|
...
end
end
end
end
If you want some more conveniences you can also use zipline which will automatically process and stream attachments (Carrierwave, Shrine, ActiveStorage) and remote objects via HTTP.
Basic use case is compressing on the fly. Some data will be buffered by the Zlib deflater, but memory inflation is going to be very constrained. Data will be written to destination at fairly regular intervals. Deflate compression will work best for things like text files.
out = my_tempfile # can also be a socket
ZipTricks::Streamer.open(out) do |zip|
zip.write_stored_file('mov.mp4.txt') do |sink|
File.open('mov.mp4', 'rb'){|source| IO.copy_stream(source, sink) }
end
zip.write_deflated_file('long-novel.txt') do |sink|
File.open('novel.txt', 'rb'){|source| IO.copy_stream(source, sink) }
end
end
Unfortunately with this approach it is impossible to compute the size of the ZIP file being output, since you do not know how large the compressed data segments are going to be.
To "pull" data from ZipTricks you can create an OutputEnumerator
object which will yield the binary chunks piece
by piece, and apply some amount of buffering as well. Since this OutputEnumerator
responds to #each
and yields
Strings it also can (and should!) be used as a Rack response body. Return it to your webserver and you will
have your ZIP streamed. The block that you give to the OutputEnumerator
will only start executing once your
response body starts getting iterated over - when actually sending the response to the client
(unless you are using a buffering Rack webserver, such as Webrick).
body = ZipTricks::Streamer.output_enum do | zip |
zip.write_stored_file('mov.mp4') do |sink| # Those MPEG4 files do not compress that well
File.open('mov.mp4', 'rb'){|source| IO.copy_stream(source, sink) }
end
zip.write_deflated_file('long-novel.txt') do |sink|
File.open('novel.txt', 'rb'){|source| IO.copy_stream(source, sink) }
end
end
[200, {}, body]
Use the SizeEstimator
to compute the correct size of the resulting archive.
# Precompute the Content-Length ahead of time
bytesize = ZipTricks::SizeEstimator.estimate do |z|
z.add_stored_entry(filename: 'myfile1.bin', size: 9090821)
z.add_stored_entry(filename: 'myfile2.bin', size: 458678)
end
# Prepare the response body. The block will only be called when the response starts to be written.
zip_body = ZipTricks::RackBody.new do | zip |
zip.add_stored_entry(filename: "myfile1.bin", size: 9090821, crc32: 12485)
zip << read_file('myfile1.bin')
zip.add_stored_entry(filename: "myfile2.bin", size: 458678, crc32: 89568)
zip << read_file('myfile2.bin')
end
[200, {'Content-Length' => bytesize.to_s}, zip_body]
You do not have to "feed" all the contents of the files you put in the archive through the Streamer object.
If the write destination for your use case is a Socket
(say, you are writing using Rack hijack) and you know
the metadata of the file upfront (the CRC32 of the uncompressed file and the sizes), you can write directly
to that socket using some accelerated writing technique, and only use the Streamer to write out the ZIP metadata.
# io has to be an object that supports #<<
ZipTricks::Streamer.open(io) do | zip |
# raw_file is written "as is" (STORED mode).
# Write the local file header first..
zip.add_stored_entry(filename: "first-file.bin", size: raw_file.size, crc32: raw_file_crc32)
# Adjust the ZIP offsets within the Streamer
zip.simulate_write(my_temp_file.size)
# ...and then send the actual file contents bypassing the Streamer interface
io.sendfile(my_temp_file)
end
Check out the examples/
directory at the root of the project. This will give you a good idea
of various use cases the library supports.
BlockCRC32
computes the CRC32 checksum of an IO in a streaming fashion.
It is slightly more convenient for the purpose than using the raw Zlib library functions.
crc = ZipTricks::StreamCRC32.new
crc << next_chunk_of_data
...
crc.to_i # Returns the actual CRC32 value computed so far
...
# Append a known CRC32 value that has been computed previosuly
crc.append(precomputed_crc32, size_of_the_blob_computed_from)
You can also compute the CRC32 for an entire IO object if it responds to #eof?
:
crc = ZipTricks::StreamCRC32.from_io(file) # Returns an Integer
The library contains a reader module, play with it to see what is possible. It is not a complete ZIP reader but it was designed for a specific purpose (highly-parallel unpacking of remotely stored ZIP files), and as such it performs it's function quite well. Please beware of the security implications of using ZIP readers that have not been formally verified (ours hasn't been).
- Check out the latest
main
to make sure the feature hasn't been implemented or the bug hasn't been fixed yet. - Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
- Fork the project.
- Start a feature/bugfix branch.
- 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.
Copyright (c) 2020 WeTransfer.
zip_tricks
is distributed under the conditions of the Hippocratic License
See LICENSE.txt for further details. If this license is not acceptable for your use case we still maintain the 4.x version tree
which remains under the MIT license, see https://rubygems.org/gems/zip_tricks/versions for more information.
Note that we only backport some performance optimizations and crucial bugfixes but not the new features to that tree.