rubyzip

Rubyzip is a ruby library for reading and writing zip files.

Important note

The Rubyzip interface has changed!!! No need to do require "zip/zip" and Zip prefix in class names removed.

If you have issues with any third-party gems that require an old version of rubyzip, you can use this workaround:

gem'rubyzip','>= 1.0.0'# will load new rubyzip versiongem'zip-zip'# will load compatibility for old rubyzip API.

Requirements

• Ruby 1.9.2 or greater

Installation

Rubyzip is available on RubyGems:

gem install rubyzip

Or in your Gemfile:

gem'rubyzip'

Usage

Basic zip archive creation

require'rubygems'require'zip'folder="Users/me/Desktop/stuff_to_zip"input_filenames=['image.jpg','description.txt','stats.csv']zipfile_name="/Users/me/Desktop/archive.zip"Zip::File.open(zipfile_name,Zip::File::CREATE)do |zipfile|
input_filenames.eachdo |filename|
# Two arguments:# - The name of the file as it will appear in the archive# - The original file, including the path to find itzipfile.add(filename,File.join(folder,filename))endzipfile.get_output_stream("myFile"){ |f| f.write"myFile contains just this"}end

Zipping a directory recursively

Copy from here

require'zip'# This is a simple example which uses rubyzip to# recursively generate a zip file from the contents of# a specified directory. The directory itself is not# included in the archive, rather just its contents.## Usage:# directory_to_zip = "/tmp/input"# output_file = "/tmp/out.zip"# zf = ZipFileGenerator.new(directory_to_zip, output_file)# zf.write()classZipFileGenerator# Initialize with the directory to zip and the location of the output archive.definitialize(input_dir,output_file)@input_dir=input_dir@output_file=output_fileend# Zip the input directory.defwriteentries=Dir.entries(@input_dir) - %w(...)
::Zip::File.open(@output_file, ::Zip::File::CREATE)do |zipfile|
write_entriesentries,'',zipfileendendprivate# A helper method to make the recursion work.defwrite_entries(entries,path,zipfile)entries.eachdo |e|
zipfile_path=path == '' ? e : File.join(path,e)disk_file_path=File.join(@input_dir,zipfile_path)puts"Deflating #{disk_file_path}"ifFile.directory?disk_file_pathrecursively_deflate_directory(disk_file_path,zipfile,zipfile_path)elseput_into_archive(disk_file_path,zipfile,zipfile_path)endendenddefrecursively_deflate_directory(disk_file_path,zipfile,zipfile_path)zipfile.mkdirzipfile_pathsubdir=Dir.entries(disk_file_path) - %w(...)write_entriessubdir,zipfile_path,zipfileenddefput_into_archive(disk_file_path,zipfile,zipfile_path)zipfile.get_output_stream(zipfile_path)do |f|
f.write(File.open(disk_file_path,'rb').read)endendend

Save zip archive entries in sorted by name state

To save zip archives in sorted order like below, you need to set ::Zip.sort_entries to true

Vegetable/
Vegetable/bean
Vegetable/carrot
Vegetable/celery
fruit/
fruit/apple
fruit/kiwi
fruit/mango
fruit/orange

After this, entries in the zip archive will be saved in ordered state.

Default permissions of zip archives

On Posix file systems the default file permissions applied to a new archive are (0666 - umask), which mimics the behavior of standard tools such as touch.

On Windows the default file permissions are set to 0644 as suggested by the Ruby File documentation.

When modifying a zip archive the file permissions of the archive are preserved.

Reading a Zip file

Zip::File.open('foo.zip')do |zip_file|
# Handle entries one by onezip_file.eachdo |entry|
# Extract to file/directory/symlinkputs"Extracting #{entry.name}"entry.extract(dest_file)# Read into memorycontent=entry.get_input_stream.readend# Find specific entryentry=zip_file.glob('*.csv').firstputsentry.get_input_stream.readend

Notice about ::Zip::InputStream

