bzip2-ffi 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91dd417ec50336680acdedba3bc7eb9c80a268f6
+  data.tar.gz: 637b7684138b2e615ce3720dd8d9a927029481bb
+SHA512:
+  metadata.gz: a74b7c8e55a23de078c58b0d1c10b9f1addba8867a3b91bac0fbd7c4f22a663e5dccbbc1523814c5e6fdd779728c2d6acb92ad08bce3c05102a42eb97dd743b4
+  data.tar.gz: 10a5f0950a4bb5e4005632679097bcfdfb838bfcebf120ea9f986b9d30c5d1042ebb01bb7e866cb1891a919cbc90746f2a30df5dbce58bc3aa0c570cd828c750

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+{-l�P["A���V�>����{�9�2�	���gc=CZ_
+��!���O�>g<��f�d���{s�L}V0>O�x�cp��8��L�91��ʯh��e���ˑ�

data.tar.gz.sig

@@ -0,0 +1 @@
+D �h��pX�曦���3�2��镀W��S��F0�'�����^3T{�0o�8�3��Ğ�|A��o!�j�K��������My�� v�)�8+X��G�f������}[2j�p��1�=i�Kņ��;��'o�@�IP!u׈�-���p��.�=�r1���	�/��iԇ�t��qy�+:[ʠ�7q��Q�l@,�F������62\�we��ep��������&�ѫ 8]�דzֶ��9t) �'iX'�

data/.yardopts

@@ -0,0 +1,7 @@
+--markup=markdown
+--no-private
+lib/**/*.rb
+-
+CHANGES.md
+LICENSE
+README.md

data/CHANGES.md

@@ -0,0 +1,4 @@
+Version 1.0.0 - 28-Feb-2015
+---------------------------
+
+* First release.

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'rake', '~> 10.0'
+  gem 'git', '~> 1.2', require: false
+end
+
+group :test do
+  gem 'minitest', '~> 5.0'
+  gem 'simplecov', '~> 0.9', require: false
+  gem 'coveralls', '~> 0.7', require: false
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 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.

data/README.md

@@ -0,0 +1,144 @@
+# Bzip2::FFI #
+
+[![Gem Version](https://badge.fury.io/rb/bzip2-ffi.svg)](http://badge.fury.io/rb/bzip2-ffi) [![Build Status](https://travis-ci.org/philr/bzip2-ffi.svg?branch=master)](https://travis-ci.org/philr/bzip2-ffi) [![Coverage Status](https://coveralls.io/repos/philr/bzip2-ffi/badge.svg?branch=master)](https://coveralls.io/r/philr/bzip2-ffi?branch=master)
+
+Bzip2::FFI is a Ruby wrapper for libbz2 using FFI bindings.
+
+The Bzip2::FFI Reader and Writer classes support reading and writing bzip2
+compressed data as an `IO`-like stream.
+
+
+## Installation ##
+
+To install the Bzip2::FFI gem, run the following command:
+
+    gem install bzip2-ffi
+
+To add Bzip2::FFI as a Bundler dependency, add the following line to your
+`Gemfile`:
+
+    gem 'bzip2-ffi'
+
+
+## Compatibility ##
+
+Bzip2::FFI is tested on Ruby MRI 1.9.3+, JRuby 1.7+ and Rubinius 2+.
+
+
+## Runtime Dependencies ##
+
+Bzip2::FFI is a pure-Ruby library that uses
+[Ruby-FFI](https://rubygems.org/gems/ffi) (Foreign Function Interface) to load
+the libbz2 dynamic library at runtime.
+
+libbz2 is available as a package on most UNIX-based systems (for example,
+`libbz2-1.0` on Debian and Ubuntu, or `bzip2-libs` on Fedora, Red Hat, and
+CentOS).
+
+
+### Windows ###
+
+On Windows, you will need to have `libbz2.dll` or `bz2.dll` available on the
+`PATH` or in the Ruby `bin` directory.
+
+Suitable builds of `libbz2.dll` are available from the
+[bzip2-windows project](https://github.com/philr/bzip2-windows/releases).
+Download the DLL only package that matches your Ruby installation (x86 or x64)
+and extract to your `ruby\bin` directory.
+
+Builds from the bzip2-windows project depend on the Visual Studio 2013 C Runtime
+Library (msvcr120.dll). This can be installed using the
+[Visual C++ Redistributable Packages for Visual Studio 2013 installer](http://www.microsoft.com/en-gb/download/details.aspx?id=40784).
+
+
+## Usage ##
+
+To use Bzip2::FFI, it must first be loaded with:
+
+    require 'bzip2/ffi'
+
+
+### Compressing ###
+
+Data can be compressed using the `Bzip2::FFI::Writer` class. For example, the
+following compresses lines read from standard input (`ARGF`):
+
+    Bzip2::FFI::Writer.open(io_or_path) do |writer|
+      ARGF.each_line do |line|
+        writer.write(line)
+      end
+    end
+
+Alternatively, without passing a block to `open`:
+
+    writer = Bzip2::FFI::Writer.open(io_or_path)
+    begin
+      ARGF.each_line do |line|
+        writer.write(line)
+      end
+    ensure
+      writer.close
+    end
+
+An entire bzip2 structure can also be written in a single step:
+
+    Bzip2::FFI::Writer.write(io_or_path, 'Hello, World!')
+
+In each of the examples above, `io_or_path` can either be a path to a file to
+write to or an `IO`-like object that has a `write` method.
+
+
+### Decompressing ###
+
+Data can be decompressed using the `Bzip2::FFI::Reader` class. For example:
+
+    Bzip2::FFI::Reader.open(io_or_path) do |reader|
+      while buffer = reader.read(1024) do
+        # process uncompressed bytes in buffer
+      end
+    end
+
+Alternatively, without passing a block to `open`:
+
+    reader = Bzip2::FFI::Reader.open(io_or_path)
+    begin
+      while buffer = reader.read(1024) do
+        # process uncompressed bytes in buffer
+      end
+    ensure
+      reader.close
+    end
+
+An entire bzip2 structure can be read and decompressed in a single step:
+
+    uncompressed = Bzip2::FFI::Reader.read(io_or_path)
+
+In each of the examples above, `io_or_path` can either be a path to a file to
+read from or an `IO`-like object that has a `read` method.
+
+
+### Character Encoding ###
+
+Bzip2::FFI does not perform any encoding conversion when reading or writing.
+Data read using `Bzip2::FFI::Reader` is returned as `String` instances with
+ASCII-8BIT (BINARY) encoding representing the raw decompressed bytes.
+`Bzip2::FFI::Writer` compresses the raw bytes from the `Strings` passed to the
+`write` method (using the encoding of the `String`).
+
+
+## Documentation ##
+
+Documentation for Bzip2::FFI is available on
+[RubyDoc.info](http://www.rubydoc.info/gems/bzip2-ffi).
+
+
+## License ##
+
+Bzip2::FFI is distributed under the terms of the MIT license. A copy of this
+license can be found in the included LICENSE file.
+
+
+## GitHub Project ##
+
+Source code, release information and the issue tracker can be found on the
+[Bzip2::FFI GitHub project page](https://github.com/philr/bzip2-ffi).

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rake/testtask'
+
+BASE_DIR = File.expand_path(File.dirname(__FILE__))
+
+task :default => :test
+
+def spec
+  @spec ||= eval(File.read('bzip2-ffi.gemspec'))
+end
+
+# Attempt to find the private key and return a spec with added options for
+# signing the gem if found.
+def add_signing_key(spec)
+  private_key_path = File.expand_path(File.join(BASE_DIR, '..', 'key', 'gem-private_key.pem'))
+
+  if File.exist?(private_key_path)
+    spec = spec.clone
+    spec.signing_key = private_key_path
+    spec.cert_chain = [File.join(BASE_DIR, 'gem-public_cert.pem')]
+  else
+    puts 'WARNING: Private key not found. Not signing gem file.'
+  end
+
+  spec
+end
+
+package_task = Gem::PackageTask.new(add_signing_key(spec)) do
+end
+
+# Ensure files are world-readable before packaging.
+Rake::Task[package_task.package_dir_path].enhance do
+  recurse_chmod(package_task.package_dir_path)
+end
+
+def recurse_chmod(dir)
+  File.chmod(0755, dir)
+
+  Dir.entries(dir).each do |entry|
+    if entry != '.' && entry != '..'
+      path = File.join(dir, entry)
+      if File.directory?(path)
+        recurse_chmod(path)
+      else
+        File.chmod(0644, path)
+      end
+    end
+  end
+end
+
+task :tag do
+  require 'git'
+  g = Git.init(BASE_DIR)
+  g.add_tag("v#{spec.version}", annotate: true, message: "Tagging v#{spec.version}")
+end
+
+Rake::TestTask.new do |t|
+  t.libs = [File.join(BASE_DIR, 'test')]
+  t.pattern = File.join(BASE_DIR, 'test', '**', '*_test.rb')
+  t.warning = true
+end

data/bzip2-ffi.gemspec

@@ -0,0 +1,30 @@
+require File.expand_path(File.join('..', 'lib', 'bzip2', 'ffi', 'version'), __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'bzip2-ffi'
+  s.version = Bzip2::FFI::VERSION
+  s.summary = 'Reads and writes bzip2 compressed data using FFI bindings for libbz2.'
+  s.description = <<-EOF
+    Bzip2::FFI is a Ruby wrapper for libbz2 using FFI bindings.
+
+    The Bzip2::FFI Reader and Writer classes support reading and writing bzip2
+    compressed data as an IO-like stream.
+  EOF
+  s.author = 'Philip Ross'
+  s.email = 'phil.ross@gmail.com'
+  s.homepage = 'https://github.com/philr/bzip2-ffi'
+  s.license = 'MIT'
+  s.files = %w(CHANGES.md Gemfile LICENSE README.md Rakefile bzip2-ffi.gemspec .yardopts) +
+            Dir['lib/**/*.rb'] +
+            Dir['test/**/*.rb'] +
+            Dir['test/fixtures/*']
+  s.platform = Gem::Platform::RUBY
+  s.require_path = 'lib'
+  s.rdoc_options << '--title' << 'Bzip2::FFI' <<
+                    '--main' << 'README.md' <<
+                    '--markup' << 'markdown'
+  s.extra_rdoc_files = ['CHANGES.md', 'LICENSE', 'README.md']
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_runtime_dependency 'ffi', '~> 1.0'
+  s.requirements << 'libbz2.(so|dll|dylib) available on the library search path'
+end

data/lib/bzip2/ffi.rb

@@ -0,0 +1,14 @@
+module Bzip2
+  # Bzip2::FFI is a wrapper for libbz2 using FFI bindings. Bzip2 compressed data
+  # can be read and written as a stream using the Reader and Writer classes.
+  module FFI
+  end
+end
+
+require 'bzip2/ffi/libbz2'
+require 'bzip2/ffi/error'
+require 'bzip2/ffi/io'
+require 'bzip2/ffi/reader'
+require 'bzip2/ffi/writer'
+require 'bzip2/ffi/version'
+

data/lib/bzip2/ffi/error.rb

@@ -0,0 +1,100 @@
+module Bzip2
+  module FFI
+    # The Bzip2::FFI::Error namespace contains exception classes that are raised
+    # if an error occurs whilst compressing or decompressing data.
+    module Error
+      # Base class for Bzip2::FFI exceptions.
+      class Bzip2Error < IOError
+      end
+
+      # Raised if libbz2 functions were called out of sequence or with data
+      # structures in incorrect states.
+      class SequenceError < Bzip2Error
+        # Initializes a new instance of SequenceError.
+        #
+        # @private
+        def initialize #:nodoc:
+          super('libbz2 functions called out of sequence or with data structures in incorrect states (this is likely to be caused by a bug in Bzip2::FFI)')
+        end
+      end
+
+      # Raised if a parameter passed to libbz2 was out of range or incorrect.
+      class ParamError < Bzip2Error
+        # Initializes a new instance of ParamError.
+        #
+        # @private
+        def initialize #:nodoc:
+          super('A parameter passed to libbz2 is out of range or incorrect (this may indicate a bug in Bzip2::FFI)')
+        end
+      end
+
+      # Raised if a failure occurred allocating memory to complete a request.
+      class MemoryError < Bzip2Error
+        # Initializes a new instance of MemoryError.
+        #
+        # @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 < Bzip2Error
+        # 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 < Bzip2Error
+        # Initializes a new instance of ConfigError.
+        #
+        # @private
+        def initialize #:nodoc:
+          super('libbz2 has been improperly compiled on your platform')
+        end
+      end
+
+      # Raised if an end of file (EOF) condition was detected before the end
+      # of the logical bzip2 stream.
+      class UnexpectedEofError < Bzip2Error
+        # UnexpectedEofError is raised directly by Reader. It does not map to
+        # a libbz2 low-level interface error code.
+
+        # Initializes a new instance of UnexpectedEofError.
+        #
+        # @private
+        def initialize #:nodoc:
+          super('EOF was detected before the end of the logical stream')
+        end
+      end
+
+      # Raised if libbz2 reported an unexpected error code.
+      class UnexpectedError < Bzip2Error
+        # 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
+end

data/lib/bzip2/ffi/io.rb

@@ -0,0 +1,250 @@
+module Bzip2
+  module FFI
+    # `IO` is a base class providing common functionality for the {Reader} and
+    # {Writer} subclasses.
+    #
+    # `Bzip2::FFI::IO` holds a reference to an underlying `IO`-like stream
+    # representing the bzip2-compressed data to be read from or written to.
+    class IO
+      class << self
+        protected :new
+
+        protected
+
+        # If no block is provided, returns a new `IO`. If a block is provided,
+        # a new `IO` is created and yielded to the block. After the block has
+        # executed, the `IO` is closed and the result of the block is returned.
+        #
+        # If `io_or_proc` is a `Proc`, it is called to obtain an IO-like
+        # instance to pass to `new`. Otherwise `io_or_proc` is passed directly
+        # to `new`.
+        #
+        # @param io_or_proc [Object] An IO-like object or a `Proc` that returns
+        #                            an IO-like object when called.
+        # @param options [Hash] Options to pass to `new`.
+        def open(io_or_proc, options = {})
+          if io_or_proc.kind_of?(Proc)
+            io = io_or_proc.call
+            begin
+              bz_io = new(io, options)
+            rescue
+              io.close if io.respond_to?(:close)
+              raise
+            end
+          else
+            bz_io = new(io_or_proc, options)
+          end
+
+          if block_given?
+            begin            
+              yield bz_io
+            ensure
+              bz_io.close unless bz_io.closed?
+            end
+          else
+            bz_io
+          end
+        end
+
+        # Opens and returns a bzip `File` using the specified mode. The system
+        # is advised that the file will be accessed once sequentially.
+        #
+        # @param path [String] The path to open.
+        # @param mode [String] The file open mode to use.
+        # @return [File] An open `File` object for `path` opened using `mode`.
+        def open_bzip_file(path, mode)
+          io = File.open(path, mode)
+
+          begin
+            after_open_file(io)
+          rescue
+            io.close
+            raise
+          end
+
+          io
+        end
+
+        private
+
+        # Advises the system that an `IO` will be accessed once sequentially.
+        #
+        # @param io [IO] An `IO` instance to advise.
+        def after_open_file(io)
+          # JRuby 1.7.18 doesn't have a File#advise method (in any mode).
+          if io.respond_to?(:advise)
+            io.advise(:sequential)
+            io.advise(:noreuse)
+          end
+        end
+      end
+
+      # Returns `true` if the underlying compressed `IO` instance will be closed
+      # when {#close} is called, otherwise `false`.
+      #
+      # @return [Boolean] `true` if the underlying compressed IO instance will
+      #                   be closed when {#close} is closed, otherwise `false`.
+      # @raise [IOError] If the instance has been closed.
+      def autoclose?
+        check_closed
+        @autoclose
+      end
+
+      # Sets whether the underlying compressed `IO` instance should be closed
+      # when {#close} is called (`true`) or left open (`false`).
+      #
+      # @param autoclose [Boolean] `true` if the underlying compressed `IO`
+      #                            instance should be closed when {#close} is
+      #                            called, or `false` if it should be left open.
+      # @raise [IOError] If the instance has been closed.
+      def autoclose=(autoclose)
+        check_closed
+        @autoclose = !!autoclose
+      end
+
+      # Returns `true` to indicate that the `IO` is operating in binary mode
+      # (as is always the case).
+      #
+      # @return [Boolean] `true`.
+      # @raise [IOError] If the `IO` has been closed.
+      def binmode?
+        check_closed
+        true
+      end
+
+      # Puts the `IO` into binary mode.
+      #
+      # Note that `Bzip2::FFI::IO` and subclasses always operate in binary mode,
+      # so calling `binmode` has no effect.
+      #
+      # @return [IO] `self`.
+      # @raise [IOError] If the `IO` has been closed.
+      def binmode
+        check_closed
+        self
+      end
+
+      # Closes the `IO`.
+      #
+      # If {#autoclose?} is true and the underlying compressed `IO` responds to
+      # `close`, it will also be closed.
+      #
+      # @return [NilClass] `nil`.
+      # @raise [IOError] If the `IO` has already been closed.
+      def close
+        check_closed
+        @io.close if autoclose? && @io.respond_to?(:close)
+        @stream = nil
+      end
+
+      # Indicates whether the `IO` has been closed by calling {#close}.
+      #
+      # @return [Boolean] `true` if the `IO` has been closed, otherwise `false`.
+      def closed?
+        !@stream
+      end
+
+      # Returns the `Encoding` object that represents the encoding of data
+      # prior to being compressed or after being decompressed.
+      #
+      # No character conversion is performed, so `external_encoding` always
+      # returns `Encoding::ASCII_8BIT` (also known as `Encoding::BINARY`).
+      #
+      # @return [Encoding] `Encoding::ASCII_8BIT`.
+      # @raise [IOError] If the `IO` has been closed.
+      def external_encoding
+        check_closed
+        Encoding::ASCII_8BIT
+      end
+
+      # The internal encoding for character conversions.
+      #
+      # No character conversion is performed, so `internal_encoding` always
+      # returns `Encoding::ASCII_8BIT` (also known as `Encoding::BINARY`).
+      #
+      # @return [Encoding] `Encoding::ASCII_8BIT`.
+      # @raise [IOError] If the `IO` has been closed.
+      def internal_encoding
+        check_closed
+        Encoding::ASCII_8BIT
+      end
+      
+      protected
+
+      # The underlying compressed `IO` instance.
+      attr_reader :io
+
+      # Initializes a new {Bzip2::FFI::IO} instance with an underlying
+      # compressed `IO` instance and `options` `Hash`.
+      #
+      # `binmode` is called on `io` if `io` responds to `binmode`.
+      #
+      # A single `:autoclose` option is supported. Set `:autoclose` to true
+      # to close the underlying compressed `IO` instance when {#close} is
+      # called.
+      #
+      # @param io [IO] An `IO`-like object that represents the compressed data.
+      # @param options [Hash] Optional parameters (:autoclose).
+      # @raise [ArgumentError] If `io` is nil.
+      def initialize(io, options = {})
+        raise ArgumentError, 'io is required' unless io
+        
+        @io = io
+        @io.binmode if @io.respond_to?(:binmode)        
+
+        @autoclose = !!options[:autoclose]
+        
+        @stream = Libbz2::BzStream.new
+      end
+
+      # Returns the {Libbz2::BzStream} instance being used to interface with
+      # libbz2.
+      #
+      # @return [Libbz2::BzStream] The {Libbz2::BzStream} instance being used
+      #                            to interface with libbz2.
+      # @raise [IOError] If the `IO` has been closed.
+      def stream
+        check_closed
+        @stream
+      end      
+
+      # Raises an `IOError` if {#close} has been called to close the {IO}.
+      #
+      # @raise [IOError] If the `IO` has been closed.
+      def check_closed
+        raise IOError, 'closed stream' if closed?
+      end
+
+      # Checks a return code from a libbz2 function. If it is greater than or
+      # equal to 0 (success), the return code is returned. If it is less than
+      # zero (an error), the appropriate {Bzip2::Bzip2Error} sub-class is
+      # raised.
+      #
+      # @param res [Integer] The result of a call to a libbz2 function.
+      # @return [Integer] `res` if `res` is greater than or equal to 0.
+      # @raise [Error::Bzip2Error] if `res` is less than 0.
+      def check_error(res)
+        return res if res >= 0
+
+        error_class = case res
+          when Libbz2::BZ_SEQUENCE_ERROR
+            Error::SequenceError
+          when Libbz2::BZ_PARAM_ERROR
+            Error::ParamError
+          when Libbz2::BZ_MEM_ERROR
+            Error::MemoryError
+          when Libbz2::BZ_DATA_ERROR
+            Error::DataError
+          when Libbz2::BZ_DATA_ERROR_MAGIC
+            Error::MagicDataError
+          when Libbz2::BZ_CONFIG_ERROR
+            Error::ConfigError
+          else
+            raise Error::UnexpectedError.new(res)
+        end
+
+        raise error_class.new
+      end      
+    end
+  end
+end