extlzma2 2.0.0

data/lib/extlzma2/encoder.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'stringio'
+
+module LZMA
+  Encoder = Struct.new(:context, :outport, :writebuf, :workbuf, :status) do |klass|
+    klass::BLOCKSIZE = 256 * 1024 # 256 KiB
+
+    def initialize(context, outport)
+      super(context, outport, StringIO.new(String.new), String.new, [1])
+      self.class.method(:finalizer_regist).call(self, context, outport, writebuf, workbuf, status)
+    end
+
+    def write(buf)
+      writebuf.rewind
+      writebuf.string.clear
+      writebuf << buf
+      until writebuf.string.empty?
+        s = context.code(writebuf.string, workbuf, self.class::BLOCKSIZE, 0)
+        Utils.raise_err s unless s == 0
+        outport << workbuf
+        workbuf.clear
+      end
+
+      self
+    end
+
+    alias_method :<<, :write
+
+    def close
+      raise "already closed stream - #{inspect}" if eof?
+
+      self.class.method(:finalizer_close).call(context, outport, workbuf)
+
+      status[0] = nil
+
+      nil
+    end
+
+    def eof
+      !status[0]
+    end
+
+    alias_method :eof?, :eof
+
+    class << self
+      private
+
+      def finalizer_regist(obj, context, outport, writebuf, workbuf, status)
+        ObjectSpace.define_finalizer(obj, finalizer_make(context, outport, writebuf, workbuf, status))
+      end
+
+      def finalizer_make(context, outport, writebuf, workbuf, status)
+        proc do
+          if status[0]
+            until writebuf.string.empty?
+              s = context.code(writebuf.string, workbuf, self::BLOCKSIZE, 0)
+              Utils.raise_err s unless s == LZMA::OK
+              outport << workbuf
+              workbuf.clear
+            end
+
+            finalizer_close(context, outport, workbuf)
+
+            status[0] = nil
+          end
+        end
+      end
+
+      def finalizer_close(context, outport, workbuf)
+        loop do
+          workbuf.clear
+          s = context.code(nil, workbuf, self::BLOCKSIZE, LZMA::FINISH)
+          outport << workbuf
+          break if s == LZMA::STREAM_END
+
+          Utils.raise_err s unless s == LZMA::OK
+        end
+      end
+    end
+  end
+end

data/lib/extlzma2/filter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LZMA
+  class Filter
+    def self.lzma1(*args)
+      LZMA1.new(*args)
+    end
+
+    def self.lzma2(*args)
+      LZMA2.new(*args)
+    end
+
+    def self.delta(*args)
+      Delta.new(*args)
+    end
+  end
+end

data/lib/extlzma2/stream.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module LZMA
+  class Stream
+    def self.encoder(*args, **opts)
+      if args.empty?
+        Encoder.new(Filter::LZMA2.new(LZMA::PRESET_DEFAULT), **opts)
+      elsif args.size == 1 && args[0].is_a?(Numeric)
+        Encoder.new(Filter::LZMA2.new(args[0]), **opts)
+      else
+        Encoder.new(*args, **opts)
+      end
+    end
+
+    def self.decoder(*args)
+      if args.empty?
+        Decoder.new(Filter::LZMA2.new(LZMA::PRESET_DEFAULT))
+      elsif args.size == 1 && args[0].is_a?(Numeric)
+        Decoder.new(Filter::LZMA2.new(args[0]))
+      else
+        Decoder.new(*args)
+      end
+    end
+
+    def self.auto_decoder(*args)
+      AutoDecoder.new(*args)
+    end
+
+    def self.raw_encoder(*args)
+      if args.empty?
+        RawEncoder.new(Filter::LZMA2.new(LZMA::PRESET_DEFAULT))
+      elsif args.size == 1 && args[0].is_a?(Numeric)
+        RawEncoder.new(Filter::LZMA2.new(args[0]))
+      else
+        RawEncoder.new(*args)
+      end
+    end
+
+    def self.raw_decoder(*args)
+      if args.empty?
+        RawDecoder.new(Filter::LZMA2.new(LZMA::PRESET_DEFAULT))
+      elsif args.size == 1 && args[0].is_a?(Numeric)
+        RawDecoder.new(Filter::LZMA2.new(args[0]))
+      else
+        RawDecoder.new(*args)
+      end
+    end
+  end
+end

