mixlib-archive 0.4.18-universal-mingw32

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de9ff0590dffce184e62081562f227982518bc36f2d464f4acd5eed2fed7d430
+  data.tar.gz: d07765cb5842b125e3b04e7dbcb5797703245da166d4c5bcc2ade159e208e4fa
+SHA512:
+  metadata.gz: 8adc47ad95a1c94c109fe14167c9e10ee708c6fd5a0c52a9f53fb933bf47384cc99b4954f850026e53dee136763b2100cef31ce9059a99123fe773ab4e142587
+  data.tar.gz: 1f67f28595a46f016093754076af696c658e9ef363161a5353d119d6825be1c3dc6ec5ca1872d3775ca4ce70e7b9f4e645745498e05a45a256f1d5053b03ce4f

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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/README.md

@@ -0,0 +1,78 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mixlib-archive'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install mixlib-archive
+```
+
+## Usage
+
+To extract an archive
+
+```ruby
+require "mixlib/archive"
+tar = Mixlib::Archive.new("/path/to/tar")
+tar.extract("/destination/directory")
+```
+
+To create an archive
+
+```ruby
+require "mixlib/archive"
+tar = Mixlib::Archive.new("/path/to/foo.tar.gz")
+tar.create(%w{ file.rb file2.rb }, gzip: true)
+```
+
+## Development
+
+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
+
+For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md)
+
+## License & Copyright
+
+- 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/lib/mixlib/archive.rb

@@ -0,0 +1,67 @@
+require "mixlib/archive/tar"
+require "mixlib/archive/version"
+require "mixlib/log"
+require "find"
+
+module Mixlib
+  class Archive
+    class TarError < StandardError; end
+
+    attr_reader :archiver
+    alias_method :extractor, :archiver
+
+    def self.archive_directory(path, archive, gzip: false, format: :tar, compression: :none)
+      targets = Find.find(path).collect { |fn| fn }
+      new(archive).create(targets, gzip: gzip)
+    end
+
+    def initialize(archive, empty: false)
+      @empty = empty
+
+      archive = File.expand_path(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
+      extend Mixlib::Log
+    end
+
+    Log.level = :error
+
+    def create(files = [], gzip: false)
+      archiver.create(files, gzip: gzip)
+    end
+
+    def extract(destination, perms: true, ignore: [])
+      ignore = [/^\.$/, /\.{2}#{path_separator}/] + Array(ignore)
+
+      create_and_empty(destination)
+
+      archiver.extract(destination, perms: perms, ignore: ignore)
+    end
+
+    private
+
+    def path_separator
+      File::SEPARATOR
+    end
+
+    def create_and_empty(destination)
+      FileUtils.mkdir_p(destination)
+      if @empty
+        Dir.foreach(destination) do |entry|
+          next if entry == "." || entry == ".."
+          FileUtils.remove_entry_secure(File.join(destination, entry))
+        end
+      end
+    end
+
+  end
+end

data/lib/mixlib/archive/lib_archive.rb

@@ -0,0 +1,97 @@
+require "ffi-libarchive"
+
+module Mixlib
+  class Archive
+    class LibArchive
+      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
+      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
+        FileUtils.mkdir_p(destination)
+
+        # @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.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
+      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|
+              content = nil
+              entry.pathname = fn
+              stat = File.lstat(fn)
+              if File.file?(fn)
+                content = File.read(fn)
+                entry.size = content.bytesize
+              end
+              entry.mode = stat.mode
+              entry.filetype = resolve_type(stat.ftype)
+              entry.atime = stat.atime
+              entry.mtime = stat.mtime
+              entry.symlink = File.readlink(fn) if File.symlink?(fn)
+              tar.write_header(entry)
+
+              tar.write_data(content) unless content.nil?
+            end
+          end
+        end
+      end
+
+      def resolve_type(type)
+        case type
+        when "characterSpecial"
+          ::Archive::Entry::CHARACTER_SPECIAL
+        when "blockSpecial"
+          ::Archive::Entry::BLOCK_SPECIAL
+        when "link"
+          ::Archive::Entry::SYMBOLIC_LINK
+        else
+          ::Archive::Entry.const_get(type.upcase)
+        end
+      end
+    end
+  end
+end

data/lib/mixlib/archive/tar.rb

@@ -0,0 +1,159 @@
+require "rubygems/package"
+require "tempfile"
+require "zlib"
+
+module Mixlib
+  class Archive
+    class Tar
+      TAR_LONGLINK = "././@LongLink".freeze
+
+      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: [])
+        # (http://stackoverflow.com/a/31310593/506908)
+        ignore_re = Regexp.union(ignore)
+        reader do |tar|
+          dest = nil
+          tar.each do |entry|
+            if entry.full_name == TAR_LONGLINK
+              dest = File.join(destination, entry.read.strip)
+              next
+            end
+            if entry.full_name =~ ignore_re
+              Mixlib::Archive::Log.warn "ignoring entry #{entry.full_name}"
+              next
+            end
+            dest ||= File.expand_path(File.join(destination, entry.full_name))
+            parent = File.dirname(dest)
+            FileUtils.mkdir_p(parent)
+
+            if entry.directory? || (entry.header.typeflag == "" && entry.full_name.end_with?("/"))
+              File.delete(dest) if File.file?(dest)
+
+              if perms
+                FileUtils.mkdir_p(dest, mode: entry.header.mode, verbose: false)
+              else
+                FileUtils.mkdir_p(dest, verbose: false)
+              end
+
+            elsif entry.file? || (entry.header.typeflag == "" && !entry.full_name.end_with?("/"))
+              FileUtils.rm_rf(dest) if File.directory?(dest)
+              File.open(dest, "wb") do |f|
+                f.print(entry.read)
+              end
+              FileUtils.chmod(entry.header.mode, dest, verbose: false) if perms
+            elsif entry.header.typeflag == "2"
+              # handle symlink
+              File.symlink(entry.header.linkname, dest)
+            else
+              Mixlib::Archive::Log.warn "unknown tar entry: #{entry.full_name} type: #{entry.header.typeflag}"
+            end
+
+            dest = nil
+          end
+        end
+      end
+
+      # Creates an archive with the given set of +files+
+      #
+      # === Parameters
+      # gzip<Boolean>:: should the archive be gzipped?
+      def create(files, gzip: false)
+        tgt_dir = File.dirname(archive)
+        target = Tempfile.new(File.basename(archive), tgt_dir)
+
+        Gem::Package::TarWriter.new(target) do |tar|
+          files.each do |fn|
+            mode = File.stat(fn).mode
+            if File.symlink?(fn)
+              target = File.readlink(fn)
+              tar.add_symlink(fn, target, mode)
+            elsif File.directory?(fn)
+              tar.mkdir(fn, mode)
+            elsif File.file?(fn)
+              file = File.open(fn, "rb")
+              tar.add_file(fn, mode) do |io|
+                io.write(file.read)
+              end
+              file.close
+            end
+          end
+        end
+
+        target.close
+        if gzip
+          Zlib::GzipWriter.open(archive, Zlib::BEST_COMPRESSION) do |gz|
+            gz.mtime = File.mtime(target.path)
+            gz.orig_name = File.basename(archive)
+            File.open(target.path) do |file|
+              while (chunk = file.read(16 * 1024))
+                gz.write(chunk)
+              end
+            end
+          end
+        else
+          FileUtils.mv(target.path, archive)
+        end
+      ensure
+        target.close unless target.closed?
+      end
+
+      private
+
+      def is_gzip_file?(path)
+        # You cannot write "\x1F\x8B" because the default encoding of
+        # ruby >= 1.9.3 is UTF-8 and 8B is an invalid in UTF-8.
+        IO.binread(path, 2) == [0x1F, 0x8B].pack("C*")
+      end
+
+      # tar's magic is at byte 257 and is "ustar\0"
+      # OLDGNU_MAGIC "ustar  \0"  /* 7 chars and a null */
+      def is_tar_archive?(io)
+        !(read_tar_magic(io) =~ /ustar\s{0,2}\x00/).nil?
+      end
+
+      def read_tar_magic(io)
+        io.rewind
+        magic = Array(io.read(512).bytes[257..264]).pack("C*")
+        io.rewind
+        magic
+      end
+
+      def reader(&block)
+        raw = File.open(archive, "rb")
+
+        file = if is_gzip_file?(archive)
+                 Mixlib::Archive::Log.debug "gzip file detected"
+                 Zlib::GzipReader.wrap(raw)
+               else
+                 raw
+               end
+
+        raise Mixlib::Archive::TarError, "Unrecognized archive format" unless is_tar_archive?(file)
+
+        Gem::Package::TarReader.new(file, &block)
+      ensure
+        if file
+          file.close unless file.closed?
+          file = nil # rubocop:disable Lint/UselessAssignment
+        end
+        if raw
+          raw.close unless raw.closed?
+          raw = nil # rubocop:disable Lint/UselessAssignment
+        end
+      end
+
+    end
+  end
+end

data/lib/mixlib/archive/version.rb

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

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: mixlib-archive
+version: !ruby/object:Gem::Version
+  version: 0.4.18
+platform: universal-mingw32
+authors:
+- Chef Software, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-log
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple interface to various archive formats
+email:
+- info@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- distro/ruby_bin_folder/libarchive.dll
+- distro/ruby_bin_folder/liblzma-5.dll
+- distro/ruby_bin_folder/libxml2-2.dll
+- lib/mixlib/archive.rb
+- lib/mixlib/archive/lib_archive.rb
+- lib/mixlib/archive/tar.rb
+- lib/mixlib/archive/version.rb
+homepage: https://github.com/chef/mixlib-archive
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A simple interface to various archive formats
+test_files: []