bzip2-ffi 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 91dd417ec50336680acdedba3bc7eb9c80a268f6
-  data.tar.gz: 637b7684138b2e615ce3720dd8d9a927029481bb
+SHA256:
+  metadata.gz: 25b15e037a74f589a612d955890d194519a97abfa903c993589d0096794b6459
+  data.tar.gz: '088c393a99b19d1d625148c951461333d2ed9ef934df6e5efaee2ea0007b9620'
 SHA512:
-  metadata.gz: a74b7c8e55a23de078c58b0d1c10b9f1addba8867a3b91bac0fbd7c4f22a663e5dccbbc1523814c5e6fdd779728c2d6acb92ad08bce3c05102a42eb97dd743b4
-  data.tar.gz: 10a5f0950a4bb5e4005632679097bcfdfb838bfcebf120ea9f986b9d30c5d1042ebb01bb7e866cb1891a919cbc90746f2a30df5dbce58bc3aa0c570cd828c750
+  metadata.gz: 84ff7dd72ab2d08ebaf3eda64b104db414b882f90f4d05df06485bf0b5f9e6c116512d5c5183e8f921aacf660eaf58eb37d5d2fd959002b859fd97f9c8af7a8e
+  data.tar.gz: 59ee28b33e364ce56a453ad9abd2f6fad30e8aa623d6ddb89f50d8211b4ad77d32e3493bbac853e74b558e307af6f7db71d057aaddb72cbcc15338c332dec16b

data/CHANGES.md

@@ -1,4 +1,35 @@
-Version 1.0.0 - 28-Feb-2015
----------------------------
+# Changes
+
+## Version 1.1.1 - 8-Jul-2023
+
+* Added `Bzip2::FFI::Reader#tell`, returning the number of decompressed bytes
+  that have been read. `Bzip2::FFI::Reader#pos` is now an alias for
+  `Bzip2::FFI::Reader#tell`.
+* Added `Bzip2::FFI::Writer#tell`, returning the number of uncompressed bytes
+  that have been written. `Bzip2::FFI::Writer#pos` is now an alias for
+  `Bzip2::FFI::Writer#tell`.
+
+
+## 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,53 @@ 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', git: 'https://github.com/philr/coveralls-ruby.git', 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.
+  #
+  # The source version of ffi 1.15.5 is declared as compatible with Ruby >= 2.3.
+  # The binary version of 1.15.5 is declared as compatible with Ruby >= 2.4, so
+  # doesn't get used. The using the source version results in a segmentation
+  # fault during libffi initialization.
+  #
+  # Binaries of 15.5.0 to 15.5.4 are declared as compatible with Ruby >= 2.3,
+  # but don't get used with Bundler 2.3.23 and Ruby 2.3 on Windows.
+  #
+  # Limit to earlier compatible versions.
+  if RUBY_VERSION < '2.0' && RUBY_PLATFORM =~ /mingw/
+    gem 'ffi', '< 1.9.0'
+  elsif RUBY_VERSION < '2.4' && RUBY_PLATFORM =~ /mingw/
+    gem 'ffi', '< 1.15.0'
+  end
 end

data/LICENSE

@@ -1,19 +1,19 @@
-Copyright (c) 2015 Philip Ross
+Copyright (c) 2015-2023 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,35 +8,30 @@ 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
 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
+`libbz2-1.0` on Debian and Ubuntu, or `bzip2-libs` on Fedora, Red Hat and
 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,134 @@ 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 releases 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 also 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`).
+
+
+### Streaming and Memory Usage
+
+Bzip2::FFI compresses and decompresses data as a stream, allowing large files to
+be handled without requiring the complete contents to be held in memory.
+
+When decompressing, 4 KB of compressed data is read at a time. An additional 4
+KB is required to pass the data to libbz2. Decompressed data is output in blocks
+dictated by the length passed to `Bzip2::FFI::Reader#read` (defaulting to 4 KB
+and requiring twice the length in memory to read from libbz2).
+
+When compressing, up to 4 KB of compressed data is written at a time, requiring
+up to 8 KB of memory. An additional copy is also taken of the `String` passed to
+`Bzip2::FFI::Writer#write`.
+
+Internally, libbz2 allocates additional memory according to the bzip2 block
+size. Please refer to the
+[Memory Management](https://sourceware.org/bzip2/manual/manual.html#memory-management)
+section of the Bzip2 documentation for details.
 
 
-## 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

@@ -3,7 +3,7 @@ require File.expand_path(File.join('..', 'lib', 'bzip2', 'ffi', 'version'), __FI
 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.summary = 'Reads and writes bzip2 compressed data as a stream using FFI bindings for libbz2.'
   s.description = <<-EOF
     Bzip2::FFI is a Ruby wrapper for libbz2 using FFI bindings.
 
@@ -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/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