bzip2-ffi 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03b164babce536cf85cdf6fa03a4baa85651c8a9463284eeb633a0db4ffcc6fa
-  data.tar.gz: 42a231de039d293fe25cf5dc98c22d4650225a73fb363cee7fb3c16d69af0355
+  metadata.gz: 25b15e037a74f589a612d955890d194519a97abfa903c993589d0096794b6459
+  data.tar.gz: '088c393a99b19d1d625148c951461333d2ed9ef934df6e5efaee2ea0007b9620'
 SHA512:
-  metadata.gz: 12a699a68f65e217b5c958697709bc65f3a64e2d627ab1ee16bf7519c43a0571321bb435a38f199639b6b1a9842a0e179022d91fd033ebf8ac907897c9e76c27
-  data.tar.gz: 0dc68221d4c9ee943efd3bffaea0584cefd6d5b30f5ad4d998384177a3d6fe83e29691f344e4ee110786a0558355f2a90a74aed2624ff30257e72c66ad90727f
+  metadata.gz: 84ff7dd72ab2d08ebaf3eda64b104db414b882f90f4d05df06485bf0b5f9e6c116512d5c5183e8f921aacf660eaf58eb37d5d2fd959002b859fd97f9c8af7a8e
+  data.tar.gz: 59ee28b33e364ce56a453ad9abd2f6fad30e8aa623d6ddb89f50d8211b4ad77d32e3493bbac853e74b558e307af6f7db71d057aaddb72cbcc15338c332dec16b

data/CHANGES.md

@@ -1,5 +1,15 @@
 # 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

data/Gemfile

@@ -13,7 +13,7 @@ group :test do
 
   # 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', 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'
 
 
@@ -38,8 +38,18 @@ group :test do
   # 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,4 +1,4 @@
-Copyright (c) 2015-2021 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

data/README.md

@@ -27,7 +27,7 @@ Bzip2::FFI is a pure-Ruby library that uses
 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).
 
 
@@ -42,7 +42,7 @@ 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 C Runtime
-Library. Links to the installer can be found on the bzip2-windows release page.
+Library. Links to the installer can be found on the bzip2-windows releases page.
 
 
 ## Usage
@@ -58,7 +58,7 @@ require 'bzip2/ffi'
 
 Data can be compressed using the `Bzip2::FFI::Writer` class. For example, the
 following compresses lines read from `ARGF` (either standard input, or file
-names given as command-line arguments:
+names given as command-line arguments):
 
 ```ruby
 Bzip2::FFI::Writer.open(io_or_path) do |writer|
@@ -116,7 +116,8 @@ ensure
 end
 ```
 
-All the available bzipped data can be read and decompressed in a single step:
+All the available bzipped data can also be read and decompressed in a single
+step:
 
 ```ruby
 uncompressed = Bzip2::FFI::Reader.read(io_or_path)
@@ -135,6 +136,26 @@ ASCII-8BIT (BINARY) encoding representing the raw decompressed bytes.
 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 for Bzip2::FFI is available on

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.
 

data/lib/bzip2/ffi/reader.rb

@@ -51,6 +51,11 @@ module Bzip2
     # the stream to the byte immediately following the end of the compressed
     # bzip2 data. If `#seek` raises an `IOError`, it will be caught and the
     # stream position will be left unchanged.
+    #
+    # {Reader} does not support seeking (it's not supported by the underlying
+    # libbz2 library). There are no `#seek` or `#pos=` methods. The only way to
+    # advance the position is to call {#read}. Discard the result if it's not
+    # needed.
     class Reader < IO
       # The number of bytes read from the compressed data stream at a time.
       #
@@ -352,10 +357,11 @@ module Bzip2
       #
       # @return [Integer] The number of decompressed bytes that have been read.
       # @raise [IOError] If the {Reader} has been closed.
-      def pos
+      def tell
         check_closed
         @out_pos
       end
+      alias pos tell
 
       private
 

data/lib/bzip2/ffi/version.rb

@@ -4,6 +4,6 @@
 module Bzip2
   module FFI
     # The Bzip2::FFI version number.
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

data/lib/bzip2/ffi/writer.rb

@@ -40,6 +40,9 @@ module Bzip2
     # No character conversion is performed when writing and compressing. The
     # {write} and {#write} methods compress the raw bytes from the given
     # `String` (using the encoding of the `String`).
+    #
+    # {Writer} does not support seeking (it's not supported by the underlying
+    # libbz2 library). There are no `#seek` or `#pos=` methods.
     class Writer < IO
       # Size of the buffer passed to libbz2 for it to write compressed data to.
       #
@@ -344,10 +347,11 @@ module Bzip2
       # @return [Integer] The number of uncompressed bytes that have been
       #                   written.
       # @raise [IOError] If the {Writer} has been closed.
-      def pos
+      def tell
         s = stream
         (s[:total_in_hi32] << 32) | s[:total_in_lo32]
       end
+      alias pos tell
 
       private
 

data/test/reader_test.rb

@@ -79,6 +79,7 @@ class ReaderTest < Minitest::Test
             decompressed = reader.read(read_size)
           end
 
+          assert_equal(input.tell, reader.tell)
           assert_equal(input.pos, reader.pos)
 
           if buffer
@@ -104,6 +105,7 @@ class ReaderTest < Minitest::Test
           decompressed = reader.read
         end
 
+        assert_equal(buffer.bytesize, reader.tell)
         assert_equal(buffer.bytesize, reader.pos)
 
         refute_nil(decompressed)
@@ -569,23 +571,25 @@ class ReaderTest < Minitest::Test
     end
   end
 
