liblzma 0.3-x86-mingw32

data/lib/liblzma.rb

@@ -0,0 +1,222 @@
+#vim: set fileencoding:utf-8
+
+ver = RbConfig::CONFIG["ruby_version"]
+lib = File.join(File.dirname(__FILE__), ver, "liblzma.so")
+if File.file?(lib)
+  require_relative File.join(ver, "liblzma.so")
+else
+  require_relative "liblzma.so"
+end
+
+
+#--
+# This comment is avoid the problem that is recognized binary by rdoc
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#                                                                       #
+#++
+
+module LibLZMA
+  LZMA = self
+
+  # call-seq:
+  # LibLZMA.encode(data, ...) -> encoded_xz_data
+  #
+  # データを圧縮します。圧縮されたデータ列は、xz ファイルフォーマットとなるため、コマンドラインの xz などで伸張させることが可能です。
+  #
+  # [data]        圧縮元となるデータを String インスタンスで渡します。liblzma はエンコーディング情報を無視し、そのままのバイト列をバイナリデータと見立て処理を行います。
+  #
+  # [options]     LZMA::Filter::LZMA2.new に渡される可変引数です。詳細は LZMA::Filter::LZMA2.new を見てください。
+  #
+  # [RETURN]      xz データストリームとしての String インスタンスです。
+  #
+  # [EXCEPTIONS]  (NO DOCUMENT)
+  module_function
+  def encode(data, *args)
+    s = Stream.encoder(Filter.lzma2(*args))
+    s.update(data, LZMA::FINISH)
+  ensure
+    s.finish rescue nil if s
+  end
+
+  # call-seq:
+  # LZMA.decode(encoded_data, ...) -> string
+  #
+  # 圧縮されたデータを伸張します。
+  #
+  # [encoded_data] 圧縮されたデータを与えます。圧縮されたデータの形式は、xz と lzma です。これらはあらかじめ区別する必要なく与えることが出来ます。
+  #
+  # [options]     LZMA::Filter::LZMA2.new に渡される可変引数です。詳細は LZMA::Filter::LZMA2.new を見てください。
+  #
+  # [RETURN]      xz データストリームとしての String インスタンスです。
+  #
+  # [EXCEPTIONS]  (NO DOCUMENT)
+  module_function
+  def decode(data, *args)
+    s = Stream.auto_decoder(*args)
+    s.update(data, LZMA::FINISH)
+  ensure
+    s.finish rescue nil if s
+  end
+
+  # call-seq:
+  # LZMA.raw_encode(data, ...) -> encoded_data
+  #
+  # データを圧縮します。圧縮されたデータ列は生の lzma1/lzma2 のデータ列であるため、伸張する際に適切なフィルタを与える必要があります。
+  #
+  # xz ファイルフォーマットヘッダや整合値を持たないため、これらが不要な場合は有用かもしれません。
+  #
+  # [data]        圧縮元となるデータを String インスタンスで渡します。liblzma はエンコーディング情報を無視し、そのままのバイト列をバイナリデータと見立てて処理を行います。
+  #
+  # [options]     LZMA::Filter のインスタンスを与えます。
+  #
+  # [RETURN]      生の lzma1/lzma2 のデータ列となる String インスタンスです。
+  #
+  # [EXCEPTIONS]  (NO DOCUMENT)
+  module_function
+  def raw_encode(data, *args)
+    s = Stream.raw_encoder(*args)
+    s.update(data, LZMA::FINISH)
+  ensure
+    s.finish rescue nil if s
+  end
+
+  # call-seq:
+  # LZMA.raw_decode(encoded_data, ...) -> decoded_data
+  #
+  # 圧縮されたデータを伸張します。圧縮した際に用いたフィルタをそのままの順番・数で与える必要があります。
+  #
+  # [data]        圧縮された生の lzma1/lzma2 の String インスタンスを渡します。liblzma はエンコーディング情報を無視し、そのままのバイト列をバイナリデータと見立てて処理を行います。
+  #
+  # [options]     LZMA::Filter のインスタンスを与えます。
+  #
+  # [RETURN]      伸張されたデータ列となる String インスタンスです。
+  #
+  # [EXCEPTIONS]  (NO DOCUMENT)
+  module_function
+  def raw_decode(data, *args)
+    s = Stream.raw_decoder(*args)
+    s.update(data, LZMA::FINISH)
+  ensure
+    s.finish rescue nil if s
+  end
+
+  class Stream
+    def self.encoder(*args)
+      Encoder.new(*args)
+    end
+
+    def self.decoder(*args)
+      Decoder.new(*args)
+    end
+
+    def self.auto_decoder(*args)
+      AutoDecoder.new(*args)
+    end
+
+    def self.raw_encoder(*args)
+      RawEncoder.new(*args)
+    end
+
+    def self.raw_decoder(*args)
+      RawDecoder.new(*args)
+    end
+  end
+
+  module Utils
+    # CRC32 を Digest のように生成できるようになります。
+    class CRC32 < Struct.new(:state, :init)
+      def initialize(state = 0)
+        state = state.to_i
+        super(state, state)
+      end
+
+      # call-seq:
+      # LZMA::Utils::CRC32#update(data) -> self
+      def update(data)
+        self.state = Utils.crc32(data, state)
+        self
+      end
+
+      alias << update
+
+      def finish
+        self
+      end
+
+      def reset
+        self.state = init
+        self
+      end
+
+      def digest
+        [state].pack("N")
+      end
+
+      def hexdigest
+        "%08x" % state
+      end
+
+      alias to_s hexdigest
+
+      def to_str
+        "CRC32 <#{hexdigest}>"
+      end
+
+      alias inspect to_str
+    end
+
+    # CRC64 を Digest のように生成できるようになります。
+    class CRC64 < Struct.new(:state, :init)
+      def initialize(state = 0)
+        state = state.to_i
+        super(state, state)
+      end
+
+      # call-seq:
+      # LZMA::Utils::CRC64#update(data) -> self
+      def update(data)
+        self.state = Utils.crc64(data, state)
+        self
+      end
+
+      alias << update
+
+      def finish
+        self
+      end
+
+      def reset
+        self.state = init
+        self
+      end
+
+      def digest
+        [state].pack("Q>")
+      end
+
+      def hexdigest
+        "%016x" % state
+      end
+
+      alias to_s hexdigest
+
+      def to_str
+        "CRC64 <#{hexdigest}>"
+      end
+
+      alias inspect to_str
+    end
+  end
+end
+
+LZMA = LibLZMA unless Object.const_defined?(:LZMA)

