command_kit 0.2.2 → 0.4.0

data/lib/command_kit/colors.rb

@@ -76,8 +76,53 @@ module CommandKit
       # ANSI color code for white
       WHITE = "\e[37m"
 
+      # ANSI color code for black
+      #
+      # @since 0.3.0
+      BRIGHT_BLACK = "\e[90m"
+
+      # ANSI color code for red
+      #
+      # @since 0.3.0
+      BRIGHT_RED = "\e[91m"
+
+      # ANSI color code for green
+      #
+      # @since 0.3.0
+      BRIGHT_GREEN = "\e[92m"
+
+      # ANSI color code for yellow
+      #
+      # @since 0.3.0
+      BRIGHT_YELLOW = "\e[93m"
+
+      # ANSI color code for blue
+      #
+      # @since 0.3.0
+      BRIGHT_BLUE = "\e[94m"
+
+      # ANSI color code for magenta
+      #
+      # @since 0.3.0
+      BRIGHT_MAGENTA = "\e[95m"
+
+      # ANSI color code for cyan
+      #
+      # @since 0.3.0
+      BRIGHT_CYAN = "\e[96m"
+
+      # ANSI color code for white
+      #
+      # @since 0.3.0
+      BRIGHT_WHITE = "\e[97m"
+
       # ANSI color for the default foreground color
-      RESET_COLOR = "\e[39m"
+      #
+      # @since 0.3.0
+      RESET_FG = "\e[39m"
+
+      # @see RESET_FG
+      RESET_COLOR = RESET_FG
 
       # ANSI color code for background color black
       #
@@ -119,6 +164,46 @@ module CommandKit
       # @since 0.2.0
       ON_WHITE = "\e[47m"
 
+      # ANSI color code for background color bright black
+      #
+      # @since 0.3.0
+      ON_BRIGHT_BLACK = "\e[100m"
+
+      # ANSI color code for background color bright red
+      #
+      # @since 0.3.0
+      ON_BRIGHT_RED = "\e[101m"
+
+      # ANSI color code for background color bright green
+      #
+      # @since 0.3.0
+      ON_BRIGHT_GREEN = "\e[102m"
+
+      # ANSI color code for background color bright yellow
+      #
+      # @since 0.3.0
+      ON_BRIGHT_YELLOW = "\e[103m"
+
+      # ANSI color code for background color bright blue
+      #
+      # @since 0.3.0
+      ON_BRIGHT_BLUE = "\e[104m"
+
+      # ANSI color code for background color bright magenta
+      #
+      # @since 0.3.0
+      ON_BRIGHT_MAGENTA = "\e[105m"
+
+      # ANSI color code for background color bright cyan
+      #
+      # @since 0.3.0
+      ON_BRIGHT_CYAN = "\e[106m"
+
+      # ANSI color code for background color bright white
+      #
+      # @since 0.3.0
+      ON_BRIGHT_WHITE = "\e[107m"
+
       # ANSI color for the default background color
       #
       # @since 0.2.0
@@ -126,6 +211,10 @@ module CommandKit
 
       module_function
 
+      #
+      # @group Styling Methods
+      #
+
       #
       # Resets text formatting.
       #
@@ -167,6 +256,10 @@ module CommandKit
         end
       end
 
+      #
+      # @group Foreground Color Methods
+      #
+
       #
       # Sets the text color to black.
       #
@@ -181,7 +274,7 @@ module CommandKit
       # @api public
       #
       def black(string=nil)
-        if string then "#{BLACK}#{string}#{RESET_COLOR}"
+        if string then "#{BLACK}#{string}#{RESET_FG}"
         else           BLACK
         end
       end
@@ -200,7 +293,7 @@ module CommandKit
       # @api public
       #
       def red(string=nil)
-        if string then "#{RED}#{string}#{RESET_COLOR}"
+        if string then "#{RED}#{string}#{RESET_FG}"
         else           RED
         end
       end
@@ -219,7 +312,7 @@ module CommandKit
       # @api public
       #
       def green(string=nil)
-        if string then "#{GREEN}#{string}#{RESET_COLOR}"
+        if string then "#{GREEN}#{string}#{RESET_FG}"
         else           GREEN
         end
       end
