command_kit 0.1.0.pre1

data/spec/console_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+require 'command_kit/console'
+
+require 'stringio'
+
+describe Console do
+  module TestConsole
+    class TestCommand
+      include CommandKit::Console
+    end
+  end
+
+  let(:command_class) { TestConsole::TestCommand }
+  subject { command_class.new }
+
+  describe "#console?" do
+    context "when stdout is connected to a TTY" do
+      subject { command_class.new(stdout: STDOUT) }
+
+      it do
+        skip "STDOUT is not a TTY" unless STDOUT.tty?
+
+        expect(subject.console?).to be(true)
+      end
+    end
+
+    context "when stdout is not connected to a TTY" do
+      subject { command_class.new(stdout: StringIO.new) }
+
+      it do
+        expect(subject.console?).to be(false)
+      end
+    end
+
+    context "when IO.console is missing" do
+      before do
+        expect(IO).to receive(:respond_to?).with(:console).and_return(false)
+      end
+
+      it do
+        expect(subject.console?).to be(false)
+      end
+    end
+  end
+
+  describe "#console" do
+    context "when stdout is connected to a TTY" do
+      subject { command_class.new(stdout: STDOUT) }
+
+      it do
+        skip "STDOUT is not a TTY" unless STDOUT.tty?
+
+        expect(subject.console).to eq(IO.console)
+      end
+    end
+
+    context "when stdout is not connected to a TTY" do
+      subject { command_class.new(stdout: StringIO.new) }
+
+      it do
+        expect(subject.console).to eq(nil)
+      end
+    end
+
+    context "when IO.console is missing" do
+      before do
+        expect(IO).to receive(:respond_to?).with(:console).and_return(false)
+      end
+
+      it do
+        expect(subject.console).to be(nil)
+      end
+    end
+  end
+
+  describe "#console_height" do
+    context "when stdout is connected to a TTY" do
+      subject { command_class.new(stdout: STDOUT) }
+
+      it do
+        skip "STDOUT is not a TTY" unless STDOUT.tty?
+
+        expect(subject.console_height).to eq(STDOUT.winsize[0])
+      end
+    end
+
+    context "when stdout is not connected to a TTY" do
+      subject { command_class.new(stdout: StringIO.new) }
+
+      it "must fallback to DEFAULT_HEIGHT" do
+        expect(subject.console_height).to eq(described_class::DEFAULT_HEIGHT)
+      end
+
+      context "but the LINES env variable was set" do
+        let(:lines) { 10 }
+        let(:env)   { {'LINES' => lines.to_s} }
+
+        subject { command_class.new(stdout: StringIO.new, env: env) }
+
+        it "must fallback to the LINES environment variable" do
+          expect(subject.console_height).to eq(lines)
+        end
+      end
+    end
+  end
+
+  describe "#console_width" do
+    context "when stdout is connected to a TTY" do
+      subject { command_class.new(stdout: STDOUT) }
+
+      it do
+        skip "STDOUT is not a TTY" unless STDOUT.tty?
+
+        expect(subject.console_width).to eq(STDOUT.winsize[1])
+      end
+    end
+
+    context "when stdout is not connected to a TTY" do
+      subject { command_class.new(stdout: StringIO.new) }
+
+      it "must fallback to DEFAULT_WIDTH" do
+        expect(subject.console_width).to eq(described_class::DEFAULT_WIDTH)
+      end
+
+      context "but the COLUMNS env variable was set" do
+        let(:columns) { 50 }
+        let(:env)     { {'COLUMNS' => columns.to_s} }
+
+        subject { command_class.new(stdout: StringIO.new, env: env) }
+
+        it "must fallback to the COLUMNS environment variable" do
+          expect(subject.console_width).to eq(columns)
+        end
+      end
+    end
+  end
+
+  describe "#console_size" do
+    context "when stdout is connected to a TTY" do
+      subject { command_class.new(stdout: STDOUT) }
+
+      it do
+        skip "STDOUT is not a TTY" unless STDOUT.tty?
+
+        expect(subject.console_size).to eq(STDOUT.winsize)
+      end
+    end
+
+    context "when stdout is not connected to a TTY" do
+      subject { command_class.new(stdout: StringIO.new) }
+
+      it "must fallback to [DEFAULT_HEIGHT, DEFAULT_WIDTH]" do
+        expect(subject.console_size).to eq(
+          [described_class::DEFAULT_HEIGHT, described_class::DEFAULT_WIDTH]
+        )
+      end
+
+      context "but the LINES env variable was set" do
+        let(:lines) { 10 }
+        let(:env)   { {'LINES' => lines.to_s} }
+
+        subject { command_class.new(stdout: StringIO.new, env: env) }
+
+        it "must fallback to the [$LINES, DEFAULT_WIDTH]" do
+          expect(subject.console_size).to eq(
+            [lines, described_class::DEFAULT_WIDTH]
+          )
+        end
+      end
+
+      context "but the COLUMNS env variable was set" do
+        let(:columns) { 50 }
+        let(:env)     { {'COLUMNS' => columns.to_s} }
+
+        subject { command_class.new(stdout: StringIO.new, env: env) }
+
+        it "must fallback to the [DEFAULT_HEIGHT, COLUMNS]" do
+          expect(subject.console_size).to eq(
+            [described_class::DEFAULT_HEIGHT, columns]
+          )
+        end
+      end
+
+      context "but the LINES and COLUMNS env variable was set" do
+        let(:lines) { 10 }
+        let(:columns) { 50 }
+        let(:env) do
+          {'LINES' => lines.to_s, 'COLUMNS' => columns.to_s}
+        end
+
+        subject { command_class.new(stdout: StringIO.new, env: env) }
+
+        it "must fallback to the [LINES, COLUMNS]" do
+          expect(subject.console_size).to eq(
+            [lines, columns]
+          )
+        end
+      end
+    end
+  end
+end

