command_kit 0.1.0.pre2 → 0.2.1

data/spec/colors_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/colors'
 
-describe Colors do
+describe CommandKit::Colors do
   module TestColors
     class TestCommand
       include CommandKit::Colors
@@ -11,10 +11,10 @@ describe Colors do
   let(:command_class) { TestColors::TestCommand }
   subject { command_class.new }
 
-  it { expect(described_class).to include(Stdio) }
-  it { expect(described_class).to include(Env) }
+  it { expect(described_class).to include(CommandKit::Stdio) }
+  it { expect(described_class).to include(CommandKit::Env) }
 
-  describe Colors::ANSI do
+  describe CommandKit::Colors::ANSI do
     subject { described_class }
 
     describe "RESET" do
@@ -65,6 +65,38 @@ describe Colors do
       it { expect(subject::WHITE).to eq("\e[37m") }
     end
 
+    describe "ON_BLACK" do
+      it { expect(subject::ON_BLACK).to eq("\e[40m") }
+    end
+
+    describe "ON_RED" do
+      it { expect(subject::ON_RED).to eq("\e[41m") }
+    end
+
+    describe "ON_GREEN" do
+      it { expect(subject::ON_GREEN).to eq("\e[42m") }
+    end
+
+    describe "ON_YELLOW" do
+      it { expect(subject::ON_YELLOW).to eq("\e[43m") }
+    end
+
+    describe "ON_BLUE" do
+      it { expect(subject::ON_BLUE).to eq("\e[44m") }
+    end
+
+    describe "ON_MAGENTA" do
+      it { expect(subject::ON_MAGENTA).to eq("\e[45m") }
+    end
+
+    describe "ON_CYAN" do
+      it { expect(subject::ON_CYAN).to eq("\e[46m") }
+    end
+
+    describe "ON_WHITE" do
+      it { expect(subject::ON_WHITE).to eq("\e[47m") }
+    end
+
     describe "RESET_COLOR" do
       it { expect(subject::RESET_COLOR).to eq("\e[39m") }
     end
@@ -186,9 +218,105 @@ describe Colors do
         it { expect(subject.white).to eq("\e[37m") }
       end
     end
