excavate 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9ea70e2de46706b2324d98253d9012d175a706fc010478a0ccb1b6af00fc02e
-  data.tar.gz: 51c3c8e44013e17201114f4315b4314d9f44dc645c41d3f8627f81353b0269b1
+  metadata.gz: fa5e513f27e2996c18e3b006569540ec1c06c8b178460e2241a891e42fddcfda
+  data.tar.gz: 3a0c7b6f1829f2a1d2ff4645d8b40d677a54b693351a883b53b2feb47d29b9b3
 SHA512:
-  metadata.gz: 4f1c1c62794e14c5272cb8c9881dd50a8be3992c446086c0a5f58cecf51100458f962ddaeec1d2d329a0d3e03cff328bb287a9183ab5315534ba203fb1758544
-  data.tar.gz: 79a3aac7b28480c4a1675b68877e21e192d311099f348aaebc84ae157d966e6bb56c2dffe53c25aeea331a08286aa7b34e8e92fd015cb8588514da8340092d85
+  metadata.gz: 7176e3bb221ef27aa16bb666f278d2081030c28778380fa40b5cdd44737fef9b5a76e9f7b7475dfaceaf33583b7caea80590f39e3a2a5f614f9a957baf082af8
+  data.tar.gz: '0359c8ea5ac50e2ad79c8c453b81a5dea7c2a11c1c1e9accf0844aa5f6ea110a3cfe692819c8c786c45a1191cce2d26259135832238fb268a31e913696cac951'

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

@@ -0,0 +1,92 @@
+name: test-and-release
+
+on:
+  push:
+    branches: [ main ]
+    tags: [ 'v*' ]
+  pull_request:
+
+concurrency:
+  group: '${{ github.workflow }}-${{ github.job }}-${{ github.head_ref || github.ref_name }}'
+  cancel-in-progress: true
+
+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 }}
+    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
+
+      - 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, metanorma ]
+    runs-on: ubuntu-latest
+    if: contains(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: cadwallion/publish-rubygems-action@master
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.FONTIST_CI_RUBYGEMS_API_KEY}}

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", "0.75.0"
-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

@@ -12,6 +12,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"
@@ -20,17 +21,25 @@ 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_ruby", "~> 1.0"
   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

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
@@ -155,11 +153,7 @@ module Excavate
     end
 
     def extract_recursively(archive, target)
-      if File.directory?(archive)
-        duplicate_dir(archive, target)
-      else
-        extract_once(archive, target)
-      end
+      extract_to_directory(archive, target)
 
       all_files_in(target).each do |file|
         next unless archive?(file)
@@ -168,6 +162,16 @@ module Excavate
       end
     end
 
+    def extract_to_directory(archive, target)
+      if File.directory?(archive)
+        duplicate_dir(archive, target)
+      elsif !archive?(archive)
+        copy_file(archive, target)
+      else
+        extract_once(archive, target)
+      end
+    end
+
     def duplicate_dir(source, target)
       Dir.chdir(source) do
         (Dir.entries(".") - [".", ".."]).each do |entry|
@@ -176,6 +180,10 @@ module Excavate
       end
     end
 
+    def copy_file(archive, target)
+      FileUtils.cp(archive, target)
+    end
+
     def extract_once(archive, target)
       extension = normalized_extension(archive)
       extractor_class = TYPES[extension]

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

@@ -1,13 +1,24 @@
-require "seven_zip_ruby"
+require "ffi-libarchive-binary"
 
 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
+          extract_with_libarchive
         end
       end
+
+      def extract_with_libarchive
+        flags = ::Archive::EXTRACT_PERM
+        reader = ::Archive::Reader.open_filename(@archive)
+
+        reader.each_entry do |entry|
+          reader.extract(entry, flags.to_i)
+        end
+
+        reader.close
+      end
     end
   end
 end

data/lib/excavate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excavate
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2022-10-26 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
@@ -81,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: seven_zip_ruby
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -95,19 +115,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        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,9 +164,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/metanorma.yml"
-- ".github/workflows/release.yml"
-- ".github/workflows/rspec.yml"
+- ".github/workflows/test-and-release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -154,6 +200,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:
@@ -162,14 +209,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Extract nested archives with a single command.

data/.github/workflows/metanorma.yml

@@ -1,35 +0,0 @@
-name: metanorma
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-
-jobs:
-  test:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ true ]
-    steps:
-      - uses: actions/checkout@master
-        with:
-          repository: metanorma/metanorma
-
-      - uses: actions/checkout@master
-        with:
-          path: "excavate"
-
-      - run: 'echo ''gem "excavate", path: "./excavate"'' > Gemfile.devel'
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake

data/.github/workflows/release.yml

@@ -1,36 +0,0 @@
-name: release
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-jobs:
-  release:
-    runs-on: ubuntu-18.04
-    steps:
-      - uses: actions/checkout@v1
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '2.6'
-
-      - run: bundle config set path 'vendor/bundle'
-
-      - run: bundle install --jobs 4 --retry 3
-
-      - run: bundle exec rspec
-
-      - name: Publish to rubygems.org
-        env:
-          RUBYGEMS_API_KEY: ${{secrets.FONTIST_CI_RUBYGEMS_API_KEY}}
-        run: |
-          gem install gem-release
-          touch ~/.gem/credentials
-          cat > ~/.gem/credentials << EOF
-          ---
-          :rubygems_api_key: ${RUBYGEMS_API_KEY}
-          EOF
-          chmod 0600 ~/.gem/credentials
-          git status
-          gem release

data/.github/workflows/rspec.yml

@@ -1,47 +0,0 @@
-name: rspec
-
-on:
-  push:
-    branches: [ master, main ]
-  pull_request:
-
-jobs:
-  build:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
-
-    steps:
-      - uses: actions/checkout@master
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-
-      - uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
-          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
-
-      - run: bundle config set path 'vendor/bundle'
-
-      - run: bundle install --jobs 4 --retry 3
-
-      - run: bundle exec rspec