data/samples/01-easy_using.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+#vim: set fileencoding:utf-8
+
+# このrubyスクリプトはliblzma for Rubyの利用手引きを兼ねたサンプルスクリプトです。
+
+
+# rubyでliblzmaの機能を利用するのに必要なのは、次の一文のみです
+require "liblzma"
+
+
+# 圧縮するデータを用意します
+original_data = "0123456789abcdefghijklmnopqrstuvwxyz\n" * 10
+
+
+# liblzmaを使って、データを圧縮します (xzデータストリームそのものが出力されます)
+encoded_data = LZMA.encode(original_data)
+
+
+# 圧縮レベルを変える場合は、第二引数に0から9の整数値を与えます
+# この例は xz -1 と等価です
+# (『9』を与える場合、作業メモリ空間が700MBほど必要になります)
+encoded_data = LZMA.encode(original_data, 1)
+
+
+# さらに細かい調整は、圧縮レベル(プリセット値)の後にハッシュ値を指定します
+# この例ではプリセット値を省略しています
+# (プリセット値の規定値はliblzma由来であり、『6』です)
+encoded_data = LZMA.encode(original_data, mode: LZMA::MODE_FAST)
+
+# この他にどんな値が与えられるかは、LZMA::Filter::LZMA2.newを参考にしてください
+
+
+# 必要であればファイルに書き出しましょう
+# xzデータストリームそのものです
+File.write("sample.txt.xz", encoded_data, mode: "wb")
+
+# 出力されたファイルがxzユーティリティ(もしくは7-Zip)で開けることを確認してください
+
+
+
+# 圧縮されたデータを伸張してみましょう
+# たったこれだけです
+puts LZMA.decode(encoded_data)
+
+
+
+# 今回は処理したいデータをあらかじめ用意してから、一気に処理を行う方法を提示しました
+# 現実には少しずつデータを処理していく必要がある事例も少なくありません
+# (巨大な――数ギガバイトにも及ぶ――ファイルなどはオンメモリでは現実的に処理できませんね)
+# データを少しずつ圧縮/伸張していく、ストリーム志向での処理は 02-* にて提示します
+
+
+# 今回利用したクラス/モジュール/メソッド
+#   LZMA.encode
+#   LZMA.decode
+
+
+# [EOF]

