mixlib-archive 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06e38a8e985c4488c001cdc1f2bb9a802eea85d8
-  data.tar.gz: ab35dfd768fab3de993a7bf9ac6f7417a6da5edd
+SHA256:
+  metadata.gz: e333d2af05598e7404ffdd49f2333d5edf345e7483aa7d03270da16e10001e52
+  data.tar.gz: 26d5a8f15aef2788da1ce44636282e736172d6bd579b532e2c9efcb39c52e098
 SHA512:
-  metadata.gz: 76067595e643e6d4699fa856ee0c716618ef7707c4e5c4e0a5cd8bd5f5c8cee8448b22a92d800efb452baad0d7ac3a922bc4b38c2c7f17b089fa397de36fa479
-  data.tar.gz: 7cc24941518f91fcd10d8433df67c74938c9a988050dedf23bfd08b50fefbf6256b6c79ed46e85857d1015e275d3a359f68ff1c7063b5e25a8320de694ac4fad
+  metadata.gz: d08e1d6b5e38ccf53381f412ca1d1ffb400c6262f74fc972b5f798f52abc2136f7317f2ee99b9cdb4de6ee3eb7f5358b417897d194fe315ae7fcbcba76249ee8
+  data.tar.gz: 878e846762cae3ca0d21dcb9dc0975ad35c40705fa3cd29accf0d91b9b3eb15a65832be0ee95e0a6ec1379b9db1b6b56c5ed066db4e98cef94b9e15c6819c750

data/.expeditor/config.yml

@@ -0,0 +1,35 @@
+---
+slack:
+  notify_channel: chef-notify
+
+github:
+  version_tag_format: "v{{version}}"
+  minor_bump_labels:
+    - "Version: Bump Minor"
+
+changelog:
+  rollup_header: Changes not yet released to rubygems.org
+
+rubygems:
+  - mixlib-archive
+
+merge_actions:
+  - built_in:bump_version:
+      ignore_labels:
+        - "Version: Skip Bump"
+        - "Expeditor: Skip All"
+  - bash:.expeditor/update_version.sh:
+      only_if:
+        - built_in:bump_version
+  - built_in:update_changelog:
+      ignore_labels:
+        - "Changelog: Skip Update"
+        - "Expeditor: Skip All"
+  - built_in:build_gem:
+      only_if:
+        - built_in:bump_version
+
+promote:
+  action:
+    - built_in:publish_rubygems
+    - built_in:rollover_changelog

data/.expeditor/update_version.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+#
+# After a PR merge, Chef Expeditor will bump the PATCH version in the VERSION file.
+# It then executes this file to update any other files/components with that new version.
+#
+
+set -evx
+
+sed -i -r "s/^(\s*)VERSION = \".+\"/\1VERSION = \"$(cat VERSION)\"/" lib/mixlib/archive/version.rb
+
+# Once Expeditor finshes executing this script, it will commit the changes and push
+# the commit as a new tag corresponding to the value in the VERSION file.

data/.travis.yml

@@ -1,12 +1,30 @@
+sudo: false
+language: ruby
+cache: bundler
+
+addons:
+  apt:
+    packages:
+      - libarchive-dev
+
+matrix:
+  include:
+    - rvm: 2.4.4
+    - rvm: 2.5.1
+    - rvm: ruby-head
+  allow_failures:
+    - rvm: ruby-head
 branches:
   only:
-    master
+  - master
 
-language: ruby
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3.1
-before_install: gem install bundler -v 1.11.2
-script: bundle exec rake ci
 bundler_args: --without changelog
+
+before_install:
+  - gem install bundler
+  - bundle --version
+  - gem update --system
+  - gem --version
+
+script:
+  - bundle exec rake ci

data/CHANGELOG.md

@@ -1,10 +1,24 @@
+<!-- usage documentation: http://expeditor-docs.es.chef.io/configuration/changelog/ -->
 # Change Log
 
