openzip 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf00f428db2855cde725e2a5ca4a347eeb627919
-  data.tar.gz: 6d278070f52f7f01389cd3f1d1e73b2401cb62ce
+  metadata.gz: 8f451c024999099c3a92d2c1a2d8a4188f8579b9
+  data.tar.gz: 3a115ee87ca4b72a1c6343c82ddfa7b08a0e1a10
 SHA512:
-  metadata.gz: b4b111c006a188cd75ff13dc26fa1ed3ed429076166e21343eb1d3db0db3252ccd5641e8c3af6d49894820724118c0a8760b4e5665afcc9de1c60c6def650719
-  data.tar.gz: 3eaa5a0e80e6a6fca72b488cb2ff11c728ddabae60ce3b7a9ce8a41c1492bdc8fc944c7111eba7f8e6a280d97ae17e17b70f46b8cab79c6cbf2bb3a72a22feb9
+  metadata.gz: ebd30eaf00e393a0e76242e6a0884a37b30e790084e549b587cf090990dfc2250d74f9506f7cb8a4d7a44bcdb0c035e622ba3bff9b23cf821803fe8ec6d79396
+  data.tar.gz: 73ad5ee53c7102c29cc45b50694ab9248ed1c3df021c695e7b55d2e01f9211e44e272edb77079e1b65fb017ae6736f34ef7af6ea43bd779564ea1619daf1091d

data/.gitignore

@@ -9,3 +9,4 @@
 /spec/reports/
 /tmp/
 /source/target/
+/benchmarking/files/

data/.rubocop.yml

@@ -32,6 +32,10 @@ Metrics/LineLength:
   Description: 'Limit lines to 120 characters.'
   Max: 120
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
 Lint/EndAlignment:
   EnforcedStyleAlignWith: variable
   SupportedStylesAlignWith:
@@ -54,3 +58,9 @@ Style/StringMethods:
 RSpec/MessageSpies:
   Enabled: true
   EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/.simplecov

@@ -1,3 +1,4 @@
 SimpleCov.start do
-  add_filter "spec"
+  add_filter ".bundle"
+  add_filter "vendor"
 end

data/.travis.yml

@@ -2,11 +2,19 @@ language: ruby
 cache: bundler
 sudo: required
 
+os:
+  - linux
+  - osx
+
 rvm:
-  - 2.3.0
+  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.3
+  - 2.4.0
 
 before_install:
-  - gem install bundler -v 1.13.6
+  - gem install bundler
   - bin/compile
 
 script:

data/Gemfile

@@ -9,6 +9,7 @@ group :development, :test do
 end
 
 group :test do
+  gem "climate_control"
   gem "codeclimate-test-reporter", "~> 1.0.0", require: false
   gem "simplecov", require: false
 end

data/README.md

