minitar-cli 0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7e1a33ed236a1c4df613b9176391edfa14b61eb
+  data.tar.gz: 1e961009d5987fe7bbfcb53a1d7fd681ee382a98
+SHA512:
+  metadata.gz: b3748531f8787423e3d116d1b15a86d3e50781b7645c3b7c22fbf13eea27320608b52d2b6f44d3ff1ca59be380422e4e7198e6608ba1e5d4401e03dc4a0ef9bf
+  data.tar.gz: 24917476a4030a12b6af70d498b9ea2fcb70f9624a75504ce5902ea45833bb315c5653e1b296e78358ce691f438c448903b87db5731cfa846bc415a212d1c0aa

data/Contributing.md

@@ -0,0 +1,71 @@
+## Contributing
+
+I value any contribution to minitar-cli you can provide: a bug report, a
+feature request, or code contributions. There are a few guidelines for
+contributing to minitar:
+
+*   Code changes *will not* be accepted without tests. The test suite is
+    written with [Minitest][].
+*   Match my coding style.
+*   Use a thoughtfully-named topic branch that contains your change. Rebase
+    your commits into logical chunks as necessary.
+*   Use [quality commit messages][].
+*   Do not change the version number; when your patch is accepted and a release
+    is made, the version will be updated at that point.
+*   Submit a GitHub pull request with your changes.
+*   New or changed behaviours require appropriate documentation.
+
+### Test Dependencies
+
+minitar-cli uses Ryan Davis’s [Hoe][] to manage the release process, and it
+adds a number of rake tasks. You will mostly be interested in:
+
+    $ rake
+
+which runs the tests the same way that:
+
+    $ rake test
+    $ rake travis
+
+will do.
+
+To assist with the installation of the development dependencies for
+minitar-cli, I have provided the simplest possible Gemfile pointing to the
+(generated) `minitar-cli.gemspec` file. This will permit you to do:
+
+    $ bundle install
+
+to get the development dependencies. If you aleady have `hoe` installed, you
+can accomplish the same thing with:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs, and
+generate the RDoc.
+
+You can run tests with code coverage analysis by running:
+
+    $ rake test:coverage
+
+### Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+*   Fork the project.
+*   Clone down your fork (`git clone git://github.com/<username>/minitar-cli.git`).
+*   Create a topic branch to contain your change (`git checkout -b
+    my_awesome_feature`).
+*   Hack away, add tests. Not necessarily in that order.
+*   Make sure everything still passes by running `rake`.
+*   If necessary, rebase your commits into logical chunks, without errors.
+*   Push the branch up (`git push origin my_awesome_feature`).
+*   Create a pull request against halostatue/minitar-cli and describe what your
+    change does and the why you think it should be merged.
+
+### Contributors
+
+* Austin Ziegler created minitar-cli, extracted from Archive::Tar::Minitar.
+
+[Minitest]: https://github.com/seattlerb/minitest
+[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[Hoe]: https://github.com/seattlerb/hoe

data/History.md

@@ -0,0 +1,25 @@
+## 0.6 / 2017-02-07
+
+*   Hello, minitar-cli. This is a new gem containing code originally from
+    archive-tar-minitar.
+
+*   Enhancements:
+
+    *   Extracted `bin/minitar` from [minitar][].
+    *   Replaced Satoru Takabayashi’s [Ruby Progress Bar][] with
+        [busyloop/powerbar][].
+    *   Added filename filtering to `minitar list`.
+
+*   Bugs:
+
+    *   Fixed a problem where `bin/minitar create` would not include dotfiles
+        on Unix systems.
+
+*   Development:
+
+    *   Modernized minitar tooling around Hoe.
+    *   Added travis and coveralls.
+
+[minitar]: https://github.com/halostatue/minitar
+[Ruby Progress Bar]: https://namazu.org/~satoru/ruby-progressbar/
+[busyloop/powerbar]: https://github.com/busyloop/powerbar

data/Licence.md

@@ -0,0 +1,15 @@
+## Licence
+
+minitar-cli is free software that may be redistributed and/or modified under
+the terms of Ruby’s licence or the Simplified BSD licence.
+
+* Copyright 2004–2017 Austin Ziegler.
+* Portions copyright 2004 Mauricio Julio Fernández Pradier.
+
+### Simplified BSD Licence
+
+See the file docs/bsdl.txt in the main distribution.
+
+### Ruby’s Licence
+
+See the file docs/ruby.txt in the main distribution.

data/Manifest.txt

@@ -0,0 +1,22 @@
+Contributing.md
+History.md
+Licence.md
+Manifest.txt
+README.rdoc
+Rakefile
+bin/minitar
+docs/bsdl.txt
+docs/ruby.txt
+lib/minitar/cli.rb
+lib/minitar/cli/command.rb
+lib/minitar/cli/command/create.rb
+lib/minitar/cli/command/extract.rb
+lib/minitar/cli/command/help.rb
+lib/minitar/cli/command/list.rb
+lib/minitar/cli/commander.rb
+test/fixtures/bad-dir.tar.gz
+test/fixtures/spaces.tar.gz
+test/minitest_helper.rb
+test/support/minitar_cli_test_helper.rb
+test/test_cli_help.rb
+test/test_cli_list.rb

data/README.rdoc

@@ -0,0 +1,105 @@
+= minitar-cli
+
+home :: https://github.com/halostatue/minitar-cli/
+code :: https://github.com/halostatue/minitar-cli/
+bugs :: https://github.com/halostatue/minitar-cli/issues
+rdoc :: http://rdoc.info/gems/minitar-cli/
+continuous integration :: {<img src="https://travis-ci.org/halostatue/minitar-cli.svg" />}[https://travis-ci.org/halostatue/minitar-cli]
+                          {<img src="https://ci.appveyor.com/api/projects/status/bj4gqn3gp3gu45sa?svg=true" />}[https://ci.appveyor.com/project/halostatue/minitar-cli]
+test coverage :: {<img src="https://coveralls.io/repos/halostatue/minitar-cli/badge.svg" alt="Coverage Status" />}[https://coveralls.io/r/halostatue/minitar-cli]
+
+== Description
+
+<tt>minitar-cli</tt> is a pure-Ruby command-line tool that uses
+{minitar}[https://github.com/halostatue/minitar] to provide a command-line
+tool, +minitar+, for working with POSIX tar(1) archive files.
+
+This is release 0.6, extracted from {minitar}[https://halostatue.ca/minitar],
+with modernizations.
+
+== Synopsis
+
+Using <tt>minitar-cli</tt> is easy; its functionality is provided through
+<tt>bin/minitar</tt> (installed as +miniitar+). It supports three basic
+commands: +create+, +extract+, and +list+.
+
+All +minitar+ commands support two common options, +verbose+ and +progress+.
+These are mutually exclusive and +progress+ has a higher priority than
++verbose+.
+
++verbose+:: <tt>--verbose</tt> (<tt>-V</tt>), puts the requested command in
+            verbose mode.
++progress+:: <tt>--progress</tt> (<tt>-P</tt>), shows a progress bar (if
+             appropriate) or puts the requested command in verbose mode.
+
+=== +minitar create+
+
+    minitar create [OPTIONS] <tarfile|-> <file|directory|-->+
+
+Creates a new tarfile. If the tarfile is named .tar.gz or .tgz, then it will be
+compressed automatically. If the tarfile is "-", then it will be output to
+standard output (stdout) so that minitar may be piped.
+
+The files or directories that will be packed into the tarfile are
+specified after the name of the tarfile itself. Directories will be
+processed recursively. If the token "--" is found in the list of files
+to be packed, additional filenames will be read from standard input
+(stdin). If any file is not found, the packaging will be halted.
+
++create+ also supports the +compress+ option.
+
++compress+:: <tt>--compress</tt> (<tt>-z</tt>), compresses the tarfile with
+             gzip.
+
+=== +minitar extract+
+
+    minitar extract [OPTIONS] <tarfile|-> [<file>+]
+
+Extracts files from an existing tarfile. If the tarfile is named .tar.gz or
+.tgz, then it will be uncompressed automatically. If the tarfile is "-", then
+it will be read from standard input (stdin) so that minitar may be piped.
+
+The files or directories that will be extracted from the tarfile are specified
+after the name of the tarfile itself. Directories will be processed
+recursively. Files must be specified in full. A file "foo/bar/baz.txt" cannot
+simply be specified by specifying "baz.txt". Any file not found will simply be
+skipped and an error will be reported.
+
++extract+ also supports the +uncompress+, +pipe+, and +output+ options.
+
++uncompress+:: <tt>--uncompress</tt> (<tt>-z</tt>), uncompresses the tarfile
+               with gzip.
++pipe+:: <tt>--pipe</tt>, emits the extracted files to STDOUT for piping.
++output+:: <tt>--output</tt> (<tt>-o</tt>), extracts the files to the specified
+           directory.
+
+=== +minitar list+
+
+    minitar list [OPTIONS] <tarfile|-> [<file>+]
+
+Lists files in an existing tarfile. If the tarfile is named .tar.gz or .tgz,
+then it will be uncompressed automatically. If the tarfile is "-", then it will
+be read from standard input (stdin) so that minitar may be piped.
+
+The files or directories to be filtered are specified after the name of the
+tarfile itself.
+
+Both +verbose+ and +progress+ act as a file detail view, similar to <tt>ls
+-l</tt>.
+
++list+ also supports the +uncompress+, +sort+, +reverse+, and +l+ options.
+
++uncompress+:: <tt>--uncompress</tt> <tt>-z</tt>, uncompresses the tarfile with
+               gzip.
++sort+:: <tt>--sort</tt> (<tt>-S</tt>), sorts the list of files by the
+         specified field. Supported sort fields are +name+ (the default),
+         +mtime+, and +size+.
++reverse+:: Reverses the sort.
++l+:: Lists the files in detail (like +verbose+).
+
+== minitar-cli Semantic Versioning
+
+The minitar-cli tool uses a {Semantic Versioning}[http://semver.org/] scheme
+with one change:
+
+* When PATCH is zero (+0+), it will be omitted from version references.

data/Rakefile

@@ -0,0 +1,47 @@
+# -*- ruby encoding: utf-8 -*-
+
+require 'rubygems'
+require 'hoe'
+require 'rake/clean'
+
+Hoe.plugin :doofus
+Hoe.plugin :gemspec2
+Hoe.plugin :git
+Hoe.plugin :minitest
+Hoe.plugin :travis
+Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
+
+spec = Hoe.spec 'minitar-cli' do
+  developer('Austin Ziegler', 'halostatue@gmail.com')
+
+  require_ruby_version '>= 1.8'
+
+  self.history_file = 'History.md'
+  self.readme_file = 'README.rdoc'
+  self.licenses = ['Ruby', 'BSD-2-Clause']
+
+  extra_deps << ['minitar', '~> 0.6.0']
+  extra_deps << ['powerbar', '~> 1.0']
+
+  extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  extra_dev_deps << ['hoe-git', '~> 1.6']
+  extra_dev_deps << ['hoe-rubygems', '~> 1.0']
+  extra_dev_deps << ['hoe-travis', '~> 1.2']
+  extra_dev_deps << ['minitest', '~> 5.3']
+  extra_dev_deps << ['minitest-autotest', ['>= 1.0', '<2']]
+  extra_dev_deps << ['rake', '>= 10.0', '< 12']
+  extra_dev_deps << ['rdoc', '>= 0.0']
+end
+
+if RUBY_VERSION >= '2.0' && RUBY_ENGINE == 'ruby'
+  namespace :test do
+    desc 'Run test coverage'
+    task :coverage do
+      spec.test_prelude = 'load ".simplecov-prelude.rb"'
+      Rake::Task['test'].execute
+    end
+  end
+
+  Rake::Task['travis'].prerequisites.replace(%w(test:coverage))
+end

data/bin/minitar

@@ -0,0 +1,11 @@
+#! /usr/bin/env ruby
+# coding: utf-8
+
+git_path = File.expand_path('../../.git', __FILE__)
+if File.exist?(git_path)
+  $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+end
+
+require 'minitar/cli'
+
+exit Minitar::CLI.run(ARGV)

data/docs/bsdl.txt

@@ -0,0 +1,19 @@
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/docs/ruby.txt

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/lib/minitar/cli.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'minitar'
+
+# The Minitar command-line application.
+class Minitar::CLI
+  VERSION = '0.6'.freeze #:nodoc:
+
+  # rubocop:disable Lint/InheritException
+  class AbstractCommandError < Exception; end
+  # rubocop:enable Lint/InheritException
+  class UnknownCommandError < StandardError; end
+  class CommandAlreadyExists < StandardError; end
+
+  def self.run(argv, input = $stdin, output = $stdout, error = $stderr)
+    new(input, output, error).run(argv)
+  end
+
+  attr_reader :commander
+  attr_reader :ioe
+
+  def initialize(input = $stdin, output = $stdout, error = $stderr)
+    @ioe = {
+      :input  => input,
+      :output => output,
+      :error  => error
+    }
+    @commander = Minitar::CLI::Commander.new(ioe)
+    Minitar::CLI::Command.children.each do |command|
+      commander.register(command)
+    end
+    commander.default_command = 'help'
+  end
+
+  def run(argv)
+    opts = {}
+
+    output << "minitar #{VERSION}\n" if argv.include?('--version')
+
+    if argv.include?('--verbose') or argv.include?('-V')
+      opts[:verbose] = true
+      argv.delete('--verbose')
+      argv.delete('-V')
+    end
+
+    if argv.include?('--progress') or argv.include?('-P')
+      opts[:progress] = true
+      opts[:verbose]  = false
+      argv.delete('--progress')
+      argv.delete('-P')
+    end
+
+    command = commander[(argv.shift or '').downcase]
+    command ||= commander['help']
+    command.call(argv, opts)
+  end
+end
+
+require 'minitar/cli/command'
+require 'minitar/cli/commander'
+require 'minitar/cli/command/help'
+require 'minitar/cli/command/create'
+require 'minitar/cli/command/extract'
+require 'minitar/cli/command/list'