rubyzip-bzip2 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7322a0596a465cab1e1f7e5a2bfa7c7fbc8d5d8265187dffb8eb2c3826066c8e
-  data.tar.gz: 83693f7f9c329715977b8bcef4990013c6983ca0e1945525a877352814d612d7
+  metadata.gz: 568ccb1b7481eecd0f87a943b4b8a44bab0daef37739e0eefb01bdf5719d92b8
+  data.tar.gz: 59b1efa8e578d6334399745bedf424f13d1b9a1e4a4902c890902388f29afa71
 SHA512:
-  metadata.gz: 67d3cdb7afe2d41236cc7cd3b6350b32dcc4d009ce8ae30f327cf6cc3fee8a0a75b9b5aeec016a0d97a437699dc6a919d0f636a309b1dd075c61b55917dc28c9
-  data.tar.gz: a8130502de8fd975e62095197d1ec41b669a3bddd56adedd8a6feda29fb12db2c35a71ac016b96d9e7b2b7579a9a1ecd4d13fa13ed5ab75a647b9030af756421
+  metadata.gz: a789417a9bcc5ffe6ced70e29dbf2e6b64af2c522105201e8f77bf494be2d333f1178e09e949664a015d53cf1c5fe171bb8a056bcab46391e7bbc21b4fc64176
+  data.tar.gz: 6f88e4f8e236c676c733f663f2fe5040cc89a4cd72aaa69ab8d3e6b51e365a0661a9a657a678e83525263d92ce06b41ac5e6dc13335320746d239ac303a35933

data/.github/workflows/lint.yml

@@ -0,0 +1,19 @@
+name: Linter
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout rubyzip-bzip2 code
+      uses: actions/checkout@v4
+
+    - name: Install and set up ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.4
+        bundler-cache: true
+
+    - name: Rubocop
+      run: bundle exec rubocop

data/.github/workflows/tests.yml

@@ -0,0 +1,57 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4', head, jruby, jruby-head, truffleruby, truffleruby-head]
+        include:
+          - os: macos
+            ruby: '2.6'
+          - os: windows
+            ruby: '2.4.10'
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.os == 'windows' }}
+    steps:
+    - name: Checkout rubyzip-bzip2 code
+      uses: actions/checkout@v4
+
+    - name: Install and set up ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        rubygems: latest
+        bundler-cache: true
+
+    - name: Install bzip2 library
+      if: matrix.os == 'windows'
+      run: |
+        wget https://github.com/philr/bzip2-windows/releases/download/v1.0.8.0/bzip2-dll-1.0.8.0-win-x64.zip
+        Expand-Archive -Path bzip2-dll-1.0.8.0-win-x64.zip -DestinationPath C:\hostedtoolcache\windows\Ruby\${{ matrix.ruby }}\x64\bin
+
+    - name: Run the tests
+      env:
+        JRUBY_OPTS: --debug
+      run: bundle exec rake
+
+    - name: Coveralls
+      if: matrix.os == 'ubuntu' && !endsWith(matrix.ruby, 'head')
+      uses: coverallsapp/github-action@v2
+      with:
+        github-token: ${{ secrets.github_token }}
+        flag-name: ${{ matrix.ruby }}
+        parallel: true
+
+  finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@v2
+      with:
+        github-token: ${{ secrets.github_token }}
+        parallel-finished: true

data/.gitignore

@@ -0,0 +1,9 @@
+.idea
+*.gem
+.bundle
+Gemfile.lock
+coverage
+pkg/
+.ruby-gemset
+.ruby-version
+/vendor/bundle

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15

data/.simplecov

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'simplecov-lcov'
+
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.output_directory = 'coverage'
+  c.lcov_file_name = 'lcov.info'
+  c.report_with_single_file = true
+  c.single_report_path = 'coverage/lcov.info'
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::LcovFormatter
+  ]
+)
+
+SimpleCov.start do
+  # enable_coverage :branch   <-- Re-enable this when we move to ruby ~> 2.5.
+  add_filter ['/test/', '/samples/']
+end

data/Changelog.md