data/spec/description_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+require 'command_kit/description'
+
+describe Description do
+  module TestDescription
+    class ImplicitCmd
+      include CommandKit::Description
+    end
+  end
+
+  let(:command_class) { TestDescription::ImplicitCmd }
+
+  describe ".description" do
+    subject { TestDescription::ImplicitCmd }
+
+    context "when no description have been set" do
+      it "should default to nil" do
+        expect(subject.description).to be_nil
+      end
+    end
+
+    context "when a description is explicitly set" do
+      module TestDescription
+        class ExplicitCmd
+          include CommandKit::Description
+          description "Example command"
+        end
+      end
+
+      subject { TestDescription::ExplicitCmd }
+
+      it "must return the explicitly set description" do
+        expect(subject.description).to eq("Example command")
+      end
+    end
+
+    context "when the command class inherites from another class" do
+      context "but no description is set" do
+        module TestDescription
+          class BaseCmd
+            include CommandKit::Description
+          end
+
+          class InheritedCmd < BaseCmd
+          end
+        end
+
+        subject { TestDescription::InheritedCmd }
+
+        it "must search each class then return nil "do
+          expect(subject.description).to be_nil
+        end
+      end
+
+      module TestDescription
+        class ExplicitBaseCmd
+          include CommandKit::Description
+          description "Example base command"
+        end
+      end
+
+      context "when the superclass defines an explicit description" do
+        module TestDescription
+          class ImplicitInheritedCmd < ExplicitBaseCmd
+          end
+        end
+
+        let(:super_subject) { TestDescription::ExplicitBaseCmd }
+        subject { TestDescription::ImplicitInheritedCmd }
+
+        it "must inherit the superclass'es description" do
+          expect(subject.description).to eq(super_subject.description)
+        end
+
+        it "must not change the superclass'es description" do
+          expect(super_subject.description).to eq("Example base command")
+        end
+      end
+
+      context "when the subclass defines an explicit description" do
+        module TestDescription
+          class ImplicitBaseCmd
+            include CommandKit::Description
+          end
+
+          class ExplicitInheritedCmd < ImplicitBaseCmd
+            description "Example inherited command"
+          end
+        end
+
+        let(:super_subject) { TestDescription::ImplicitBaseCmd }
+        subject { TestDescription::ExplicitInheritedCmd }
+
+        it "must return the subclass'es description" do
+          expect(subject.description).to eq("Example inherited command")
+        end
+
+        it "must not change the superclass'es description" do
+          expect(super_subject.description).to be_nil
+        end
+      end
+
+      context "when both the subclass overrides the superclass's descriptions" do
+        module TestDescription
+          class ExplicitOverridingInheritedCmd < ExplicitBaseCmd
+            description "Example overrided description"
+          end
+        end
+
+        let(:super_subject) { TestDescription::ExplicitBaseCmd }
+        subject { TestDescription::ExplicitOverridingInheritedCmd }
+
+        it "must return the subclass'es description" do
+          expect(subject.description).to eq("Example overrided description")
+        end
+
+        it "must not change the superclass'es description" do
+          expect(super_subject.description).to eq("Example base command")
+        end
+      end
+    end
+  end
+
+  subject { command_class.new }
+
+  describe "#description" do
+    it "must be the same as .description" do
+      expect(subject.description).to eq(command_class.description)
+    end
+  end
+
+  describe "#help_description" do
+    context "when #description returns nil" do
+      module TestDescription
+        class NoDescription
+          include CommandKit::Description
+        end
+      end
+
+      let(:command_class) { TestDescription::NoDescription }
+      subject { command_class.new }
+
+      it "must print out the description" do
+        expect { subject.help_description }.to_not output.to_stdout
+      end
+    end
+
+    context "when #description returns a String" do
+      module TestDescription
+        class DefinesDescription
+          include CommandKit::Description
+
+          description "Example command"
+        end
+      end
+
+      let(:command_class) { TestDescription::DefinesDescription }
+      subject { command_class.new }
+
+      it "must print out the description" do
+        expect { subject.help_description }.to output(
+          [
+            '',
+            subject.description,
+            ''
+          ].join($/)
+        ).to_stdout
+      end
+    end
+  end
+
+  describe "#help" do
+    it "must call #help_description" do
+      expect(subject).to receive(:help_description)
+
+      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

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'command_kit/env/home'
+
+describe Env::Home do
+  module TestEnvHome
+    class TestCommand
+      include CommandKit::Env::Home
+    end
+  end
+
+  let(:command_class) { TestEnvHome::TestCommand }
+
+  describe ".included" do
+    it "must include CommandKit::Env" do
+      expect(command_class).to be_include(CommandKit::Env)
+    end
+  end
+
+  describe ".home_dir" do
+    subject { command_class }
+
+    it "must return Gem.user_home" do
+      expect(subject.home_dir).to eq(Gem.user_home)
+    end
+  end
+
+  describe "#home_dir" do
+    context "when env['HOME'] is set" do
+      let(:home_dir) { '/path/to/home_dir' }
+
+      subject { command_class.new(env: {'HOME' => home_dir}) }
+
+      it "must return the env['HOME'] value" do
+        expect(subject.home_dir).to eq(home_dir)
+      end
+    end
+
+    context "when env['HOME'] is not set" do
+      subject { command_class.new(env: {}) }
+
+      it "must return .home_dir" do
+        expect(subject.home_dir).to eq(subject.class.home_dir)
+      end
+    end
+  end
+end