command_kit 0.1.0.pre1 → 0.2.0

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
@@ -46,4 +46,7 @@ describe Command do
     expect(described_class).to include(CommandKit::ExceptionHandler)
   end
 
+  it "must include FileUtils" do
+    expect(described_class).to include(FileUtils)
+  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') }

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

data/spec/commands_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/commands'
 
-describe Commands do
+describe CommandKit::Commands do
   module TestCommands
     class TestEmptyCommands
 
@@ -191,7 +191,7 @@ describe Commands do
       it "must contain the mapping of aliases to command names" do
       expect(subject.command_aliases).to eq({
         't1' => 'test1',
-        't2' => 'test2',
+        't2' => 'test2'
       })
       end
     end

data/spec/description_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/description'
 
-describe Description do
+describe CommandKit::Description do
   module TestDescription
     class ImplicitCmd
       include CommandKit::Description
@@ -175,29 +175,5 @@ describe Description do
 
       subject.help
     end
-
-    context "when the superclass defines it's own #help method" do
-      module TestDescription
-        class SuperclassHelpMethod
-          def help
-            puts 'superclass'
-          end
-        end
-
-        class InheritedHelpMethod < SuperclassHelpMethod
-          include CommandKit::Description
-        end
-      end
-
-      let(:super_command_class) { TestDescription::SuperclassHelpMethod }
-      let(:command_class) { TestDescription::InheritedHelpMethod }
-
-      it "must call the superclass'es #help method first" do
-        expect_any_instance_of(super_command_class).to receive(:help)
-        expect(subject).to receive(:help_description)
-
-        subject.help
-      end
-    end
   end
 end

data/spec/env/home_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/env/home'
 
-describe Env::Home do
+describe CommandKit::Env::Home do
   module TestEnvHome
     class TestCommand
       include CommandKit::Env::Home

data/spec/env/path_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/env/path'
 
-describe Env::Path do
+describe CommandKit::Env::Path do
   module TestEnvPath
     class TestCommand
 

data/spec/examples_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/examples'
 
-describe Examples do
+describe CommandKit::Examples do
   module TestExamples
     class ImplicitCmd
       include CommandKit::Examples
@@ -207,29 +207,5 @@ describe Examples do
 
       subject.help
     end
-
-    context "when the superclass defines it's own #help method" do
-      module TestDescription
-        class SuperclassHelpMethod
-          def help
-            puts 'superclass'
-          end
-        end
-
-        class InheritedHelpMethod < SuperclassHelpMethod
-          include CommandKit::Examples
-        end
-      end
-
-      let(:super_command_class) { TestDescription::SuperclassHelpMethod }
-      let(:command_class) { TestDescription::InheritedHelpMethod }
-
-      it "must call the superclass'es #help method first" do
-        expect_any_instance_of(super_command_class).to receive(:help)
-        expect(subject).to receive(:help_examples)
-
-        subject.help
-      end
-    end
   end
 end

data/spec/exception_handler_spec.rb

@@ -73,7 +73,7 @@ describe CommandKit::ExceptionHandler do
           include CommandKit::ExceptionHandler
 
           def run
-            raise(RuntimeError.new("error"))
+            raise("error")
           end
 
         end

data/spec/help/man_spec.rb

