bzip2-ffi 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 91dd417ec50336680acdedba3bc7eb9c80a268f6
-  data.tar.gz: 637b7684138b2e615ce3720dd8d9a927029481bb
+SHA256:
+  metadata.gz: 03b164babce536cf85cdf6fa03a4baa85651c8a9463284eeb633a0db4ffcc6fa
+  data.tar.gz: 42a231de039d293fe25cf5dc98c22d4650225a73fb363cee7fb3c16d69af0355
 SHA512:
-  metadata.gz: a74b7c8e55a23de078c58b0d1c10b9f1addba8867a3b91bac0fbd7c4f22a663e5dccbbc1523814c5e6fdd779728c2d6acb92ad08bce3c05102a42eb97dd743b4
-  data.tar.gz: 10a5f0950a4bb5e4005632679097bcfdfb838bfcebf120ea9f986b9d30c5d1042ebb01bb7e866cb1891a919cbc90746f2a30df5dbce58bc3aa0c570cd828c750
+  metadata.gz: 12a699a68f65e217b5c958697709bc65f3a64e2d627ab1ee16bf7519c43a0571321bb435a38f199639b6b1a9842a0e179022d91fd033ebf8ac907897c9e76c27
+  data.tar.gz: 0dc68221d4c9ee943efd3bffaea0584cefd6d5b30f5ad4d998384177a3d6fe83e29691f344e4ee110786a0558355f2a90a74aed2624ff30257e72c66ad90727f

checksums.yaml.gz.sig

