https://github.com/ilyasgaraev/openzip

Openzip is a Ruby library (written in Rust) for fast extract Zip files
https://github.com/ilyasgaraev/openzip

ruby rust zip

Last synced: 7 months ago
JSON representation

Openzip is a Ruby library (written in Rust) for fast extract Zip files

• Host: GitHub
• URL: https://github.com/ilyasgaraev/openzip
• Owner: ilyasgaraev
• License: mit
• Created: 2017-01-20T22:41:00.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-04-08T20:11:50.000Z (about 8 years ago)
• Last Synced: 2025-10-08T01:29:04.523Z (7 months ago)
• Topics: ruby, rust, zip
• Language: Ruby
• Homepage:
• Size: 30.3 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Openzip

[![Build Status](https://img.shields.io/travis/ilyasgaraev/openzip/master.svg?style=flat-square)](https://travis-ci.org/ilyasgaraev/openzip)

[![Code Climate](https://img.shields.io/codeclimate/github/ilyasgaraev/openzip.svg?style=flat-square)](https://codeclimate.com/github/ilyasgaraev/openzip)

[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/ilyasgaraev/openzip.svg?style=flat-square)](https://codeclimate.com/github/ilyasgaraev/openzip/coverage)

[![Gem](https://img.shields.io/gem/v/openzip.svg?style=flat-square)](https://github.com/ilyasgaraev/openzip)

**Openzip** is a Ruby library (written in Rust) for fast extract Zip files.

## Usage

Before you begin, you need to install Rust (with Cargo) on your system (see [Requirements](#requirements)).

```ruby

Openzip.extract("path/to/file.zip", "extract/path")

# returns true if the method successfully executed; otherwise, false

```

The **DEBUG** environment variable can be used to enable debug logs:

```ruby

# DEBUG=true

Openzip.extract("wrong/path/file.zip", "extract/path")

# Error: No such file or directory (os error 2)

# => false

```

## Requirements

* Rust and Cargo ([https://www.rust-lang.org/en-US/install.html](https://www.rust-lang.org/en-US/install.html))

* Ruby 2.0 or greater

## Benchmarking

* Memory usage: [benchmarking/memory.md](benchmarking/memory.md)

* Iterations per second: [benchmarking/iterations.md](benchmarking/iterations.md)

## Installation

Add this line to your application's Gemfile:

```ruby

gem "openzip"

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install openzip

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ilyasgaraev/openzip. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).