@@ -238,7 +331,7 @@ module CommandKit
       # @api public
       #
       def yellow(string=nil)
-        if string then "#{YELLOW}#{string}#{RESET_COLOR}"
+        if string then "#{YELLOW}#{string}#{RESET_FG}"
         else           YELLOW
         end
       end
@@ -257,7 +350,7 @@ module CommandKit
       # @api public
       #
       def blue(string=nil)
-        if string then "#{BLUE}#{string}#{RESET_COLOR}"
+        if string then "#{BLUE}#{string}#{RESET_FG}"
         else           BLUE
         end
       end
@@ -276,7 +369,7 @@ module CommandKit
       # @api public
       #
       def magenta(string=nil)
-        if string then "#{MAGENTA}#{string}#{RESET_COLOR}"
+        if string then "#{MAGENTA}#{string}#{RESET_FG}"
         else           MAGENTA
         end
       end
@@ -295,7 +388,7 @@ module CommandKit
       # @api public
       #
       def cyan(string=nil)
-        if string then "#{CYAN}#{string}#{RESET_COLOR}"
+        if string then "#{CYAN}#{string}#{RESET_FG}"
         else           CYAN
         end
       end
@@ -314,11 +407,201 @@ module CommandKit
       # @api public
       #
       def white(string=nil)
-        if string then "#{WHITE}#{string}#{RESET_COLOR}"
+        if string then "#{WHITE}#{string}#{RESET_FG}"
         else           WHITE
         end
       end
 
+      #
+      # Sets the text color to bright black (gray).
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, BRIGHT_BLACK]
+      #   The colorized string or just {BRIGHT_BLACK} if no arguments were
+      #   given.
+      #
+      # @see BRIGHT_BLACK
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def bright_black(string=nil)
+        if string then "#{BRIGHT_BLACK}#{string}#{RESET_FG}"
+        else           BRIGHT_BLACK
+        end
+      end
+
+      #
+      # Sets the text color to gray.
+      #
+      # @api public
+      #
+      # @see #bright_black
+      #
+      # @since 0.3.0
+      #
+      def gray(string=nil)
+        bright_black(string)
+      end
+
+      #
+      # Sets the text color to bright red.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, BRIGHT_RED]
+      #   The colorized string or just {BRIGHT_RED} if no arguments were given.
+      #
+      # @see BRIGHT_RED
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def bright_red(string=nil)
+        if string then "#{BRIGHT_RED}#{string}#{RESET_FG}"
+        else           BRIGHT_RED
+        end
+      end
+
+      #
+      # Sets the text color to bright green.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, BRIGHT_GREEN]
+      #   The colorized string or just {BRIGHT_GREEN} if no arguments were
+      #   given.
+      #
+      # @see BRIGHT_GREEN
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def bright_green(string=nil)
+        if string then "#{BRIGHT_GREEN}#{string}#{RESET_FG}"
+        else           BRIGHT_GREEN
+        end
+      end
+
+      #
+      # Sets the text color to bright yellow.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, BRIGHT_YELLOW]
+      #   The colorized string or just {BRIGHT_YELLOW} if no arguments were
+      #   given.
+      #
+      # @see BRIGHT_YELLOW
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def bright_yellow(string=nil)
+        if string then "#{BRIGHT_YELLOW}#{string}#{RESET_FG}"
+        else           BRIGHT_YELLOW
+        end
+      end
+
+      #
+      # Sets the text color to bright blue.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, BRIGHT_BLUE]
+      #   The colorized string or just {BRIGHT_BLUE} if no arguments were given.
+      #
+      # @see BRIGHT_BLUE
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def bright_blue(string=nil)
+        if string then "#{BRIGHT_BLUE}#{string}#{RESET_FG}"
+        else           BRIGHT_BLUE
+        end
+      end
+
+      #
+      # Sets the text color to bright magenta.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, BRIGHT_MAGENTA]
+      #   The colorized string or just {BRIGHT_MAGENTA} if no arguments were
+      #   given.
+      #
+      # @see BRIGHT_MAGENTA
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def bright_magenta(string=nil)
+        if string then "#{BRIGHT_MAGENTA}#{string}#{RESET_FG}"
+        else           BRIGHT_MAGENTA
+        end
+      end
+
+      #
+      # Sets the text color to bright cyan.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, BRIGHT_CYAN]
+      #   The colorized string or just {BRIGHT_CYAN} if no arguments were given.
+      #
+      # @see BRIGHT_CYAN
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def bright_cyan(string=nil)
+        if string then "#{BRIGHT_CYAN}#{string}#{RESET_FG}"
+        else           BRIGHT_CYAN
+        end
+      end
+
+      #
+      # Sets the text color to bright white.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, BRIGHT_WHITE]
+      #   The colorized string or just {BRIGHT_WHITE} if no arguments were
+      #   given.
+      #
+      # @see BRIGHT_WHITE
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def bright_white(string=nil)
+        if string then "#{BRIGHT_WHITE}#{string}#{RESET_FG}"
+        else           BRIGHT_WHITE
+        end
+      end
+
+      #
+      # @group Background Color Methods
+      #
+
       #
       # Sets the background color to black.
       #