::Zip::InputStream usable for fast reading zip file content because it not read Central directory.

But there is one exception when it is not working - General Purpose Flag Bit 3.

If bit 3 (0x08) of the general-purpose flags field is set, then the CRC-32 and file sizes are not known when the header is written. The fields in the local header are filled with zero, and the CRC-32 and size are appended in a 12-byte structure (optionally preceded by a 4-byte signature) immediately after the compressed data

If ::Zip::InputStream finds such entry in the zip archive it will raise an exception.

Password Protection (Experimental)

Rubyzip supports reading/writing zip files with traditional zip encryption (a.k.a. "ZipCrypto"). AES encryption is not yet supported. It can be used with buffer streams, e.g.:

Zip::OutputStream.write_buffer(::StringIO.new(''),Zip::TraditionalEncrypter.new('password'))do |out|
out.put_next_entry("my_file.txt")out.writemy_dataend.string

This is an experimental feature and the interface for encryption may change in future versions.

Known issues

Modify docx file with rubyzip

Use write_buffer instead open. Thanks to @jondruse

buffer=Zip::OutputStream.write_bufferdo |out|
@zip_file.entries.eachdo |e|
unless[DOCUMENT_FILE_PATH,RELS_FILE_PATH].include?(e.name)out.put_next_entry(e.name)out.writee.get_input_stream.readendendout.put_next_entry(DOCUMENT_FILE_PATH)out.writexml_doc.to_xml(:indent=>0).gsub("\n","")out.put_next_entry(RELS_FILE_PATH)out.writerels.to_xml(:indent=>0).gsub("\n","")endFile.open(new_path,"wb"){|f| f.write(buffer.string)}

Configuration

By default, rubyzip will not overwrite files if they already exist inside of the extracted path. To change this behavior, you may specify a configuration option like so:

Zip.on_exists_proc=true

If you're using rubyzip with rails, consider placing this snippet of code in an initializer file such as config/initializers/rubyzip.rb

Additionally, if you want to configure rubyzip to overwrite existing files while creating a .zip file, you can do so with the following:

Zip.continue_on_exists_proc=true

If you want to store non-english names and want to open them on Windows(pre 7) you need to set this option:

Zip.unicode_names=true

Some zip files might have an invalid date format, which will raise a warning. You can hide this warning with the following setting:

Zip.warn_invalid_date=false

You can set the default compression level like so:

Zip.default_compression=Zlib::DEFAULT_COMPRESSION

It defaults to Zlib::DEFAULT_COMPRESSION. Possible values are Zlib::BEST_COMPRESSION, Zlib::DEFAULT_COMPRESSION and Zlib::NO_COMPRESSION

Sometimes file names inside zip contain non-ASCII characters. If you can assume which encoding was used for such names and want to be able to find such entries using find_entry then you can force assumed encoding like so:

Zip.force_entry_names_encoding='UTF-8'

Allowed encoding names are the same as accepted by String#force_encoding

You can set multiple settings at the same time by using a block:

Zip.setupdo |c|
c.on_exists_proc=truec.continue_on_exists_proc=truec.unicode_names=truec.default_compression=Zlib::BEST_COMPRESSIONend

By default, Zip64 support is disabled for writing. To enable it do this:

Zip.write_zip64_support=true

NOTE: If you will enable Zip64 writing then you will need zip extractor with Zip64 support to extract archive.

Developing

To run the test you need to do this:

bundle install
rake

Website and Project Home

http://github.com/rubyzip/rubyzip

http://rdoc.info/github/rubyzip/rubyzip/master/frames

Authors

Alexander Simonov ( alex at simonov.me)

Alan Harper ( alan at aussiegeek.net)

Thomas Sondergaard (thomas at sondergaard.cc)

Technorama Ltd. (oss-ruby-zip at technorama.net)

extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)

License

Rubyzip is distributed under the same license as ruby. See http://www.ruby-lang.org/en/LICENSE.txt