@@ -6,23 +6,42 @@
 [![Gem](https://img.shields.io/gem/v/openzip.svg?style=flat-square)](https://github.com/ilyasgaraev/openzip)
 
 
-**Openzip** is a Ruby library for fast extract Zip files.
+**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
-path_to_zip = "path/to/zipfile.zip"
-extract_to_path = "path/to/extract"
+Openzip.extract("path/to/file.zip", "extract/path")
+# returns true if the method successfully executed; otherwise, false
+```
 
-Openzip.extract(path_to_zip, extract_to_path)
+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'
+gem "openzip"
 ```
 
 And then execute:

data/benchmarking/iterations.md

@@ -0,0 +1,48 @@
+# Iterations per second
+
+**Openzip** vs **rubyzip**.
+
+---
+## Zip file
+
+### File info
+* **Type:** zip
+* **Files in archive:** 2500
+* **Size:** 6 500 079 bytes (6,5 MB)
+
+### Results
+
+```
+Warming up --------------------------------------
+             openzip     1.000  i/100ms
+             rubyzip     1.000  i/100ms
+Calculating -------------------------------------
+             openzip      0.841  (± 0.0%) i/s -      5.000  in   5.943962s
+             rubyzip      0.369  (± 0.0%) i/s -      2.000  in   5.416802s
+
+Comparison:
+             openzip:        0.8 i/s
+             rubyzip:        0.4 i/s - 2.28x  slower
+```
+
+---
+## Excel file
+
+### File info
+* **Type:** xlsx
+* **Files in archive:** 13
+* **Size:** 775 231 bytes (778 KB)
+* **Filled rows:** 5000
+
+```
+Warming up --------------------------------------
+             openzip     1.000  i/100ms
+             rubyzip     1.000  i/100ms
+Calculating -------------------------------------
+             openzip     18.270  (± 5.5%) i/s -     91.000  in   5.000976s
+             rubyzip     13.548  (± 7.4%) i/s -     68.000  in   5.033290s
+
+Comparison:
+             openzip:       18.3 i/s
+             rubyzip:       13.5 i/s - 1.35x  slower
+```

data/benchmarking/memory.md

@@ -0,0 +1,50 @@
+# Memory usage
+
+**Openzip** vs **rubyzip**.
+
+---
+## Zip file
+
+### File info
+* **Type:** zip
+* **Files in archive:** 2500
+* **Size:** 6 500 079 bytes (6,5 MB)
+
+### Results
+
+```
+Calculating -------------------------------------
+             openzip   627.000  memsize (    40.000  retained)
+                        10.000  objects (     1.000  retained)
+                         3.000  strings (     0.000  retained)
+             rubyzip   304.757M memsize (   120.000  retained)
+                       866.162k objects (     3.000  retained)
+                        50.000  strings (     2.000  retained)
+
+Comparison:
+             openzip:        627 allocated
+             rubyzip:  304757473 allocated - 486056.58x more
+```
+
+---
+## Excel file
+
+### File info
+* **Type:** xlsx
+* **Files in archive:** 13
+* **Size:** 775 231 bytes (778 KB)
+* **Filled rows:** 5000
+
+```
+Calculating -------------------------------------
+             openzip   626.000  memsize (    40.000  retained)
+                        10.000  objects (     1.000  retained)
+                         3.000  strings (     0.000  retained)
+             rubyzip    62.955M memsize (    40.000  retained)
+                         2.763k objects (     1.000  retained)
+                        50.000  strings (     0.000  retained)
+
+Comparison:
+             openzip:        626 allocated
+             rubyzip:   62954673 allocated - 100566.57x more
+```

data/lib/openzip/version.rb

@@ -1,3 +1,3 @@
 module Openzip
-  VERSION = "0.1.1".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/openzip.rb

@@ -5,11 +5,17 @@ module Openzip
   extend Fiddle::Importer
 
   def self.lib_ext
-    raise "Sorry, windows is not supported yet" if RUBY_PLATFORM =~ /win32/
+    raise NotImplementedError, "Sorry, Windows is not supported" if RUBY_PLATFORM =~ /win32/
 
     RUBY_PLATFORM =~ /darwin/ ? "dylib" : "so"
   end
 
   dlload "#{File.dirname(__FILE__)}/../source/target/release/libopenzip.#{lib_ext}"
-  extern "void extract(char*, char*)"
+
+  def self.extract(zippath, outdirpath)
+    extract_rust(zippath, outdirpath) != 0
+  end
+
+  extern "char extract_rust(char*, char*)"
+  private_class_method :extract_rust
 end

data/openzip.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ilyas Garaev"]
   spec.email         = ["vearagi@gmail.com"]
 
-  spec.summary       = "Openzip is a Ruby library for fast reading Zip files."
-  spec.description   = "Openzip is a Ruby library for fast reading Zip files."
+  spec.summary       = "Openzip is a Ruby library (written in Rust) for fast reading Zip files."
+  spec.description   = "Openzip is a Ruby library (written in Rust) for fast reading Zip files."
   spec.homepage      = "https://github.com/ilyasgaraev/openzip"
   spec.license       = "MIT"
 
@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.extensions    = Dir["source/extconf.rb"]
 
+  spec.required_ruby_version = "~> 2.0"
+
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/source/extconf.rb

@@ -1,3 +1,3 @@
 unless system("cargo --version") || system("rustc --version")
-  raise "You have to install Rust with Cargo (https://www.rust-lang.org/)"
+  raise SystemCallError, "You have to install Rust with Cargo (https://www.rust-lang.org/en-US/install.html)"
 end

data/source/src/extractor.rs

@@ -0,0 +1,93 @@
+extern crate zip;
+
+use std::io;
+use std::fs;
+use std::path::{Path, PathBuf, Component};
+use std::error::Error;
+
+#[cfg(unix)]
+use std::os::unix::fs::PermissionsExt;
+
+pub fn run(zippath: &Path, outdirpath: &Path) -> Result<bool, Box<Error>>
+{
+    let file = try!(fs::File::open(&zippath));
+    try!(create_directory(&outdirpath, None));
+
+    let mut archive = try!(zip::ZipArchive::new(file));
+
+    for i in 0..archive.len()
+    {
+        let mut file = archive.by_index(i).unwrap();
+        let outpath = sanitize_filename(file.name(), outdirpath);
+
+        try!(create_directory(outpath.parent().unwrap_or(Path::new("")), None));
+
+        let perms = convert_permissions(file.unix_mode());
+
+        if file.name().ends_with("/") {
+            try!(create_directory(&outpath, perms));
+        } else {
+            try!(write_file(&mut file, &outpath, perms));
+        }
+    }
+
+    Ok(true)
+}
+
+#[cfg(unix)]
+fn convert_permissions(mode: Option<u32>) -> Option<fs::Permissions>
+{
+    match mode {
+        Some(mode) => Some(fs::Permissions::from_mode(mode)),
+        None => None,
+    }
+}
+
+#[cfg(not(unix))]
+fn convert_permissions(_mode: Option<u32>) -> Option<fs::Permissions>
+{
+    None
+}
+
+fn write_file(file: &mut zip::read::ZipFile, outpath: &Path, perms: Option<fs::Permissions>) -> Result<(), Box<Error>>
+{
+    let mut outfile = try!(fs::File::create(&outpath));
+    try!(io::copy(file, &mut outfile));
+
+    if let Some(perms) = perms {
+        try!(fs::set_permissions(outpath, perms));
+    }
+
+    Ok(())
+}
+
+fn create_directory(outpath: &Path, perms: Option<fs::Permissions>) -> Result<(), Box<Error>>
+{
+    try!(fs::create_dir_all(&outpath));
+
+    if let Some(perms) = perms {
+        try!(fs::set_permissions(outpath, perms));
+    }
+
+    Ok(())
+}
+
+fn sanitize_filename(filename: &str, outdir: &Path) -> PathBuf
+{
+    let no_null_filename = match filename.find('\0') {
+        Some(index) => &filename[0..index],
+        None => filename,
+    };
+
+    let filepath = Path::new(no_null_filename)
+        .components()
+        .filter(|component| *component != Component::ParentDir)
+        .fold(PathBuf::new(), |mut path, ref cur| {
+            path.push(cur.as_os_str());
+            path
+        });
+
+    let mut outdirbuf = PathBuf::from(outdir);
+    outdirbuf.push(filepath);
+    return outdirbuf.to_path_buf();
+}

data/source/src/lib.rs

@@ -1,94 +1,30 @@
-extern crate zip;
 extern crate libc;
 
-use std::io;
-use std::fs;
-use std::path::{Path, PathBuf, Component};
-use std::ffi::CStr;
+mod extractor;
 
-#[cfg(unix)]
-use std::os::unix::fs::PermissionsExt;
+use std::env;
+use std::path::Path;
+use std::ffi::CStr;
 
 #[no_mangle]
-pub extern fn extract(zippath: *const libc::c_char, outdirpath: *const libc::c_char) {
-    let zname = Path::new(rust_string(zippath));
-    let outdir = Path::new(rust_string(outdirpath));
-
-    create_directory(&outdir, None);
-    let file = fs::File::open(&zname).unwrap();
-
-    let mut archive = zip::ZipArchive::new(file).unwrap();
-
-    for i in 0..archive.len()
-    {
-        let mut file = archive.by_index(i).unwrap();
-        let outpath = sanitize_filename(file.name(), outdir);
-
-        create_directory(outpath.parent().unwrap_or(Path::new("")), None);
-
-        let perms = convert_permissions(file.unix_mode());
-
-        if (&*file.name()).ends_with("/") {
-            create_directory(&outpath, perms);
-        }
-        else {
-            write_file(&mut file, &outpath, perms);
-        }
-    }
-}
-
-fn rust_string(r_string: *const libc::c_char) -> &'static str {
-  unsafe { CStr::from_ptr(r_string) }.to_str().unwrap()
-}
-
-#[cfg(unix)]
-fn convert_permissions(mode: Option<u32>) -> Option<fs::Permissions>
+pub extern fn extract_rust(zip: *const libc::c_char, outdir: *const libc::c_char) -> bool
 {
-    match mode {
-        Some(mode) => Some(fs::Permissions::from_mode(mode)),
-        None => None,
-    }
-}
+    let zippath = Path::new(rust_string(zip));
+    let outdirpath = Path::new(rust_string(outdir));
 
-#[cfg(not(unix))]
-fn convert_permissions(_mode: Option<u32>) -> Option<fs::Permissions>
-{
-    None
-}
-
-fn write_file(file: &mut zip::read::ZipFile, outpath: &Path, perms: Option<fs::Permissions>)
-{
-    let mut outfile = fs::File::create(&outpath).unwrap();
-    io::copy(file, &mut outfile).unwrap();
-    if let Some(perms) = perms {
-        fs::set_permissions(outpath, perms).unwrap();
-    }
-}
+    return match extractor::run(zippath, outdirpath) {
+        Ok(_) => true,
+        Err(e) => {
+            if env::var("DEBUG").ok() == Some(String::from("true")) {
+                println!("Error: {}", e);
+            }
 
-fn create_directory(outpath: &Path, perms: Option<fs::Permissions>)
-{
-    fs::create_dir_all(&outpath).unwrap();
-    if let Some(perms) = perms {
-        fs::set_permissions(outpath, perms).unwrap();
+            false
+        }
     }
 }
 
-fn sanitize_filename(filename: &str, outdir: &Path) -> PathBuf
+fn rust_string(r_string: *const libc::c_char) -> &'static str
 {
-    let no_null_filename = match filename.find('\0') {
-        Some(index) => &filename[0..index],
-        None => filename,
-    };
-
-    let filepath = Path::new(no_null_filename)
-        .components()
-        .filter(|component| *component != Component::ParentDir)
-        .fold(PathBuf::new(), |mut path, ref cur| {
-            path.push(cur.as_os_str());
-            path
-        });
-
-    let mut outdirbuf = PathBuf::from(outdir);
-    outdirbuf.push(filepath);
-    return outdirbuf.to_path_buf();
+  unsafe { CStr::from_ptr(r_string) }.to_str().unwrap()
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openzip
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ilyas Garaev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2017-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Openzip is a Ruby library for fast reading Zip files.
+description: Openzip is a Ruby library (written in Rust) for fast reading Zip files.
 email:
 - vearagi@gmail.com
 executables: []
@@ -84,6 +84,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmarking/iterations.md
+- benchmarking/memory.md
 - bin/bundle-audit
 - bin/ci
 - bin/compile
@@ -100,6 +102,7 @@ files:
 - source/Cargo.toml
 - source/Makefile
 - source/extconf.rb
+- source/src/extractor.rs
 - source/src/lib.rs
 homepage: https://github.com/ilyasgaraev/openzip
 licenses:
@@ -111,9 +114,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -124,5 +127,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Openzip is a Ruby library for fast reading Zip files.
+summary: Openzip is a Ruby library (written in Rust) for fast reading Zip files.
 test_files: []