command_kit 0.1.0 → 0.2.0

data/Rakefile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'rubygems'
 
 begin
@@ -21,3 +19,6 @@ task :default => :spec
 require 'yard'
 YARD::Rake::YardocTask.new
 task :doc => :yard
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new

data/command_kit.gemspec

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'yaml'
 
 Gem::Specification.new do |gem|
@@ -20,11 +18,13 @@ Gem::Specification.new do |gem|
   gem.authors     = Array(gemspec['authors'])
   gem.email       = gemspec['email']
   gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
   glob = lambda { |patterns| gem.files & Dir[*patterns] }
 
-  gem.files = `git ls-files`.split($/)
-  gem.files = glob[gemspec['files']] if gemspec['files']
+  gem.files = if gemspec['files'] then glob[gemspec['files']]
+              else                     `git ls-files`.split($/)
+              end
 
   gem.executables = gemspec.fetch('executables') do
     glob['bin/*'].map { |path| File.basename(path) }

data/examples/command.rb

@@ -16,7 +16,7 @@ class Command < CommandKit::Command
 
   option :output, value: {
                     type: String,
-                    usage: 'FILE',
+                    usage: 'FILE'
                   },
                   short: '-o',
                   desc: "Optional output file"

data/gemspec.yml

@@ -9,6 +9,13 @@ authors: Postmodern
 email: postmodern.mod3@gmail.com
 homepage: https://github.com/postmodern/command_kit.rb#readme
 
+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
+
+
 required_ruby_version: ">= 2.7.0"
 
 development_dependencies:

data/lib/command_kit/arguments.rb

@@ -186,7 +186,7 @@ module CommandKit
         puts
         puts 'Arguments:'
 
-        self.class.arguments.each_value do |arg|
+        arguments.each_value do |arg|
           puts "    #{arg.usage.ljust(33)}#{arg.desc}"
         end
       end

data/lib/command_kit/colors.rb

@@ -26,7 +26,7 @@ module CommandKit
   #
   # ## Alternatives
   #
-  # * [ansi](http://rubyworks.github.io/ansi/)
+  # * [ansi](https://rubyworks.github.io/ansi/)
   # * [colorize](https://github.com/fazibear/colorize#readme)
   #
   # @see https://en.wikipedia.org/wiki/ANSI_escape_code
@@ -67,7 +67,7 @@ module CommandKit
       # ANSI color code for blue
       BLUE = "\e[34m"
 
-      # ANSI color code for megenta
+      # ANSI color code for magenta
       MAGENTA = "\e[35m"
 
       # ANSI color code for cyan
@@ -79,6 +79,51 @@ module CommandKit
       # ANSI color for the default foreground color
       RESET_COLOR = "\e[39m"
 
+      # ANSI color code for background color black
+      #
+      # @since 0.2.0
+      ON_BLACK = "\e[40m"
+
+      # ANSI color code for background color red
+      #
+      # @since 0.2.0
+      ON_RED = "\e[41m"
+
+      # ANSI color code for background color green
+      #
+      # @since 0.2.0
+      ON_GREEN = "\e[42m"
+
+      # ANSI color code for background color yellow
+      #
+      # @since 0.2.0
+      ON_YELLOW = "\e[43m"
+
+      # ANSI color code for background color blue
+      #
+      # @since 0.2.0
+      ON_BLUE = "\e[44m"
+
+      # ANSI color code for background color megenta
+      #
+      # @since 0.2.0
+      ON_MAGENTA = "\e[45m"
+
+      # ANSI color code for background color cyan
+      #
+      # @since 0.2.0
+      ON_CYAN = "\e[46m"
+
+      # ANSI color code for background color white
+      #
+      # @since 0.2.0
+      ON_WHITE = "\e[47m"
+
+      # ANSI color for the default background color
+      #
+      # @since 0.2.0
+      RESET_BG = "\e[49m"
+
       module_function
 
       #
@@ -273,71 +318,202 @@ module CommandKit
         else           WHITE
         end
       end
-    end
 
-    #
-    # Dummy module with the same interface as {ANSI}, but for when ANSI is not
-    # supported.
-    #
-    module PlainText
-      RESET = \
-        CLEAR = \
-        BOLD = \
-        RESET_INTENSITY = \
-        BLACK = \
-        RED = \
-        GREEN = \
-        YELLOW = \
-        BLUE = \
-        MAGENTA = \
-        CYAN = \
-        WHITE = \
-        RESET_COLOR = ''
-
-      module_function
+      #
+      # Sets the background color to black.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BLACK]
+      #   The colorized string or just {ON_BLACK} if no arguments were given.
+      #
+      # @see ON_BLACK
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def on_black(string=nil)
+        if string then "#{ON_BLACK}#{string}#{RESET_BG}"
+        else           ON_BLACK
+        end
+      end
 
-      def reset
-        RESET
+      #
+      # Sets the background color to red.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_RED]
+      #   The colorized string or just {ON_RED} if no arguments were given.
+      #
+      # @see ON_RED
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def on_red(string=nil)
+        if string then "#{ON_RED}#{string}#{RESET_BG}"
+        else           ON_RED
+        end
       end
 
