Merge pull request #2 from SpringMT/add-decompress-benchmarks

Add decompress benchmarks

Author: SpringMT

.gitignore

@@ -13,6 +13,7 @@
 *.a
 mkmf.log
 vendor/
+*.gem
 
 # rspec failure tracking
 .rspec_status

LICENSE-zstd

@@ -6,6 +6,8 @@ Ruby binding for zstd(Zstandard - Fast real-time compression algorithm)
 
 See https://github.com/facebook/zstd
 
+Fork from https://github.com/jarredholman/ruby-zstd.
+
 ## Zstd version
 v1.1.2 (https://github.com/facebook/zstd/releases/tag/v1.1.2)
 

README.md

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'fileutils'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -14,5 +15,8 @@ end
 
 task :default => [:clobber, :compile, :spec]
 
-#task :sync
-
+desc 'Sync zstd libs dirs to ext/zstdruby/libzstd'
+task :zstd_update do
+  FileUtils.rm_r('ext/zstdruby/libzstd')
+  FileUtils.cp_r('zstd/lib', 'ext/zstdruby/libzstd')
+end

Rakefile

@@ -4,4 +4,4 @@ gem 'benchmark-ips'
 gem 'snappy'
 gem 'ruby-xz'
 gem 'lz4-ruby'
-
+#gem 'zstd', github: 'jarredholman/ruby-zstd', branch: 'master'

benchmarks/Gemfile

@@ -1,11 +1,12 @@
+
 # sample data
 FROM http://www.cl.ecei.tohoku.ac.jp/~matsuda/LRE_corpus/
 
 # usage
 
-
 ```
-bundle exec ruby compress.rb city
+bundle exec ruby compress.rb city.json
+bundle exec ruby decompress.rb city.json
 ```
 
 
@@ -53,3 +54,22 @@ total 2712
 -rw-r--r--   1 makoto  staff   238K  2  5 16:08 city.json.zstd
 ```
 
+## Decompression
+### Performance
+
+```
+Warming up --------------------------------------
+              snappy    59.000  i/100ms
+                gzip    19.000  i/100ms
+                  xz     5.000  i/100ms
+                 lz4    51.000  i/100ms
+                zstd    31.000  i/100ms
+Calculating -------------------------------------
+              snappy    583.211  (± 9.1%) i/s -      2.891k in   5.002226s
+                gzip    195.468  (±10.7%) i/s -    969.000  in   5.028082s
+                  xz     53.501  (± 7.5%) i/s -    270.000  in   5.083982s
+                 lz4    511.275  (± 9.4%) i/s -      2.550k in   5.036539s
+                zstd    302.455  (±16.5%) i/s -      1.488k in   5.070354s
+```
+
+

benchmarks/README.md

@@ -1,6 +1,6 @@
 require 'benchmark/ips'
 
-$LOAD_PATH.unshift "../lib"
+$LOAD_PATH.unshift '../lib'
 
 require 'json'
 require 'snappy'

benchmarks/compress.rb

@@ -1,10 +1,13 @@
 require 'benchmark/ips'
 
+$LOAD_PATH.unshift '../lib'
+
 require 'json'
 require 'snappy'
 require 'zlib'
 require 'xz'
 require 'lz4-ruby'
+require 'zstd-ruby'
 
 sample_file_name = ARGV[0]
 
@@ -30,5 +33,4 @@
   x.report("zstd") do
     Zstd.decompress IO.read("./results/#{sample_file_name}.zstd")
   end
-
 end

benchmarks/decompress.rb

@@ -9,29 +9,29 @@ Gem::Specification.new do |spec|
   spec.authors       = ["SpringMT"]
   spec.email         = ["[email protected]"]
 
-  spec.summary       = %q{Write a short summary, because Rubygems requires one.}
-  spec.description   = %q{ Write a longer description or delete this line.}
+  spec.summary       = %q{Ruby binding for zstd(Zstandard - Fast real-time compression algorithm)}
+  spec.description   = %q{Ruby binding for zstd(Zstandard - Fast real-time compression algorithm). See https://github.com/facebook/zstd}
   spec.homepage      = "https://github.com/SpringMT/zstd-ruby"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+    spec.metadata['allowed_push_host'] = "Set to 'http://mygemserver.com'"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|benchmarks|zstd)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rake-compiler", '~> 1'
   spec.add_development_dependency "rspec", "~> 3.0"
 end