rubyzip-bzip2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7322a0596a465cab1e1f7e5a2bfa7c7fbc8d5d8265187dffb8eb2c3826066c8e
+  data.tar.gz: 83693f7f9c329715977b8bcef4990013c6983ca0e1945525a877352814d612d7
+SHA512:
+  metadata.gz: 67d3cdb7afe2d41236cc7cd3b6350b32dcc4d009ce8ae30f327cf6cc3fee8a0a75b9b5aeec016a0d97a437699dc6a919d0f636a309b1dd075c61b55917dc28c9
+  data.tar.gz: a8130502de8fd975e62095197d1ec41b669a3bddd56adedd8a6feda29fb12db2c35a71ac016b96d9e7b2b7579a9a1ecd4d13fa13ed5ab75a647b9030af756421

data/README.md

@@ -0,0 +1,59 @@
+# rubyzip-bzip2
+
+[![Gem Version](https://badge.fury.io/rb/rubyzip-bzip2.svg)](http://badge.fury.io/rb/rubyzip-bzip2)
+[![Build Status](https://secure.travis-ci.org/rubyzip/rubyzip-bzip2.svg)](http://travis-ci.org/rubyzip/rubyzip-bzip2)
+[![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip-bzip2.svg)](https://codeclimate.com/github/rubyzip/rubyzip-bzip2)
+[![Coverage Status](https://img.shields.io/coveralls/rubyzip/rubyzip-bzip2.svg)](https://coveralls.io/r/rubyzip/rubyzip-bzip2?branch=master)
+
+The rubyzip-bzip2 gem provides an extension of the rubyzip gem for reading zip files
+compressed with bzip2 compression.
+
+## Website and Project Home
+http://github.com/rubyzip/rubyzip-bzip2
+
+## Requirements
+- Ruby 2.4 or greater
+
+## Installation
+The rubyzip-bzip2 gem is available on RubyGems:
+
+```
+gem install rubyzip-bzip2
+```
+
+Or in your Gemfile:
+
+```ruby
+gem 'rubyzip-bzip2'
+```
+
+## Usage
+Reading a zip file with bzip2 compression is not different from reading
+any other zip file using rubyzip:
+
+```ruby
+Zip::File.open('foo.zip') do |zipfile|
+  zipfile.each do |entry|
+    content = zipfile.read(entry.name)
+  end
+end
+
+```
+
+## License
+Rubyzip-bzip2 is distributed under the same license as ruby. See
+http://www.ruby-lang.org/en/LICENSE.txt
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyzip/rubyzip-bzip2.
+
+## Development
+You can run the tests with:
+
+```
+bundle install
+rake
+```
+
+## Authors
+Jan-Joost Spanjers ( oss at hiberis.nl )

data/lib/zip/bzip2.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'zip'
+require 'zip/bzip2/version'
+require 'zip/bzip2/decompressor'
+
+module Zip
+  # The Zip::Bzip2 module extends Rubyzip with support for the bzip2 compression method.
+  module Bzip2
+  end
+end

data/lib/zip/bzip2/decompress.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'zip/bzip2/libbz2'
+
+module Zip
+  module Bzip2
+    class Decompress #:nodoc:
+      OUTPUT_BUFFER_SIZE = 4096
+
+      def initialize(options = {})
+        small = options[:small]
+
+        @libbz2 = Libbz2.new.tap do |libbz2|
+          libbz2.decompress_init!(small)
+        end
+
+        @finished = false
+      end
+
+      def decompress(data)
+        result = ''.dup
+
+        with_input_buffer(data) do |input_buffer|
+          @libbz2.input_buffer = input_buffer
+
+          with_output_buffer(OUTPUT_BUFFER_SIZE) do |output_buffer|
+            while @libbz2.input?
+              @libbz2.output_buffer = output_buffer
+
+              @finished = @libbz2.decompress!
+              result += @libbz2.output
+              next unless @finished
+
+              @libbz2.decompress_end!
+              break
+            end
+          end
+        end
+
+        result
+      end
+
+      def finished?
+        @finished
+      end
+
+      private
+
+      def with_input_buffer(data)
+        input_buffer = nil
+        begin
+          input_buffer = Libbz2.buffer_from_data(data)
+          yield input_buffer
+        ensure
+          input_buffer&.free
+        end
+      end
+
+      def with_output_buffer(length)
+        output_buffer = nil
+        begin
+          output_buffer = Libbz2.buffer(length)
+          yield output_buffer
+        ensure
+          output_buffer&.free
+        end
+      end
+    end
+  end
+end

data/lib/zip/bzip2/decompressor.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'zip'
+require 'zip/bzip2/decompress'
+
+module Zip #:nodoc:
+  module Bzip2
+    class Decompressor < ::Zip::Decompressor #:nodoc:
+      def initialize(*args)
+        super
+
+        @buffer = ''.dup
+        @bzip2_ffi_decompressor = ::Zip::Bzip2::Decompress.new
+      end
+
+      def read(length = nil, outbuf = ''.dup)
+        return return_value_on_eof(length) if eof
+
+        fill_buffer(length)
+
+        outbuf.replace(@buffer.slice!(0...(length || @buffer.bytesize)))
+      end
+
+      def eof
+        @buffer.empty? && input_finished?
+      end
+
+      alias eof? eof
+
+      private
+
+      def return_value_on_eof(length)
+        return '' if length.nil? || length.zero?
+      end
+
+      def fill_buffer(min_length)
+        while min_length.nil? || (@buffer.bytesize < min_length)
+          break if input_finished?
+
+          @buffer << produce_input
+        end
+      end
+
+      def produce_input
+        @bzip2_ffi_decompressor.decompress(input_stream.read(Decompressor::CHUNK_SIZE))
+      rescue Bzip2::Error
+        raise(::Zip::DecompressionError, 'bzip2 error while decompressing')
+      end
+
+      def input_finished?
+        @bzip2_ffi_decompressor.finished?
+      end
+    end
+  end
+
+  ::Zip::Decompressor.register(::Zip::COMPRESSION_METHOD_BZIP2, ::Zip::Bzip2::Decompressor)
+end

data/lib/zip/bzip2/errors.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Zip
+  module Bzip2
+    # Base class for Zip::Bzip2 exceptions.
+    class Error < IOError
+    end
+
+    # Raised if a failure occurred allocating memory to complete a request.
+    class MemError < Error
+      # Initializes a new instance of MemError.
+      #
+      # @private
+      def initialize #:nodoc:
+        super('Could not allocate enough memory to perform this request')
+      end
+    end
+
+    # Raised if a data integrity error is detected (a mismatch between
+    # stored and computed CRCs or another anomaly in the compressed data).
+    class DataError < Error
+      # Initializes a new instance of DataError.
+      #
+      # @param message [String] Exception message (overrides the default).
+      # @private
+      def initialize(message = nil) #:nodoc:
+        super(
+          message ||
+            'Data integrity error detected (mismatch between stored and computed CRCs, '\
+            'or other anomaly in the compressed data)',
+        )
+      end
+    end
+
+    # Raised if the compressed data does not start with the correct magic
+    # bytes ('BZh').
+    class MagicDataError < DataError
+      # Initializes a new instance of MagicDataError.
+      #
+      # @private
+      def initialize #:nodoc:
+        super('Compressed data does not start with the correct magic bytes (\'BZh\')')
+      end
+    end
+
+    # Raised if libbz2 detects that it has been improperly compiled.
+    class ConfigError < DataError
+      # Initializes a new instance of ConfigError.
+      #
+      # @private
+      def initialize #:nodoc:
+        super('libbz2 has been improperly compiled on your platform')
+      end
+    end
+
+    # Raised if libbz2 reported an unexpected error code.
+    class UnexpectedError < Error
+      # Initializes a new instance of UnexpectedError.
+      #
+      # @param error_code [Integer] The error_code reported by libbz2.
+      # @private
+      def initialize(error_code) #:nodoc:
+        super("An unexpected error was detected (error code: #{error_code})")
+      end
+    end
+  end
+end

data/lib/zip/bzip2/ffi/libbz2.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# This file is copied from:
+#
+# https://github.com/philr/bzip2-ffi/raw/master/lib/bzip2/ffi/libbz2.rb
+
+# Copyright (c) 2015-2016 Philip Ross
+#
+# 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.
+
+require 'ffi'
+
+module Zip
+  module Bzip2
+    module FFI
+      # FFI bindings for the libbz2 low-level interface.
+      #
+      # See bzlib.h and http://bzip.org/docs.html.
+      #
+      # @private
+      module Libbz2 #:nodoc:
+        extend ::FFI::Library
+
+        ffi_lib ['bz2', 'libbz2.so.1', 'libbz2.dll']
+
+        BZ_RUN    = 0
+        BZ_FLUSH  = 1
+        BZ_FINISH = 2
+
+        BZ_OK               =  0
+        BZ_RUN_OK           =  1
+        BZ_FLUSH_OK         =  2
+        BZ_FINISH_OK        =  3
+        BZ_STREAM_END       =  4
+        BZ_SEQUENCE_ERROR   = -1
+        BZ_PARAM_ERROR      = -2
+        BZ_MEM_ERROR        = -3
+        BZ_DATA_ERROR       = -4
+        BZ_DATA_ERROR_MAGIC = -5
+        BZ_CONFIG_ERROR     = -9
+
+        # void *(*bzalloc)(void *,int,int);
+        callback :bzalloc, %i[pointer int int], :pointer
+
+        # void (*bzfree)(void *,void *);
+        callback :bzfree, %i[pointer pointer], :void
+
+        # typedef struct { ... } bz_stream;
+        class BzStream < ::FFI::Struct #:nodoc:
+          layout :next_in,       :pointer,
+                 :avail_in,      :uint,
+                 :total_in_lo32, :uint,
+                 :total_in_hi32, :uint,
+                 :next_out,       :pointer,
+                 :avail_out,      :uint,
+                 :total_out_lo32, :uint,
+                 :total_out_hi32, :uint,
+                 :state,          :pointer,
+                 :bzalloc,        :bzalloc,
+                 :bzfree,         :bzfree,
+                 :opaque,         :pointer
+        end
+
+        # int BZ2_bzCompressInt(bz_stream* strm, int blockSize100k, int verbosity, int workFactor);
+        attach_function :BZ2_bzCompressInit, [BzStream.by_ref, :int, :int, :int], :int
+
+        # int BZ2_bzCompress (bz_stream* strm, int action);
+        attach_function :BZ2_bzCompress, [BzStream.by_ref, :int], :int
+
+        # int BZ2_bzCompressEnd (bz_stream* strm);
+        attach_function :BZ2_bzCompressEnd, [BzStream.by_ref], :int
+
+        # int BZ2_bzDecompressInit (bz_stream *strm, int verbosity, int small);
+        attach_function :BZ2_bzDecompressInit, [BzStream.by_ref, :int, :int], :int
+
+        # int BZ2_bzDecompress (bz_stream* strm);
+        attach_function :BZ2_bzDecompress, [BzStream.by_ref], :int
+
+        # int BZ2_bzDecompressEnd (bz_stream *strm);
+        attach_function :BZ2_bzDecompressEnd, [BzStream.by_ref], :int
+      end
+    end
+  end
+end

data/lib/zip/bzip2/libbz2.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'ffi'
+require 'zip/bzip2/errors'
+require 'zip/bzip2/ffi/libbz2'
+
+module Zip
+  module Bzip2
+    class Libbz2 #:nodoc:
+      def self.finalizer
+        lambda do |_id|
+          decompress_end
+        end
+      end
+      private_class_method :finalizer
+
+      def self.buffer(length)
+        ::FFI::MemoryPointer.new(1, length)
+      end
+
+      def self.buffer_from_data(data)
+        buffer = ::FFI::MemoryPointer.new(1, data.bytesize)
+        buffer.write_bytes(data)
+        buffer
+      end
+
+      def initialize
+        @stream = FFI::Libbz2::BzStream.new
+      end
+
+      def decompress_init!(small = false)
+        result = FFI::Libbz2::BZ2_bzDecompressInit(@stream, 0, small ? 1 : 0)
+        check_error(result)
+
+        ObjectSpace.define_finalizer(self, self.class.send(:finalizer))
+
+        true
+      end
+
+      def decompress!
+        result = FFI::Libbz2::BZ2_bzDecompress(@stream)
+        check_error(result)
+
+        result == FFI::Libbz2::BZ_STREAM_END
+      end
+
+      def decompress_end!
+        result = FFI::Libbz2::BZ2_bzDecompressEnd(@stream)
+        check_error(result)
+
+        ObjectSpace.undefine_finalizer(self)
+
+        true
+      end
+
+      def input_buffer=(input_buffer)
+        @stream[:next_in] = input_buffer
+        @stream[:avail_in] = input_buffer.size
+      end
+
+      def output_buffer=(output_buffer)
+        @output_buffer = output_buffer
+        @stream[:next_out] = output_buffer
+        @stream[:avail_out] = output_buffer.size
+      end
+
+      def input?
+        @stream[:avail_in].positive?
+      end
+
+      def output
+        @output_buffer.read_bytes(@output_buffer.size - @stream[:avail_out])
+      end
+
+      private
+
+      def check_error(result)
+        return if result >= 0
+
+        raise error(result)
+      end
+
+      def error(result)
+        case result
+        when FFI::Libbz2::BZ_MEM_ERROR
+          MemError
+        when FFI::Libbz2::BZ_DATA_ERROR
+          DataError
+        when FFI::Libbz2::BZ_DATA_ERROR_MAGIC
+          MagicDataError
+        when FFI::Libbz2::BZ_CONFIG_ERROR
+          ConfigError
+        else
+          raise UnexpectedError, result
+        end
+      end
+    end
+  end
+end

data/lib/zip/bzip2/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Zip
+  module Bzip2
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: rubyzip-bzip2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jan-Joost Spanjers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+description: The rubyzip-bzip2 gem provides an extension of the rubyzip gem for reading
+  zip files compressed with bzip2 compression
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/zip/bzip2.rb
+- lib/zip/bzip2/decompress.rb
+- lib/zip/bzip2/decompressor.rb
+- lib/zip/bzip2/errors.rb
+- lib/zip/bzip2/ffi/libbz2.rb
+- lib/zip/bzip2/libbz2.rb
+- lib/zip/bzip2/version.rb
+homepage: http://github.com/rubyzip/rubyzip-bzip2
+licenses:
+- BSD 2-Clause
+metadata:
+  bug_tracker_uri: https://github.com/rubyzip/rubyzip-bzip2/issues
+  changelog_uri: https://github.com/rubyzip/rubyzip-bzip2/blob/v0.0.1/Changelog.md
+  documentation_uri: https://www.rubydoc.info/gems/rubyzip-bzip2/0.0.1
+  source_code_uri: https://github.com/rubyzip/rubyzip-bzip2/tree/v0.0.1
+  wiki_uri: https://github.com/rubyzip/rubyzip-bzip2/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Extension of rubyzip to read bzip2 compressed files
+test_files: []