nub 0.0.67 → 0.0.69

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3df7ecdb78ebe134cdc50b183cd9c70ffd0ac21e9ebfed9a6b0b315a93ce2089
-  data.tar.gz: 5066c0edf1c3bae95d7d38c07ba215de19123bce35b0b833e1202953e4afbe1b
+  metadata.gz: d84be2ede441cb3107962c1c895223d490172d7c6fba52c8c0d3b2a12229694e
+  data.tar.gz: 7efb787247ca60748e5584806e7300922daa2cd9e646bfad300061174711c9f4
 SHA512:
-  metadata.gz: 37715e0e876c66e1cb081f05a111dbb814e00571017fa970664703c38a2e734a4fadf7a1f87bc27b3c7aa5f9522f12085121b6e5abd292770c71df1d0ccc8c53
-  data.tar.gz: f4376f093fc3d1b7ab3e9b35119346a859331e40a66567ac0f32aa72048bcfb91cc7178c47decd338314ac6025b8ce965658aab92929222e4d287a1c54268f98
+  metadata.gz: cf4a3b69649a686a27998c4fd249243b7a4394d4d574cf55814560ac71e06a7cae6b96d5897182d90a9ee9ef9be5b791dc22e00e982092970658259051e4c574
+  data.tar.gz: 154b85284a4aeb66f9ebaec6c90ed4287882be46be1de41eeacc85bcb1a91be6430c182d1175fd3d29f669aa15127dc9ae4f28ab8c5ee5fc1bddba8156275408

data/lib/nub/commander.rb

@@ -103,15 +103,18 @@ class Command
   attr_reader(:desc)
   attr_accessor(:nodes)
   attr_accessor(:help)
+  attr_accessor(:examples)
 
   # Create a new command
   # @param name [String] command name used on command line
   # @param desc [String] the command's description
   # @param nodes [String] the command's description
-  def initialize(name, desc, nodes:[])
+  # @param examples [String] the command's examples
+  def initialize(name, desc, nodes:[], examples:nil)
     @name = name
     @desc = desc
     @nodes = nodes
+    @examples = examples
     @help = ""
   end
 
@@ -184,7 +187,8 @@ class Commander
   # @param cmd [String] name of the command
   # @param desc [String] description of the command
   # @param nodes [List] list of command nodes (i.e. options or commands)
-  def add(cmd, desc, nodes:[])
+  # @param examples [String] the command's examples
+  def add(cmd, desc, nodes:[], examples:nil)
     Log.die("'#{@k.global}' is a reserved command name") if cmd == @k.global
     Log.die("'#{cmd}' already exists") if @config.any?{|x| x.name == cmd}
     Log.die("'help' is a reserved option name") if nodes.any?{|x| x.class == Option && !x.key.nil? && x.key.include?('help')}
@@ -200,7 +204,7 @@ class Commander
     }
     nodes.select{|x| x.class != Option}.each{|x| validate_subcmd.(x)}
 
-    @config << add_cmd(cmd, desc, nodes)
+    @config << add_cmd(cmd, desc, nodes, examples:examples)
   end
 
   # Add global options (any option coming before all commands)
@@ -600,14 +604,18 @@ class Commander
   # @param nodes [Array] list of command nodes (i.e. options or commands)
   # @param hierarchy [Array] list of commands
   # @return [Command] new command
-  def add_cmd(name, desc, nodes, hierarchy:[])
+  def add_cmd(name, desc, nodes, examples:nil, hierarchy:[])
     hierarchy << name
-    cmd = Command.new(name, desc)
+    cmd = Command.new(name, desc, examples:examples)
     subcmds = nodes.select{|x| x.class == Command}.sort{|x,y| x.name <=> y.name}
 
     # Build help for command
     #---------------------------------------------------------------------------
     cmd.help = "#{desc}\n"
+    if !cmd.examples.nil? && !cmd.examples.empty?
+      newline = cmd.examples.strip_color[-1] != "\n" ? "\n" : ""
+      cmd.help += "Examples:\n#{cmd.examples.colorize(:green)}#{newline}"
+    end
     app = @app || @app_default
     cmd_prompt = subcmds.any? ? "[commands] " : ""
     cmd.help += "\nUsage: ./#{app} #{hierarchy * ' '} #{cmd_prompt}[options]\n" if name != @k.global
@@ -644,7 +652,7 @@ class Commander
     cmd.help += "\nsee './#{app} #{name} COMMAND --help' for specific command help\n" if subcmds.any?
 
     # Configure help for each sub command
-    subcmds.each{|x| cmd.nodes << add_cmd(x.name, x.desc, x.nodes, hierarchy:hierarchy)}
+    subcmds.each{|x| cmd.nodes << add_cmd(x.name, x.desc, x.nodes, examples:x.examples, hierarchy:hierarchy)}
 
     # Add options after any sub-commands
     cmd.nodes += sorted_options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nub
 version: !ruby/object:Gem::Version
-  version: 0.0.67
+  version: 0.0.69
 platform: ruby
 authors:
 - Patrick Crummett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Collection of useful utilities