excavate 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b66a3e8ff5083bd78711cff8289e18f958578d84fea44be53dcd4f5349508755
-  data.tar.gz: 1c65ff305ed20893b27470063280f60698d9920db597d42af8e75127c947784a
+  metadata.gz: ae1e2f6707705a5247f26db5c29f7ffb3618ccdf890277ca664cc91361e9ab7c
+  data.tar.gz: 5ea58834d2bcbb1005a36c9f239d32f34a7e61a2bff4a4a0548cdc5e4ae38688
 SHA512:
-  metadata.gz: feac4007753c19cb52d9f32432f96ab2a2cf6553556cb950ad15f210a0e8f3d0209622b81702e17d4a9fef3e975b42f7f97178d7d55dfc914731245093a159f0
-  data.tar.gz: 93bed15a89d5f620e45232f9de42afde7efaabc7e79734617c8443f2324858a6a97e6b9e40995ee18ad5bce4d36ea1ac584b238d257accf567e88472ea0fd991
+  metadata.gz: 38d73443fa50e9d4af01d9adcde21e45cee4c201f7bb586ce9097d37e092153d18acd5109183ba3bec3c9ecbd4a017d4f4882a44f3f1caf9e83ad98b769b8997
+  data.tar.gz: 0c6b9f6673b571ca5f582b4b0080180b89d091cfbaa85932b642f3c9ee690433e9e0afbac4b7ad1536307c09f54f2d614dc9df1a1690cdde0e0f736ac9f3151b

data/.github/workflows/test-and-release.yml

@@ -10,40 +10,22 @@ concurrency:
   group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
   cancel-in-progress: true
 
-jobs:
-  prepare:
-    runs-on: ubuntu-latest
-    outputs:
-      head_tag: ${{ steps.check.outputs.head_tag }}
-      foreign_pr: ${{ steps.check.outputs.foreign_pr }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2.3.4
-
-      - name: Retrieve tags
-        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* || true
-      - name: Set output variables
-        id: check
-        run: |
-          fpr="no"
-          tag=""
-          if [[ "${{ github.ref }}" == refs/heads/* ]]; then
-            tag="$(git tag --points-at HEAD)"
-          elif [[ "${{ github.ref }}" == refs/pull/* ]] && [ "${{ github.event.pull_request.head.repo.full_name }}" != "${{ github.event.pull_request.base.repo.full_name }}" ]; then
-            fpr="yes"
-          fi
-          echo "::set-output name=foreign_pr::${fpr}"
-          echo "::set-output name=head_tag::${tag}"
+env:
+  BUNDLER_VER: 2.3.24
+# Forcing bundler version to ensure that it is consistent everywhere and
+# does not cause bundler gem reinstalls
+# bundler/rubygems 2.3.22 is a minimal requirement to support gnu/musl differentiation
+# https://github.com/rubygems/rubygems/pull/4488
 
+jobs:
   test:
     name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    needs: prepare
     runs-on: ${{ matrix.os }}
     continue-on-error: false
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
+        ruby: [ '2.7', '3.0', '3.1' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
 
     steps:
@@ -52,13 +34,54 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler: ${{ env.BUNDLER_VER }}
           bundler-cache: true
 
       - run: bundle exec rspec
 
+  metanorma:
+    name: Test with Metanorma on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: false
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.0', '3.1' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: metanorma/metanorma
+
+      - uses: metanorma/metanorma-build-scripts/inkscape-setup-action@main
+
+      - uses: actions/checkout@v3
+        with:
+          path: "excavate"
+
+      - run: 'echo ''gem "excavate", path: "./excavate"'' > Gemfile.devel'
+
+      # https://github.com/rubygems/rubygems/issues/5160
+      - if: matrix.ruby == '3.0'
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          bundler: ${{ env.BUNDLER_VER }}
+          rubygems: latest
+
+      - if: matrix.ruby != '3.0'
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: ${{ env.BUNDLER_VER }}
+          bundler-cache: true
+
+      - run: bundle exec rake
+
   release:
     name: Release gem
-    needs: test
+    needs: [ test, metanorma ]
     runs-on: ubuntu-latest
     if: contains(github.ref, 'refs/tags/v')
     steps:

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /.yardoc
+/.vscode
 /_yardoc/
 /coverage/
 /doc/

data/.rubocop.yml

@@ -1,2 +1,15 @@
 inherit_from:
   - 'https://raw.githubusercontent.com/fontist/oss-guides/master/ci/rubocop.yml'
+
+
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  Exclude:
+    - 'pkg/**/*'
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 160

data/Gemfile

@@ -3,10 +3,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-gem "gem-release"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.2"
-gem "rubocop"
-gem "rubocop-performance"
-gem "rubocop-rails"

data/Rakefile

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/excavate.gemspec

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+
 require_relative "lib/excavate/version"
 
+# rubocop:disable Metrics/BlockLength
+
 Gem::Specification.new do |spec|
   spec.name          = "excavate"
   spec.version       = Excavate::VERSION
@@ -11,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Extract nested archives with a single command."
   spec.homepage      = "https://github.com/fontist/excavate"
   spec.license       = "BSD-3-Clause"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/fontist/excavate"
@@ -19,17 +23,27 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|bin)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features|bin)/})
+    end
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "arr-pm", "~> 0.0"
-  spec.add_runtime_dependency "ffi-libarchive-binary", "~> 0.0"
+  spec.add_runtime_dependency "bundler", "~> 2.3", ">= 2.3.24"
+  spec.add_runtime_dependency "ffi-libarchive-binary", "~> 0.3"
   spec.add_runtime_dependency "libmspack", "~> 0.1"
   spec.add_runtime_dependency "ruby-ole", "~> 1.0"
   spec.add_runtime_dependency "rubyzip", "~> 2.3"
   spec.add_runtime_dependency "seven-zip", "~> 1.4"
   spec.add_runtime_dependency "thor", "~> 1.0"
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.7"
+  spec.add_development_dependency "rubocop-performance", "~> 1.15"
+  spec.metadata["rubygems_mfa_required"] = "false"
 end