data/lib/extlzma2/utils.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module LZMA
+  module Utils
+    def self.crc32_digest(seq, init = 0)
+      [Utils.crc32(seq, init)].pack('N')
+    end
+
+    def self.crc32_hexdigest(seq, init = 0)
+      format('%08X', Utils.crc32(seq, init))
+    end
+
+    def self.crc64_digest(seq, init = 0)
+      [Utils.crc64(seq, init)].pack('Q>')
+    end
+
+    def self.crc64_hexdigest(seq, init = 0)
+      format('%016X', Utils.crc64(seq, init))
+    end
+
+    CRC32 = Struct.new(:state, :init) do
+      def initialize(state = 0)
+        state = state.to_i
+        super(state, state)
+      end
+
+      def update(data)
+        self.state = Utils.crc32(data, state)
+        self
+      end
+
+      alias_method :<<, :update
+
+      def finish
+        self
+      end
+
+      def reset
+        self.state = init
+        self
+      end
+
+      def digest
+        [state].pack('N')
+      end
+
+      def hexdigest
+        format('%08x', state)
+      end
+
+      alias_method :to_s, :hexdigest
+
+      def to_str
+        "CRC32 <#{hexdigest}>"
+      end
+
+      alias_method :inspect, :to_str
+    end
+
+    CRC64 = Struct.new(:state, :init) do
+      def initialize(state = 0)
+        state = state.to_i
+        super(state, state)
+      end
+
+      def update(data)
+        self.state = Utils.crc64(data, state)
+        self
+      end
+
+      alias_method :<<, :update
+
+      def finish
+        self
+      end
+
+      def reset
+        self.state = init
+        self
+      end
+
+      def digest
+        [state].pack('Q>')
+      end
+
+      def hexdigest
+        '%016x' % state
+      end
+
+      alias_method :to_s, :hexdigest
+
+      def to_str
+        "CRC64 <#{hexdigest}>"
+      end
+
+      alias_method :inspect, :to_str
+    end
+
+    def raise_err(lzma_ret, mesg = nil)
+      et = Utils.lookup_error(lzma_ret)
+      raise et, mesg, caller
+    end
+  end
+end

data/lib/extlzma2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LZMA
+  VERSION = '2.0.0'
+end