@@ -1,2 +1 @@
-{-l�P["A���V�>����{�9�2�	���gc=CZ_
-��!���O�>g<��f�d���{s�L}V0>O�x�cp��8��L�91��ʯh��e���ˑ�
+|��k���\s��u�G�y�_�|R�l�M?�;5�+j����.�ѩR;yfo[�	1�LU�|x��H�*I��9}_�X�ȭҨ��e��y@ʭCƐ߀��W����N>ޤj�E�!��A�Sy�#(h?b3�7�3�E�-ˇ�����SZ�N��۳�T3��`�O����:�F�r�}�A�D��M����|\����i��Q�$EZ�`� �^�q`��#]'�
w�K�~��}�(��ͷ~�ک`��V�

data/CHANGES.md

@@ -1,4 +1,25 @@
-Version 1.0.0 - 28-Feb-2015
----------------------------
+# Changes
+
+## Version 1.1.0 - 27-Feb-2021
+
+* `Bzip2::FFI::Reader` will now read all consecutive bzip2 compressed structures
+  in the input by default instead of just the first (the same as the
+  bzip2/bunzip2 commands). A new `:first_only` option has been added to allow
+  the version 1.0.0 behaviour to be retained. #1.
+* Added `#eof?` and `#eof` to `Bzip2::FFI::Reader`, indicating when
+  decompression has completed.
+* Added `Bzip2::FFI::Reader#pos`, returning the number of decompressed bytes
+  that have been read.
+* Added `Bzip2::FFI::Writer#pos`, returning the number of uncompressed bytes
+  that have been written.
+* Support using Bzip2::FFI with frozen string literals enabled (and enable in
+  all files with `# frozen_string_literal: true`).
+* Constants documented as private in version 1.0.0 are now set as private using
+  `Module#private_constant`.
+* `require_relative` is now used when loading dependencies for a minor
+  performance gain.
+
+
+## Version 1.0.0 - 28-Feb-2015
 
 * First release.

data/Gemfile

@@ -3,12 +3,43 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem 'rake', '~> 10.0'
+  gem 'rake', ['>= 12.2.1', '< 14']
   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
+
+  # coveralls is no longer maintained, but supports Ruby < 2.3.
+  # coveralls_reborn is maintained, but requires Ruby >= 2.3.
+  gem 'coveralls', '~> 0.8', require: false if RUBY_VERSION < '2.3'
+  gem 'coveralls_reborn', '~> 0.13', require: false if RUBY_VERSION >= '2.3'
+
+
+  # json is a dependency of simplecov. Version 2.3.0 is declared as compatible
+  # with Ruby >= 1.9, but actually fails with a syntax error:
+  # https://travis-ci.org/tzinfo/tzinfo/jobs/625092293#L605
+  #
+  # 2.5.1 is declared as compatible with Ruby >= 2.0, but actually fails to
+  # compile with an undefined reference to `rb_funcallv` on Windows:
+  # https://github.com/tzinfo/tzinfo/runs/1664656059#step:3:757
+  #
+  # 2.3.0 also fails to build the native extension with Rubinius:
+  # https://travis-ci.org/tzinfo/tzinfo/jobs/625092305#L1310
+  #
+  # Limit to earlier compatible versions.
+  if RUBY_VERSION < '2.0' || RUBY_ENGINE == 'rbx'
+    gem 'json', '< 2.3.0'
+  elsif RUBY_VERSION < '2.1' && RUBY_PLATFORM =~ /mingw/
+    gem 'json', '< 2.5.0'
+  end
+
+  # ffi 1.9.15 is declared as compatible with Ruby >= 1.8.7, but doesn't compile
+  # on Ruby 1.9.3 on Windows.
+  #
+  # Limit to earlier compatible versions.
+  if RUBY_VERSION < '2.0' && RUBY_PLATFORM =~ /mingw/
+    gem 'ffi', '< 1.9.0'
+  end
 end

data/LICENSE

@@ -1,19 +1,19 @@
-Copyright (c) 2015 Philip Ross
+Copyright (c) 2015-2021 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 
+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 
+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 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

@@ -1,6 +1,6 @@
-# Bzip2::FFI #
+# 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)
+[![RubyGems](https://img.shields.io/gem/v/bzip2-ffi?logo=rubygems&label=Gem)](https://rubygems.org/gems/bzip2-ffi) [![Tests](https://github.com/philr/bzip2-ffi/workflows/Tests/badge.svg?branch=master&event=push)](https://github.com/philr/bzip2-ffi/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush) [![Coverage Status](https://img.shields.io/coveralls/github/philr/bzip2-ffi/master?label=Coverage&logo=Coveralls)](https://coveralls.io/github/philr/bzip2-ffi?branch=master)
 
 Bzip2::FFI is a Ruby wrapper for libbz2 using FFI bindings.
 
@@ -8,24 +8,19 @@ The Bzip2::FFI Reader and Writer classes support reading and writing bzip2
 compressed data as an `IO`-like stream.
 
 
-## Installation ##
+## Installation
 
-To install the Bzip2::FFI gem, run the following command:
+The Bzip2::FFI gem can be installed by running `gem install bzip2-ffi` or by
+adding `gem 'bzip2-ffi'` to your `Gemfile` and running `bundle install`.
 
-    gem install bzip2-ffi
 
-To add Bzip2::FFI as a Bundler dependency, add the following line to your
-`Gemfile`:
+## Compatibility
 
-    gem 'bzip2-ffi'
+Bzip2::FFI requires a minimum of Ruby MRI 1.9.3 or JRuby 1.7 (in 1.9 mode or
+later).
 
 
-## Compatibility ##
-
-Bzip2::FFI is tested on Ruby MRI 1.9.3+, JRuby 1.7+ and Rubinius 2+.
-
-
-## Runtime Dependencies ##
+## Runtime Dependencies
 
 Bzip2::FFI is a pure-Ruby library that uses
 [Ruby-FFI](https://rubygems.org/gems/ffi) (Foreign Function Interface) to load
@@ -36,7 +31,7 @@ libbz2 is available as a package on most UNIX-based systems (for example,
 CentOS).
 
 
-### Windows ###
+### Windows
 
 On Windows, you will need to have `libbz2.dll` or `bz2.dll` available on the
 `PATH` or in the Ruby `bin` directory.
@@ -46,99 +41,113 @@ Suitable builds of `libbz2.dll` are available from the
 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).
+Builds from the bzip2-windows project depend on the Visual Studio C Runtime
+Library. Links to the installer can be found on the bzip2-windows release page.
 
 
-## Usage ##
+## Usage
 
 To use Bzip2::FFI, it must first be loaded with:
 
-    require 'bzip2/ffi'
+```ruby
+require 'bzip2/ffi'
+```
 
 
-### Compressing ###
+### Compressing
 
 Data can be compressed using the `Bzip2::FFI::Writer` class. For example, the
-following compresses lines read from standard input (`ARGF`):
+following compresses lines read from `ARGF` (either standard input, or file
+names given as command-line arguments:
 
-    Bzip2::FFI::Writer.open(io_or_path) do |writer|
-      ARGF.each_line do |line|
-        writer.write(line)
-      end
-    end
+```ruby
+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
+```ruby
+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!')
+```ruby
+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.
+write to or an `IO`-like object that has a `#write` method.
 
 
-### Decompressing ###
+### 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
+```ruby
+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
+```ruby
+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:
+All the available bzipped data can be read and decompressed in a single step:
 
-    uncompressed = Bzip2::FFI::Reader.read(io_or_path)
+```ruby
+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.
+read from or an `IO`-like object that has a `#read` method.
 
 
-### Character Encoding ###
+### 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`).
+`Bzip2::FFI::Writer` compresses the raw bytes from the `String` instances passed
+to the `#write` method (using the encoding of the `String`).
 
 
-## Documentation ##
+## Documentation
 
 Documentation for Bzip2::FFI is available on
-[RubyDoc.info](http://www.rubydoc.info/gems/bzip2-ffi).
+[RubyDoc.info](https://www.rubydoc.info/gems/bzip2-ffi).
 
 
-## License ##
+## 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 ##
+## 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

@@ -60,3 +60,27 @@ Rake::TestTask.new do |t|
   t.pattern = File.join(BASE_DIR, 'test', '**', '*_test.rb')
   t.warning = true
 end
+
+# Coveralls expects an sh compatible shell when running git commands with Kernel#`
+# On Windows, the results end up wrapped in single quotes.
+# Patch Coveralls::Configuration to remove the quotes.
+if RUBY_PLATFORM =~ /mingw/
+  module CoverallsFixConfigurationOnWindows
+    def self.included(base)
+      base.instance_eval do
+        class << self
+          alias_method :git_without_windows_fix, :git
+
+          def git
+            git_without_windows_fix.tap do |hash|
+              hash[:head] = hash[:head].map {|k, v| [k, v =~ /\A'(.*)'\z/ ? $1 : v] }.to_h
+            end
+          end
+        end
+      end
+    end
+  end
+
+  require 'coveralls'
+  Coveralls::Configuration.send(:include, CoverallsFixConfigurationOnWindows)
+end

data/bzip2-ffi.gemspec

@@ -14,6 +14,15 @@ Gem::Specification.new do |s|
   s.email = 'phil.ross@gmail.com'
   s.homepage = 'https://github.com/philr/bzip2-ffi'
   s.license = 'MIT'
+  if s.respond_to? :metadata=
+    s.metadata = {
+      'bug_tracker_uri' => 'https://github.com/philr/bzip2-ffi/issues',
+      'changelog_uri' => 'https://github.com/philr/bzip2-ffi/blob/master/CHANGES.md',
+      'documentation_uri' => "https://rubydoc.info/gems/#{s.name}/#{s.version}",
+      'homepage_uri' => s.homepage,
+      'source_code_uri' => "https://github.com/philr/bzip2-ffi/tree/v#{s.version}"
+    }
+  end
   s.files = %w(CHANGES.md Gemfile LICENSE README.md Rakefile bzip2-ffi.gemspec .yardopts) +
             Dir['lib/**/*.rb'] +
             Dir['test/**/*.rb'] +

data/lib/bzip2/ffi.rb

@@ -1,3 +1,6 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
 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.
@@ -5,10 +8,10 @@ module Bzip2
   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'
+require_relative 'ffi/libbz2'
+require_relative 'ffi/error'
+require_relative 'ffi/io'
+require_relative 'ffi/reader'
+require_relative 'ffi/writer'
+require_relative 'ffi/version'
 

data/lib/bzip2/ffi/error.rb

@@ -1,7 +1,10 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
 module Bzip2
   module FFI
-    # The Bzip2::FFI::Error namespace contains exception classes that are raised
-    # if an error occurs whilst compressing or decompressing data.
+    # The {Error} module 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

data/lib/bzip2/ffi/io.rb

@@ -1,19 +1,22 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
 module Bzip2
   module FFI
-    # `IO` is a base class providing common functionality for the {Reader} and
+    # {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.
+    # 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 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
@@ -22,6 +25,11 @@ module Bzip2
         # @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`.
+        # @yield [io] If a block is given, it is yielded to.
+        # @yieldparam io [IO] The new {IO} instance.
+        # @yieldresult [Object] A result to be returned as the result of {open}.
+        # @return [Object] The result of the block if a block is given,
+        #                  otherwise the new {IO} instance.
         def open(io_or_proc, options = {})
           if io_or_proc.kind_of?(Proc)
             io = io_or_proc.call
@@ -36,7 +44,7 @@ module Bzip2
           end
 
           if block_given?
-            begin            
+            begin
               yield bz_io
             ensure
               bz_io.close unless bz_io.closed?
@@ -46,7 +54,7 @@ module Bzip2
           end
         end
 
-        # Opens and returns a bzip `File` using the specified mode. The system
+        # 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.
@@ -67,9 +75,9 @@ module Bzip2
 
         private
 
-        # Advises the system that an `IO` will be accessed once sequentially.
+        # Advises the system that an `::IO` will be accessed once sequentially.
         #
-        # @param io [IO] An `IO` instance to advise.
+        # @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)
@@ -79,67 +87,69 @@ module Bzip2
         end
       end
 
-      # Returns `true` if the underlying compressed `IO` instance will be closed
-      # when {#close} is called, otherwise `false`.
+      # Returns `true` if the underlying compressed IO-like 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.
+      # @return [Boolean] `true` if the underlying compressed IO-like instance
+      #                   will be closed when {#close} is closed, otherwise
+      #                   `false`.
+      # @raise [IOError] If the {IO} instance has been closed.
       def autoclose?
         check_closed
         @autoclose
       end
 
-      # Sets whether the underlying compressed `IO` instance should be closed
+      # Sets whether the underlying compressed IO-like 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.
+      # @raise [IOError] If the {IO} 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).
+      # Returns `true` to indicate that the {IO} instance is operating in binary
+      # mode (as is always the case).
       #
       # @return [Boolean] `true`.
-      # @raise [IOError] If the `IO` has been closed.
+      # @raise [IOError] If the {IO} instance has been closed.
       def binmode?
         check_closed
         true
       end
 
-      # Puts the `IO` into binary mode.
+      # Puts the {IO} instance into binary mode.
       #
-      # Note that `Bzip2::FFI::IO` and subclasses always operate in binary mode,
-      # so calling `binmode` has no effect.
+      # Note that {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.
+      # @raise [IOError] If the {IO} instance has been closed.
       def binmode
         check_closed
         self
       end
 
-      # Closes the `IO`.
+      # Closes the {IO} instance.
       #
-      # If {#autoclose?} is true and the underlying compressed `IO` responds to
-      # `close`, it will also be closed.
+      # If {#autoclose?} is true and the underlying compressed IO-like instance
+      # responds to `close`, it will also be closed.
       #
       # @return [NilClass] `nil`.
-      # @raise [IOError] If the `IO` has already been closed.
+      # @raise [IOError] If the {IO} instance 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}.
+      # Indicates whether the {IO} instance has been closed by calling {#close}.
       #
-      # @return [Boolean] `true` if the `IO` has been closed, otherwise `false`.
+      # @return [Boolean] `true` if the {IO} instance has been closed, otherwise
+      #                   `false`.
       def closed?
         !@stream
       end
@@ -151,7 +161,7 @@ module Bzip2
       # returns `Encoding::ASCII_8BIT` (also known as `Encoding::BINARY`).
       #
       # @return [Encoding] `Encoding::ASCII_8BIT`.
-      # @raise [IOError] If the `IO` has been closed.
+      # @raise [IOError] If the {IO} instance has been closed.
       def external_encoding
         check_closed
         Encoding::ASCII_8BIT
@@ -168,32 +178,33 @@ module Bzip2
         check_closed
         Encoding::ASCII_8BIT
       end
-      
+
       protected
 
-      # The underlying compressed `IO` instance.
+      # The underlying compressed IO-like instance.
       attr_reader :io
 
-      # Initializes a new {Bzip2::FFI::IO} instance with an underlying
-      # compressed `IO` instance and `options` `Hash`.
+      # Initializes a new {IO} instance with an underlying compressed IO-like
+      # 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
+      # A single `:autoclose` option is supported. Set `:autoclose` to true to
+      # close the underlying compressed IO-like instance when {#close} is
       # called.
       #
-      # @param io [IO] An `IO`-like object that represents the compressed data.
+      # @param io [Object] 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)        
+        @io.binmode if @io.respond_to?(:binmode)
 
         @autoclose = !!options[:autoclose]
-        
+
         @stream = Libbz2::BzStream.new
       end
 
@@ -202,22 +213,23 @@ module Bzip2
       #
       # @return [Libbz2::BzStream] The {Libbz2::BzStream} instance being used
       #                            to interface with libbz2.
-      # @raise [IOError] If the `IO` has been closed.
+      # @raise [IOError] If the {IO} instance has been closed.
       def stream
         check_closed
         @stream
-      end      
+      end
 
-      # Raises an `IOError` if {#close} has been called to close the {IO}.
+      # Raises an `IOError` if {#close} has been called to close the {IO}
+      # instance.
       #
-      # @raise [IOError] If the `IO` has been closed.
+      # @raise [IOError] If the {IO} instance 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
+      # zero (an error), the appropriate {Error::Bzip2Error} sub-class is
       # raised.
       #
       # @param res [Integer] The result of a call to a libbz2 function.
@@ -244,7 +256,7 @@ module Bzip2
         end
 
         raise error_class.new
-      end      
+      end
     end
   end
 end