@@ -0,0 +1,316 @@
+require 'spec_helper'
+require 'command_kit/help/man'
+
+describe CommandKit::Help::Man do
+  module TestHelpMan
+    class TestCommand
+      include CommandKit::Help::Man
+
+      man_dir "#{__dir__}/fixtures/man"
+    end
+
+    class TestCommandWithManPage
+      include CommandKit::Help::Man
+
+      man_dir "#{__dir__}/fixtures/man"
+      man_page 'foo.1'
+    end
+
+    class EmptyCommand
+      include CommandKit::Help::Man
+    end
+  end
+
+  let(:command_class) { TestHelpMan::TestCommand }
+
+  describe ".included" do
+    subject { command_class }
+
+    it "must include CommandName" do
+      expect(subject).to include(CommandKit::CommandName)
+    end
+
+    it "must include Help" do
+      expect(subject).to include(CommandKit::Help)
+    end
+
+    it "must include Stdio" do
+      expect(subject).to include(CommandKit::Stdio)
+    end
+  end
+
+  describe ".man_dir" do
+    context "when no man_dir have been set" do
+      subject { TestHelpMan::EmptyCommand }
+
+      it "should default to nil" do
+        expect(subject.man_dir).to be_nil
+      end
+    end
+
+    context "when a man_dir is explicitly set" do
+      subject { TestHelpMan::TestCommand }
+
+      it "must return the explicitly set man_dir" do
+        expect(subject.man_dir).to eq(File.expand_path('../fixtures/man',__FILE__))
+      end
+    end
+
+    context "when the command class inherites from another class" do
+      context "but no man_dir is set" do
+        module TestHelpMan
+          class BaseCmd
+            include CommandKit::Help::Man
+          end
+
+          class InheritedCmd < BaseCmd
+          end
+        end
+
+        subject { TestHelpMan::InheritedCmd }
+
+        it "must search each class then return nil "do
+          expect(subject.man_dir).to be_nil
+        end
+      end
+
+      module TestHelpMan
+        class ExplicitBaseCmd
+          include CommandKit::Help::Man
+
+          man_dir 'set/in/baseclass'
+        end
+      end
+
+      context "when the superclass defines an explicit man_dir" do
+        module TestHelpMan
+          class ImplicitInheritedCmd < ExplicitBaseCmd
+          end
+        end
+
+        let(:super_subject) { TestHelpMan::ExplicitBaseCmd }
+        subject { TestHelpMan::ImplicitInheritedCmd }
+
+        it "must inherit the superclass'es man_dir" do
+          expect(subject.man_dir).to eq(super_subject.man_dir)
+        end
+
+        it "must not change the superclass'es man_dir" do
+          expect(super_subject.man_dir).to eq('set/in/baseclass')
+        end
+      end
+
+      context "when the subclass defines an explicit man_dir" do
+        module TestHelpMan
+          class ImplicitBaseCmd
+            include CommandKit::Help::Man
+          end
+
+          class ExplicitInheritedCmd < ImplicitBaseCmd
+            man_dir 'set/in/subclass'
+          end
+        end
+
+        let(:super_subject) { TestHelpMan::ImplicitBaseCmd }
+        subject { TestHelpMan::ExplicitInheritedCmd }
+
+        it "must return the subclass'es man_dir" do
+          expect(subject.man_dir).to eq('set/in/subclass')
+        end
+
+        it "must not change the superclass'es man_dir" do
+          expect(super_subject.man_dir).to be_nil
+        end
+      end
+
+      context "when both the subclass overrides the superclass's man_dirs" do
+        module TestHelpMan
+          class ExplicitOverridingInheritedCmd < ExplicitBaseCmd
+            man_dir 'set/in/subclass'
+          end
+        end
+
+        let(:super_subject) { TestHelpMan::ExplicitBaseCmd }
+        subject { TestHelpMan::ExplicitOverridingInheritedCmd }
+
+        it "must return the subclass'es man_dir" do
+          expect(subject.man_dir).to eq('set/in/subclass')
+        end
+
+        it "must not change the superclass'es man_dir" do
+          expect(super_subject.man_dir).to eq('set/in/baseclass')
+        end
+      end
+    end
+  end
+
+  describe ".man_page" do
+    context "when no man_page has been set" do
+      subject { TestHelpMan::TestCommand }
+
+      it "should default to \"\#{command_name}.1\"" do
+        expect(subject.man_page).to eq("#{subject.command_name}.1")
+      end
+    end
+
+    context "when a man_page is explicitly set" do
+      module TestHelpMan
+        class ExplicitCmd
+          include CommandKit::Help::Man
+          man_page 'explicit.1'
+        end
+      end
+
+      subject { TestHelpMan::ExplicitCmd }
+
+      it "must return the explicitly set man_page" do
+        expect(subject.man_page).to eq('explicit.1')
+      end
+    end
+
+    context "when the command class inherites from another class" do
+      module TestHelpMan
+        class BaseCmd
+          include CommandKit::Help::Man
+        end
+
+        class InheritedCmd < BaseCmd
+        end
+      end
+
+      subject { TestHelpMan::InheritedCmd }
+
+      it "should underscore the class'es name" do
+        expect(subject.man_page).to eq('inherited_cmd.1')
+      end
+
+      context "when the superclass defines an explicit man_page" do
+        module TestHelpMan
+          class ExplicitBaseCmd
+            include CommandKit::Help::Man
+            man_page 'explicit.1'
+          end
+
+          class ImplicitInheritedCmd < ExplicitBaseCmd
+          end
+        end
+
+        let(:super_subject) { TestHelpMan::ExplicitBaseCmd }
+        subject { TestHelpMan::ImplicitInheritedCmd }
+
+        it "must return the subclass'es man_page, not the superclass'es" do
+          expect(subject.man_page).to eq('implicit_inherited_cmd.1')
+        end
+
+        it "must not change the superclass'es man_page" do
+          expect(super_subject.man_page).to eq('explicit.1')
+        end
+      end
+
+      context "when the subclass defines an explicit man_page" do
+        module TestHelpMan
+          class ImplicitBaseCmd
+            include CommandKit::Help::Man
+          end
+
+          class ExplicitInheritedCmd < ImplicitBaseCmd
+            man_page 'explicit.1'
+          end
+        end
+
+        let(:super_subject) { TestHelpMan::ImplicitBaseCmd }
+        subject { TestHelpMan::ExplicitInheritedCmd }
+
+        it "must return the subclass'es man_page, not the superclass'es" do
+          expect(subject.man_page).to eq('explicit.1')
+        end
+
+        it "must not change the superclass'es man_page" do
+          expect(super_subject.man_page).to eq('implicit_base_cmd.1')
+        end
+      end
+    end
+  end
+
+  subject { command_class.new }
+
+  describe "#help_man" do
+    context "when .man_dir is not set" do
+      let(:command_class) { TestHelpMan::EmptyCommand }
+      subject { command_class.new }
+
+      it do
+        expect { subject.help_man }.to raise_error(NotImplementedError)
+      end
+    end
+
+    let(:man_page_path) do
+      File.join(subject.class.man_dir,subject.class.man_page)
+    end
+
+    it "must open the .man_page within the .man_dir" do
+      expect(subject).to receive(:system).with('man',man_page_path)
+
+      subject.help_man
+    end
+
+    context "when given a custom man page" do
+      let(:man_page)      { 'bar.1' }
+      let(:man_page_path) { File.join(subject.class.man_dir,man_page) }
+
+      it "must open the custom man-page within the .man_dir" do
+        expect(subject).to receive(:system).with('man',man_page_path)
+
+        subject.help_man(man_page)
+      end
+    end
+  end
+
+  describe "#help" do
+    let(:normal_help_output) do
+      stdout = StringIO.new
+
+      command_class.new(stdout: stdout).tap do |command|
+        command.method(:help).super_method.call
+      end
+
+      stdout.string
+    end
+
+    let(:stdout) { StringIO.new }
+
+    subject { command_class.new(stdout: stdout) }
+
+    context "when stdout is a TTY" do
+      before do
+        expect(subject.stdout).to receive(:tty?).and_return(true)
+      end
+
+      it "must open the command's man-page" do
+        expect(subject).to receive(:help_man).and_return(true)
+
+        subject.help
+      end
+
+      context "but when the man command is not installed" do
+        before do
+          expect(subject).to receive(:help_man).and_return(nil)
+        end
+
+        it "must call the super help() method" do
+          subject.help
+
+          expect(subject.stdout.string).to eq(normal_help_output)
+        end
+      end
+    end
+
+    context "when stdout is not a TTY" do
+      it "must call the super help() method" do
+        subject.help
+
+        expect(stdout.string).to eq(normal_help_output)
+      end
+    end
+  end
+end