+
+# rubocop:enable Metrics/BlockLength

data/lib/excavate/archive.rb

@@ -17,14 +17,12 @@ module Excavate
       @archive = archive
     end
 
-    def files(recursive_packages: false, files: [], filter: nil)
+    def files(recursive_packages: false, files: [], filter: nil, &block)
       target = Dir.mktmpdir
       extract(target, recursive_packages: recursive_packages,
                       files: files, filter: filter)
 
-      all_files_in(target).map do |file|
-        yield file
-      end
+      all_files_in(target).map(&block)
     ensure
       FileUtils.rm_rf(target)
     end
@@ -186,6 +184,12 @@ module Excavate
       FileUtils.cp(archive, target)
     end
 
+    def may_be_nested_cab?(extension, message)
+      extension == "exe" &&
+        message.start_with?("Invalid file format",
+                            "Unrecognized archive format")
+    end
+
     def extract_once(archive, target)
       extension = normalized_extension(archive)
       extractor_class = TYPES[extension]
@@ -195,8 +199,7 @@ module Excavate
 
       extractor_class.new(archive).extract(target)
     rescue StandardError => e
-      raise unless extension == "exe" &&
-        e.message.start_with?("Invalid file format")
+      raise unless may_be_nested_cab?(extension, e.message)
 
       Extractors::CabExtractor.new(archive).extract(target)
     end

data/lib/excavate/extractors/cab_extractor.rb

@@ -19,7 +19,7 @@ module Excavate
 
       def open_cab(archive)
         decompressor = LibMsPack::CabDecompressor.new
-        cab = Utils.silence_stream(STDERR) do
+        cab = Utils.silence_stream($stderr) do
           decompressor.search(archive)
         end
 

data/lib/excavate/extractors/cpio_extractor.rb

@@ -14,30 +14,38 @@ module Excavate
 
       private
 
+      def extract_cpio_inner_new(entry, file, target)
+        path = File.join(target, entry.name)
+        if entry.directory?
+          FileUtils.mkdir_p(path)
+        else
+          FileUtils.mkdir_p(File.dirname(path))
+          File.write(path, file.read, mode: "wb")
+        end
+      end
+
       def extract_cpio_new_format(target)
         File.open(@archive, "rb") do |archive_file|
           CPIO::ASCIIReader.new(archive_file).each do |entry, file|
-            path = File.join(target, entry.name)
-            if entry.directory?
-              FileUtils.mkdir_p(path)
-            else
-              FileUtils.mkdir_p(File.dirname(path))
-              File.write(path, file.read, mode: "wb")
-            end
+            extract_cpio_inner_new(entry, file, target)
           end
         end
       end
 
+      def extract_cpio_inner_old(entry, target)
+        path = File.expand_path(entry.filename, target)
+        if entry.directory?
+          FileUtils.mkdir_p(path)
+        else
+          FileUtils.mkdir_p(File.dirname(path))
+          File.write(path, entry.data, mode: "wb")
+        end
+      end
+
       def extract_cpio_old_format(target)
         File.open(@archive, "rb") do |archive_file|
           CPIO::ArchiveReader.new(archive_file).each_entry do |entry|