+<!-- latest_release -->
+<!-- latest_release -->
+
+<!-- release_rollup -->
+<!-- release_rollup -->
+
+<!-- latest_stable_release -->
+## [v0.4.2](https://github.com/chef/mixlib-archive/tree/v0.4.2) (2018-04-25)
+
+#### Merged Pull Requests
+- use libarchive by preference [#17](https://github.com/chef/mixlib-archive/pull/17) ([thommay](https://github.com/thommay))
+<!-- latest_stable_release -->
+
 ## [v0.4.1](https://github.com/chef/mixlib-archive/tree/v0.4.1) (2017-02-02)
 
 [Full Changelog](https://github.com/chef/mixlib-archive/compare/v0.4.0...v0.4.1)
 
-**Merged pull requests:**
+###Merged pull requests:
 
 - Accept a single pattern to ignore [\#8](https://github.com/chef/mixlib-archive/pull/8) ([thommay](https://github.com/thommay))
 
@@ -40,4 +54,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -3,6 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in mixlib-archive.gemspec
 gemspec
 
-group(:changelog) do
-  gem "github_changelog_generator", git: "https://github.com/chef/github-changelog-generator"
-end
+gem "ffi-libarchive"

data/README.md

@@ -1,5 +1,6 @@
 # Mixlib::Archive
-[![Build Status Master](https://travis-ci.org/chef/mixlib-archive.svg?branch=master)](https://travis-ci.org/chef/mixlib-archive)
+
+[![Build Status Master](https://travis-ci.org/chef/mixlib-archive.svg?branch=master)](https://travis-ci.org/chef/mixlib-archive) [![Gem Version](https://badge.fury.io/rb/mixlib-archive.svg)](https://badge.fury.io/rb/mixlib-archive)
 
 A very simple gem to extract archives.
 
@@ -13,25 +14,31 @@ gem 'mixlib-archive'
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install mixlib-archive
+```shell
+$ gem install mixlib-archive
+```
 
 ## Usage
 
 To extract an archive
 
 ```ruby
-tar = Mixlib::Artifact.new("/path/to/tar")
+require "mixlib/archive"
+tar = Mixlib::Archive.new("/path/to/tar")
 tar.extract("/destination/directory")
 ```
 
 To create an archive
 
 ```ruby
-tar = Mixlib::Artifact.new("/path/to/foo.tar.gz")
+require "mixlib/archive"
+tar = Mixlib::Archive.new("/path/to/foo.tar.gz")
 tar.create(%w{ file.rb file2.rb }, gzip: true)
 ```
 
@@ -41,10 +48,8 @@ After checking out the repo, run `bundle` to install dependencies. Then, run `bu
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/chef/mixlib-archive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Community Guidelines](https://docs.chef.io/community_guidelines.html) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at <https://github.com/chef/mixlib-archive>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Community Guidelines](https://docs.chef.io/community_guidelines.html) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the Apache License, v2
-

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "mixlib/archive/version"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -17,3 +18,14 @@ begin
 rescue LoadError
   puts "chefstyle/rubocop is not available.  gem install chefstyle to do style checking."
 end
+
+begin
+  require "github_changelog_generator/task"
+
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.issues = false
+    config.future_release = Mixlib::Archive::VERSION
+  end
+rescue LoadError
+  puts "github_changelog_generator is not available. gem install github_changelog_generator to generate changelogs"
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.3

data/lib/mixlib/archive.rb

@@ -11,8 +11,14 @@ module Mixlib
       @empty = empty
 
       archive = File.expand_path(archive)
-      # for now we only support Tar format archives.
-      @archiver = Mixlib::Archive::Tar.new(archive)
+      begin
+        # we prefer to use libarchive, which supports a great big pile o' stuff
+        require "mixlib/archive/lib_archive"
+        @archiver = Mixlib::Archive::LibArchive.new(archive)
+      rescue LoadError
+        # but if we can't use that, we'll fall back to ruby's native tar implementation
+        @archiver = Mixlib::Archive::Tar.new(archive)
+      end
     end
 
     class Log

data/lib/mixlib/archive/lib_archive.rb

@@ -0,0 +1,63 @@
+require "ffi-libarchive"
+
+module Mixlib
+  class Archive
+    class LibArchive
+      attr_reader :options
+      attr_reader :archive
+
+      def initialize(archive, options = {})
+        @archive = archive
+        @options = options
+      end
+
+      # Extracts the archive to the given +destination+
+      #
+      # === Parameters
+      # perms<Boolean>:: should the extracter use permissions from the archive.
+      # ignore[Array]:: an array of matches of file paths to ignore
+      def extract(destination, perms: true, ignore: [])
+        ignore_re = Regexp.union(ignore)
+        flags = perms ? ::Archive::EXTRACT_PERM : nil
+        Dir.chdir(destination) do
+          reader = ::Archive::Reader.open_filename(@archive)
+
+          reader.each_entry do |entry|
+            if entry.pathname =~ ignore_re
+              Mixlib::Archive::Log.warn "ignoring entry #{entry.pathname}"
+              next
+            end
+
+            reader.extract(entry, flags.to_i)
+          end
+          reader.close
+        end
+      end
+
+      # Creates an archive with the given set of +files+
+      #
+      # === Parameters
+      # gzip<Boolean>:: should the archive be gzipped?
+      def create(files, gzip: false)
+        compression = gzip ? ::Archive::COMPRESSION_GZIP : ::Archive::COMPRESSION_NONE
+        # "PAX restricted" will use PAX extensions when it has to, but will otherwise
+        # use ustar for maximum compatibility
+        format = ::Archive::FORMAT_TAR_PAX_RESTRICTED
+
+        ::Archive.write_open_filename(archive, compression, format) do |tar|
+          files.each do |fn|
+            tar.new_entry do |entry|
+              entry.pathname = fn
+              entry.copy_stat(fn)
+              tar.write_header(entry)
+              if File.file?(fn)
+                content = File.read(fn)
+                tar.write_data(content)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mixlib/archive/tar.rb

@@ -119,11 +119,11 @@ module Mixlib
       ensure
         if file
           file.close unless file.closed?
-          file = nil
+          file = nil # rubocop:disable Lint/UselessAssignment
         end
         if raw
           raw.close unless raw.closed?
-          raw = nil
+          raw = nil # rubocop:disable Lint/UselessAssignment
         end
       end
 

data/lib/mixlib/archive/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class Archive
-    VERSION = "0.4.1"
+    VERSION = "0.4.2"
   end
 end

data/mixlib-archive.gemspec

@@ -17,8 +17,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "rake", "~> 12"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "chefstyle"
   spec.add_dependency "mixlib-log"

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-archive
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".expeditor/config.yml"
+- ".expeditor/update_version.sh"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -95,7 +83,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- VERSION
 - lib/mixlib/archive.rb
+- lib/mixlib/archive/lib_archive.rb
 - lib/mixlib/archive/tar.rb
 - lib/mixlib/archive/version.rb
 - mixlib-archive.gemspec
@@ -119,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A simple interface to various archive formats