-      def clear
-        reset
+      #
+      # Sets the background color to green.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_GREEN]
+      #   The colorized string or just {ON_GREEN} if no arguments were given.
+      #
+      # @see ON_GREEN
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def on_green(string=nil)
+        if string then "#{ON_GREEN}#{string}#{RESET_BG}"
+        else           ON_GREEN
+        end
       end
 
-      def bold(string=nil)
-        string || ''
+      #
+      # Sets the background color to yellow.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_YELLOW]
+      #   The colorized string or just {ON_YELLOW} if no arguments were given.
+      #
+      # @see ON_YELLOW
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def on_yellow(string=nil)
+        if string then "#{ON_YELLOW}#{string}#{RESET_BG}"
+        else           ON_YELLOW
+        end
       end
 
-      def black(string=nil)
-        string || ''
+      #
+      # Sets the background color to blue.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_BLUE]
+      #   The colorized string or just {ON_BLUE} if no arguments were given.
+      #
+      # @see ON_BLUE
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def on_blue(string=nil)
+        if string then "#{ON_BLUE}#{string}#{RESET_BG}"
+        else           ON_BLUE
+        end
       end
 
-      def red(string=nil)
-        string || ''
+      #
+      # Sets the background color to magenta.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_MAGENTA]
+      #   The colorized string or just {ON_MAGENTA} if no arguments were given.
+      #
+      # @see ON_MAGENTA
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def on_magenta(string=nil)
+        if string then "#{ON_MAGENTA}#{string}#{RESET_BG}"
+        else           ON_MAGENTA
+        end
       end
 
-      def green(string=nil)
-        string || ''
+      #
+      # Sets the background color to cyan.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_CYAN]
+      #   The colorized string or just {ON_CYAN} if no arguments were given.
+      #
+      # @see ON_CYAN
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def on_cyan(string=nil)
+        if string then "#{ON_CYAN}#{string}#{RESET_BG}"
+        else           ON_CYAN
+        end
       end
 
-      def yellow(string=nil)
-        string || ''
+      #
+      # Sets the background color to white.
+      #
+      # @param [String, nil] string
+      #   An optional string.
+      #
+      # @return [String, ON_WHITE]
+      #   The colorized string or just {ON_WHITE} if no arguments were given.
+      #
+      # @see ON_WHITE
+      #
+      # @api public
+      #
+      # @since 0.2.0
+      #
+      def on_white(string=nil)
+        if string then "#{ON_WHITE}#{string}#{RESET_BG}"
+        else           ON_WHITE
+        end
       end
+    end
 
-      def blue(string=nil)
-        string || ''
+    #
+    # Dummy module with the same interface as {ANSI}, but for when ANSI is not
+    # supported.
+    #
+    module PlainText
+      ANSI.constants(false).each do |name|
+        const_set(name,'')
       end
 
-      def magenta(string=nil)
-        string || ''
+      module_function
+
+      def reset
+        RESET
       end
 
-      def cyan(string=nil)
-        string || ''
+      def clear
+        reset
       end
 
-      def white(string=nil)
-        string || ''
+      [
+        :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
+      ].each do |name|
+        define_method(name) do |string=nil|
+          string || ''
+        end
       end
     end
 

data/lib/command_kit/command.rb

@@ -56,7 +56,7 @@ module CommandKit
   #       end
   #     end
   #
-  # ### initialize and using ivars
+  # ### initialize and using instance variables
   #
   #     option :verbose, short: '-v', desc: "Increase verbose level" do
   #       @verbose += 1

data/lib/command_kit/commands.rb

@@ -81,10 +81,10 @@ module CommandKit
       # 
       def commands
         @commands ||= if superclass.kind_of?(ClassMethods)
-                         superclass.commands.dup
-                       else
-                         {}
-                       end
+                        superclass.commands.dup
+                      else
+                        {}
+                      end
       end
 
       #

data/lib/command_kit/help/man.rb

@@ -3,6 +3,7 @@
 require 'command_kit/command_name'
 require 'command_kit/help'
 require 'command_kit/stdio'
+require 'command_kit/man'
 
 module CommandKit
   module Help
@@ -23,6 +24,7 @@ module CommandKit
       include CommandName
       include Help
       include Stdio
+      include CommandKit::Man
 
       #
       # @api private
@@ -96,29 +98,6 @@ module CommandKit
         end
       end
 
-      #
-      # Displays the given man page.
-      #
-      # @param [String] page
-      #   The man page file name.
-      #
-      # @param [Integer, String, nil] section
-      #   The optional section number to specify.
-      #
-      # @return [Boolean, nil]
-      #   Specifies whether the `man` command was successful or not.
-      #   Returns `nil` when the `man` command is not installed.
-      #
-      # @api public
-      #
-      def man(page, section: nil)
-        if section
-          system('man',section.to_s,page.to_s)
-        else
-          system('man',page.to_s)
-        end
-      end
-
       #
       # Provides help information by showing one of the man pages within
       # {ClassMethods#man_dir .man_dir}.
@@ -153,8 +132,8 @@ module CommandKit
       #   {ClassMethods#man_dir .man_dir} does not have a value.
       #
       # @note
-      #   if `TERM` is `dumb` or `$stdout` is not a TTY, fallsback to printing
-      #   the usual `--help` output.
+      #   if `TERM` is `dumb` or `$stdout` is not a TTY, will fall back to
+      #   printing the usual `--help` output.
       #
       # @api public
       #