-            path = File.expand_path(entry.filename, target)
-            if entry.directory?
-              FileUtils.mkdir_p(path)
-            else
-              FileUtils.mkdir_p(File.dirname(path))
-              File.write(path, entry.data, mode: "wb")
-            end
+            extract_cpio_inner_old(entry, target)
           end
         end
       end

data/lib/excavate/extractors/rpm_extractor.rb

@@ -1,9 +1,11 @@
 require "arr-pm"
 
+H_MAGIC = "\x8e\xad\xe8\x01\x00\x00\x00\x00".force_encoding("BINARY")
+
 # fix for Ruby 3.0
-unless RPM::File::Header::HEADER_MAGIC == "\x8e\xad\xe8\x01\x00\x00\x00\x00".force_encoding("BINARY")
+unless RPM::File::Header::HEADER_MAGIC == H_MAGIC
   RPM::File::Header.send(:remove_const, "HEADER_MAGIC")
-  RPM::File::Header.const_set("HEADER_MAGIC", "\x8e\xad\xe8\x01\x00\x00\x00\x00".force_encoding("BINARY"))
+  RPM::File::Header.const_set(:HEADER_MAGIC, H_MAGIC)
 end
 
 module Excavate
@@ -25,7 +27,7 @@ module Excavate
         archive_format = tags[:payloadformat]
         compression_format = tags[:payloadcompressor] == "gzip" ? "gz" : tags[:payloadcompressor]
         basename = File.basename(archive, ".*")
-        filename = basename + "." + archive_format + "." + compression_format
+        filename = "#{basename}.#{archive_format}.#{compression_format}"
         File.join(dir, filename)
       end
     end

data/lib/excavate/extractors/seven_zip_extractor.rb

@@ -4,8 +4,10 @@ module Excavate
   module Extractors
     class SevenZipExtractor < Extractor
       def extract(target)
-        File.open(@archive, "rb") do |file|
-          SevenZipRuby::Reader.extract_all(file, target)
+        Dir.chdir(target) do
+          File.open(@archive, "rb") do |file|
+            SevenZipRuby::Reader.extract_all(file, target)
+          end
         end
       end
     end

data/lib/excavate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Excavate
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excavate
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-16 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arr-pm
@@ -24,20 +24,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.24
 - !ruby/object:Gem::Dependency
   name: ffi-libarchive-binary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: libmspack
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +128,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
 description: Extract nested archives with a single command.
 email:
 - open.source@ribose.com
@@ -116,7 +178,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/metanorma.yml"
 - ".github/workflows/test-and-release.yml"
 - ".gitignore"
 - ".rspec"
@@ -153,6 +214,7 @@ metadata:
   homepage_uri: https://github.com/fontist/excavate
   source_code_uri: https://github.com/fontist/excavate
   changelog_uri: https://github.com/fontist/excavate
+  rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -161,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/metanorma.yml

@@ -1,76 +0,0 @@
-name: metanorma
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-
-concurrency:
-  group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
-  cancel-in-progress: true
-
-jobs:
-  prepare:
-    runs-on: ubuntu-latest
-    outputs:
-      head_tag: ${{ steps.check.outputs.head_tag }}
-      foreign_pr: ${{ steps.check.outputs.foreign_pr }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2.3.4
-
-      - name: Retrieve tags
-        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/* || true
-      - name: Set output variables
-        id: check
-        run: |
-          fpr="no"
-          tag=""
-          if [[ "${{ github.ref }}" == refs/heads/* ]]; then
-            tag="$(git tag --points-at HEAD)"
-          elif [[ "${{ github.ref }}" == refs/pull/* ]] && [ "${{ github.event.pull_request.head.repo.full_name }}" != "${{ github.event.pull_request.base.repo.full_name }}" ]; then
-            fpr="yes"
-          fi
-          echo "::set-output name=foreign_pr::${fpr}"
-          echo "::set-output name=head_tag::${tag}"
-
-  test:
-    name: Test with Metanorma on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    needs: prepare
-    runs-on: ${{ matrix.os }}
-    continue-on-error: false
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.7', '3.0', '3.1' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          repository: metanorma/metanorma
-
-      - uses: metanorma/metanorma-build-scripts/inkscape-setup-action@main
-
-      - uses: actions/checkout@v3
-        with:
-          path: "excavate"
-
-      - run: 'echo ''gem "excavate", path: "./excavate"'' > Gemfile.devel'
-
-      - if: matrix.ruby == '3.0'
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: false
-          rubygems: latest
-
-      - if: matrix.ruby == '3.0'
-        run: bundle
-
-      - if: matrix.ruby != '3.0'
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake