extlz4 0.2.4.2

data/lib/extlz4/version.rb

@@ -0,0 +1,3 @@
+module LZ4
+  VERSION = "0.2.4.2"
+end

data/test/common.rb

@@ -0,0 +1,18 @@
+require "openssl" # for OpenSSL::Random.random_bytes
+require "digest"
+
+SMALLSIZE = 400
+BIGSIZE = 12000000
+
+SAMPLES = {
+  "empty"               => "",
+  "\\0 (small size)"    => "\0".b * SMALLSIZE,
+  "\\0 (big size)"      => "\0".b * BIGSIZE,
+  "\\xaa (small size)"  => "\xaa".b * SMALLSIZE,
+  "\\xaa (big size)"    => "\xaa".b * BIGSIZE,
+  "random (small size)" => OpenSSL::Random.random_bytes(SMALLSIZE),
+  "random (big size)"   => OpenSSL::Random.random_bytes(BIGSIZE),
+}
+
+SAMPLES["freebsd ports index"] = File.read("/usr/ports/INDEX-10", mode: "rb") rescue nil # if on FreeBSD
+SAMPLES["freebsd kernel"] = File.read("/boot/kernel/kernel", mode: "rb") rescue nil # if on FreeBSD

data/test/test_blockapi.rb

@@ -0,0 +1,105 @@
+#!ruby
+
+require "test-unit"
+require "extlz4"
+
+require_relative "common"
+
+class TestBlockAPI < Test::Unit::TestCase
+  unless Object.const_defined?(:FrozenError)
+    # NOTE: FrozenError は ruby-2.5 で登場
+    FrozenError = RuntimeError
+  end
+
+  SAMPLES.each_pair do |name, data|
+    [-20, -10, -1, nil, 0, 1, 9].each do |level|
+      define_method("test_block_encode_decode_sample:#{name}:level=#{level.inspect}", -> {
+        assert(data, LZ4.block_decode(LZ4.block_encode(level, data)))
+      })
+
+      [[], [data]].each do |opt_dict|
+        define_method("test_streaming_block_encode_decode:#{name}:level=#{level.inspect}#{opt_dict.empty? ? nil : ":with predict"}", -> {
+          lz4 = LZ4.block_stream_encode level, *opt_dict
+          input = StringIO.new(data)
+          buf = "".b
+          blocks = []
+          input.size.times do |size|
+            break unless input.read((1 << size) + 1, buf)
+            blocks << lz4.update(buf)
+          end
+          lz4.free
+
+          lz4 = LZ4.block_stream_decode *opt_dict
+          data1 = "".b
+          blocks.each do |b|
+            data1 << lz4.update(b)
+          end
+          lz4.free
+
+          assert(data, data1)
+        })
+      end
+    end
+  end
+
+  def test_block_encode
+    buf = ""
+    assert_kind_of(String, LZ4.block_encode(SAMPLES["\\0 (small size)"]))
+    assert_kind_of(String, LZ4.block_encode(SAMPLES["\\0 (small size)"], 1000))
+    assert_same(buf, LZ4.block_encode(SAMPLES["\\0 (small size)"], buf))
+    assert_same(buf, LZ4.block_encode(SAMPLES["\\0 (small size)"], 1000, buf))
+    assert_same(buf, LZ4.block_encode(nil, SAMPLES["\\0 (small size)"], 1000, buf))
+
+    # high speed
+    assert_kind_of(String, LZ4.block_encode(-15, SAMPLES["\\0 (small size)"]))
+    assert_kind_of(String, LZ4.block_encode(-15, SAMPLES["\\0 (small size)"], 1000))
+    assert_same(buf, LZ4.block_encode(-15, SAMPLES["\\0 (small size)"], buf))
+    assert_same(buf, LZ4.block_encode(-15, SAMPLES["\\0 (small size)"], 1000, buf))
+
+    # high compression
+    assert_kind_of(String, LZ4.block_encode(0, SAMPLES["\\0 (small size)"]))
+    assert_kind_of(String, LZ4.block_encode(0, SAMPLES["\\0 (small size)"], 1000))
+    assert_same(buf, LZ4.block_encode(0, SAMPLES["\\0 (small size)"], buf))
+    assert_same(buf, LZ4.block_encode(0, SAMPLES["\\0 (small size)"], 1000, buf))
+  end
+
+  def test_block_encode_invalid_args
+    src = SAMPLES["\\0 (small size)"]
+    buf = ""
+    assert_raise(ArgumentError) { LZ4.block_encode } # no arguments
+    assert_raise(TypeError) { LZ4.block_encode(100) } # source is not string
+    assert_raise(TypeError) { LZ4.block_encode(nil) } # source is not string
+    assert_raise(TypeError) { LZ4.block_encode(:bad_input) } # source is not string
+    assert_raise(TypeError) { LZ4.block_encode(/bad-input/) } # source is not string
+    assert_raise(FrozenError) { LZ4.block_encode(src, "bad-destbuf".freeze) } # can't modify frozen String
+    assert_raise(LZ4::Error) { LZ4.block_encode(src, 1) } # maxdest is too small
+    assert_raise(LZ4::Error) { LZ4.block_encode(src, 1, buf) } # maxdest is too small
+    assert_raise(TypeError) { LZ4.block_encode(src, "bad-maxsize", "a") } # "bad-maxsize" is not integer
+  end
+
+  def test_block_decode
+    src = LZ4.block_encode(SAMPLES["\\0 (small size)"])
+    buf = ""
+    assert_kind_of(String, LZ4.block_decode(src))
+    assert_kind_of(String, LZ4.block_decode(src, 1000))
+    assert_same(buf, LZ4.block_decode(src, buf))
+    assert_same(buf, LZ4.block_decode(src, 1000, buf))
+  end
+
+  def test_block_decode_invalid_args
+    src = LZ4.block_encode(SAMPLES["\\0 (small size)"])
+    buf = ""
+    assert_raise(ArgumentError) { LZ4.block_decode } # no arguments
+    assert_raise(TypeError) { LZ4.block_decode(-1, src) } # do not given level
+    assert_raise(TypeError) { LZ4.block_decode(100) } # source is not string
+    assert_raise(TypeError) { LZ4.block_decode(nil) } # source is not string
+    assert_raise(TypeError) { LZ4.block_decode(:bad_input) } # source is not string
+    assert_raise(TypeError) { LZ4.block_decode(/bad-input/) } # source is not string
+    assert_raise(FrozenError) { LZ4.block_decode(src, "bad-destbuf".freeze) } # can't modify frozen String
+    assert_raise(TypeError) { LZ4.block_decode(src, "bad-maxsize", "a") } # "bad-maxsize" is not integer
+
+    src2 = SAMPLES["\\xaa (small size)"]
+    assert_raise(LZ4::Error) { LZ4.block_decode(src2) } # encounted invalid end of sequence
+    assert_raise(LZ4::Error) { LZ4.block_decode(src2, 100000) } # max_dest_size is too small, or data is corrupted
+  end
+end

