mixlib-archive 0.4.8 → 0.4.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89f65f9ebf0b9670aa04782cab4ee5887c64ec8e609f96b5cb0979b328ee0a1a
-  data.tar.gz: dd8460110ee8f6e20cfece1848f4420ebf4575c947b0133704ce8da0fd65ad9c
+  metadata.gz: 7e890314d0486efb10e07cdd98e93e988cd0c834f5d7bf9edfb04ac6b5515b68
+  data.tar.gz: ede93fcd80ad8727bee334de0e4f88a51780ec6d17d174de8fd587da118771de
 SHA512:
-  metadata.gz: 128ed8853d6d686101c8a120ce7cd7e862f89877ba7bc5a8965ce60d690ee02139a8d4a0a964278331fdfc4ad5f00c3761f3b4cbbda09d6584ee581c107e04e4
-  data.tar.gz: 7d394e01de3f3638c728e3e14bfd0b24bde6aea0488d3065f9cdd2b70e59173173cf652f41f60bce6b75adc1652851f7c1a83e6592494616717e061332bef459
+  metadata.gz: 0b1b9352ddcbbc2c63e81eb2df36ebba3badb2fa7744229983c2a04f4af8cadd94642a816de90f115520623f45e912d532889eb79fb37274133831b67ed29dd4
+  data.tar.gz: a03196e419a33aa8c72aad11e0a44f68d102d7f77c72385a2b2a9d1dc9cdaa9905f644e13a6085f60325a7b329c5ed012a0fd6fb33528ea636ca0cae5fb87b36

data/.expeditor/config.yml

@@ -1,35 +1,41 @@
+# Documentation available at https://expeditor.chef.io/docs/getting-started/
 ---
+# Slack channel in Chef Software slack to send notifications about build failures, etc
 slack:
   notify_channel: chef-notify
 
+# This publish is triggered by the `built_in:publish_rubygems` artifact_action.
+rubygems:
+  - mixlib-archive
+
 github:
+  # This deletes the GitHub PR branch after successfully merged into the release branch
+  delete_branch_on_merge: true
+  # The tag format to use (e.g. v1.0.0)
   version_tag_format: "v{{version}}"
+  # allow bumping the minor release via label
   minor_bump_labels:
-    - "Version: Bump Minor"
+    - "Expeditor: Bump Minor Version"
 
 changelog:
   rollup_header: Changes not yet released to rubygems.org
 
-rubygems:
-  - mixlib-archive
-
+# These actions are taken, in order they are specified, anytime a Pull Request is merged.
 merge_actions:
   - built_in:bump_version:
       ignore_labels:
-        - "Version: Skip Bump"
+        - "Expeditor: Skip Version Bump"
         - "Expeditor: Skip All"
   - bash:.expeditor/update_version.sh:
-      only_if:
-        - built_in:bump_version
+      only_if: built_in:bump_version
   - built_in:update_changelog:
       ignore_labels:
-        - "Changelog: Skip Update"
+        - "Expeditor: Exclude From Changelog"
         - "Expeditor: Skip All"
   - built_in:build_gem:
-      only_if:
-        - built_in:bump_version
+      only_if: built_in:bump_version
 
 promote:
-  action:
-    - built_in:publish_rubygems
+  actions:
     - built_in:rollover_changelog
