lz4-ruby 0.1.6-x86-mingw32

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "rake-compiler", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 KOMIYA Atsushi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,76 @@
+= lz4-ruby
+
+Ruby bindings for {LZ4}[http://code.google.com/p/lz4/].
+
+== Installation
+
+    gem install lz4-ruby
+
+== Usage
+
+    require 'rubygems'
+    require 'lz4-ruby'
+
+    # compress (fast)
+    compressed = LZ4::compress("hello, world")
+
+    # compress (high compression)
+    compressed = LZ4::compressHC("hello, world")
+
+    # uncompress
+    uncompressed = LZ4::uncompress(compressed)
+
+== Benchmark
+
+Tested on VirtualBox VM : 2-core / 4GB RAM (Host : Core i5-2520M / 8GB RAM).
+
+=== {enwik8}[http://mattmahoney.net/dc/enwik8.zip]
+    method  ratio(bpc)      comp.time(ms)   uncomp.time(ms)
+    -------------------------------------------------------
+    lz4     4.559           519.25          182.67
+    snappy  4.668           1050.73         257.94
+    lzo     4.279           1000.13         574.77
+
+== TODO
+
+* Write API documents.
+
+== Copyright
+
+Copyright (c) 2012 KOMIYA Atsushi.
+See LICENSE.txt for further details.
+
+== About LZ4
+
+This Rubygem includes LZ4 codes written by Yann Collet.
+
+   LZ4 - Fast LZ compression algorithm
+   Copyright (C) 2011-2012, Yann Collet.
+   BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
+
+   Redistribution and use in source and binary forms, with or without
+   modification, are permitted provided that the following conditions are
+   met:
+
+       * Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+       * Redistributions in binary form must reproduce the above
+   copyright notice, this list of conditions and the following disclaimer
+   in the documentation and/or other materials provided with the
+   distribution.
+
+   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+   You can contact the author at :
+   - LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html
+   - LZ4 source repository : http://code.google.com/p/lz4/

data/Rakefile

@@ -0,0 +1,97 @@
+# -*- mode: ruby -*-
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+jeweler_tasks = Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "lz4-ruby"
+  gem.homepage = "http://github.com/komiya-atsushi/lz4-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby bindings for LZ4 (Extremely Fast Compression algorithm).}
+  gem.description = %Q{Ruby bindings for LZ4. LZ4 is a very fast lossless compression algorithm.}
+  gem.email = "komiya.atsushi@gmail.com"
+  gem.authors = ["KOMIYA Atsushi"]
+  gem.extensions = ["ext/lz4ruby/extconf.rb"]
+  
+  gem.files.exclude("*.sh")
+  
+  gem.files.include("ext/lz4ruby/*.c")
+  gem.files.include("ext/lz4ruby/*.h")
+  
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+$gemspec = jeweler_tasks.gemspec
+$gemspec.version = jeweler_tasks.jeweler.version
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lz4-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new("lz4ruby", $gemspec) do |ext|
+  ext.cross_compile = true
+  ext.cross_platform = ["x86-mingw32"]
+end
+
+Rake::Task.tasks.each do |task_name|
+  case task_name.to_s
+  when /^native/
+    task_name.prerequisites.unshift('fix_rake_compiler_gemspec_dump')
+  end
+end
+
+task :fix_rake_compiler_gemspec_dump do
+  %w{files extra_rdoc_files test_files}.each do |accessor|
+    $gemspec.send(accessor).instance_eval {
+      @exclude_procs = Array.new
+    }
+  end
+end
+
+task :gems do
+  sh "rake clean build:cross"
+  sh "rake clean build"
+end
+
+task "build:cross" => [:modify_gemspec_for_windows, :cross, :build] do
+  file = "pkg/lz4-ruby-#{get_version}.gem"
+  mv file, "#{file.ext}-x86-mingw32.gem"
+end
+
+task :modify_gemspec_for_windows do
+  $gemspec.extensions = []
+  $gemspec.files.include("lib/?.?/*.so")
+  $gemspec.platform = "x86-mingw32"
+end
+
+def get_version
+  `cat VERSION`.chomp
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.6

data/benchmarking/bench.rb

@@ -0,0 +1,137 @@
+require 'benchmark'
+require 'rubygems'
+
+CHUNK_SIZE = 8 << 20
+NUM_LOOP = 10
+
+class DevNullIO
+  def write(arg)
+    # Do nothing
+  end
+end
+
+class StringIO
+  def initialize(text)
+    @text = text
+    @len = text.length
+    @pos = 0
+  end
+
+  def read(length)
+    return nil if @pos == @len
+
+    length = @len - @pos if @pos + length > @len
+    
+    result = @text[@pos, length]
+    @pos += length
+    
+    return result
+  end
+end
+
+class CompressorBenchmark
+  USAGE = <<EOS
+Usage:
+    ruby #{$0} compressor testdata
+
+Compressor:
+    lz4
+    snappy
+    lzo
+EOS
+
+  def initialize(args)
+    if args.length != 2
+      puts USAGE
+      exit 1
+    end
+
+    @signature = args[0]
+    @compressor_rb = "compressor_#{@signature}.rb"
+    
+    if !File.file?(@compressor_rb)
+      puts "Error: Compressor '#{@compressor_rb}' is not found."
+      puts USAGE
+      exit 1
+    end
+
+    @testdata_filename = args[1]
+    if !File.file?(@testdata_filename)
+      puts "Error: testdata `#{@testdata_filename}` is not found."
+      puts USAGE
+      exit 1
+    end
+
+    @compressed_filename = "#{@testdata_filename}.#{@signature}.compressed"
+    
+    require "./#{@compressor_rb}"
+    @compressor = create_compressor(CHUNK_SIZE)
+  end
+
+  def setup_compressed
+    `ruby #{@compressor_rb} c #{CHUNK_SIZE} <#{@testdata_filename} >#{@compressed_filename}`
+  end
+
+  def benchmark_compression
+    data = nil
+    File.open(@testdata_filename) do |file|
+      data = file.read(File.size(@testdata_filename))
+    end
+
+    devnull = DevNullIO.new
+
+    # warm up
+    @compressor.compress(StringIO.new(data), devnull)
+
+    result = Benchmark.measure {
+      NUM_LOOP.times { |t| @compressor.compress(StringIO.new(data), devnull) }
+    }
+
+    return result
+  end
+  
+  def benchmark_uncompression
+    data = nil
+    File.open(@compressed_filename) do |file|
+      data = file.read(File.size(@compressed_filename))
+    end
+
+    devnull = DevNullIO.new
+
+    # warm up
+    @compressor.uncompress(StringIO.new(data), devnull)
+
+    result = Benchmark.measure {
+      NUM_LOOP.times { |t| @compressor.uncompress(StringIO.new(data), devnull) }
+    }
+
+    return result
+  end
+
+  def show_result(result_comp, result_uncomp)
+    orig_size = File.size(@testdata_filename)
+    comp_size = File.size(@compressed_filename)
+    
+    ratio = comp_size * 8.0 / orig_size
+    comp_time = result_comp.real * 1000.0 / NUM_LOOP
+    uncomp_time = result_uncomp.real * 1000.0 / NUM_LOOP
+
+    puts "method\tratio(bpc)\tcomp.time(ms)\tuncomp.time(ms)"
+    puts "-------------------------------------------------------"
+    puts "%s\t%.3f\t\t%.2f\t\t%.2f" % [@signature, ratio, comp_time, uncomp_time]
+  end
+
+  def do_benchmark
+    setup_compressed()
+
+    result_comp = benchmark_compression()
+    result_uncomp = benchmark_uncompression()
+
+    show_result(result_comp, result_uncomp)
+  end
+end
+
+if $0 == __FILE__
+  CompressorBenchmark.new(ARGV).do_benchmark
+end
+

data/benchmarking/bench_all.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+ruby bench.rb lz4 $1
+ruby bench.rb snappy $1 | tail -n 1
+ruby bench.rb lzo $1 | tail -n 1

data/benchmarking/compressor.rb

@@ -0,0 +1,71 @@
+class Compressor
+  DEFAULT_CHUNK_SIZE = 8 << 20
+  
+  def initialize(chunk_size)
+    if chunk_size == nil
+      @chunk_size = DEFAULT_CHUNK_SIZE
+    else
+      @chunk_size = chunk_size
+    end
+    
+    require_libs()
+  end
+
+  def compress(infile, outfile)
+    loop do
+      text = infile.read(@chunk_size)
+      break if text == nil || text.length == 0
+
+      compressed = compress_text(text)
+      comp_size = compressed.length
+
+      outfile.write([comp_size].pack("L"))
+      outfile.write(compressed)
+    end
+  end
+
+  def uncompress(infile, outfile)
+    loop do
+      comp_size = infile.read(4)
+      break if comp_size == nil || comp_size.length == 0
+
+      comp_size = comp_size.unpack("L")[0]
+      compressed = infile.read(comp_size)
+
+      text = uncompress_text(compressed)
+
+      outfile.write(text)
+    end
+  end
+
+  def self.unit_driver()
+    if !(ARGV.length == 1) && !(ARGV.length == 2 && ARGV[0] == 'c')
+      puts <<EOS
+Compress:
+    ./#{$0} c <infile >outfile
+
+Uncompress:
+    ./#{$0} u <infile >outfile
+EOS
+      exit 1
+    end
+  
+    require 'rubygems'
+
+    case ARGV[0]
+    when 'c'
+      chunk_size = nil
+      chunk_size = ARGV[1].to_i if ARGV.length == 2
+      compressor = create_compressor(chunk_size)
+      compressor.compress($stdin, $stdout)
+    
+    when 'u'
+      compressor = create_compressor(nil)
+      compressor.uncompress($stdin, $stdout)
+
+    else
+      puts "Error: illegal argument '#{ARGV[0]}'"
+      exit 1
+    end
+  end
+end

data/benchmarking/compressor_lz4.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require './compressor.rb'
+
+class LZ4Compressor < Compressor
+  def require_libs
+    require 'lz4-ruby'
+  end
+
+  def compress_text(text)
+    return LZ4::compress(text)
+  end
+
+  def uncompress_text(compressed)
+    return LZ4::uncompress(compressed)
+  end
+end
+
+def create_compressor(chunk_size)
+  return LZ4Compressor.new(chunk_size)
+end
+
+if $0 == __FILE__
+  Compressor.unit_driver() { |chunk_size| LZ4Compressor.new(chunk_size) }
+end

data/benchmarking/compressor_lzo.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require './compressor.rb'
+
+class LZOCompressor < Compressor
+  def require_libs
+    require 'lzoruby'
+  end
+
+  def compress_text(text)
+    return LZO.compress(text)
+  end
+
+  def uncompress_text(compressed)
+    return LZO.decompress(compressed)
+  end
+end
+
+def create_compressor(chunk_size)
+  return LZOCompressor.new(chunk_size)
+end
+
+if $0 == __FILE__
+  Compressor.unit_driver() { |chunk_size| LZOCompressor.new(chunk_size) }
+end

data/benchmarking/compressor_snappy.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require './compressor.rb'
+
+class SnappyCompressor < Compressor
+  def require_libs
+    require 'snappy'
+  end
+
+  def compress_text(text)
+    return Snappy.deflate(text)
+  end
+
+  def uncompress_text(compressed)
+    return Snappy.inflate(compressed)
+  end
+end
+
+def create_compressor(chunk_size)
+  return SnappyCompressor.new(chunk_size)
+end
+
+if $0 == __FILE__
+  Compressor.unit_driver() { |chunk_size| SnappyCompressor.new(chunk_size) }
+end

data/ext/lz4ruby/extconf.rb

@@ -0,0 +1,6 @@
+require 'mkmf'
+
+$CFLAGS += " -Wall "
+
+create_makefile('lz4ruby')
+