bzip2-ffi 1.0.0 → 1.1.0

data/test/test_helper.rb

@@ -1,8 +1,11 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
 unless RUBY_ENGINE == 'jruby'
   require 'simplecov'
   require 'coveralls'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov.formatters = [
     SimpleCov::Formatter::HTMLFormatter,
     Coveralls::SimpleCov::Formatter
   ]
@@ -17,6 +20,7 @@ require 'bzip2/ffi'
 require 'fileutils'
 require 'minitest/autorun'
 require 'open3'
+require 'pathname'
 
 class Bzip2::FFI::IO
   class << self
@@ -61,6 +65,10 @@ module TestHelper
       end
     end
 
+    def skip_slow_test_unless_enabled
+      skip('Skipping slow test (enable with RUN_SLOW_TESTS=1)') unless ENV['RUN_SLOW_TESTS'] == '1'
+    end
+
     private
 
     if File::ALT_SEPARATOR
@@ -74,25 +82,54 @@ module TestHelper
     end
 
     def assert_bzip2_command_successful(*arguments)
-      out, err, status = Open3.capture3(*(['bzip2'] + arguments))
-
-      args_string = arguments.collect {|a| "'#{a}'" }.join(' ')
-      assert(err == '', "`bzip2 #{args_string}` returned error: #{err}")
-      assert(out == '', "`bzip2 #{args_string}` returned output: #{out}")
-      assert(status.exitstatus == 0, "`bzip2 #{args_string}` exit status was non-zero")
+      command_with_arguments = ['bzip2'] + arguments
+      begin
+        out, err, status = Open3.capture3(*command_with_arguments)
+
+        args_string = arguments.collect {|a| "'#{a}'" }.join(' ')
+        assert(err == '', "`bzip2 #{args_string}` returned error: #{err}")
+        assert(out == '', "`bzip2 #{args_string}` returned output: #{out}")
+
+        # Ruby 1.9.3 on Windows intermittently returns a nil status. Assume that
+        # the process completed successfully.
+        if status
+          assert(status.exitstatus == 0, "`bzip2 #{args_string}` exit status was non-zero")
+        else
+          puts "`#{command_with_arguments.join(' ')}`: command status was nil, assuming successful"
+        end
+      rescue Errno::EBADF => e
+        # JRuby 1.7 intermittently reports a bad file descriptor when closing
+        # one of the input or output streams. Assume that the process completed
+        # successfully.
+        puts "`#{command_with_arguments.join(' ')}`: Open3.capture3 raised Errno::EBADF, assuming successful"
+        puts e.inspect
+        puts e.backtrace.join("\n")
+      end
     end
   end
 
   module Fixtures
     FIXTURES_DIR = File.join(BASE_DIR, 'fixtures')
-  
+
     def fixture_path(fixture)
       File.join(FIXTURES_DIR, fixture)
     end
   end
+
+  module TestDefinitions
+    def path_or_pathname_tests(name, &block)
+      [['path', Proc.new {|p| p }], ['pathname', Proc.new {|p| Pathname.new(p) }]].each do |(description, path_param)|
+        define_method("test_#{name}_with_#{description}") do
+          instance_exec(path_param, &block)
+        end
+      end
+    end
+  end
 end
 
 class Minitest::Test
   include TestHelper::Assertions
   include TestHelper::Fixtures
+  extend TestHelper::Fixtures
+  extend TestHelper::TestDefinitions
 end

data/test/version_test.rb

@@ -1,4 +1,7 @@
-require 'test_helper'
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require_relative 'test_helper'
 
 class VersionTest < Minitest::Test
   def test_version

data/test/writer_test.rb

@@ -1,22 +1,38 @@
 # encoding: UTF-8
+# frozen_string_literal: true
 
-require 'pathname'
-require 'test_helper'
 require 'tmpdir'
+require_relative 'test_helper'
 
 class WriterTest < Minitest::Test
   class DummyIO
     attr_reader :written_bytes
-  
+
     def initialize
       @written_bytes = 0
     end
-  
+
     def write(string)
       @written_bytes += string.bytesize
     end
   end
 
+  class << self
+    def read_size_combinations(fixture)
+      [16, 1024, 16384, File.size(fixture_path(fixture)), nil].each do |read_size|
+        yield read_size, "#{read_size ? "_with_read_size_#{read_size}" : ''}"
+      end
+    end
+
+    def bunzip_fixture_tests(name, fixture)
+      read_size_combinations(fixture) do |read_size, description|
+        define_method("test_fixture_#{name}#{description}") do
+          bunzip_test(fixture, read_size: read_size)
+        end
+      end
+    end
+  end
+
   def setup
     Bzip2::FFI::Writer.test_after_open_file_raise_exception = false
   end
