command_kit 0.1.0.pre1 → 0.2.0

data/spec/pager_spec.rb

@@ -3,7 +3,7 @@ require 'command_kit/pager'
 
 require 'stringio'
 
-describe Pager do
+describe CommandKit::Pager do
   module TestPager
     class TestCommand
       include CommandKit::Pager
@@ -19,8 +19,8 @@ describe Pager do
 
       subject { command_class.new(env: {'PAGER' => pager}) }
 
-      it "must set @pager to the PAGER env variable" do
-        expect(subject.instance_variable_get('@pager')).to eq(pager)
+      it "must set @pager_command to the PAGER env variable" do
+        expect(subject.instance_variable_get('@pager_command')).to eq(pager)
       end
     end
 
@@ -29,7 +29,7 @@ describe Pager do
         subject { command_class.new(env: {'PATH' => ENV['PATH']}) }
 
         it "must search PATH for one of the pagers" do
-          expect(subject.instance_variable_get('@pager')).to eq("less -r")
+          expect(subject.instance_variable_get('@pager_command')).to eq("less -r")
         end
       end
     end
@@ -46,9 +46,9 @@ describe Pager do
       end
     end
 
-    context "when @pager isn't initialized" do
+    context "when @pager_command isn't initialized" do
       before do
-        subject.instance_variable_set('@pager',nil)
+        subject.instance_variable_set('@pager_command',nil)
       end
 
       it "must yield stdout" do
@@ -58,7 +58,7 @@ describe Pager do
       end
     end
 
-    context "when stdout is a TTY and @pager is initialized" do
+    context "when stdout is a TTY and @pager_command is initialized" do
       let(:pager) { 'less -r' }
 
       subject { command_class.new(env: {'PAGER' => pager}) }
@@ -67,6 +67,8 @@ describe Pager do
       let(:pager_pid) { double('pid')  }
 
       before do
+        expect(subject.stdout).to receive(:tty?).and_return(true)
+
         expect(IO).to receive(:popen).with(pager,'w').and_return(pager_io)
         expect(pager_io).to receive(:pid).and_return(pager_pid)
 
@@ -75,8 +77,6 @@ describe Pager do
       end
 
       it "must spawn a new process and yield an IO object" do
-        skip "STDOUT is not a TTY" unless STDOUT.tty?
-
         expect { |b|
           subject.pager(&b)
         }.to yield_with_args(pager_io)
@@ -84,8 +84,6 @@ describe Pager do
 
       context "when Errno::EPIPE is raised" do
         it "must return gracefully" do