@@ -486,6 +769,193 @@ module CommandKit
         else           ON_WHITE
         end
       end
+
+      #
+      # Sets the background color to bright black.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BRIGHT_BLACK]
+      #   The colorized string or just {ON_BRIGHT_BLACK} if no arguments were
+      #   given.
+      #
+      # @see ON_BRIGHT_BLACK
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_bright_black(string=nil)
+        if string then "#{ON_BRIGHT_BLACK}#{string}#{RESET_BG}"
+        else           ON_BRIGHT_BLACK
+        end
+      end
+
+      #
+      # @see #on_bright_black
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_gray(string=nil)
+        on_bright_black(string)
+      end
+
+      #
+      # Sets the background color to bright red.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BRIGHT_RED]
+      #   The colorized string or just {ON_BRIGHT_RED} if no arguments were
+      #   given.
+      #
+      # @see ON_BRIGHT_RED
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_bright_red(string=nil)
+        if string then "#{ON_BRIGHT_RED}#{string}#{RESET_BG}"
+        else           ON_BRIGHT_RED
+        end
+      end
+
+      #
+      # Sets the background color to bright green.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BRIGHT_GREEN]
+      #   The colorized string or just {ON_BRIGHT_GREEN} if no arguments were
+      #   given.
+      #
+      # @see ON_BRIGHT_GREEN
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_bright_green(string=nil)
+        if string then "#{ON_BRIGHT_GREEN}#{string}#{RESET_BG}"
+        else           ON_BRIGHT_GREEN
+        end
+      end
+
+      #
+      # Sets the background color to bright yellow.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BRIGHT_YELLOW]
+      #   The colorized string or just {ON_BRIGHT_YELLOW} if no arguments were
+      #   given.
+      #
+      # @see ON_BRIGHT_YELLOW
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_bright_yellow(string=nil)
+        if string then "#{ON_BRIGHT_YELLOW}#{string}#{RESET_BG}"
+        else           ON_BRIGHT_YELLOW
+        end
+      end
+
+      #
+      # Sets the background color to bright blue.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BRIGHT_BLUE]
+      #   The colorized string or just {ON_BRIGHT_BLUE} if no arguments were
+      #   given.
+      #
+      # @see ON_BRIGHT_BLUE
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_bright_blue(string=nil)
+        if string then "#{ON_BRIGHT_BLUE}#{string}#{RESET_BG}"
+        else           ON_BRIGHT_BLUE
+        end
+      end
+
+      #
+      # Sets the background color to bright magenta.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BRIGHT_MAGENTA]
+      #   The colorized string or just {ON_BRIGHT_MAGENTA} if no arguments were
+      #   given.
+      #
+      # @see ON_BRIGHT_MAGENTA
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_bright_magenta(string=nil)
+        if string then "#{ON_BRIGHT_MAGENTA}#{string}#{RESET_BG}"
+        else           ON_BRIGHT_MAGENTA
+        end
+      end
+
+      #
+      # Sets the background color to bright cyan.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BRIGHT_CYAN]
+      #   The colorized string or just {ON_BRIGHT_CYAN} if no arguments were
+      #   given.
+      #
+      # @see ON_BRIGHT_CYAN
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_bright_cyan(string=nil)
+        if string then "#{ON_BRIGHT_CYAN}#{string}#{RESET_BG}"
+        else           ON_BRIGHT_CYAN
+        end
+      end
+
+      #
+      # Sets the background color to bright white.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BRIGHT_WHITE]
+      #   The colorized string or just {ON_BRIGHT_WHITE} if no arguments were
+      #   given.
+      #
+      # @see ON_BRIGHT_WHITE
+      #
+      # @api public
+      #
+      # @since 0.3.0
+      #
+      def on_bright_white(string=nil)
+        if string then "#{ON_BRIGHT_WHITE}#{string}#{RESET_BG}"
+        else           ON_BRIGHT_WHITE
+        end
+      end
     end
 
     #