@@ -32,10 +48,12 @@ class WriterTest < Minitest::Test
         buffer = io.read(read_size)
         break unless buffer
         assert_equal(buffer.bytesize, writer.write(buffer))
+        assert_equal(io.pos, writer.pos)
       end
     else
       buffer = io.read
       assert_equal(buffer.bytesize, writer.write(buffer))
+      assert_equal(io.pos, writer.pos)
     end
   end
 
@@ -72,8 +90,8 @@ class WriterTest < Minitest::Test
     end
   end
 
-  def bunzip_test(fixture_or_strings, options = {})  
-    Dir.mktmpdir('bzip2-ffi-test') do |dir|      
+  def bunzip_test(fixture_or_strings, options = {})
+    Dir.mktmpdir('bzip2-ffi-test') do |dir|
       compressed = File.join(dir, "test.bz2")
       Bzip2::FFI::Writer.open(compressed, options[:writer_options] || {}) do |writer|
         if fixture_or_strings
@@ -88,7 +106,7 @@ class WriterTest < Minitest::Test
       end
 
       bunzip_and_compare(compressed, fixture_or_strings)
-    end    
+    end
   end
 
   def test_initialize_nil_io
@@ -113,29 +131,10 @@ class WriterTest < Minitest::Test
     bunzip_test(nil)
   end
 
-  def test_fixture_text
-    [16, 1024, 16384, nil].each do |read_size|
-      bunzip_test('lorem.txt', read_size: read_size)
-    end
-  end
-
-  def test_fixture_very_compressible
-    [16, 1024, 16384, nil].each do |read_size|
-      bunzip_test('zero.txt', read_size: read_size)
-    end
-  end
-
-  def test_fixture_uncompressible
-    [16, 1024, 16384, nil].each do |read_size|
-      bunzip_test('bzipped', read_size: read_size)
-    end
-  end
-
-  def test_fixture_image
-    [16, 1024, 16384, nil].each do |read_size|
-      bunzip_test('moon.tiff', read_size: read_size)
-    end    
-  end
+  bunzip_fixture_tests(:text, 'lorem.txt')
+  bunzip_fixture_tests(:very_compressible, 'zero.txt')
+  bunzip_fixture_tests(:uncompressible, 'compressed.bz2')
+  bunzip_fixture_tests(:image, 'moon.tiff')
 
   def test_encoding_handling
     bunzip_test(['áÁçÇðÐéÉ'.encode(Encoding::UTF_8), 'áÁçÇðÐéÉ'.encode(Encoding::ISO_8859_1)])
@@ -148,11 +147,11 @@ class WriterTest < Minitest::Test
   def test_block_size
     sizes = [1, 9].collect do |block_size|
       io = DummyIO.new
-      
+
       Bzip2::FFI::Writer.open(io, block_size: block_size) do |writer|
         write_fixture(writer, 'lorem.txt')
       end
-      
+
       io.written_bytes
     end
 
@@ -177,11 +176,8 @@ class WriterTest < Minitest::Test
     assert_equal(explicit_io.written_bytes, default_io.written_bytes)
   end
 
-  def test_work_factor
-    # Not trivial to check if the value passed has any effect. Just check that
-    # there are no failures for values within the acceptable range.
-
-    [0, 100, 250].each do |work_factor|
+  [0, 100, 250].each do |work_factor|
+    define_method("test_work_factor_#{work_factor}") do
       bunzip_test('lorem.txt', writer_options: {work_factor: work_factor})
     end
   end
@@ -230,6 +226,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)
+    end
+  end
+
+  def test_pos_returns_uncompressed_64bit_position
+    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
+
+      (2**(32 - buffer_bits)).times do |i|
+        writer.write(buffer)
+      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 }
+  end
+
   def test_finalizer
     # Code coverage will verify that the finalizer was called.
     10.times { Bzip2::FFI::Writer.new(DummyIO.new) }
@@ -244,14 +274,16 @@ class WriterTest < Minitest::Test
     assert_raises(ArgumentError) { Bzip2::FFI::Writer.open(Object.new) }
   end
 
-  def test_open_invalid_block_size
-    assert_raises(RangeError) { Bzip2::FFI::Writer.open(DummyIO.new, block_size: 0) }
-    assert_raises(RangeError) { Bzip2::FFI::Writer.open(DummyIO.new, block_size: 10) }
+  [0, 10].each do |block_size|
+    define_method("test_open_invalid_block_size_#{block_size}") do
+      assert_raises(RangeError) { Bzip2::FFI::Writer.open(DummyIO.new, block_size: block_size) }
+    end
   end
 
-  def test_open_invalid_work_factor
-    assert_raises(RangeError) { Bzip2::FFI::Writer.open(DummyIO.new, work_factor: -1) }
-    assert_raises(RangeError) { Bzip2::FFI::Writer.open(DummyIO.new, work_factor: 251) }
+  [-1, 251].each do |work_factor|
+    define_method("test_open_invalid_work_factor_#{work_factor}") do
+      assert_raises(RangeError) { Bzip2::FFI::Writer.open(DummyIO.new, work_factor: work_factor) }
+    end
   end
 
   def test_open_block_io