+
+    describe ".on_black" do
+      context "when given a string" do
+        it "must wrap the string with \\e[40m and \\e[39m" do
+          expect(subject.on_black(str)).to eq("\e[40m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_black).to eq("\e[40m") }
+      end
+    end
+
+    describe ".on_red" do
+      context "when given a string" do
+        it "must wrap the string with \\e[41m and \\e[39m" do
+          expect(subject.on_red(str)).to eq("\e[41m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_red).to eq("\e[41m") }
+      end
+    end
+
+    describe ".on_green" do
+      context "when given a string" do
+        it "must wrap the string with \\e[42m and \\e[39m" do
+          expect(subject.on_green(str)).to eq("\e[42m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_green).to eq("\e[42m") }
+      end
+    end
+
+    describe ".on_yellow" do
+      context "when given a string" do
+        it "must wrap the string with \\e[43m and \\e[39m" do
+          expect(subject.on_yellow(str)).to eq("\e[43m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_yellow).to eq("\e[43m") }
+      end
+    end
+
+    describe ".on_blue" do
+      context "when given a string" do
+        it "must wrap the string with \\e[44m and \\e[39m" do
+          expect(subject.on_blue(str)).to eq("\e[44m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_blue).to eq("\e[44m") }
+      end
+    end
+
+    describe ".on_magenta" do
+      context "when given a string" do
+        it "must wrap the string with \\e[45m and \\e[39m" do
+          expect(subject.on_magenta(str)).to eq("\e[45m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_magenta).to eq("\e[45m") }
+      end
+    end
+
+    describe ".on_cyan" do
+      context "when given a string" do
+        it "must wrap the string with \\e[46m and \\e[39m" do
+          expect(subject.on_cyan(str)).to eq("\e[46m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_cyan).to eq("\e[46m") }
+      end
+    end
+
+    describe ".on_white" do
+      context "when given a string" do
+        it "must wrap the string with \\e[47m and \\e[39m" do
+          expect(subject.on_white(str)).to eq("\e[47m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_white).to eq("\e[47m") }
+      end
+    end
   end
 
-  describe Colors::PlainText do
+  describe CommandKit::Colors::PlainText do
     subject { described_class }
 
     let(:str) { 'foo' }
@@ -241,6 +369,38 @@ describe Colors do
       it { expect(subject::WHITE).to eq('') }
     end
 
+    describe "ON_BLACK" do
+      it { expect(subject::ON_BLACK).to eq('') }
+    end
+
+    describe "ON_RED" do
+      it { expect(subject::ON_RED).to eq('') }
+    end
+
+    describe "ON_GREEN" do
+      it { expect(subject::ON_GREEN).to eq('') }
+    end
+
+    describe "ON_YELLOW" do
+      it { expect(subject::ON_YELLOW).to eq('') }
+    end
+
+    describe "ON_BLUE" do
+      it { expect(subject::ON_BLUE).to eq('') }
+    end
+
+    describe "ON_MAGENTA" do
+      it { expect(subject::ON_MAGENTA).to eq('') }
+    end
+
+    describe "ON_CYAN" do
+      it { expect(subject::ON_CYAN).to eq('') }
+    end
+
+    describe "ON_WHITE" do
+      it { expect(subject::ON_WHITE).to eq('') }
+    end
+
     describe "RESET_COLOR" do
       it { expect(subject::RESET_COLOR).to eq('') }
     end
@@ -360,6 +520,102 @@ describe Colors do
         it { expect(subject.white).to eq('') }
       end
     end
+
+    describe ".on_black" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_black(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_black).to eq('') }
+      end
+    end
+
+    describe ".on_red" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_red(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_red).to eq('') }
+      end
+    end
+
+    describe ".on_green" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_green(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_green).to eq('') }
+      end
+    end
+
+    describe ".on_yellow" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_yellow(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_yellow).to eq('') }
+      end
+    end
+
+    describe ".on_blue" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_blue(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_blue).to eq('') }
+      end
+    end
+
+    describe ".on_magenta" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_magenta(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_magenta).to eq('') }
+      end
+    end
+
+    describe ".on_cyan" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_cyan(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_cyan).to eq('') }
+      end
+    end
+
+    describe ".on_white" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_white(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_white).to eq('') }
+      end
+    end
   end
 
   describe "#ansi?" do
@@ -409,13 +665,15 @@ describe Colors do
 
       before { allow(stdout).to receive(:tty?).and_return(true) }
 
-      it { expect(subject.colors).to be(Colors::ANSI) }
+      it do
+        expect(subject.colors).to be(described_class::ANSI)
+      end
 
       context "when a block is given" do
         it do
           expect { |b|
             subject.colors(&b)
-          }.to yield_with_args(Colors::ANSI)
+          }.to yield_with_args(described_class::ANSI)
         end
       end
     end
@@ -424,13 +682,15 @@ describe Colors do
       let(:stdout) { StringIO.new }
       subject { command_class.new(stdout: stdout) }
 
-      it { expect(subject.colors).to be(Colors::PlainText) }
+      it do
+        expect(subject.colors).to be(described_class::PlainText)
+      end
 
       context "when a block is given" do
         it do
           expect { |b|
             subject.colors(&b)
-          }.to yield_with_args(Colors::PlainText)
+          }.to yield_with_args(described_class::PlainText)
         end
       end
     end
@@ -441,13 +701,15 @@ describe Colors do
 
         before { allow(stream).to receive(:tty?).and_return(true) }
 
-        it { expect(subject.colors(stream)).to be(Colors::ANSI) }
+        it do
+          expect(subject.colors(stream)).to be(described_class::ANSI)
+        end
 
         context "when a block is given" do
           it do
             expect { |b|
               subject.colors(stream,&b)
-            }.to yield_with_args(Colors::ANSI)
+            }.to yield_with_args(described_class::ANSI)
           end
         end
       end
@@ -455,13 +717,15 @@ describe Colors do
       context "but the alternate stream does not support ANSI" do
         let(:stream) { StringIO.new }
 
-        it { expect(subject.colors(stream)).to be(Colors::PlainText) }
+        it do
+          expect(subject.colors(stream)).to be(described_class::PlainText)
+        end
 
         context "when a block is given" do
           it do
             expect { |b|
               subject.colors(stream,&b)
-            }.to yield_with_args(Colors::PlainText)
+            }.to yield_with_args(described_class::PlainText)
           end
         end
       end

data/spec/command_name_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/command_name'
 
-describe CommandName do
+describe CommandKit::CommandName do
   module TestCommandName
     class ImplicitCmd
       include CommandKit::CommandName

data/spec/command_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/command'
 
-describe Command do
+describe CommandKit::Command do
   it "must include CommandKit::Main" do
     expect(described_class).to include(CommandKit::Main)
   end
@@ -26,14 +26,14 @@ describe Command do
     expect(described_class).to include(CommandKit::Usage)
   end
 
-  it "must include CommandKit::Arguments" do
-    expect(described_class).to include(CommandKit::Arguments)
-  end
-
   it "must include CommandKit::Options" do
     expect(described_class).to include(CommandKit::Options)
   end
 
+  it "must include CommandKit::Arguments" do
+    expect(described_class).to include(CommandKit::Arguments)
+  end
+
   it "must include CommandKit::Examples" do
     expect(described_class).to include(CommandKit::Examples)
   end
@@ -46,4 +46,78 @@ describe Command do
     expect(described_class).to include(CommandKit::ExceptionHandler)
   end
 
+  it "must include FileUtils" do
+    expect(described_class).to include(FileUtils)
+  end
+
+  module TestCommandClass
+    class TestCommand < CommandKit::Command
+
+      usage '[OPTIONS] ARG1 [ARG2]'
+
+      option :option1, short: '-a',
+                       value: {
+                         type: Integer,
+                         default: 1
+                       },
+                       desc: "Option 1"
+
+      option :option2, short: '-b',
+                       value: {
+                         type: String,
+                         usage: 'FILE'
+                       },
+                       desc: "Option 2"
+
+      argument :argument1, required: true,
+                           usage:    'ARG1',
+                           desc:     "Argument 1"
+
+      argument :argument2, required: false,
+                           usage:    'ARG2',
+                           desc:     "Argument 2"
+
+      examples [
+        '-a 42 foo/bar/baz',
+        '-a 42 -b bar.txt baz qux'
+      ]
+
+      description 'Example command'
+
+    end
+  end
+
+  let(:command_class) { TestCommandClass::TestCommand }
+  subject { command_class.new }
+
+  describe "#help" do
+    let(:option1)   { command_class.options[:option1]     }
+    let(:option2)   { command_class.options[:option2]     }
+    let(:argument1) { command_class.arguments[:argument1] }
+    let(:argument2) { command_class.arguments[:argument2] }
+
+    it "must print the usage, options, arguments, examples, and description" do
+      expect { subject.help }.to output(
+        [
+          "Usage: #{subject.usage}",
+          '',
+          'Options:',
+          "    #{option1.usage.join(', ').ljust(33 - 1)} #{option1.desc}",
+          "    #{option2.usage.join(', ').ljust(33 - 1)} #{option2.desc}",
+          '    -h, --help                       Print help information',
+          '',
+          "Arguments:",
+          "    #{argument1.usage.ljust(33)}#{argument1.desc}",
+          "    #{argument2.usage.ljust(33)}#{argument2.desc}",
+          '',
+          "Examples:",
+          "    #{subject.command_name} #{command_class.examples[0]}",
+          "    #{subject.command_name} #{command_class.examples[1]}",
+          '',
+          command_class.description,
+          ''
+        ].join($/)
+      ).to_stdout
+    end
+  end
 end

data/spec/commands/auto_load/subcommand_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/commands/auto_load/subcommand'
 
-describe Commands::AutoLoad::Subcommand do
+describe CommandKit::Commands::AutoLoad::Subcommand do
   let(:fixtures_dir) { File.expand_path('../../fixtures',__FILE__) }
 
   let(:file) { 'test1.rb' }

data/spec/commands/auto_load_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/commands/auto_load'
 
-describe Commands::AutoLoad do
+describe CommandKit::Commands::AutoLoad do
   let(:fixtures_dir) { File.expand_path('../fixtures',__FILE__) }
 
   let(:dir)       { File.join(fixtures_dir,'test_auto_load','cli','commands') }
@@ -54,16 +54,27 @@ describe Commands::AutoLoad do
   end
 
   module TestAutoLoad
-    class CLI
+    class TestCommand
       include CommandKit::Commands
       include CommandKit::Commands::AutoLoad.new(
         dir:       File.expand_path('../fixtures/test_auto_load/cli/commands',__FILE__),
         namespace: "#{self}::Commands"
       )
     end
+
+    class TestCommandWithBlock
+      include CommandKit::Commands
+      include(CommandKit::Commands::AutoLoad.new(
+        dir:       File.expand_path('../fixtures/test_auto_load/cli/commands',__FILE__),
+        namespace: "#{self}::Commands"
+      ) { |autoload|
+        autoload.command 'test-1', 'Test1', 'test1.rb', aliases: %w[test_1]
+        autoload.command 'test-2', 'Test2', 'test2.rb', aliases: %w[test_2]
+      })
+    end
   end
 
-  let(:command_class)   { TestAutoLoad::CLI }
+  let(:command_class)   { TestAutoLoad::TestCommand }
   let(:autoload_module) { command_class.included_modules.first }
 
   describe "#included" do
@@ -76,6 +87,26 @@ describe Commands::AutoLoad do
     it "must merge the module's #commands into the class'es #commands" do
       expect(command_class.commands).to include(autoload_module.commands)
     end
+
+    context "when CommandKit::Commands::AutoLoad has an explicit mapping" do
+      let(:command_class) { TestAutoLoad::TestCommandWithBlock }
+
+      it "must merge the module's #commands into the class'es #commands" do
+        expect(command_class.commands).to include(autoload_module.commands)
+      end
+
+      it "must also merge the any aliases into the class'es #command_aliases" do
+        expected_command_aliases = {}
+
+        autoload_module.commands.each do |name,subcommand|
+          subcommand.aliases.each do |alias_name|
+            expected_command_aliases[alias_name] = name
+          end
+        end
+
+        expect(command_class.command_aliases).to include(expected_command_aliases)
+      end
+    end
   end
 
   describe "#join" do

data/spec/commands/auto_require_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/commands/auto_require'
 
-describe Commands::AutoRequire do
+describe CommandKit::Commands::AutoRequire do
   let(:fixtures_dir) { File.expand_path('../fixtures',__FILE__) }
   let(:lib_dir)      { File.join(fixtures_dir,'test_auto_require','lib') }
   let(:dir)          { File.join('test_auto_require','cli','commands') }
@@ -126,7 +126,7 @@ describe Commands::AutoRequire do
 
       it "the .commands.default_proc must auto-require commands and return a Subcommand" do
         expect(command_class.commands[command_name]).to_not be(nil)
-        expect(command_class.commands[command_name]).to be_kind_of(Commands::Subcommand)
+        expect(command_class.commands[command_name]).to be_kind_of(CommandKit::Commands::Subcommand)
         expect(command_class.commands[command_name].command).to eq(TestAutoRequire::CLI::Commands::Test1)
       end
 

data/spec/commands/help_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'command_kit/commands/help'
 require 'command_kit/commands'
 
-describe Commands::Help do
+describe CommandKit::Commands::Help do
   module TestHelpCommand
     class CLI
       include CommandKit::Commands

data/spec/commands/parent_command_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'command_kit/commands'
 require 'command_kit/commands/parent_command'
 
-describe Commands::ParentCommand do
+describe CommandKit::Commands::ParentCommand do
   module TestParentCommand
     class TestCommands
 

data/spec/commands/subcommand_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'command_kit/commands/subcommand'
 require 'command_kit/command'
 
-describe Commands::Subcommand do
+describe CommandKit::Commands::Subcommand do
   module TestSubcommands
     class TestCommand < CommandKit::Command
     end