command_kit 0.1.0 → 0.3.0

data/spec/pager_spec.rb

@@ -19,8 +19,8 @@ describe CommandKit::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 CommandKit::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 CommandKit::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 CommandKit::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}) }
@@ -149,4 +149,69 @@ describe CommandKit::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) { %w[. -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) { %w[. -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

@@ -12,14 +12,16 @@ describe CommandKit::Printing::Indent do
   subject { command_class.new }
 
   describe "#initialize" do
-    it "must initialize @indent to 0" do
-      expect(subject.instance_variable_get('@indent')).to eq(0)
+    it "must initialize #indent to 0" do
+      expect(subject.indent).to eq(0)
     end
 
     context "when the class has a superclass" do
       module TestIndent
         class TestSuperCommand
 
+          attr_reader :var
+
           def initialize(var: 'default')
             @var = var
           end
@@ -36,11 +38,11 @@ describe CommandKit::Printing::Indent do
       let(:command_class) { TestIndent::TestSubCommand }
 
       it "must initialize @indent to 0" do
-        expect(subject.instance_variable_get('@indent')).to eq(0)
+        expect(subject.indent).to eq(0)
       end
 
       it "must call super()" do
-        expect(subject.instance_variable_get('@var')).to eq('default')
+        expect(subject.var).to eq('default')
       end
 
       context "and additional keyword arguments are given" do
@@ -49,7 +51,7 @@ describe CommandKit::Printing::Indent do
         subject { command_class.new(var: var) }
 
         it "must call super() with the additional keyword arguments" do
-          expect(subject.instance_variable_get('@var')).to eq(var)
+          expect(subject.var).to eq(var)
         end
       end
     end

data/spec/printing_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'command_kit/printing'
+require 'command_kit/command_name'
 
 require 'stringio'
 
@@ -34,11 +35,32 @@ describe CommandKit::Printing do
   describe "#print_error" do
     let(:message) { "oh no!" }
 
-    it "must print a line to stderr" do
+    it "must print the error message to stderr" do
       expect {
         subject.print_error(message)
       }.to output("#{message}#{nl}").to_stderr
     end
+
+    context "and when CommandKit::CommandName is included" do
+      module TestPrinting
+        class TestCmdWithCommandName
+
+          include CommandKit::CommandName
+          include CommandKit::Printing
+
+          command_name 'foo'
+
+        end
+      end
+
+      let(:command_class) { TestPrinting::TestCmdWithCommandName }
+
+      it "must print the command_name and the error message" do
+        expect {
+          subject.print_error(message)
+        }.to output("#{subject.command_name}: #{message}#{nl}").to_stderr
+      end
+    end
   end
 
   describe "#print_exception" do

data/spec/program_name_spec.rb

@@ -56,6 +56,14 @@ describe CommandKit::ProgramName do
     end
   end
 
+  describe "#command_name" do
+    subject { command_class.new }
+
+    it "should be the same as #program_name" do
+      expect(subject.command_name).to eq(subject.program_name)
+    end
+  end
+
   after do
     $PROGRAM_NAME = @original_program_name
   end

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/terminal_spec.rb

@@ -43,6 +43,36 @@ describe CommandKit::Terminal do
     end
   end
 
+  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.tty?).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.tty?).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.tty?).to be(false)
+      end
+    end
+  end
+
   describe "#terminal" do
     context "when stdout is connected to a TTY" do
       subject { command_class.new(stdout: STDOUT) }

data/spec/usage_spec.rb

@@ -182,7 +182,7 @@ describe CommandKit::Usage do
           [
             "#{subject.command_name} #{command_class.usage[0]}",
             "#{subject.command_name} #{command_class.usage[1]}",
-            "#{subject.command_name} #{command_class.usage[2]}",
+            "#{subject.command_name} #{command_class.usage[2]}"
           ]
         )
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-17 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".yardopts"
 - ChangeLog.md
 - Gemfile
@@ -70,11 +71,14 @@ files:
 - lib/command_kit/env/path.rb
 - lib/command_kit/examples.rb
 - lib/command_kit/exception_handler.rb
+- lib/command_kit/file_utils.rb
 - lib/command_kit/help.rb
 - lib/command_kit/help/man.rb
 - lib/command_kit/inflector.rb
 - lib/command_kit/interactive.rb
 - lib/command_kit/main.rb
+- lib/command_kit/man.rb
+- lib/command_kit/open_app.rb
 - lib/command_kit/options.rb
 - lib/command_kit/options/option.rb
 - lib/command_kit/options/option_value.rb
@@ -83,11 +87,14 @@ files:
 - lib/command_kit/options/verbose.rb
 - lib/command_kit/options/version.rb
 - lib/command_kit/os.rb
+- lib/command_kit/os/linux.rb
+- lib/command_kit/package_manager.rb
 - lib/command_kit/pager.rb
 - lib/command_kit/printing.rb
 - lib/command_kit/printing/indent.rb
 - lib/command_kit/program_name.rb
 - lib/command_kit/stdio.rb
+- lib/command_kit/sudo.rb
 - lib/command_kit/terminal.rb
 - lib/command_kit/usage.rb
 - lib/command_kit/version.rb
@@ -115,29 +122,41 @@ files:
 - spec/env_spec.rb
 - spec/examples_spec.rb
 - spec/exception_handler_spec.rb
+- spec/file_utils_spec.rb
+- spec/fixtures/template.erb
 - spec/help/man_spec.rb
 - spec/help_spec.rb
 - spec/inflector_spec.rb
 - spec/interactive_spec.rb
 - spec/main_spec.rb
+- spec/man_spec.rb
+- spec/open_app_spec.rb
 - spec/options/option_spec.rb
 - spec/options/option_value_spec.rb
 - spec/options/parser_spec.rb
 - spec/options_spec.rb
+- spec/os/linux_spec.rb
 - spec/os_spec.rb
+- spec/package_manager_spec.rb
 - spec/pager_spec.rb
 - spec/printing/indent_spec.rb
 - spec/printing_spec.rb
 - spec/program_name_spec.rb
 - spec/spec_helper.rb
 - spec/stdio_spec.rb
+- spec/sudo_spec.rb
 - spec/terminal_spec.rb
 - spec/usage_spec.rb
 - spec/xdg_spec.rb
 homepage: https://github.com/postmodern/command_kit.rb#readme
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://rubydoc.info/gems/command_kit
+  source_code_uri: https://github.com/postmodern/command_kit.rb
+  bug_tracker_uri: https://github.com/postmodern/command_kit.rb/issues
+  changelog_uri: https://github.com/postmodern/command_kit.rb/blob/main/ChangeLog.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -153,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A toolkit for building Ruby CLI commands