@@ -273,42 +305,38 @@ class WriterTest < Minitest::Test
     end
   end
 
-  def test_open_block_path
+  path_or_pathname_tests(:open_block) do |path_param|
     Dir.mktmpdir('bzip2-ffi-test') do |dir|
       path = File.join(dir, 'test')
-      [path, Pathname.new(path)].each do |path_param|
-        Bzip2::FFI::Writer.open(path_param) do |writer|
-          io = writer.send(:io)
-          assert_kind_of(File, io)
-          assert_equal(path, io.path)
-          assert_raises(IOError) { io.read(1) }
-          assert_nothing_raised { io.write('test') }
-        end
+      Bzip2::FFI::Writer.open(path_param.call(path)) do |writer|
+        io = writer.send(:io)
+        assert_kind_of(File, io)
+        assert_equal(path, io.path)
+        assert_raises(IOError) { io.read(1) }
+        assert_nothing_raised { io.write('test') }
       end
     end
   end
 
-  def test_open_no_block_path
+  path_or_pathname_tests(:open_no_block) do |path_param|
     Dir.mktmpdir('bzip2-ffi-test') do |dir|
       path = File.join(dir, 'test')
-      [path, Pathname.new(path)].each do |path_param|
-        writer = Bzip2::FFI::Writer.open(path_param)
-        begin
-          io = writer.send(:io)
-          assert_kind_of(File, io)
-          assert_equal(path, io.path)
-          assert_raises(IOError) { io.read(1) }
-          assert_nothing_raised { io.write('test') }
-        ensure
-          writer.close
-        end
+      writer = Bzip2::FFI::Writer.open(path_param.call(path))
+      begin
+        io = writer.send(:io)
+        assert_kind_of(File, io)
+        assert_equal(path, io.path)
+        assert_raises(IOError) { io.read(1) }
+        assert_nothing_raised { io.write('test') }
+      ensure
+        writer.close
       end
     end
   end
 
   def test_open_block_path_always_autoclosed
     Dir.mktmpdir('bzip2-ffi-test') do |dir|
-      Bzip2::FFI::Writer.open(File.join(dir, 'test'), autoclose: false) do |writer|    
+      Bzip2::FFI::Writer.open(File.join(dir, 'test'), autoclose: false) do |writer|
         assert_equal(true, writer.autoclose?)
       end
     end
@@ -405,15 +433,9 @@ class WriterTest < Minitest::Test
     end
   end
 
-  def test_class_write_path
+  path_or_pathname_tests(:class_write) do |path_param|
     class_write_test('test_path') do |compressed, content|