-          skip "STDOUT is not a TTY" unless STDOUT.tty?
-
           expect {
             subject.pager do
               raise(Errno::EPIPE,"pipe broken")
@@ -97,10 +95,10 @@ describe Pager do
   end
 
   describe "#print_or_page" do
-    let(:console_height) { 10 }
+    let(:terminal_height) { 10 }
 
     before do
-      expect(subject).to receive(:console_height).and_return(console_height)
+      expect(subject).to receive(:terminal_height).and_return(terminal_height)
     end
 
     context "when given a String" do
@@ -115,7 +113,7 @@ describe Pager do
       end
 
       context "and the number of lines is greater than the console's height" do
-        let(:string) { "foo#{$/}bar#{$/}" * console_height }
+        let(:string) { "foo#{$/}bar#{$/}" * terminal_height }
 
         it "must spawn a pager and puts the String to the pager" do
           pager = double('pager')
@@ -139,7 +137,7 @@ describe Pager do
       end
 
       context "and the number of lines is greater than the console's height" do
-        let(:array) { ['foo', 'bar'] * console_height }
+        let(:array) { ['foo', 'bar'] * terminal_height }
 
         it "must spawn a pager and puts the Array of Strings to the pager" do
           pager = double('pager')
@@ -151,4 +149,69 @@ describe Pager do
       end
     end
   end
+
+  describe "#pipe_to_pager" do
+    context "when @pager_command is initialized" do
+      let(:pager) { 'less' }
+
+      subject do
+        command_class.new(env: {'PAGER' => pager})
+      end
+
+      context "and when given a single String" do
+        let(:command) { "find ." }
+
+        it "must run the command but piped into the pager" do
+          expect(subject).to receive(:system).with("#{command} | #{pager}")
+
+          subject.pipe_to_pager(command)
+        end
+      end
+
+      context "and when given a String and additional arguments" do
+        let(:command)   { 'find'          }
+        let(:arguments) { %[. -name *.md] }
+
+        let(:escaped_command) do
+          Shellwords.shelljoin([command,*arguments])
+        end
+
+        it "must shell escape the command and arguments" do
+          expect(subject).to receive(:system).with(
+            "#{escaped_command} | #{pager}"
+          )
+
+          subject.pipe_to_pager(command,*arguments)
+        end
+      end
+    end
+
+    context "when @pager_command is not initialized" do
+      before do
+        subject.instance_variable_set('@pager_command',nil)
+      end
+
+      let(:command)   { 'find' }
+      let(:arguments) { %[. -name *.md] }
+
+      it "must pass the command and any additional arguments to #system" do
+        expect(subject).to receive(:system).with(command,*arguments)
+
+        subject.pipe_to_pager(command,*arguments)
+      end
+
+      context "when one of the arguments is not a String" do
+        let(:command)   { :find }
+        let(:arguments) { ['.', :"-name", "*.md"] }
+
+        it "must convert the command to a String before calling #system" do
+          expect(subject).to receive(:system).with(
+            command.to_s, *arguments.map(&:to_s)
+          )
+
+          subject.pipe_to_pager(command,*arguments)
+        end
+      end
+    end
+  end
 end

data/spec/printing/indent_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/printing/indent'
 
-describe Printing::Indent do
+describe CommandKit::Printing::Indent do
   module TestIndent
     class TestCommand
       include CommandKit::Printing::Indent

data/spec/printing_spec.rb

@@ -3,7 +3,7 @@ require 'command_kit/printing'
 
 require 'stringio'
 
-describe Printing do
+describe CommandKit::Printing do
   module TestPrinting
     class TestCmd
 
@@ -14,11 +14,19 @@ describe Printing do
 
   let(:command_class) { TestPrinting::TestCmd }
   subject { command_class.new }
+  
+  describe "EOL" do
+    subject { described_class::EOL }
+
+    it "must equal $/" do
+      expect(subject).to eq($/)
+    end
+  end
 
   describe ".included" do
     subject { command_class }
 
-    it { expect(command_class).to include(Stdio) }
+    it { expect(command_class).to include(CommandKit::Stdio) }
   end
 
   let(:nl) { $/ }

data/spec/program_name_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'command_kit/program_name'
 
-describe ProgramName do
+describe CommandKit::ProgramName do
   module TestProgramName
     class TestCmd
       include CommandKit::ProgramName

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
 require 'rspec'
 require 'simplecov'
 SimpleCov.start
-
-require 'command_kit/version'
-include CommandKit

data/spec/sudo_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'command_kit/sudo'
+
+describe CommandKit::Sudo do
+  module TestSudo
+    class TestCommand
+      include CommandKit::Sudo
+    end
+  end
+
+  let(:command_class) { TestSudo::TestCommand }
+  subject { command_class.new }
+
+  describe "#sudo" do
+    let(:command) { "ls" }
+    let(:arguments) { ["-la", "~root"] }
+    let(:status) { double(:status) }
+
+    context "on UNIX" do
+      context "when the UID is 0" do
+        before { allow(Process).to receive(:uid).and_return(0) }
+
+        it "must execute the command without sudo" do
+          expect(subject).to receive(:system).with(command,*arguments).and_return(status)
+
+          expect(subject.sudo(command,*arguments)).to be(status)
+        end
+      end
+
+      context "when the UID is not 0" do
+        before { allow(Process).to receive(:uid).and_return(1000) }
+
+        it "must execute the command with 'sudo ...'" do
+          expect(subject).to receive(:system).with('sudo',command,*arguments).and_return(status)
+
+          expect(subject.sudo(command,*arguments)).to be(status)
+        end
+      end
+    end
+
+    context "on Windows" do
+      subject { command_class.new(os: :windows) }
+
+      it "must execute the command with 'runas /user:administrator ...'" do
+        expect(subject).to receive(:system).with('runas','/user:administrator',command,*arguments).and_return(status)
+
+        expect(subject.sudo(command,*arguments)).to be(status)
+      end
+    end
+  end
+end

data/spec/{console_spec.rb → terminal_spec.rb}

@@ -1,26 +1,26 @@
 require 'spec_helper'
-require 'command_kit/console'
+require 'command_kit/terminal'
 
 require 'stringio'
 
-describe Console do
-  module TestConsole
+describe CommandKit::Terminal do
+  module TestTerminal
     class TestCommand
-      include CommandKit::Console
+      include CommandKit::Terminal
     end
   end
 
-  let(:command_class) { TestConsole::TestCommand }
+  let(:command_class) { TestTerminal::TestCommand }
   subject { command_class.new }
 
-  describe "#console?" do
+  describe "#terminal?" 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)
+        expect(subject.terminal?).to be(true)
       end
     end
 