data/samples/02-streaming.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+#vim: set fileencoding:utf-8
+
+# この ruby スクリプトは liblzma for Ruby の利用手引きを兼ねたサンプルスクリプトです。
+
+
+# 01-* ではデータの全てを用意してから処理を行う方法を提示しますた。
+# このサンプルではオンメモリでは難しい大きなデータを処理する方法を提示します。
+
+
+# 始めはお決まりで
+require "liblzma"
+
+# 今回のサンプルでファイルI/Oを再現するためにStringIOを利用します
+require "stringio"
+
+# 圧縮元となるデータを用意します
+original_data = "abcdefghijklmnopqrstuvwxyz" * 50
+
+
+# まずは圧縮してみましょう
+source = StringIO.new(original_data)
+dest = ""
+encoder = LZMA::Stream.encoder(LZMA::Filter.lzma2)  # (1)
+while fragment = source.read(16)                    # (2)
+    dest << encoder.update(fragment)                #  -
+end                                                 #  -
+dest << encoder.finish                              # (3)
+
+# (1) はじめに圧縮器を構築します
+#     LZMA::Stream.encoderの引数は、1つ以上をとることが出来ます (上限はliblzma由来となる4つです)
+#     LZMA::Filter.lzma2の引数は、LZMA.encodeの二つ目以降の引数と同じです
+#     (LZMA::Filter.lzma2(1) とか LZMA::Filter.lzma2(mode: LZMA::MODE_FAST) とか)
+# (2) 取り込んだ部分データを処理します
+# (3) データの終わりを通知し、圧縮器内に残ったデータを取り出します
+#     これを忘れるとxzデータストリームとして間違ったものが生成されます
+
+
+
+encoded_data = dest
+
+
+# 伸張も圧縮とほとんど同じです
+source = StringIO.new(encoded_data)
+dest = ""
+decoder = LZMA::Stream.decoder                      # (1)
+while fragment = source.read(16)                    # (2)
+    dest << decoder.update(fragment)                #  -
+end                                                 #  -
+dest << decoder.finish                              # (3)
+
+puts(dest == original_data ? "data ok" : "bad data")
+
+# 圧縮時と伸張時の違いがわかりますか?
+# はじめ(1)の伸張器の構築部分 (encoderかdecoderか) を変更するだけで、後は同じような文で処理を行えます
+
+
+# 上の例ではxzデータストリームのみの対応です
+# lzmaデータストリームは対象となりません
+# xzもlzmaも区別なく伸張したい場合は、decoder ではなく auto_decoder を使います
+source = StringIO.new(encoded_data)
+dest = ""
+decoder = LZMA::Stream.auto_decoder                 # (1)
+while fragment = source.read(16)                    # (2)
+    dest << decoder.update(fragment)                #  -
+end                                                 #  -
+dest << decoder.finish                              # (3)
+
+puts(dest == original_data ? "data ok" : "bad data")
+
+
+
+# 今回利用したクラス/モジュール/メソッド
+#   LZMA::Stream.encoder        LZMA::Stream::Encoder.new と等価
+#   LZMA::Stream.decoder        LZMA::Stream::Decoder.new と等価
+#   LZMA::Stream.auto_decoder   LZMA::Stream::AutoDecoder.new と等価
+#   LZMA::Filter.lzma2          LZMA::Filter::LZMA2.new と等価
+#   LZMA::Stream#update
+#   LZMA::Stream#finish
+
+
+# [EOF]

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: liblzma
+version: !ruby/object:Gem::Version
+  version: '0.3'
+  prerelease: 
+platform: x86-mingw32
+authors:
+- dearblue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: dearblue@users.sourceforge.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.txt
+- ext/extconf.rb
+- ext/liblzma.c
+- lib/liblzma.rb
+- lib/1.9.1/liblzma.so
+- lib/2.0.0/liblzma.so
+- samples/01-easy_using.rb
+- samples/02-streaming.rb
+homepage: 
+licenses:
+- 2-clause BSD License
+post_install_message: 
+rdoc_options:
+- -eUTF-8
+- -mREADME.txt
+- README.txt
+- ext/liblzma.c
+- lib/liblzma.rb
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ruby bindings for liblzma that is included in the xz utilities
+test_files: []
+has_rdoc: false