command_kit 0.1.0 → 0.2.0

data/lib/command_kit/printing/indent.rb

@@ -20,7 +20,7 @@ module CommandKit
     #
     module Indent
       #
-      # Initializes the indententation level to zero.
+      # Initializes the indentation level to zero.
       #
       def initialize(**kwargs)
         @indent = 0
@@ -40,7 +40,7 @@ module CommandKit
       #   increased.
       #
       # @return [Integer]
-      #   If no block is given, the indententation level will be returned.
+      #   If no block is given, the indentation level will be returned.
       #
       # @example
       #   puts "values:"

data/lib/command_kit/printing.rb

@@ -9,7 +9,7 @@ module CommandKit
   module Printing
     include Stdio
 
-    # Platform independency new-line constant
+    # Platform independent new-line constant
     #
     # @return [String]
     #

data/lib/command_kit/sudo.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'command_kit/os'
+
+module CommandKit
+  #
+  # Allows running commands with `sudo`.
+  #
+  # @since 0.2.0
+  #
+  module Sudo
+    include OS
+
+    #
+    # Runs the command under sudo, if the user isn't already root.
+    #
+    # @param [String] command
+    #   The command to execute.
+    #
+    # @param [Array<String>] arguments
+    #   Additional arguments for the command.
+    #
+    # @return [Boolean, nil]
+    #   Specifies whether the command was successfully ran or not.
+    #
+    # @api public
+    #
+    def sudo(command,*arguments)
+      if windows?
+        system('runas','/user:administrator',command,*arguments)
+      else
+        if Process.uid == 0
+          system(command,*arguments)
+        else
+          system('sudo',command,*arguments)
+        end
+      end
+    end
+  end
+end

data/lib/command_kit/terminal.rb

@@ -71,6 +71,11 @@ module CommandKit
       IO.respond_to?(:console) && stdout.tty?
     end
 
+    #
+    # @since 0.2.0
+    #
+    alias tty? terminal?
+
     #
     # Returns the terminal object, if {Stdio#stdout stdout} is connected to a
     # terminal.

data/lib/command_kit/version.rb

@@ -1,4 +1,4 @@
 module CommandKit
   # command_kit version
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/arguments/argument_spec.rb

@@ -126,7 +126,7 @@ describe CommandKit::Arguments::Argument do
       let(:repeats) { false }
 
       it "must return the usage name unchanged" do
-        expect(subject.usage).to eq("#{usage}")
+        expect(subject.usage).to eq(usage)
       end
     end
   end

data/spec/colors_spec.rb

@@ -65,6 +65,38 @@ describe CommandKit::Colors do
       it { expect(subject::WHITE).to eq("\e[37m") }
     end
 
+    describe "ON_BLACK" do
+      it { expect(subject::ON_BLACK).to eq("\e[40m") }
+    end
+
+    describe "ON_RED" do
+      it { expect(subject::ON_RED).to eq("\e[41m") }
+    end
+
+    describe "ON_GREEN" do
+      it { expect(subject::ON_GREEN).to eq("\e[42m") }
+    end
+
+    describe "ON_YELLOW" do
+      it { expect(subject::ON_YELLOW).to eq("\e[43m") }
+    end
+
+    describe "ON_BLUE" do
+      it { expect(subject::ON_BLUE).to eq("\e[44m") }
+    end
+
+    describe "ON_MAGENTA" do
+      it { expect(subject::ON_MAGENTA).to eq("\e[45m") }
+    end
+
+    describe "ON_CYAN" do
+      it { expect(subject::ON_CYAN).to eq("\e[46m") }
+    end
+
+    describe "ON_WHITE" do
+      it { expect(subject::ON_WHITE).to eq("\e[47m") }
+    end
+
     describe "RESET_COLOR" do
       it { expect(subject::RESET_COLOR).to eq("\e[39m") }
     end
@@ -186,6 +218,102 @@ describe CommandKit::Colors do
         it { expect(subject.white).to eq("\e[37m") }
       end
     end
