root
/
rubyzip
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #230 from matugm/patch-1 

Update README.md
This commit is contained in:
Alexander Simonov 2015-04-20 16:23:11 +03:00
parent 6a98297039 1175abf1d5
commit e1d5012f89
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -4,11 +4,11 @@
[![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip.svg)](https://codeclimate.com/github/rubyzip/rubyzip) [![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip.svg)](https://codeclimate.com/github/rubyzip/rubyzip)
[![Coverage Status](https://img.shields.io/coveralls/rubyzip/rubyzip.svg)](https://coveralls.io/r/rubyzip/rubyzip?branch=master) [![Coverage Status](https://img.shields.io/coveralls/rubyzip/rubyzip.svg)](https://coveralls.io/r/rubyzip/rubyzip?branch=master)
rubyzip is a ruby library for reading and writing zip files. Rubyzip is a ruby library for reading and writing zip files.
## Important note ## Important note
Rubyzip interface changed!!! No need to do `require "zip/zip"` and `Zip` prefix in class names removed. 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: If you have issues with any third-party gems that require an old version of rubyzip, you can use this workaround:
@ -22,7 +22,7 @@ gem 'zip-zip' # will load compatibility for old rubyzip API.
* Ruby 1.9.2 or greater * Ruby 1.9.2 or greater
## Installation ## Installation
rubyzip is available on RubyGems, so: Rubyzip is available on RubyGems:
``` ```
gem install rubyzip gem install rubyzip
@ -110,7 +110,7 @@ end
### Save zip archive entries in sorted by name state ### Save zip archive entries in sorted by name state
To saving zip archives in sorted order like below you need to set `::Zip.sort_entries` to `true` To save zip archives in sorted order like below, you need to set `::Zip.sort_entries` to `true`
``` ```
Vegetable/ Vegetable/
@ -124,7 +124,7 @@ fruit/mango
fruit/orange fruit/orange
``` ```
After this entries in zip archive will be saved in ordered state. After this, entries in the zip archive will be saved in ordered state.
### Reading a Zip file ### Reading a Zip file
@ -150,17 +150,17 @@ end
`::Zip::InputStream` usable for fast reading zip file content because it not read Central directory. `::Zip::InputStream` usable for fast reading zip file content because it not read Central directory.
But there is one exception when it not working - General Purpose Flag Bit 3. 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 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` will found such entry in zip archive it will raise exception. If `::Zip::InputStream` finds such entry in the zip archive it will raise an exception.
### Password Protection (Experimental) ### 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.: 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.:
```ruby ```ruby
Zip::OutputStream.write_buffer(::StringIO.new(''), Zip::TraditionalEncrypter.new('password')) do |out| Zip::OutputStream.write_buffer(::StringIO.new(''), Zip::TraditionalEncrypter.new('password')) do |out|
@ -212,13 +212,13 @@ Additionally, if you want to configure rubyzip to overwrite existing files while
Zip.continue_on_exists_proc = true Zip.continue_on_exists_proc = true
``` ```
If you want to store non english names and want to open properly file on Windows(pre 7) you need to set next option: If you want to store non-english names and want to open them on Windows(pre 7) you need to set this option:
```ruby ```ruby
Zip.unicode_names = true Zip.unicode_names = true
``` ```
In some zip date of files stored in incorrect format. You can hide warning about it by using: Some zip files might have an invalid date format, which will raise a warning. You can hide this warning with the following setting:
```ruby ```ruby
Zip.warn_invalid_date = false Zip.warn_invalid_date = false
@ -231,7 +231,7 @@ 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` It defaults to `Zlib::DEFAULT_COMPRESSION`. Possible values are `Zlib::BEST_COMPRESSION`, `Zlib::DEFAULT_COMPRESSION` and `Zlib::NO_COMPRESSION`
All settings in same time You can set multiple settings at the same time by using a block:
```ruby ```ruby
Zip.setup do |c| Zip.setup do |c|
@ -242,7 +242,7 @@ All settings in same time
end end
``` ```
By default Zip64 support is disabled for writing. To enable it do next: By default, Zip64 support is disabled for writing. To enable it do this:
```ruby ```ruby
Zip.write_zip64_support = true Zip.write_zip64_support = true
@ -252,7 +252,7 @@ _NOTE_: If you will enable Zip64 writing then you will need zip extractor with Z
## Developing ## Developing
To run tests you need run next commands: To run the test you need to do this:
``` ```
bundle install bundle install
@ -279,5 +279,5 @@ extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)
## License ## License
rubyzip is distributed under the same license as ruby. See Rubyzip is distributed under the same license as ruby. See
http://www.ruby-lang.org/en/LICENSE.txt http://www.ruby-lang.org/en/LICENSE.txt