data/lib/extlzma2.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require_relative 'extlzma2/aux'
+require_relative 'extlzma2/decoder'
+require_relative 'extlzma2/encoder'
+require_relative 'extlzma2/filter'
+require_relative 'extlzma2/stream'
+require_relative 'extlzma2/utils'
+require_relative 'extlzma2/extlzma2'
+require_relative 'extlzma2/version'
+
+module LZMA
+  #
+  # call-seq:
+  #   encode(string_data, preset = LZMA::PRESET_DEFAULT, opts = {}) -> encoded_xz_data
+  #   encode(string_data, filter...) -> encoded_xz_data
+  #   encode(output_stream = nil, preset = LZMA::PRESET_DEFAULT, opts = {}) -> stream_encoder
+  #   encode(output_stream, filter...) -> stream_encoder
+  #   encode(output_stream = nil, preset = LZMA::PRESET_DEFAULT, opts = {}) { |encoder| ... } -> yield return value
+  #   encode(output_stream, filter...) { |encoder| ... } -> yield return value
+  #
+  # データを圧縮、または圧縮器を生成します。
+  #
+  # 圧縮されたデータ列は xz ファイルフォーマットとなるため、コマンドラインの xz などで伸張させることが可能です。
+  #
+  # [RETURN encoded_xz_data]
+  #   xz データストリームとしての String インスタンスです。
+  # [RETURN stream_encoder]
+  #   xz データストリームを生成する圧縮器を返します。
+  # [RETURN output_stream]
+  #   引数として渡した <tt>output_stream</tt> そのものを返します。
+  # [string_data]
+  #   圧縮元となるデータを String インスタンスで渡します。
+  #   liblzma はエンコーディング情報を無視し、そのままのバイト列をバイナリデータと見立て処理を行います。
+  # [preset = LZMA::PRESET_DEFAULT]
+  #   圧縮プリセット値を指定します (圧縮レベルのようなものです)。詳細は LZMA::Filter::LZMA2.new を見てください。
+  # [opts]
+  #   LZMA::Filter::LZMA2.new に渡される可変引数です。詳細は LZMA::Filter::LZMA2.new を見てください。
+  # [filter]
+  #   LZMA::Filter で定義されているクラスのインスタンスを指定します。最大4つまで指定することが出来ます。
+  # [output_stream]
+  #   圧縮データの受け皿となるオブジェクトを指定します。
+  #
+  #   <tt>.<<</tt> メソッドが呼ばれます。
+  # [YIELD RETURN]
+  #   無視されます。
+  # [YIELD encoder]
+  #   圧縮器が渡されます。
+  #
+  # [EXCEPTIONS]
+  #   (NO DOCUMENT)
+  #
+  def self.encode(src = nil, *args, &block)
+    Aux.encode(src, Stream.encoder(*args), &block)
+  end
+
+  #
+  # call-seq:
+  #   decode(string_data) -> decoded data
+  #   decode(string_data, filter...) -> decoded data
+  #   decode(input_stream) -> decoder
+  #   decode(input_stream, filter...) -> decoder
+  #   decode(input_stream) { |decoder| ... }-> yield return value
+  #   decode(input_stream, filter...) { |decoder| ... }-> yield return value
+  #
+  # 圧縮されたデータを伸張します。
+  #
+  # [RETURN decoded data]
+  #   xz データストリームとしての String インスタンスです。
+  # [RETURN decoder]
+  # [RETURN yield return value]
+  # [string_data]
+  #   圧縮されたデータを与えます。圧縮されたデータの形式は xz と lzma です。これらはあらかじめ区別する必要なく与えることが出来ます。
+  # [options]
+  #   LZMA::Filter::LZMA2.new に渡される可変引数です。詳細は LZMA::Filter::LZMA2.new を見てください。
+  # [EXCEPTIONS]
+  #   (NO DOCUMENT)
+  #
+  def self.decode(src, *args, &block)
+    Aux.decode(src, Stream.auto_decoder(*args), &block)
+  end
+
+  #
+  # call-seq:
+  #   LZMA.raw_encode(src) -> encoded data
+  #   LZMA.raw_encode(src, filter...) -> encoded data
+  #   LZMA.raw_encode(outport = nil) -> encoder
+  #   LZMA.raw_encode(outport, filter...) -> encoder
+  #   LZMA.raw_encode(outport = nil) { |encoder| ... } -> yield return value
+  #   LZMA.raw_encode(outport, filter...)  { |encoder| ... } -> yield return value
+  #
+  # データを圧縮します。圧縮されたデータ列は生の lzma1/lzma2 のデータ列であるため、伸張する際に適切なフィルタを与える必要があります。
+  #
+  # xz ファイルフォーマットヘッダや整合値を持たないため、これらが不要な場合は有用かもしれません。
+  #
+  # [RETURN encoded data]
+  #   生の lzma1/lzma2 のデータ列となる String インスタンスです。
+  # [src]
+  #   圧縮元となるデータを String インスタンスで渡します。
+  # [filter]
+  #   LZMA::Filter のインスタンスを与えます。最大4つまで指定可能です。
+  #
+  #   省略時は lzma2 フィルタが指定されたとみなします。
+  # [EXCEPTIONS]
+  #   (NO DOCUMENT)
+  #
+  def self.raw_encode(src, *args, &block)
+    Aux.encode(src, Stream.raw_encoder(*args), &block)
+  end
+
+  #
+  # call-seq:
+  #   LZMA.raw_decode(encoded_data) -> decoded data
+  #   LZMA.raw_decode(encoded_data, filter...) -> decoded data
+  #   LZMA.raw_decode(inport) -> raw decoder
+  #   LZMA.raw_decode(inport, filter...) -> raw decoder
+  #   LZMA.raw_decode(inport) { |decoder| ... } -> yield return value
+  #   LZMA.raw_decode(inport, filter...) { |decoder| ... } -> yield return value
+  #
+  # 圧縮されたデータを伸張します。圧縮した際に用いたフィルタをそのままの順番・数で与える必要があります。
+  #
+  # [RETURN decoded data]
+  #   伸張されたデータ列となる String インスタンスです。
+  # [src]
+  #   圧縮された生の lzma1/lzma2 の String インスタンスを渡します。
+  # [options]
+  #   LZMA::Filter のインスタンスを与えます。最大4つまで指定可能です。
+  #
+  #   省略時は lzma2 フィルタが指定されたとみなします。
+  # [EXCEPTIONS]
+  #   (NO DOCUMENT)
+  #
+  def self.raw_decode(src, *args, &block)
+    Aux.decode(src, Stream.raw_decoder(*args), &block)
+  end
+
+  def self.lzma1(*args)
+    LZMA::Filter::LZMA1.new(*args)
+  end
+
+  def self.lzma2(*args)
+    LZMA::Filter::LZMA2.new(*args)
+  end
+
+  def self.delta(*args)
+    LZMA::Filter::Delta.new(*args)
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: extlzma2
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Ishotihadus
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-20 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby binding of liblzma that is compatible with Ruby 3.2
+email:
+- hanachan.pao@gmail.com
+executables: []
+extensions:
+- ext/extlzma2/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rspec_status"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- ext/extlzma2/consts.c
+- ext/extlzma2/error.c
+- ext/extlzma2/extconf.rb
+- ext/extlzma2/extlzma2.c
+- ext/extlzma2/extlzma2.h
+- ext/extlzma2/filter.c
+- ext/extlzma2/index.c
+- ext/extlzma2/stream.c
+- ext/extlzma2/utils.c
+- extlzma2.gemspec
+- lib/extlzma2.rb
+- lib/extlzma2/aux.rb
+- lib/extlzma2/decoder.rb
+- lib/extlzma2/encoder.rb
+- lib/extlzma2/filter.rb
+- lib/extlzma2/stream.rb
+- lib/extlzma2/utils.rb
+- lib/extlzma2/version.rb
+homepage: https://github.com/Ishotihadus/extlzma2
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Ishotihadus/extlzma2
+  source_code_uri: https://github.com/Ishotihadus/extlzma2
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.0.dev
+signing_key:
+specification_version: 4
+summary: A Ruby binding of liblzma
+test_files: []