@@ -0,0 +1,33 @@
+# X.X.X (Next)
+
+* Fix automatic require
+* Fix the Libbz2::finalizer method.
+
+## Tooling and internal changes
+
+* Fix tests on Windows
+* Use github actions for CI
+* Add require statement to the example
+* Add LICENSE file
+* Use Markdown for the LICENSE and tidy up the README.
+* Update GitHub Actions workflows.
+* Update version of Rake to fix security alert.
+* Remove Pry and Guard development dependencies.
+* Update minimum version of RubyZip required.
+* Update MiniTest dependency.
+* Add a test to ensure correct version number format.
+* Add `bin/console'.
+* Require MFA for RubyGems operations.
+* Tighten-up RuboCop configuration.
+
+# 0.0.1
+
+* Initial version
+
+## About this Changelog file
+
+This file is, at least in part, generated by the following command:
+
+```shell
+$ git log --pretty=format:"* %s" --reverse --no-merges <commit-hash>..
+```

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2020-2025, Jan-Joost Spanjers and The Rubyzip Developers
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,12 +1,12 @@
 # rubyzip-bzip2
 
 [![Gem Version](https://badge.fury.io/rb/rubyzip-bzip2.svg)](http://badge.fury.io/rb/rubyzip-bzip2)
-[![Build Status](https://secure.travis-ci.org/rubyzip/rubyzip-bzip2.svg)](http://travis-ci.org/rubyzip/rubyzip-bzip2)
+[![Tests](https://github.com/rubyzip/rubyzip-bzip2/actions/workflows/tests.yml/badge.svg)](https://github.com/rubyzip/rubyzip-bzip2/actions/workflows/tests.yml)
+[![Linter](https://github.com/rubyzip/rubyzip-bzip2/actions/workflows/lint.yml/badge.svg)](https://github.com/rubyzip/rubyzip-bzip2/actions/workflows/lint.yml)
 [![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip-bzip2.svg)](https://codeclimate.com/github/rubyzip/rubyzip-bzip2)
 [![Coverage Status](https://img.shields.io/coveralls/rubyzip/rubyzip-bzip2.svg)](https://coveralls.io/r/rubyzip/rubyzip-bzip2?branch=master)
 
-The rubyzip-bzip2 gem provides an extension of the rubyzip gem for reading zip files
-compressed with bzip2 compression.
+The rubyzip-bzip2 gem provides an extension of the rubyzip gem for reading zip files compressed with bzip2 compression.
 
 ## Website and Project Home
 http://github.com/rubyzip/rubyzip-bzip2
@@ -32,6 +32,8 @@ Reading a zip file with bzip2 compression is not different from reading
 any other zip file using rubyzip:
 
 ```ruby
+require 'zip/bzip2'
+
 Zip::File.open('foo.zip') do |zipfile|
   zipfile.each do |entry|
     content = zipfile.read(entry.name)
@@ -41,8 +43,7 @@ end
 ```
 
 ## License
-Rubyzip-bzip2 is distributed under the same license as ruby. See
-http://www.ruby-lang.org/en/LICENSE.txt
+Rubyzip-bzip2 is distributed under the same license as Ruby. In practice this means you can use it under the terms of the Ruby License or the 2-Clause BSD License. See https://www.ruby-lang.org/en/about/license.txt and LICENSE.md for details.
 
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/rubyzip/rubyzip-bzip2.
@@ -56,4 +57,14 @@ rake
 ```
 
 ## Authors
+
+See https://github.com/rubyzip/rubyzip-bzip2/graphs/contributors for a comprehensive list.
+
+### Current maintainers
+
+* Robert Haines (@hainesr)
+* John Lees-Miller (@jdleesmiller)
+* Oleksandr Simonov (@simonoff)
+
+### Original author
 Jan-Joost Spanjers ( oss at hiberis.nl )

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'zip/bzip2'
+
+require 'irb'
+IRB.start(__FILE__)

data/lib/rubyzip/bzip2.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'zip/bzip2'

data/lib/zip/bzip2/libbz2.rb

@@ -7,9 +7,9 @@ require 'zip/bzip2/ffi/libbz2'
 module Zip
   module Bzip2
     class Libbz2 #:nodoc:
-      def self.finalizer
+      def self.finalizer(stream)
         lambda do |_id|
