minitar-cli 0.9 → 1.0.0

data/lib/minitar/cli/command/list.rb

@@ -5,14 +5,14 @@
 # support have been dropped.
 class Minitar::CLI::Command::List < Minitar::CLI::Command
   def name
-    'list'
+    "list"
   end
 
   def altname
-    'ls'
+    "ls"
   end
 
-  HELP = <<-EOH.freeze
+  HELP = <<-EOH
     minitar list [OPTIONS] <tarfile|-> [<file>+]
 
 Lists files in an existing tarfile. If the tarfile is named .tar.gz or
@@ -36,32 +36,32 @@ Sort Fields:
   EOH
 
   def modestr(mode)
-    s = String.new('---')
-    s[0] = 'r' if (mode & 4) == 4
-    s[1] = 'w' if (mode & 2) == 2
-    s[2] = 'x' if (mode & 1) == 1
+    s = String.new("---")
+    s[0] = "r" if (mode & 4) == 4
+    s[1] = "w" if (mode & 2) == 2
+    s[2] = "x" if (mode & 1) == 1
     s
   end
 
   include CatchMinitarErrors
 
   def run(args, opts = {})
-    argv    = []
-    output  = nil
-    files   = []
-    opts[:field] = 'name'
+    argv = []
+    output = nil
+    files = []
+    opts[:field] = "name"
 
     while (arg = args.shift)
       case arg
-      when '--sort', '-S'
-        opts[:sort]   = true
-        opts[:field]  = args.shift
-      when '--reverse', '-R'
+      when "--sort", "-S"
+        opts[:sort] = true
+        opts[:field] = args.shift
+      when "--reverse", "-R"
         opts[:reverse] = true
-        opts[:sort]    = true
-      when '--uncompress', '-z'
+        opts[:sort] = true
+      when "--uncompress", "-z"
         opts[:uncompress] = true
-      when '-l'
+      when "-l"
         opts[:verbose] = true
       else
         argv << arg
@@ -70,35 +70,35 @@ Sort Fields:
 
     if argv.empty?
       ioe[:output] << "Not enough arguments.\n\n"
-      commander.command('help').call(%w(list))
+      commander.command("help").call(%w(list))
       return 255
     end
 
     input = argv.shift
-    if '-' == input
-      opts[:name] = 'STDIN'
+    if input == "-"
+      opts[:name] = "STDIN"
       input = ioe[:input]
     else
       opts[:name] = input
-      input = File.open(input, 'rb')
+      input = File.open(input, "rb")
     end
 
-    if opts[:name] =~ /\.tar\.gz$|\.tgz$/ or opts[:uncompress]
-      require 'zlib'
+    if /\.tar\.gz$|\.tgz$/ =~ opts[:name] || opts[:uncompress]
+      require "zlib"
       input = Zlib::GzipReader.new(input)
     end
 
     files << argv.to_a
     files.flatten!
 
-    if opts[:verbose] or opts[:progress]
-      format  = '%10s %4d %8s %8s %8d %12s %s'
-      datefmt = '%b %d  %Y'
-      timefmt = '%b %d %H:%M'
-      fields  = %w(permissions inodes user group size date fullname)
+    if opts[:verbose] || opts[:progress]
+      format = "%10s %4d %8s %8s %8d %12s %s"
+      datefmt = "%b %d  %Y"
+      timefmt = "%b %d %H:%M"
+      fields = %w(permissions inodes user group size date fullname)
     else
-      format  = '%s'
-      fields  = %w(fullname)
+      format = "%s"
+      fields = %w(fullname)
     end
 
     opts[:field] = opts[:field].to_sym
@@ -109,44 +109,44 @@ Sort Fields:
     today = Time.now
     oneyear = Time.mktime(today.year - 1, today.month, today.day)
 