-      Bzip2::FFI::Writer.write(compressed, content)
-    end
-  end
-
-  def test_class_write_pathname
-    class_write_test('test_pathname') do |compressed, content|
-      Bzip2::FFI::Writer.write(Pathname.new(compressed), content)
+      Bzip2::FFI::Writer.write(path_param.call(compressed), content)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bzip2-ffi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Philip Ross
@@ -10,27 +10,26 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDdDCCAlygAwIBAgIBATANBgkqhkiG9w0BAQUFADBAMRIwEAYDVQQDDAlwaGls
-  LnJvc3MxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-  bTAeFw0xNDA5MjgxOTA4MDdaFw0xNTA5MjgxOTA4MDdaMEAxEjAQBgNVBAMMCXBo
-  aWwucm9zczEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYD
-  Y29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAkZzB+qfhmyY+XRvU
-  u310LMTGsTkR4/8JFCMF0YeQX6ZKmLr1fKzF3At1+DlI+v0t/G2FS6Dic0V3l8MK
-  JczyFh72NANOaQhAo0GHh8WkaeCf2DLL5K6YJeLpvkvp39oxzn00A4zosnzxM50f
-  Xrjx2HmurcJQurzafeCDj67QccaNE+5H+mcIVAJlsA1h1f5QFZ3SqQ4mf8St40pE
-  6YR4ev/Eq6Hb8aUoUq30otxbeHAEHh8cdVhTNFq7sPWb0psQRF2D/+o0MLgHt8PY
-  EUm49szlLsnjVXAMCHU7wH9CmDR/5Lzcrgqh3DgyI8ay6DnlSQ213eYZH/Nkn1Yz
-  TcNLCQIDAQABo3kwdzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU
-  D5nzO9/MG4B6ygch/Pv6PF9Q5x8wHgYDVR0RBBcwFYETcGhpbC5yb3NzQGdtYWls
-  LmNvbTAeBgNVHRIEFzAVgRNwaGlsLnJvc3NAZ21haWwuY29tMA0GCSqGSIb3DQEB
-  BQUAA4IBAQCI4Ucln0W425HOc2mIaXkAiHWNs1Fv/rCPrBIwBYhjStVYUEPCIhEf
-  MRCqpeOog3+b31SMIqqHQcNnjY9/YHeJCQ5vsRyN/A7+nafQ+PjI+E5HIl5Bd8Hk
-  nbizkcvM/qE8w2IWuadTRzGzeBolzVp4gl/GLP9wT1H+cTjC7zCjgbxnwM7zLnxA
-  F4XcKGArAMYd8GgHUTVwMsYP4XkM3CGWtuk8pmgCo2CKZA4PDrWYiuo+vtwFsgYJ
-  hKe67BDNyG4DxJTu6tP979ZXanCYEDWmxJMSm4Ih9tObHryZc6xp1SsM4jPR6Mbt
-  OWpW9iGQHkfCktjw+bYdDKVK8c0WU5PN
+  MIIDPDCCAiSgAwIBAgIBATANBgkqhkiG9w0BAQsFADAkMSIwIAYDVQQDDBlwaGls
+  LnJvc3MvREM9Z21haWwvREM9Y29tMB4XDTE5MTIyNDE0NTU0N1oXDTM5MTIyNDE0
+  NTU0N1owJDEiMCAGA1UEAwwZcGhpbC5yb3NzL0RDPWdtYWlsL0RDPWNvbTCCASIw
+  DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJGcwfqn4ZsmPl0b1Lt9dCzExrE5
+  EeP/CRQjBdGHkF+mSpi69XysxdwLdfg5SPr9LfxthUug4nNFd5fDCiXM8hYe9jQD
+  TmkIQKNBh4fFpGngn9gyy+SumCXi6b5L6d/aMc59NAOM6LJ88TOdH1648dh5rq3C
+  ULq82n3gg4+u0HHGjRPuR/pnCFQCZbANYdX+UBWd0qkOJn/EreNKROmEeHr/xKuh
+  2/GlKFKt9KLcW3hwBB4fHHVYUzRau7D1m9KbEERdg//qNDC4B7fD2BFJuPbM5S7J
+  41VwDAh1O8B/Qpg0f+S83K4Kodw4MiPGsug55UkNtd3mGR/zZJ9WM03DSwkCAwEA
+  AaN5MHcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFA+Z8zvfzBuA
+  esoHIfz7+jxfUOcfMB4GA1UdEQQXMBWBE3BoaWwucm9zc0BnbWFpbC5jb20wHgYD
+  VR0SBBcwFYETcGhpbC5yb3NzQGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEA
+  J80xgZ3gGdQVA8N+8NJANU5HLuZIU9jOaAlziU9ImoTgPiOHKGZC4as1TwT4kBt1
+  Qcnu7YSANYRrxP5tpOHsWPF/MQYgerAFCZS5+PzOTudwZ+7OsMW4/EMHy6aCVHEd
+  c7HzQRC4mSrDRpWxzyBnZ5nX5OAmIkKA8NgeKybT/4Ku6iFPPUQwlyxQaO+Wlxdo
+  FqHwpjRyoiVSpe4RUTNK3d3qesWPYi7Lxn6k6ZZeEdvG6ya33AXktE3jmmF+jPR1
+  J3Zn/kSTjTekiaspyGbczC3PUaeJNxr+yCvR4sk71Xmk/GaKKGOHedJ1uj/LAXrA
+  MR0mpl7b8zCg0PFC1J73uw==
   -----END CERTIFICATE-----
-date: 2015-02-28 00:00:00.000000000 Z
+date: 2021-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -74,9 +73,12 @@ files:
 - lib/bzip2/ffi/version.rb
 - lib/bzip2/ffi/writer.rb
 - test/error_test.rb
-- test/fixtures/bzipped
+- test/fixtures/compressed.bz2
+- test/fixtures/lorem-4096-bytes-compressed.txt.bz2
+- test/fixtures/lorem-first-structure-4096-bytes.txt.bz2
 - test/fixtures/lorem.txt
 - test/fixtures/moon.tiff
+- test/fixtures/two_structures.bz2
 - test/fixtures/zero.txt
 - test/io_test.rb
 - test/reader_test.rb
@@ -86,7 +88,12 @@ files:
 homepage: https://github.com/philr/bzip2-ffi
 licenses:
 - MIT
-metadata: {}
+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
+  homepage_uri: https://github.com/philr/bzip2-ffi
+  source_code_uri: https://github.com/philr/bzip2-ffi/tree/v1.1.0
 post_install_message: 
 rdoc_options:
 - "--title"
@@ -109,8 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - libbz2.(so|dll|dylib) available on the library search path
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Reads and writes bzip2 compressed data using FFI bindings for libbz2.