@@ -508,8 +978,11 @@ module CommandKit
       end
 
       [
-        :bold, :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white,
-        :on_black, :on_red, :on_green, :on_yellow, :on_blue, :on_magenta, :on_cyan, :on_white
+        :bold,
+        :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white,
+        :bright_black, :gray, :bright_red, :bright_green, :bright_yellow, :bright_blue, :bright_magenta, :bright_cyan, :bright_white,
+        :on_black, :on_red, :on_green, :on_yellow, :on_blue, :on_magenta, :on_cyan, :on_white,
+        :on_bright_black, :on_gray, :on_bright_red, :on_bright_green, :on_bright_yellow, :on_bright_blue, :on_bright_magenta, :on_bright_cyan, :on_bright_white
       ].each do |name|
         define_method(name) do |string=nil|
           string || ''
@@ -525,14 +998,14 @@ module CommandKit
     # @return [Boolean]
     #
     # @note
-    #   When the env variable `TERM` is set to `dumb`, it will disable color
-    #   output. Color output will also be disabled if the given stream is not
-    #   a TTY.
+    #   When the env variable `TERM` is set to `dumb` or when the `NO_COLOR`
+    #   env variable is set, it will disable color output. Color output will
+    #   also be disabled if the given stream is not a TTY.
     #
     # @api public
     #
     def ansi?(stream=stdout)
-      env['TERM'] != 'dumb' && stream.tty?
+      env['TERM'] != 'dumb' && !env['NO_COLOR'] && stream.tty?
     end
 
     #

data/lib/command_kit/command.rb

@@ -8,8 +8,7 @@ require 'command_kit/options'
 require 'command_kit/examples'
 require 'command_kit/description'
 require 'command_kit/exception_handler'
-
-require 'fileutils'
+require 'command_kit/file_utils'
 
 module CommandKit
   #

data/lib/command_kit/edit.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'command_kit/env'
+
+module CommandKit
+  #
+  # Allows invoking the `EDITOR` environment variable.
+  #
+  # ## Environment Variables
+  #
+  # * `EDITOR` - The preferred editor command.
+  #
+  # ## Example
+  #
+  #     if options[:edit]
+  #       edit CONFIG_FILE
+  #     end
+  #
+  # @since 0.4.0
+  #
+  module Edit
+    include Env
+
+    #
+    # The `EDITOR` environment variable.
+    #
+    # @return [String]
+    #   The `EDITOR` environment variable, or `"nano"` if `EDITOR` was not set.
+    #
+    # @api semipublic
+    #
+    def editor
+      env['EDITOR'] || 'nano'
+    end
+
+    #
+    # Invokes the preferred editor with the additional arguments.
+    #
+    # @param [Array] arguments
+    #   The additional arguments to pass to the editor command.
+    #
+    # @return [Boolean, nil]
+    #   Indicates whether the editor successfully launched and exited.
+    #   If the {#editor} command was not installed, `nil` will be returned.
+    #
+    # @api public
+    #
+    def edit(*arguments)
+      if editor
+        system(editor,*arguments.map(&:to_s))
+      end
+    end
+  end
+end

data/lib/command_kit/env.rb

@@ -7,7 +7,7 @@ module CommandKit
   #     class MyCmd
   #       include CommandKit::Env
   #
-  #       def main
+  #       def run
   #         home = env['HOME']
   #         # ...
   #       end