-    Archive::Tar::Minitar::Input.each_entry(input) do |entry|
+    Minitar::Input.each_entry(input) do |entry|
       next unless files.empty? || files.include?(entry.full_name)
 
       value = format % fields.map { |ff|
         case ff
-        when 'permissions'
-          s = String.new(entry.directory? ? 'd' : '-')
+        when "permissions"
+          s = String.new(entry.directory? ? "d" : "-")
           s << modestr(entry.mode / 0o100)
           s << modestr(entry.mode / 0o010)
           s << modestr(entry.mode)
-        when 'inodes'
+        when "inodes"
           entry.size / 512
-        when 'user'
+        when "user"
           entry.uname || entry.uid || 0
-        when 'group'
+        when "group"
           entry.gname || entry.gid || 0
-        when 'size'
+        when "size"
           entry.size
-        when 'date'
+        when "date"
           if Time.at(entry.mtime) > oneyear
             Time.at(entry.mtime).strftime(timefmt)
           else
             Time.at(entry.mtime).strftime(datefmt)
           end
-        when 'fullname'
+        when "fullname"
           entry.full_name
         end
       }
 
       if opts[:sort]
-        output << [ entry.send(opts[:field]), value ]
+        output << [entry.send(opts[:field]), value]
       else
         ioe[:output] << value << "\n"
       end
     end
 
     if opts[:sort]
-      output = output.sort { |a, b| a[0] <=> b[0] }
+      output = output.sort_by { |a| a[0] }
       if opts[:reverse]
         output.reverse_each { |oo| ioe[:output] << oo[1] << "\n" }
       else

data/lib/minitar/cli/command.rb

@@ -20,7 +20,7 @@ class Minitar::CLI::Command
   module CatchMinitarErrors # :nodoc:
     def call(args, opts)
       run(args, opts)
-    rescue Archive::Tar::Minitar::Error => error
+    rescue Minitar::Error => error
       ioe[:error] << "#{error}\n"
       5
     end
@@ -38,7 +38,7 @@ class Minitar::CLI::Command
   def call(_args, _opts = {})
     raise Minitar::CLI::AbstractCommandError
   end
-  alias [] call
+  alias_method :[], :call
 
   def help
     raise Minitar::CLI::AbstractCommandError

data/lib/minitar/cli/commander.rb

@@ -15,7 +15,7 @@ class Minitar::CLI::Commander
   end
 
   def register(command)
-    command = command.new(self) if command.kind_of?(Class)
+    command = command.new(self) if command.is_a?(Class)
     raise CommandAlreadyExists if command.commander != self
     raise CommandAlreadyExists if command?(command.name)
 
@@ -29,10 +29,10 @@ class Minitar::CLI::Commander
   end
 
   def default_command=(command)
-    command = command.new if command.kind_of?(Class)
+    command = command.new if command.is_a?(Class)
 
     @default_command =
-      if command.kind_of?(Minitar::CLI::Command)
+      if command.is_a?(Minitar::CLI::Command)
         register(command) unless command?(command.name)
         command
       elsif command?(command)
@@ -53,12 +53,12 @@ class Minitar::CLI::Commander
       default_command
     end
   end
-  alias [] command
+  alias_method :[], :command
 
   def default_ioe(ioe = {})
-    ioe[:input]   ||= $stdin
-    ioe[:output]  ||= $stdout
-    ioe[:error]   ||= $stderr
+    ioe[:input] ||= $stdin
+    ioe[:output] ||= $stdout
+    ioe[:error] ||= $stderr
     ioe
   end
 end

data/lib/minitar/cli.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
-require 'minitar'
+require "minitar"
 
 # The Minitar command-line application.
 class Minitar::CLI
-  VERSION = '0.9'.freeze #:nodoc:
+  VERSION = "1.0.0" # :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)
@@ -21,44 +23,44 @@ class Minitar::CLI
 
   def initialize(input = $stdin, output = $stdout, error = $stderr)
     @ioe = {
-      :input  => input,
+      :input => input,
       :output => output,
-      :error  => error
+      :error => error
     }
     @commander = Minitar::CLI::Commander.new(ioe)
     Minitar::CLI::Command.children.each do |command|
       commander.register(command)
     end
-    commander.default_command = 'help'
+    commander.default_command = "help"
   end
 
   def run(argv)
     opts = {}
 
-    output << "minitar #{VERSION}\n" if argv.include?('--version')
+    output << "minitar #{VERSION}\n" if argv.include?("--version")
 
-    if argv.include?('--verbose') or argv.include?('-V')
+    if argv.include?("--verbose") || argv.include?("-V")
       opts[:verbose] = true
-      argv.delete('--verbose')
-      argv.delete('-V')
+      argv.delete("--verbose")
+      argv.delete("-V")
     end
 
-    if argv.include?('--progress') or argv.include?('-P')
+    if argv.include?("--progress") || argv.include?("-P")
       opts[:progress] = true
