command_kit 0.1.0.pre1 → 0.1.0.pre2

data/spec/arguments_spec.rb

@@ -10,6 +10,13 @@ describe Arguments do
 
   let(:command_class) { TestArguments::ImplicitCmd }
 
+  describe ".included" do
+    subject { command_class }
+
+    it { expect(subject).to include(Main) }
+    it { expect(subject).to include(Help) }
+  end
+
   describe ".arguments" do
     subject { TestArguments::ImplicitCmd }
 

data/spec/help/man_spec.rb

@@ -0,0 +1,348 @@
+require 'spec_helper'
+require 'command_kit/help/man'
+
+describe 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 "#man" do
+    let(:man_page) { 'foo' }
+
+    it "must call system() with the given man page" do
+      expect(subject).to receive(:system).with('man',man_page)
+
+      subject.man(man_page)
+    end
+
+    context "when given a non-String man-page argument" do
+      let(:man_page_arg) { double(:non_string_arg) }
+
+      it "must call #to_s on the man-page argument" do
+        expect(man_page_arg).to receive(:to_s).and_return(man_page)
+
+        expect(subject).to receive(:system).with('man',man_page)
+
+        subject.man(man_page_arg)
+      end
+    end
+
+    context "when given the section: keyword argument" do
+      let(:section) { 7 }
+
+      it "must call system() with the given section number and man page" do
+        expect(subject).to receive(:system).with('man',section.to_s,man_page)
+
+        subject.man(man_page, section: section)
+      end
+    end
+  end
+
+  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

data/spec/options/option_spec.rb

@@ -65,22 +65,61 @@ describe Options::Option do
       subject { described_class.new(name, equals: equals, desc: desc) }
 
       it "must set #equals" do
-        expect(subject.equals).to eq(equals)
+        expect(subject.equals?).to eq(equals)
       end
     end
 
     context "when the equals: keyword is not given" do
       subject { described_class.new(name, desc: desc) }
 
-      it { expect(subject.equals).to be(false) }
+      it { expect(subject.equals?).to be(false) }
     end
 
     context "when the values: keyword is given" do
-      let(:value) { {} }
-      subject { described_class.new(name, value: {}, desc: desc) }
+      context "and it is a Hash" do
+        let(:type) { Integer }
+
+        subject { described_class.new(name, value: {type: type}, desc: desc) }
+
+        it "must initialize #value" do
+          expect(subject.value).to      be_kind_of(Options::OptionValue)
+          expect(subject.value.type).to eq(type)
+        end
+      end
+
+      context "and it is true" do
+        subject { described_class.new(name, value: true, desc: desc) }
+
+        it "must initialize #value with defaults" do
+          expect(subject.value).to           be_kind_of(Options::OptionValue)
+          expect(subject.value.type).to      eq(String)
+          expect(subject.value.required?).to be(true)
+          expect(subject.value.usage).to     eq('STR')
+        end
+      end
 
-      it "must initialize #value" do
-        expect(subject.value).to be_kind_of(Options::OptionValue)
+      context "and it is false" do
+        subject { described_class.new(name, value: false, desc: desc) }
+
+        it "must not initialize #value" do
+          expect(subject.value).to be(nil)
+        end
+      end
+
+      context "and it is nil" do
+        subject { described_class.new(name, value: nil, desc: desc) }
+
+        it "must not initialize #value" do
+          expect(subject.value).to be(nil)
+        end
+      end
+
+      context "when it is another type" do
+        it do
+          expect {
+            described_class.new(name, value: 'foo', desc: desc)
+          }.to raise_error(TypeError)
+        end
       end
     end
 

data/spec/options/option_value_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'command_kit/options/option_value'
 
 describe Options::OptionValue do
-  let(:type) { Integer }
+  let(:type)     { Integer }
   let(:usage)    { 'COUNT' }
   let(:required) { true }
   let(:default)  { 1 }
@@ -26,6 +26,22 @@ describe Options::OptionValue do
       end
     end
 
+    context "when the default: keyword is given" do
+      subject { described_class.new(default: default) }
+
+      it "must set #default" do
+        expect(subject.default).to eq(default)
+      end
+    end
+
+    context "when the default: keyword is not given" do
+      subject { described_class.new() }
+
+      it "default #default to String" do
+        expect(subject.default).to eq(nil)
+      end
+    end
+
     context "when the usage: keyword is given" do
       let(:usage) { 'FOO' }
 
@@ -45,11 +61,20 @@ describe Options::OptionValue do
     end
   end
 
+  subject do
+    described_class.new(
+      type:     type,
+      usage:    usage,
+      required: required,
+      default:  default
+    )
+  end
+
   describe "#usage" do
     let(:usage) { 'FOO' }
 
     context "when #optional? is true" do
-      subject { described_class.new(usage: usage, required: false) }
+      let(:required) { false }
 
       it "must wrap the usage within [ ] brackets" do
         expect(subject.usage).to eq("[#{usage}]")
@@ -57,11 +82,35 @@ describe Options::OptionValue do
     end
 
     context "when #optional? is false" do
-      subject { described_class.new(usage: usage, required: true) }
+      let(:required) { true }
 
       it "should return the usage string unchanged" do
         expect(subject.usage).to eq(usage)
       end
     end
   end
+
+  describe "#default_value" do
+    context "when initialized with a default: that responded to #call" do
+      let(:default) do
+        ->{ [] }
+      end
+
+      it "must call the default #call method" do
+        expect(subject.default_value).to eq(default.call)
+      end
+    end
+
+    context "when initialized with a default: that it's an Object" do
+      let(:default) { "" }
+
+      it "must return the default: object" do
+        expect(subject.default_value).to eq(default)
+      end
+
+      it "must duplicate the default: object each time" do
+        expect(subject.default_value).to_not be(subject.default_value)
+      end
+    end
+  end
 end