@@ -28,7 +28,7 @@ describe Console do
       subject { command_class.new(stdout: StringIO.new) }
 
       it do
-        expect(subject.console?).to be(false)
+        expect(subject.terminal?).to be(false)
       end
     end
 
@@ -38,19 +38,19 @@ describe Console do
       end
 
       it do
-        expect(subject.console?).to be(false)
+        expect(subject.terminal?).to be(false)
       end
     end
   end
 
-  describe "#console" do
+  describe "#tty?" 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)
+        expect(subject.tty?).to be(true)
       end
     end
 
@@ -58,7 +58,7 @@ describe Console do
       subject { command_class.new(stdout: StringIO.new) }
 
       it do
-        expect(subject.console).to eq(nil)
+        expect(subject.tty?).to be(false)
       end
     end
 
@@ -68,27 +68,57 @@ describe Console do
       end
 
       it do
-        expect(subject.console).to be(nil)
+        expect(subject.tty?).to be(false)
       end
     end
   end
 
-  describe "#console_height" do
+  describe "#terminal" 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])
+        expect(subject.terminal).to eq(IO.console)
       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)
+      it do
+        expect(subject.terminal).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.terminal).to be(nil)
+      end
+    end
+  end
+
+  describe "#terminal_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.terminal_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_TERMINAL_HEIGHT" do
+        expect(subject.terminal_height).to eq(described_class::DEFAULT_TERMINAL_HEIGHT)
       end
 
       context "but the LINES env variable was set" do
@@ -98,28 +128,28 @@ describe Console do
         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)
+          expect(subject.terminal_height).to eq(lines)
         end
       end
     end
   end
 
-  describe "#console_width" do
+  describe "#terminal_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])
+        expect(subject.terminal_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)
+      it "must fallback to DEFAULT_TERMINAL_WIDTH" do
+        expect(subject.terminal_width).to eq(described_class::DEFAULT_TERMINAL_WIDTH)
       end
 
       context "but the COLUMNS env variable was set" do
@@ -129,29 +159,29 @@ describe Console do
         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)
+          expect(subject.terminal_width).to eq(columns)
         end
       end
     end
   end
 
-  describe "#console_size" do
+  describe "#terminal_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)
+        expect(subject.terminal_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]
+      it "must fallback to [DEFAULT_TERMINAL_HEIGHT, DEFAULT_TERMINAL_WIDTH]" do
+        expect(subject.terminal_size).to eq(
+          [described_class::DEFAULT_TERMINAL_HEIGHT, described_class::DEFAULT_TERMINAL_WIDTH]
         )
       end
 
@@ -161,9 +191,9 @@ describe Console do
 
         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]
+        it "must fallback to the [$LINES, DEFAULT_TERMINAL_WIDTH]" do
+          expect(subject.terminal_size).to eq(
+            [lines, described_class::DEFAULT_TERMINAL_WIDTH]
           )
         end
       end
@@ -174,9 +204,9 @@ describe Console do
 
         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]
+        it "must fallback to the [DEFAULT_TERMINAL_HEIGHT, COLUMNS]" do
+          expect(subject.terminal_size).to eq(
+            [described_class::DEFAULT_TERMINAL_HEIGHT, columns]
           )
         end
       end
@@ -191,7 +221,7 @@ describe Console do
         subject { command_class.new(stdout: StringIO.new, env: env) }
 
         it "must fallback to the [LINES, COLUMNS]" do
-          expect(subject.console_size).to eq(
+          expect(subject.terminal_size).to eq(
             [lines, columns]
           )
         end