-      opts[:verbose]  = false
-      argv.delete('--progress')
-      argv.delete('-P')
+      opts[:verbose] = false
+      argv.delete("--progress")
+      argv.delete("-P")
     end
 
-    command = commander[(argv.shift or '').downcase]
-    command ||= commander['help']
+    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'
+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"

data/test/minitest_helper.rb

@@ -1,11 +1,12 @@
 # -*- ruby encoding: utf-8 -*-
 
-require 'fileutils'
-require 'minitar'
+require "fileutils"
+require "minitar"
 
-gem 'minitest'
-require 'minitest/autorun'
+gem "minitest"
+require "minitest/autorun"
+require "minitest/focus"
 
-Dir.glob(File.join(File.dirname(__FILE__), 'support/*.rb')).each do |support|
+Dir.glob(File.join(File.dirname(__FILE__), "support/*.rb")).sort.each do |support|
   require support
 end

data/test/support/minitar_cli_test_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'minitar/cli'
+require "minitar/cli"
 
 module MinitarCLITestHelper
   def cli(*args)
@@ -11,5 +11,11 @@ module MinitarCLITestHelper
     Regexp.union(*r)
   end
 
+  def assert_cli_output(first, last, &block)
+    out, _err = capture_io(&block)
+    assert_match first, out, "first line of output"
+    assert_match last, out, "last line of output"
+  end
+
   Minitest::Test.send(:include, self)
 end

data/test/test_cli_help.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'minitest_helper'
+require "minitest_helper"
 
 class TestCLIHelp < Minitest::Test
   def test_help_output_with_no_args
@@ -11,61 +11,61 @@ class TestCLIHelp < Minitest::Test
 
   def test_help_output_with_help
     assert_output Minitar::CLI::Command::Help::BASIC do
-      assert_equal 0, cli('help')
+      assert_equal 0, cli("help")
     end
   end
 
   def test_help_output_with_bad_command
     assert_output Minitar::CLI::Command::Help::BASIC do
-      assert_equal 0, cli('foo')
+      assert_equal 0, cli("foo")
     end
   end
 
   def test_help_output_with_help_bad_command
     assert_output "Unknown command: foo\n#{Minitar::CLI::Command::Help::BASIC}" do
-      assert_equal 0, cli('help', 'foo')
+      assert_equal 0, cli("help", "foo")
     end
   end
 
   def test_help_output_commands
     assert_output Minitar::CLI::Command::Help::COMMANDS do
-      assert_equal 0, cli('help', 'commands')
+      assert_equal 0, cli("help", "commands")
     end
   end
 
   def test_help_output_create
     assert_output Minitar::CLI::Command::Create::HELP do
-      assert_equal 0, cli('help', 'create')
+      assert_equal 0, cli("help", "create")
     end
   end
 
   def test_help_output_create_minargs
     assert_output "Not enough arguments.\n\n#{Minitar::CLI::Command::Create::HELP}" do
-      assert_equal 255, cli('create')
+      assert_equal 255, cli("create")
     end
   end
 
   def test_help_output_list
     assert_output Minitar::CLI::Command::List::HELP do
-      assert_equal 0, cli('help', 'list')
+      assert_equal 0, cli("help", "list")
     end
   end
 
   def test_help_output_list_minargs
     assert_output "Not enough arguments.\n\n#{Minitar::CLI::Command::List::HELP}" do
-      assert_equal 255, cli('list')
+      assert_equal 255, cli("list")
     end
   end
 
   def test_help_output_extract
     assert_output Minitar::CLI::Command::Extract::HELP do
-      assert_equal 0, cli('help', 'extract')
+      assert_equal 0, cli("help", "extract")
     end
   end
 
   def test_help_output_extract_minargs
     assert_output "Not enough arguments.\n\n#{Minitar::CLI::Command::Extract::HELP}" do
-      assert_equal 255, cli('extract')
+      assert_equal 255, cli("extract")
     end
   end
 end

data/test/test_cli_list.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
+require "minitest_helper"
+
 class TestCLIList < Minitest::Test
   def list_bad_dir(args = [])
-    cli_list('bad-dir', args)
+    cli_list("bad-dir", args)
   end
 
   def list_spaces(args = [])
-    cli_list('spaces', args)
+    cli_list("spaces", args)
   end
 
   def cli_list(name, args = [])