+    - built_in:publish_rubygems

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# Order is important. The last matching pattern has the most precedence.
+
+*               @chef/client-maintainers
+.expeditor/**   @chef/jex-team

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,21 @@
+# Version:
+
+[Version of the project installed]
+
+# Environment: [Details about the environment such as the Operating System, cookbook details, etc...]
+
+# Scenario:
+
+[What you are trying to achieve and you can't?]
+
+# Steps to Reproduce:
+
+[If you are filing an issue what are the things we need to do in order to repro your problem?]
+
+# Expected Result:
+
+[What are you expecting to happen as the consequence of above reproduction steps?]
+
+# Actual Result:
+
+[What actually happens after the reproduction steps?]

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Description
+
+[Please describe what this change achieves]
+
+### Issues Resolved
+
+[List any existing issues this PR resolves, or any Discourse or
+StackOverflow discussion that's relevant]
+
+### Check List
+
+- [ ] New functionality includes tests
+- [ ] All tests pass
+- [ ] All commits have been signed-off for the Developer Certificate of Origin. See <https://github.com/chef/chef/blob/master/CONTRIBUTING.md#developer-certification-of-origin-dco>

data/.gitignore

@@ -1,9 +1,27 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+_yardoc
+.bundle
+.config
+.DS_Store
+.idea
+.rake_tasks~
+.rspec
+.ruby-version
+.rvmrc
+.yardoc
+.yardopts
+*.gem
+*.rbc
+*.sw?
+bin/
+coverage
+doc
+Gemfile.local
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/.travis.yml

@@ -9,16 +9,18 @@ addons:
 
 matrix:
   include:
+    - rvm: 2.3.7
     - rvm: 2.4.4
     - rvm: 2.5.1
     - rvm: ruby-head
   allow_failures:
     - rvm: ruby-head
+
 branches:
   only:
   - master
 
-bundler_args: --without changelog
+bundler_args: --without docs development
 
 before_install:
   - gem install bundler
@@ -26,5 +28,4 @@ before_install:
   - gem update --system
   - gem --version
 
-script:
-  - bundle exec rake ci
+script: bundle exec rake

data/CHANGELOG.md

@@ -1,26 +1,35 @@
 <!-- usage documentation: http://expeditor-docs.es.chef.io/configuration/changelog/ -->
 # Change Log
 
-<!-- latest_release 0.4.8 -->
-## [v0.4.8](https://github.com/chef/mixlib-archive/tree/v0.4.8) (2018-06-21)
+<!-- latest_release 0.4.13 -->
+## [v0.4.13](https://github.com/chef/mixlib-archive/tree/v0.4.13) (2018-08-03)
 
 #### Merged Pull Requests
-- Use the correct entry size for content with multi-byte characters. [#23](https://github.com/chef/mixlib-archive/pull/23) ([coderanger](https://github.com/coderanger))
+- bugfix to make dir.chdir threadsafe [#29](https://github.com/chef/mixlib-archive/pull/29) ([stevenoneill](https://github.com/stevenoneill))
 <!-- latest_release -->
 
-<!-- release_rollup since=0.4.7 -->
+<!-- release_rollup since=0.4.8 -->
 ### Changes not yet released to rubygems.org
 
 #### Merged Pull Requests
-- Use the correct entry size for content with multi-byte characters. [#23](https://github.com/chef/mixlib-archive/pull/23) ([coderanger](https://github.com/coderanger)) <!-- 0.4.8 -->
+- bugfix to make dir.chdir threadsafe [#29](https://github.com/chef/mixlib-archive/pull/29) ([stevenoneill](https://github.com/stevenoneill)) <!-- 0.4.13 -->
+- Update codeowners and add PR template [#27](https://github.com/chef/mixlib-archive/pull/27) ([tas50](https://github.com/tas50)) <!-- 0.4.12 -->
+- Add github issue template &amp; standardize expeditor config [#26](https://github.com/chef/mixlib-archive/pull/26) ([tas50](https://github.com/tas50)) <!-- 0.4.11 -->
+- Move deps to the Gemfile and expand Rake tasks [#25](https://github.com/chef/mixlib-archive/pull/25) ([tas50](https://github.com/tas50)) <!-- 0.4.10 -->
+- add codeowners [#24](https://github.com/chef/mixlib-archive/pull/24) ([thommay](https://github.com/thommay)) <!-- 0.4.9 -->
 <!-- release_rollup -->
 
 <!-- latest_stable_release -->
+## [v0.4.8](https://github.com/chef/mixlib-archive/tree/v0.4.8) (2018-06-21)
+
+#### Merged Pull Requests
+- Use the correct entry size for content with multi-byte characters. [#23](https://github.com/chef/mixlib-archive/pull/23) ([coderanger](https://github.com/coderanger))
+<!-- latest_stable_release -->
+
 ## [v0.4.7](https://github.com/chef/mixlib-archive/tree/v0.4.7) (2018-06-07)
 
 #### Merged Pull Requests
 - fixup strange edge case around tar magic reading [#22](https://github.com/chef/mixlib-archive/pull/22) ([spion06](https://github.com/spion06))
-<!-- latest_stable_release -->
 
 ## [v0.4.6](https://github.com/chef/mixlib-archive/tree/v0.4.6) (2018-05-08)
 

data/Gemfile

@@ -1,6 +1,30 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in mixlib-archive.gemspec
 gemspec
 
 gem "ffi-libarchive"
+
+group :docs do
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
+end
+
+group :test do
+  gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master"
+  gem "rspec", "~> 3.0"
+  gem "rake"
+end
+
+group :development do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+  gem "rb-readline"
+end
+
+instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
+
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/README.md

@@ -46,10 +46,33 @@ tar.create(%w{ file.rb file2.rb }, gzip: true)
 
 After checking out the repo, run `bundle` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bundle console` for an interactive prompt that will allow you to experiment.
 
+## Documentation
+
+All documentation is written using YARD. You can generate a by running:
+
+```
+rake docs
+```
+
 ## 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.
+For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md)
 
-## License
+## License & Copyright
 
-The gem is available as open source under the terms of the Apache License, v2
+- Copyright:: Copyright (c) 2017-2018 Chef Software, Inc.
+- License:: Apache License, Version 2.0
+
+```text
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

data/Rakefile

@@ -1,13 +1,14 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require "mixlib/archive/version"
 
-RSpec::Core::RakeTask.new(:spec)
+task default: [:style, :spec]
 
-task :default => :spec
+Bundler::GemHelper.install_tasks
 
-desc "Run tests for Travis CI"
-task ci: [:style, :spec]
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
 
 begin
   require "chefstyle"
@@ -16,16 +17,20 @@ begin
     task.options += ["--display-cop-names", "--no-color"]
   end
 rescue LoadError
-  puts "chefstyle/rubocop is not available.  gem install chefstyle to do style checking."
+  puts "chefstyle/rubocop is not available. bundle install first to make sure all dependencies are installed."
 end
 
 begin
-  require "github_changelog_generator/task"
-
-  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-    config.issues = false
-    config.future_release = Mixlib::Archive::VERSION
-  end
+  require "yard"
+  YARD::Rake::YardocTask.new(:docs)
 rescue LoadError
-  puts "github_changelog_generator is not available. gem install github_changelog_generator to generate changelogs"
+  puts "yard is not available. bundle install first to make sure all dependencies are installed."
+end
+
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "mixlib/archive"
+  ARGV.clear
+  IRB.start
 end

data/VERSION

@@ -1 +1 @@
-0.4.8
+0.4.13

data/lib/mixlib/archive/lib_archive.rb

@@ -6,6 +6,12 @@ module Mixlib
       attr_reader :options
       attr_reader :archive
 
+      class << self
+        attr_accessor :mutex_chdir
+      end
+
+      Mixlib::Archive::LibArchive.mutex_chdir = Mutex.new
+
       def initialize(archive, options = {})
         @archive = archive
         @options = options
@@ -20,18 +26,24 @@ module Mixlib
         ignore_re = Regexp.union(ignore)
         flags = perms ? ::Archive::EXTRACT_PERM : nil
         FileUtils.mkdir_p(destination)
-        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
+        # @note Dir.chdir is applied to the process, thus it is not thread-safe
+        # and must be synchronized.
+        # TODO: figure out a better alternative to chdir
+        Mixlib::Archive::LibArchive.mutex_chdir.synchronize do
+          Dir.chdir(destination) do
+            reader = ::Archive::Reader.open_filename(@archive)
 
-            reader.extract(entry, flags.to_i)
+            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
-          reader.close
         end
       end
 

data/lib/mixlib/archive/tar.rb

@@ -5,7 +5,7 @@ require "zlib"
 module Mixlib
   class Archive
     class Tar
-      TAR_LONGLINK = "././@LongLink"
+      TAR_LONGLINK = "././@LongLink".freeze
 
       attr_reader :options
       attr_reader :archive

data/lib/mixlib/archive/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class Archive
-    VERSION = "0.4.8"
+    VERSION = "0.4.13".freeze
   end
 end

data/mixlib-archive.gemspec

@@ -12,13 +12,10 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{A simple interface to various archive formats}
   spec.description   = spec.summary
   spec.homepage      = "https://chef.io"
-  spec.license       = "APACHE-2.0"
+  spec.license       = "Apache-2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", "~> 12"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "chefstyle"
   spec.add_dependency "mixlib-log"
 end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-archive
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.13
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12'
-- !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: chefstyle
-  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: mixlib-log
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +33,9 @@ extra_rdoc_files: []
 files:
 - ".expeditor/config.yml"
 - ".expeditor/update_version.sh"
+- ".github/CODEOWNERS"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -91,7 +52,7 @@ files:
 - mixlib-archive.gemspec
 homepage: https://chef.io
 licenses:
-- APACHE-2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []