lz4-ruby 0.1.0

data/.document

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

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,65 @@
+= lz4-ruby
+
+Ruby bindings for {LZ4}[http://code.google.com/p/lz4/].
+
+== Install
+
+    gem install lz4-ruby
+
+== Usage
+
+    require 'rubygems'
+    require 'lz4-ruby'
+
+    compressed = LZ4::compress("hello, world")
+    # compressed = LZ4::compressHC("hello, world")
+    uncompressed = LZ4::uncompress(compressed)
+
+== TODO
+
+* Support compressCtx/compress64kCtx methods.
+* Write API documents.
+* Write test codes.
+* Benchmark other compression libraries (lzo, snappy...).
+* Optimize memory allocation.
+* Support mswin32 platform.
+
+== 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,55 @@
+# -*- 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.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.}
+  gem.description = %Q{Ruby bindings for LZ4.}
+  gem.email = "komiya.atsushi@gmail.com"
+  gem.authors = ["KOMIYA Atsushi"]
+  gem.extensions = "ext/extconf.rb"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+#  test.libs << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#  test.rcov_opts << '--exclude "gems/*"'
+#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

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ext/extconf.rb

@@ -0,0 +1,25 @@
+require 'mkmf'
+
+LZ4_REV_NO = 66
+
+URL = "http://lz4.googlecode.com/svn-history/r#{LZ4_REV_NO}/trunk/"
+
+def download_from_web(url)
+  `wget #{url}`
+  
+  if $?.exitstatus != 0
+    return false
+  end
+  
+  return true
+end
+
+return if !download_from_web("#{URL}/lz4.c")
+return if !download_from_web("#{URL}/lz4.h")
+return if !download_from_web("#{URL}/lz4hc.c")
+return if !download_from_web("#{URL}/lz4hc.h")
+
+$CFLAGS += " -Wall "
+
+create_makefile('lz4ruby')
+

data/ext/lz4ruby.c

@@ -0,0 +1,78 @@
+#include <ruby.h>
+#include "lz4.h"
+#include "lz4hc.h"
+
+typedef int (*CompressFunc)(const char *source, char *dest, int isize);
+
+static VALUE lz4;
+
+static VALUE compress(CompressFunc compressor, VALUE self, VALUE source) {
+  const char *src_p = NULL;
+  char *buf = NULL;
+  VALUE result;
+  int src_size;
+  int buf_size;
+  int comp_size;
+
+  Check_Type(source, T_STRING);
+  src_p = RSTRING_PTR(source);
+  src_size = RSTRING_LEN(source);
+  buf_size = LZ4_compressBound(src_size);
+
+  buf = xmalloc(buf_size + 4);
+  buf[0] = (char)((src_size >> 24) & 0xff);
+  buf[1] = (char)((src_size >> 16) & 0xff);
+  buf[2] = (char)((src_size >> 8) & 0xff);
+  buf[3] = (char)(src_size & 0xff);
+
+  comp_size = compressor(src_p, buf + 4, src_size);
+  result = rb_str_new(buf, comp_size + 4);
+
+  xfree(buf);
+
+  return result;
+}
+
+static VALUE lz4_ruby_compress(VALUE self, VALUE source) {
+  return compress(LZ4_compress, self, source);
+}
+
+static VALUE lz4_ruby_compressHC(VALUE self, VALUE source) {
+  return compress(LZ4_compressHC, self, source);
+}
+
+static VALUE lz4_ruby_uncompress(VALUE self, VALUE source) {
+  const char *src_p = NULL;
+  char *buf = NULL;
+  VALUE result;
+  int src_size;
+  int buf_size;
+  int read_bytes;
+
+  Check_Type(source, T_STRING);
+  src_p = RSTRING_PTR(source);
+  src_size = RSTRING_LEN(source);
+
+  buf_size = ((src_p[0] & 0xffU) << 24)
+    | ((src_p[1] & 0xffU) << 16)
+    | ((src_p[2] & 0xffU) << 8)
+    | (src_p[3] & 0xffU);
+
+  buf = xmalloc(buf_size);
+
+  read_bytes = LZ4_uncompress(src_p + 4, buf, buf_size);
+  // TODO read_bytes が負だったら、データが壊れていることを表す
+  result = rb_str_new(buf, buf_size);
+
+  xfree(buf);
+
+  return result;
+}
+
+void Init_lz4ruby(void) {
+  lz4 = rb_define_module("LZ4Native");
+
+  rb_define_module_function(lz4, "compress", lz4_ruby_compress, 1);
+  rb_define_module_function(lz4, "compressHC", lz4_ruby_compressHC, 1);
+  rb_define_module_function(lz4, "uncompress", lz4_ruby_uncompress, 1);
+}

data/lib/lz4-ruby.rb

@@ -0,0 +1,15 @@
+require 'lz4ruby'
+
+class LZ4
+  def self.compress(source)
+    return LZ4Native::compress(source)
+  end
+
+  def self.compressHC(source)
+    return LZ4Native::compressHC(source)
+  end
+
+  def self.uncompress(source)
+    return LZ4Native::uncompress(source)
+  end
+end

data/lz4-ruby.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "lz4-ruby"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["KOMIYA Atsushi"]
+  s.date = "2012-06-03"
+  s.description = "Ruby bindings for LZ4."
+  s.email = "komiya.atsushi@gmail.com"
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "ext/extconf.rb",
+    "ext/lz4ruby.c",
+    "lib/lz4-ruby.rb",
+    "lz4-ruby.gemspec",
+    "test/helper.rb",
+    "test/test_lz4-ruby.rb"
+  ]
+  s.homepage = "http://github.com/komiya-atsushi/lz4-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Ruby bindings for LZ4."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.4"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.4"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.4"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lz4-ruby'
+
+class Test::Unit::TestCase
+end

data/test/test_lz4-ruby.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestLz4Ruby < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: lz4-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- KOMIYA Atsushi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: Ruby bindings for LZ4.
+email: komiya.atsushi@gmail.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- ext/extconf.rb
+- ext/lz4ruby.c
+- lib/lz4-ruby.rb
+- lz4-ruby.gemspec
+- test/helper.rb
+- test/test_lz4-ruby.rb
+homepage: http://github.com/komiya-atsushi/lz4-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 412764659
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for LZ4.
+test_files: []