-          decompress_end
+          FFI::Libbz2::BZ2_bzDecompressEnd(stream)
         end
       end
       private_class_method :finalizer
@@ -32,7 +32,7 @@ module Zip
         result = FFI::Libbz2::BZ2_bzDecompressInit(@stream, 0, small ? 1 : 0)
         check_error(result)
 
-        ObjectSpace.define_finalizer(self, self.class.send(:finalizer))
+        ObjectSpace.define_finalizer(self, self.class.send(:finalizer, @stream))
 
         true
       end

data/lib/zip/bzip2/version.rb

@@ -2,6 +2,6 @@
 
 module Zip
   module Bzip2
-    VERSION = '0.0.1'
+    VERSION = '1.0.0'
   end
 end

data/rubyzip-bzip2.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zip/bzip2/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rubyzip-bzip2'
+  spec.version = ::Zip::Bzip2::VERSION
+  spec.authors = [
+    'Jan-Joost Spanjers', 'Robert Haines'
+  ]
+
+  spec.summary = 'Extension of rubyzip to read bzip2 compressed files'
+  spec.description =
+    'The rubyzip-bzip2 gem provides an extension of the rubyzip gem '\
+    'for reading zip files compressed with bzip2 compression'
+  spec.homepage = 'http://github.com/rubyzip/rubyzip-bzip2'
+  spec.license = 'BSD 2-Clause'
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/rubyzip/rubyzip-bzip2/issues',
+    'changelog_uri' => "https://github.com/rubyzip/rubyzip-bzip2/blob/v#{spec.version}/Changelog.md",
+    'documentation_uri' => "https://www.rubydoc.info/gems/rubyzip-bzip2/#{spec.version}",
+    'source_code_uri' => "https://github.com/rubyzip/rubyzip-bzip2/tree/v#{spec.version}",
+    'wiki_uri' => 'https://github.com/rubyzip/rubyzip-bzip2/wiki',
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.add_dependency 'ffi', '~> 1.0'
+  spec.add_dependency 'rubyzip', '~> 2.4', '< 3.0'
+
+  spec.add_development_dependency 'minitest', '~> 5.15'
+  spec.add_development_dependency 'rake', '~> 13.2'
+  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+  spec.add_development_dependency 'simplecov', '~> 0.18.0'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubyzip-bzip2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jan-Joost Spanjers
-autorequire: 
+- Robert Haines
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
+date: 2025-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -30,120 +31,109 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: 0.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '0.8'
 description: The rubyzip-bzip2 gem provides an extension of the rubyzip gem for reading
   zip files compressed with bzip2 compression
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/lint.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".simplecov"
+- Changelog.md
+- Gemfile
+- LICENSE.md
 - README.md
+- Rakefile
+- bin/console
+- lib/rubyzip/bzip2.rb
 - lib/zip/bzip2.rb
 - lib/zip/bzip2/decompress.rb
 - lib/zip/bzip2/decompressor.rb
@@ -151,16 +141,18 @@ files:
 - lib/zip/bzip2/ffi/libbz2.rb
 - lib/zip/bzip2/libbz2.rb
 - lib/zip/bzip2/version.rb
+- rubyzip-bzip2.gemspec
 homepage: http://github.com/rubyzip/rubyzip-bzip2
 licenses:
 - BSD 2-Clause
 metadata:
   bug_tracker_uri: https://github.com/rubyzip/rubyzip-bzip2/issues
-  changelog_uri: https://github.com/rubyzip/rubyzip-bzip2/blob/v0.0.1/Changelog.md
-  documentation_uri: https://www.rubydoc.info/gems/rubyzip-bzip2/0.0.1
-  source_code_uri: https://github.com/rubyzip/rubyzip-bzip2/tree/v0.0.1
+  changelog_uri: https://github.com/rubyzip/rubyzip-bzip2/blob/v1.0.0/Changelog.md
+  documentation_uri: https://www.rubydoc.info/gems/rubyzip-bzip2/1.0.0
+  source_code_uri: https://github.com/rubyzip/rubyzip-bzip2/tree/v1.0.0
   wiki_uri: https://github.com/rubyzip/rubyzip-bzip2/wiki
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,8 +167,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Extension of rubyzip to read bzip2 compressed files
 test_files: []