+
+    describe ".on_black" do
+      context "when given a string" do
+        it "must wrap the string with \\e[40m and \\e[39m" do
+          expect(subject.on_black(str)).to eq("\e[40m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_black).to eq("\e[40m") }
+      end
+    end
+
+    describe ".on_red" do
+      context "when given a string" do
+        it "must wrap the string with \\e[41m and \\e[39m" do
+          expect(subject.on_red(str)).to eq("\e[41m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_red).to eq("\e[41m") }
+      end
+    end
+
+    describe ".on_green" do
+      context "when given a string" do
+        it "must wrap the string with \\e[42m and \\e[39m" do
+          expect(subject.on_green(str)).to eq("\e[42m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_green).to eq("\e[42m") }
+      end
+    end
+
+    describe ".on_yellow" do
+      context "when given a string" do
+        it "must wrap the string with \\e[43m and \\e[39m" do
+          expect(subject.on_yellow(str)).to eq("\e[43m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_yellow).to eq("\e[43m") }
+      end
+    end
+
+    describe ".on_blue" do
+      context "when given a string" do
+        it "must wrap the string with \\e[44m and \\e[39m" do
+          expect(subject.on_blue(str)).to eq("\e[44m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_blue).to eq("\e[44m") }
+      end
+    end
+
+    describe ".on_magenta" do
+      context "when given a string" do
+        it "must wrap the string with \\e[45m and \\e[39m" do
+          expect(subject.on_magenta(str)).to eq("\e[45m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_magenta).to eq("\e[45m") }
+      end
+    end
+
+    describe ".on_cyan" do
+      context "when given a string" do
+        it "must wrap the string with \\e[46m and \\e[39m" do
+          expect(subject.on_cyan(str)).to eq("\e[46m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_cyan).to eq("\e[46m") }
+      end
+    end
+
+    describe ".on_white" do
+      context "when given a string" do
+        it "must wrap the string with \\e[47m and \\e[39m" do
+          expect(subject.on_white(str)).to eq("\e[47m#{str}\e[49m")
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_white).to eq("\e[47m") }
+      end
+    end
   end
 
   describe CommandKit::Colors::PlainText do
@@ -241,6 +369,38 @@ describe CommandKit::Colors do
       it { expect(subject::WHITE).to eq('') }
     end
 
+    describe "ON_BLACK" do
+      it { expect(subject::ON_BLACK).to eq('') }
+    end
+
+    describe "ON_RED" do
+      it { expect(subject::ON_RED).to eq('') }
+    end
+
+    describe "ON_GREEN" do
+      it { expect(subject::ON_GREEN).to eq('') }
+    end
+
+    describe "ON_YELLOW" do
+      it { expect(subject::ON_YELLOW).to eq('') }
+    end
+
+    describe "ON_BLUE" do
+      it { expect(subject::ON_BLUE).to eq('') }
+    end
+
+    describe "ON_MAGENTA" do
+      it { expect(subject::ON_MAGENTA).to eq('') }
+    end
+
+    describe "ON_CYAN" do
+      it { expect(subject::ON_CYAN).to eq('') }
+    end
+
+    describe "ON_WHITE" do
+      it { expect(subject::ON_WHITE).to eq('') }
+    end
+
     describe "RESET_COLOR" do
       it { expect(subject::RESET_COLOR).to eq('') }
     end
@@ -360,6 +520,102 @@ describe CommandKit::Colors do
         it { expect(subject.white).to eq('') }
       end
     end
+
+    describe ".on_black" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_black(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_black).to eq('') }
+      end
+    end
+
+    describe ".on_red" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_red(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_red).to eq('') }
+      end
+    end
+
+    describe ".on_green" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_green(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_green).to eq('') }
+      end
+    end
+
+    describe ".on_yellow" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_yellow(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_yellow).to eq('') }
+      end
+    end
+
+    describe ".on_blue" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_blue(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_blue).to eq('') }
+      end
+    end
+
+    describe ".on_magenta" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_magenta(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_magenta).to eq('') }
+      end
+    end
+
+    describe ".on_cyan" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_cyan(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_cyan).to eq('') }
+      end
+    end
+
+    describe ".on_white" do
+      context "when given a string" do
+        it "must return that string" do
+          expect(subject.on_white(str)).to eq(str)
+        end
+      end
+
+      context "when given no arguments" do
+        it { expect(subject.on_white).to eq('') }
+      end
+    end
   end
 
   describe "#ansi?" do

data/spec/commands_spec.rb

@@ -191,7 +191,7 @@ describe CommandKit::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/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

@@ -234,38 +234,6 @@ describe CommandKit::Help::Man do
 
   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 }

data/spec/inflector_spec.rb

@@ -28,6 +28,10 @@ describe CommandKit::Inflector do
     end
   end
 
+  ascii   = (0..255).map(&:chr)
+  alpha   = ('a'..'z').to_a + ('A'..'Z').to_a
+  numeric = ('0'..'9').to_a
+
   describe ".underscore" do
     it "must convert CamelCase to camel_case" do
       expect(subject.underscore('CamelCase')).to eq('camel_case')
@@ -37,18 +41,48 @@ describe CommandKit::Inflector do
       expect(subject.underscore('camelCase')).to eq('camel_case')
     end
 
-    it "must convert Camel to camel" do
-      expect(subject.underscore('Camel')).to eq('camel')
+    it "must convert Camelcase to camelcase" do
+      expect(subject.underscore('Camelcase')).to eq('camelcase')
     end
 
-    it "must convert CAMEL to camel" do
-      expect(subject.underscore('CAMEL')).to eq('camel')
+    it "must convert CAMELCASE to camelcase" do
+      expect(subject.underscore('CAMELCASE')).to eq('camelcase')
     end
 
-    context "when given a String containing '/' characters" do
-      it "must replace dashes with underscores" do
-        expect(subject.underscore('foo-bar')).to eq('foo_bar')
-      end
+    it "must convert CAMELCase to camel_case" do
+      expect(subject.underscore('CAMELCase')).to eq('camel_case')
+    end
+
+    it "must convert CamelCASE to camel_case" do
+      expect(subject.underscore('CAMELCase')).to eq('camel_case')
+    end
+
+    it "must convert FooBARBaz to foo_bar_baz" do
+      expect(subject.underscore('FooBARBaz')).to eq('foo_bar_baz')
+    end
+
+    it "must convert foo_bar_baz to foo_bar_baz" do
+      expect(subject.underscore('foo_bar_baz')).to eq('foo_bar_baz')
+    end
+
+    it "must convert foo___bar___baz to foo___bar___baz" do
+      expect(subject.underscore('foo___bar___baz')).to eq('foo___bar___baz')
+    end
+
+    it "must convert foo-bar-baz to foo_bar_baz" do
+      expect(subject.underscore('foo-bar-baz')).to eq('foo_bar_baz')
+    end
+
+    it "must convert foo---bar---baz to foo___bar___baz" do
+      expect(subject.underscore('foo---bar---baz')).to eq('foo___bar___baz')
+    end
+
+    it "must convert foo_BAR_baz to foo_bar_baz" do
+      expect(subject.underscore('foo_BAR_baz')).to eq('foo_bar_baz')
+    end
+
+    it "must convert foo-BAR-baz to foo_bar_baz" do
+      expect(subject.underscore('foo-BAR-baz')).to eq('foo_bar_baz')
     end
 
     context "when given a non-String" do
@@ -56,6 +90,20 @@ describe CommandKit::Inflector do
         expect(subject.underscore(:CamelCase)).to eq('camel_case')
       end
     end
+
+    separators = %w[_ -]
+
+    (ascii - alpha - numeric - separators).each do |char|
+      context "when the given String contains a #{char.inspect} character" do
+        let(:string) { "Foo#{char}Bar" }
+
+        it do
+          expect {
+            subject.underscore(string)
+          }.to raise_error(ArgumentError,"cannot convert string to underscored: #{string.inspect}")
+        end
+      end
+    end
   end
 
   describe ".dasherize" do
@@ -100,5 +148,19 @@ describe CommandKit::Inflector do
         expect(subject.camelize(:foo_bar)).to eq('FooBar')
       end
     end
+
+    separators = %w[_ - /]
+
+    (ascii - alpha - numeric - separators).each do |char|
+      context "when the given String contains a #{char.inspect} character" do
+        let(:string) { "foo#{char}bar" }
+
+        it do
+          expect {
+            subject.camelize(string)
+          }.to raise_error(ArgumentError,"cannot convert string to CamelCase: #{string.inspect}")
+        end
+      end
+    end
   end
 end