data/test/test_frameapi.rb

@@ -0,0 +1,59 @@
+#!ruby
+
+=begin
+# 必要と思われる試験項目
+
+* LZ4.encode
+  * LZ4.decode で伸長できるか
+  * lz4-cli で伸長できるか
+  * 汚染状態の伝搬
+  * security level
+* LZ4.encode_file
+  * LZ4.decode_file で伸長できるか
+  * lz4-cli で伸長できるか
+* LZ4.decode
+* LZ4.decode_file
+* LZ4.test_file
+
+* 試験で用いる試料
+  * /usr/ports/INDEX-10
+  * /boot/kernel/kernel
+  * 長さ 0 の空データ
+  * 0 で埋められた小さなデータ
+  * 0 で埋められたでかいデータ
+  * 0xaa で埋められた小さなデータ
+  * 0xaa で埋められたでかいデータ
+  * /dev/random (4000 bytes)
+  * /dev/random (12000000 bytes)
+  * 可能であれば数十 GB レベルのファイル
+=end
+
+require "test-unit"
+require "extlz4"
+
+require_relative "common"
+
+class TestFrameAPI < Test::Unit::TestCase
+  SAMPLES.each_pair do |name, data|
+    define_method("test_encode_decode_sample:#{name}", -> {
+      assert_equal(Digest::MD5.hexdigest(data), Digest::MD5.hexdigest(LZ4.decode(LZ4.encode(data))))
+    })
+  end
+
+  def test_encode_args
+    assert_kind_of(LZ4::Encoder, LZ4.encode)
+    assert_kind_of(LZ4::Encoder, LZ4.encode(StringIO.new("")))
+    assert_kind_of(String, LZ4.encode {})
+    io = StringIO.new("")
+    assert_same(io, LZ4.encode(io) {})
+    assert_kind_of(LZ4::Encoder, LZ4.encode(io, 16))
+    assert_kind_of(LZ4::Encoder, LZ4::Encoder.new)
+  end
+
+  def test_decode_args
+    assert_raise(ArgumentError) { LZ4.decode }
+    assert_raise(NoMethodError) { LZ4.decode(nil) } # undefined method `read' for nil:NilClass
+    assert_raise(LZ4::Error) { LZ4.decode("") } # read error (or already EOF)
+    assert_raise(ArgumentError) { LZ4.decode(nil, nil) } # wrong number of arguments (2 for 1)
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: extlz4
+version: !ruby/object:Gem::Version
+  version: 0.2.4.2
+platform: ruby
+authors:
+- dearblue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'ruby bindings for LZ4 <https://github.com/lz4/lz4>.
+
+'
+email: dearblue@users.noreply.github.com
+executables:
+- extlz4
+extensions:
+- ext/extconf.rb
+extra_rdoc_files:
+- HISTORY.ja.md
+- LICENSE
+- README.md
+- contrib/lz4/LICENSE
+- contrib/lz4/README.md
+- contrib/lz4/lib/LICENSE
+- contrib/lz4/lib/README.md
+- ext/blockapi.c
+- ext/extlz4.c
+- ext/extlz4.h
+- ext/frameapi.c
+- ext/hashargs.c
+- ext/hashargs.h
+- ext/lz4_amalgam.c
+- lib/extlz4.rb
+- lib/extlz4/compat.rb
+- lib/extlz4/fix-0.1bug.rb
+- lib/extlz4/oldstream.rb
+- lib/extlz4/version.rb
+files:
+- HISTORY.ja.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/extlz4
+- contrib/lz4/INSTALL
+- contrib/lz4/LICENSE
+- contrib/lz4/NEWS
+- contrib/lz4/README.md
+- contrib/lz4/circle.yml
+- contrib/lz4/lib/LICENSE
+- contrib/lz4/lib/README.md
+- contrib/lz4/lib/liblz4.pc.in
+- contrib/lz4/lib/lz4.c
+- contrib/lz4/lib/lz4.h
+- contrib/lz4/lib/lz4frame.c
+- contrib/lz4/lib/lz4frame.h
+- contrib/lz4/lib/lz4frame_static.h
+- contrib/lz4/lib/lz4hc.c
+- contrib/lz4/lib/lz4hc.h
+- contrib/lz4/lib/lz4opt.h
+- contrib/lz4/lib/xxhash.c
+- contrib/lz4/lib/xxhash.h
+- examples/frameapi.rb
+- ext/blockapi.c
+- ext/depend
+- ext/extconf.rb
+- ext/extlz4.c
+- ext/extlz4.h
+- ext/frameapi.c
+- ext/hashargs.c
+- ext/hashargs.h
+- ext/lz4_amalgam.c
+- gemstub.rb
+- lib/extlz4.rb
+- lib/extlz4/compat.rb
+- lib/extlz4/fix-0.1bug.rb
+- lib/extlz4/oldstream.rb
+- lib/extlz4/version.rb
+- test/common.rb
+- test/test_blockapi.rb
+- test/test_frameapi.rb
+homepage: https://github.com/dearblue/ruby-extlz4
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset"
+- UTF-8
+- "-m"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: ruby bindings for LZ4
+test_files: []