-    args = %W(list test/fixtures/#{name}.tar.gz) + Array(args)
+    args = %W[list test/fixtures/#{name}.tar.gz] + Array(args)
     cli(*args)
   end
 
@@ -21,103 +23,86 @@ class TestCLIList < Minitest::Test
   end
 
   def test_list_output_spaces
-    assert_output r([ %r{\A\./$}, %r{^\./bin/minitar\n\z} ]) do
+    assert_cli_output %r{\Afirst-added$}, %r{^last-added\n\z} do
       assert_equal 0, list_spaces
     end
   end
 
   def test_list_output_spaces_verbose
-    patterns = [
-      %r{\Adrwxr-xr-x\s+0\s+austin\s+staff\s+0 Feb 0[67] \d{2}:24 \./$},
-      %r{^-rwxr-xr-x\s+0\s+austin\s+staff\s+219 Feb 0[67] \d{2}:29 \./bin/minitar\n\z}
-    ]
-    assert_output r(patterns) do
-      assert_equal 0, list_spaces('--verbose')
+    first = %r{\A-rw-r--r--\s+0\s+austin\s+staff\s+2\s+Feb\s+15\s+2007\s+first-added$}
+    last = %r{^-rw-r--r--\s+0\s+austin\s+staff\s+3\s+Feb\s+15\s+2008\s+last-added\n\z}
+    assert_cli_output first, last do
+      assert_equal 0, list_spaces("--verbose")
     end
   end
 
   def test_list_output_spaces_verbose_sort_size
-    patterns = [
-      %r{\Adrwxr-xr-x\s+0\s+austin\s+staff\s+0 Feb 0[67] \d{2}:24 \./$},
-      %r{^-rw-r--r--\s+8\s+austin\s+staff\s+4296 Feb 0[67] \d{2}:29 ./lib/minitar/cli/command/extract.rb\n\z}
-    ]
-    assert_output r(patterns) do
-      assert_equal 0, list_spaces(%w(--verbose --sort size))
+    first = %r{\A-rw-r--r--\s+0\s+austin\s+staff\s+0\s+Feb\s+15\s+2005\s+000-bytes$}
+    last = %r{^-rw-r--r--\s+0\s+austin\s+staff\s+16\s+Feb\s+15\s+2006\s+largest\n\z}
+
+    assert_cli_output first, last do
+      assert_equal 0, list_spaces(%w[--verbose --sort size])
     end
   end
 
   def test_list_output_spaces_verbose_sort_size_reverse
-    patterns = [
-      %r{\A-rw-r--r--\s+8\s+austin\s+staff\s+4296 Feb 0[67] \d{2}:29 ./lib/minitar/cli/command/extract.rb$},
-      %r{^drwxr-xr-x\s+0\s+austin\s+staff\s+0 Feb 0[67] \d{2}:24 \./\n\z}
-    ]
-
-    assert_output r(patterns) do
-      assert_equal 0, list_spaces(%w(--verbose --sort size --reverse))
+    first = %r{\A-rw-r--r--\s+0\s+austin\s+staff\s+16\s+Feb\s+15\s+2006\s+largest$}
+    last = %r{^-rw-r--r--\s+0\s+austin\s+staff\s+0\s+Feb\s+15\s+2005\s+000-bytes\n\z}
+    assert_cli_output first, last do
+      assert_equal 0, list_spaces(%w[--verbose --sort size --reverse])
     end
   end
 
   def test_list_output_spaces_verbose_sort_name
-    patterns = [
-      %r{\Adrwxr-xr-x\s+0\s+austin\s+staff\s+0 Feb 0[67] \d{2}:24 \./$},
-      %r{^-rw-r--r--\s+8\s+austin\s+staff\s+3974 Feb 0[67] \d{2}:29 ./minitar-cli.gemspec\n\z}
-    ]
-    assert_output r(patterns) do
-      assert_equal 0, list_spaces(%w(--verbose --sort name))
+    first = %r{\A-rw-r--r--\s+0\s+austin\s+staff\s+4\s+Feb\s+15\s+2009\s+00-name$}
+    last = %r{^-rw-r--r--\s+0\s+austin\s+staff\s+5\s+Feb\s+15\s+2010\s+zz-name\n\z}
+    assert_cli_output first, last do
+      assert_equal 0, list_spaces(%w[--verbose --sort name])
     end
   end
 
   def test_list_output_spaces_verbose_sort_name_reverse
-    patterns = [
-      %r{\A-rw-r--r--\s+8\s+austin\s+staff\s+3974 Feb 0[67] \d{2}:29 ./minitar-cli.gemspec$},
-      %r{^drwxr-xr-x\s+0\s+austin\s+staff\s+0 Feb 0[67] \d{2}:24 \./\n\z}
-    ]
-
-    assert_output r(patterns) do
-      assert_equal 0, list_spaces(%w(--verbose --sort name --reverse))
+    first = %r{\A-rw-r--r--\s+0\s+austin\s+staff\s+5\s+Feb\s+15\s+2010\s+zz-name$}
+    last = %r{^-rw-r--r--\s+0\s+austin\s+staff\s+4\s+Feb\s+15\s+2009\s+00-name\n\z}
+    assert_cli_output first, last do
+      assert_equal 0, list_spaces(%w[--verbose --sort name --reverse])
     end
   end
 
   def test_list_output_spaces_verbose_sort_mtime
-    patterns = [
-      %r{\Adrwxr-xr-x\s+0\s+austin\s+staff\s+0 Nov 0[23] \d{2}:43 \./docs/$},
-      %r{^-rw-r--r--\s+8\s+austin\s+staff\s+4296 Feb 0[67] \d{2}:29 ./.pullreview.yml\n\z}
-    ]
-    assert_output r(patterns) do
-      assert_equal 0, list_spaces(%w(--verbose --sort mtime))
+    first = %r{\A-rw-r--r--\s+0\s+austin\s+staff\s+6\s+Feb\s+15\s+2004\s+earliest$}
+    last = %r{^-rw-r--r--\s+0\s+austin\s+staff\s+7\s+Feb\s+15\s+2014\s+latest\n\z}
+    assert_cli_output first, last do
+      assert_equal 0, list_spaces(%w[--verbose --sort mtime])
     end
   end
 
   def test_list_output_spaces_verbose_sort_mtime_reverse
-    patterns = [
-      %r{\A-rw-r--r--\s+8\s+austin\s+staff\s+4296 Feb 0[67] \d{2}:29 ./.pullreview.yml$},
-      %r{^drwxr-xr-x\s+0\s+austin\s+staff\s+0 Nov 0[23] \d{2}:43 \./docs/\n\z}
-    ]
-
-    assert_output r(patterns) do
-      assert_equal 0, list_spaces(%w(--verbose --sort mtime --reverse))
+    first = %r{\A-rw-r--r--\s+0\s+austin\s+staff\s+7\s+Feb\s+15\s+2014\s+latest$}
+    last = %r{^-rw-r--r--\s+0\s+austin\s+staff\s+6\s+Feb\s+15\s+2004\s+earliest\n\z}
+    assert_cli_output first, last do
+      assert_equal 0, list_spaces(%w[--verbose --sort mtime --reverse])
     end
   end
 
   def test_list_stdin
     assert_output "../qwerty\n" do
-      File.open('test/fixtures/bad-dir.tar.gz') do |f|
-        assert_equal 0, Minitar::CLI.run(%w(list - --uncompress), f)
+      File.open("test/fixtures/bad-dir.tar.gz") do |f|
+        assert_equal 0, Minitar::CLI.run(%w[list - --uncompress], f)
       end
     end
   end
 
   def test_list_output_spaces_filtered
-    assert_output "./bin/minitar\n" do
-      assert_equal 0, list_spaces('./bin/minitar')
+    assert_output "zz-name\n" do
+      assert_equal 0, list_spaces("zz-name")
     end
   end
 
   def test_list_output_spaces_filtered_verbose
-    expected =
-      %r{\A-rwxr-xr-x\s+0\s+austin\s+staff\s+219 Feb 0[67] \d{2}:29 ./bin/minitar\n\z}
-    assert_output expected do
-      assert_equal 0, list_spaces(['./bin/minitar', '--verbose'])
+    pattern = %r{\A-rw-r--r--\s+0\s+austin\s+staff\s+5\s+Feb\s+15\s+2010\s+zz-name\n\z}
+    assert_output pattern do
+      assert_equal 0, list_spaces(["zz-name", "--verbose"])
     end
   end
 end