-  def test_pos_returns_decompressed_position
-    Bzip2::FFI::Reader.open(fixture_path('compressed.bz2')) do |reader|
-      assert_equal(0, reader.pos)
-      reader.read(17)
-      assert_equal(17, reader.pos)
-      reader.read(8837)
-      assert_equal(8854, reader.pos)
-      reader.read
-      assert_equal(65670, reader.pos)
+  [:tell, :pos].each do |method|
+    define_method("test_#{method}_returns_decompressed_position") do
+      Bzip2::FFI::Reader.open(fixture_path('compressed.bz2')) do |reader|
+        assert_equal(0, reader.public_send(method))
+        reader.read(17)
+        assert_equal(17, reader.public_send(method))
+        reader.read(8837)
+        assert_equal(8854, reader.public_send(method))
+        reader.read
+        assert_equal(65670, reader.public_send(method))
+      end
     end
-  end
 
-  def test_pos_raises_io_error_when_closed
-    File.open(fixture_path('compressed.bz2'), 'rb') do |file|
-      reader = Bzip2::FFI::Reader.new(file)
-      reader.close
-      assert_raises(IOError) { reader.pos }
+    define_method("test_#{method}_raises_io_error_when_closed") do
+      File.open(fixture_path('compressed.bz2'), 'rb') do |file|
+        reader = Bzip2::FFI::Reader.new(file)
+        reader.close
+        assert_raises(IOError) { reader.public_send(method) }
+      end
     end
   end
 

data/test/writer_test.rb

@@ -48,11 +48,13 @@ class WriterTest < Minitest::Test
         buffer = io.read(read_size)
         break unless buffer
         assert_equal(buffer.bytesize, writer.write(buffer))
+        assert_equal(io.tell, writer.tell)
         assert_equal(io.pos, writer.pos)
       end
     else
       buffer = io.read
       assert_equal(buffer.bytesize, writer.write(buffer))
+      assert_equal(io.tell, writer.tell)
       assert_equal(io.pos, writer.pos)
     end
   end
@@ -226,38 +228,40 @@ class WriterTest < Minitest::Test
     assert_nil(writer.close)
   end
 
-  def test_pos_returns_uncompressed_position
-    Bzip2::FFI::Writer.open(DummyIO.new) do |writer|
-      assert_equal(0, writer.pos)
-      writer.write('Test')
-      assert_equal(4, writer.pos)
-      writer.write('Complete')
-      assert_equal(12, writer.pos)
+  [:tell, :pos].each do |method|
+    define_method("test_#{method}_returns_uncompressed_position") do
+      Bzip2::FFI::Writer.open(DummyIO.new) do |writer|
+        assert_equal(0, writer.public_send(method))
+        writer.write('Test')
+        assert_equal(4, writer.public_send(method))
+        writer.write('Complete')
+        assert_equal(12, writer.public_send(method))
+      end
     end
-  end
 
-  def test_pos_returns_uncompressed_64bit_position
-    skip_slow_test_unless_enabled
+    define_method("test_#{method}_returns_uncompressed_64bit_position") do
+      skip_slow_test_unless_enabled
 
-    # The position is read from separate 32-bit low and high words.
-    Bzip2::FFI::Writer.open(DummyIO.new) do |writer|
-      buffer_bits = 12
-      buffer = "\0".encode(Encoding::ASCII_8BIT) * 2**buffer_bits
+      # The position is read from separate 32-bit low and high words.
+      Bzip2::FFI::Writer.open(DummyIO.new) do |writer|
+        buffer_bits = 12
+        buffer = "\0".encode(Encoding::ASCII_8BIT) * 2**buffer_bits
 
-      (2**(32 - buffer_bits)).times do |i|
+        (2**(32 - buffer_bits)).times do |i|
+          writer.write(buffer)
+        end
+
+        assert_equal(2**32, writer.public_send(method))
         writer.write(buffer)
+        assert_equal(2**32 + buffer.bytesize, writer.public_send(method))
       end
-
-      assert_equal(2**32, writer.pos)
-      writer.write(buffer)
-      assert_equal(2**32 + buffer.bytesize, writer.pos)
     end
-  end
 
-  def test_pos_raises_io_error_when_closed
-    writer = Bzip2::FFI::Writer.new(DummyIO.new)
-    writer.close
-    assert_raises(IOError) { writer.pos }
+    define_method("test_#{method}_raises_io_error_when_closed") do
+      writer = Bzip2::FFI::Writer.new(DummyIO.new)
+      writer.close
+      assert_raises(IOError) { writer.public_send(method) }
+    end
   end
 
   def test_finalizer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bzip2-ffi
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Philip Ross
@@ -29,7 +29,7 @@ cert_chain:
   J3Zn/kSTjTekiaspyGbczC3PUaeJNxr+yCvR4sk71Xmk/GaKKGOHedJ1uj/LAXrA
   MR0mpl7b8zCg0PFC1J73uw==
   -----END CERTIFICATE-----
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2023-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -91,9 +91,9 @@ licenses:
 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/bzip2-ffi/1.1.0
+  documentation_uri: https://rubydoc.info/gems/bzip2-ffi/1.1.1
   homepage_uri: https://github.com/philr/bzip2-ffi
-  source_code_uri: https://github.com/philr/bzip2-ffi/tree/v1.1.0
+  source_code_uri: https://github.com/philr/bzip2-ffi/tree/v1.1.1
 post_install_message: 
 rdoc_options:
 - "--title"
@@ -116,8 +116,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - libbz2.(so|dll|dylib) available on the library search path
-rubygems_version: 3.2.3
+rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
-summary: Reads and writes bzip2 compressed data using FFI bindings for libbz2.
+summary: Reads and writes bzip2 compressed data as a stream using FFI bindings for
+  libbz2.
 test_files: []