nub 0.0.54 → 0.0.55

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00de24079eb9ea5d62262d9453e4bb8745a004fec49d0c300bd8b01a430e4589
-  data.tar.gz: f1c7b1a86cb4637a80b48814193305b2c7a27fb50a46b7ac35ff22cb952e1b52
+  metadata.gz: d6492bcf60374552fe23049d74396793bccae8f0e11ed9521d58feb19bc592da
+  data.tar.gz: 1113ee70f0fdef09151c7551c840dec18142af299efc7938050f49e3579e714b
 SHA512:
-  metadata.gz: 3b86079c3a02cf90b74d9db8ff3240f9d261c4ab5671af4d068e76686a45ac50682265d69bb04eb82aaee3e9c49739afe76462a19a3a08c139a03edbde992585
-  data.tar.gz: 2093bb7ee390f121324b39ab66beb74f8a8fd5c7baa45ff9671a26459e785f937203e03d80c278d744b4340db2fe27e242d9322d893e112f7198c15c596902b1
+  metadata.gz: ab873f93ede81f44697af52730f61035503a0290769f132f22118567096c1910b94a4adcd4c77b657bb68167dc6303a52bda1f6ab06b1d23be1e5f5bf1b4cc28
+  data.tar.gz: 39fe7de14e98f37b1f2d224691c801aed3c27ff44731595bc0c72a76255a2e3f847b86e6f29a7e0632c75f028860fc61bf602ce4b58de9f8f09c54e3f81885bb

data/README.md

@@ -38,23 +38,25 @@ have their own help to display their usage and available options.
 
 ### Commands <a name="commands"></a>
 Commands are defined via configuration as key words that trigger different branches of functionality
-for the application. Each command may have zero or more sub commands, each of which follow the same 
-rules in a recursive fashion. Each command may have zero or more options that modify how this 
-behavior is invoked. Whenever more than one command is used in the command line expression the 
-expression is interpreted as being a ***chained command expression***. Chained command expressions 
-are executed left to right, such that you can execute the ***clean*** command then the ***build*** 
-command or more in a single command line expression. Each command in a chained command expression 
-may have its own specific options (those coming after the command but before the next command) or if 
-options are omitted the required options from the next command will be used. The chained command 
-options syntax allows one to have a cleaner multi-command line expression with reusable options. 
-Options are said to apply in a chained command syntax when they are of the same type and position in 
-the positional case or same type and name in the named case.
+for the application. Each command may have zero or more options that modify how this behaveior is
+invoked. Whenever more than one command is used in the command line expression the expression is
+interpreted as being a ***chained command expression***. Chained command expressions are executed
+left to right, such that you can execute the ***clean*** command then the ***build*** command or
+more in a single command line expression. Each command in a chained command expression may have its
+own specific options (those coming after the command but before the next command) or if options are
+omitted the required options from the next command will be used. The chained command options syntax
+allows one to have a cleaner multi-command line expression with reusable options. Options are said
+to apply in a chained command syntax when they are of the same type and position in the positional
+case or same type and name in the named case.
 
 ***Global*** options are options that are added with the ***add_global*** function and will show up
 set in the command results using the ***:global*** symbol. Global positional options must be given
 before any other commands but global named options may appear anywhere in the command line
 expression.
 
+***Shared*** options are options that are added with the command ***add_shared*** function. They
+should be added before any commands are added. They are added to each command as an explicit option.
+
 ***Commander.new*** must be run from the app's executable file for it to pick up the app's filename
 properly.
 

data/lib/nub/commander.rb

@@ -34,6 +34,7 @@ class Option
   attr_reader(:type)
   attr_accessor(:allowed)
   attr_accessor(:required)
+  attr_accessor(:shared)
 
   # Create a new option instance
   # @param key [String] option short hand, long hand and hint e.g. -s|--skip=COMPONENTS
@@ -46,12 +47,13 @@ class Option
     @long = nil
     @short = nil
     @desc = desc
+    @shared = false
     @allowed = allowed || []
     @required = required || false
 
     # Parse the key into its components (short hand, long hand, and hint)
     #https://bneijt.nl/pr/ruby-regular-expressions/
-    # Valid forms to look for with chars [a-zA-Z0-9-_=|]
+    # Valid forms to look for with chars [a-zA-Z0-9-_=|] 
     # --help, --help=HINT, -h|--help, -h|--help=HINT
     Log.die("invalid option key #{key}") if key && (key.count('=') > 1 or key.count('|') > 1 or !key[/[^\w\-=|]/].nil? or
       key[/(^--[a-zA-Z0-9\-_]+$)|(^--[a-zA-Z\-_]+=\w+$)|(^-[a-zA-Z]\|--[a-zA-Z0-9\-_]+$)|(^-[a-zA-Z]\|--[a-zA-Z0-9\-_]+=\w+$)/].nil?)
@@ -87,7 +89,7 @@ class Commander
   attr_reader(:banner)
   attr_accessor(:cmds)
 
-  Command = Struct.new(:name, :desc, :nodes, :help)
+  Command = Struct.new(:name, :desc, :opts, :help)
 
   # Initialize the commands for your application
   # @param app [String] application name e.g. reduce
@@ -112,6 +114,9 @@ class Commander
     # Configuration - ordered list of commands
     @config = []
 
+    # List of options that will be added to all commands
+    @shared = []
+
     # Configure default global options
     add_global(Option.new('-h|--help', 'Print command/options help'))
   end
@@ -129,39 +134,46 @@ class Commander
   # Add a command to the command list
   # @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 opts [List] list of command options
+  def add(cmd, desc, options:[])
     Log.die("'global' is a reserved command name") if cmd == 'global'
+    Log.die("'shared' is a reserved command name") if cmd == 'shared'
     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')}
-    Log.die("command names must be pure lowercase letters") if cmd =~ /[^a-z]/
+    Log.die("'help' is a reserved option name") if options.any?{|x| !x.key.nil? && x.key.include?('help')}
 
-    # Validate sub command key words
-    validate_sub_cmd = ->(sub_cmd){
-      Log.die("'global' is a reserved command name") if sub_cmd.name == 'global'
-      Log.die("'help' is a reserved option name") if sub_cmd.nodes.any?{|x| x.class == Option && !x.key.nil? && x.key.include?('help')}
-      Log.die("command names must be pure lowercase letters") if sub_cmd.name =~ /[^a-z]/
-      sub_cmd.nodes.select{|x| x.class != Option}.each{|x| validate_sub_cmd.(x)}
-    }
-    nodes.select{|x| x.class != Option}.each{|x| validate_sub_cmd.(x)}
+    # Add shared options
+    @shared.each{|x| options.unshift(x)}
 
-    @config << add_cmd(cmd, desc, nodes)
+    cmd = add_cmd(cmd, desc, options)
+    @config << cmd
   end
 
   # Add global options (any option coming before all commands)
   # @param option/s [Array/Option] array or single option/s
   def add_global(options)
-    options = [options] if options.class != Array
-    Log.die("only options are allowed as globals") if options.any?{|x| x.class != Option}
+    options = [options] if options.class == Option
 
     # Aggregate global options
     if (global = @config.find{|x| x.name == 'global'})
-      global.nodes.each{|x| options << x}
+      global.opts.each{|x| options << x}
       @config.reject!{|x| x.name == 'global'}
     end
     @config << add_cmd('global', 'Global options:', options)
   end
 
+  # Add shared option (options that are added to all commands)
+  # @param option/s [Array/Option] array or single option/s
+  def add_shared(options)
+    options = [options] if options.class == Option
+    options.each{|x|
+      Log.die("duplicate shared option '#{x.desc}' given") if @shared
+        .any?{|y| y.key == x.key && y.desc == x.desc && y.type == x.type}
+      x.shared = true
+      x.required = true
+      @shared << x
+    }
+  end
+
   # Returns banner string
   # @return [String] the app's banner
   def banner
@@ -194,7 +206,7 @@ class Commander
 
     # Set help if nothing was given
     ARGV.clear and ARGV << '-h' if ARGV.empty?
-
+    
     # Process command options
     #---------------------------------------------------------------------------
     order_globals!
@@ -209,7 +221,7 @@ class Commander
         # Collect command options from args to compare against
         opts = ARGV.take_while{|x| !cmd_names.include?(x) }
         ARGV.shift(opts.size)
-
+ 
         # Handle help upfront before anything else
         if opts.any?{|x| m = match_named(x, cmd); m.hit? && m.sym == :help }
           !puts(help) and exit if cmd.name == 'global'
@@ -217,8 +229,8 @@ class Commander
         end
 
         # Check that all required options were given
-        cmd_pos_opts = cmd.nodes.select{|x| x.key.nil? }
-        cmd_named_opts = cmd.nodes.select{|x| !x.key.nil? }
+        cmd_pos_opts = cmd.opts.select{|x| x.key.nil? }
+        cmd_named_opts = cmd.opts.select{|x| !x.key.nil? }
 
         !puts("Error: positional option required!".colorize(:red)) && !puts(cmd.help) and
           exit if opts.select{|x| !x.start_with?('-')}.size < cmd_pos_opts.select{|x| x.required}.size
@@ -266,12 +278,18 @@ class Commander
           # --------------------------------------------------------------------
           !puts("Error: unknown named option '#{opt}' given!".colorize(:red)) && !puts(cmd.help) and exit if !sym
           @cmds[cmd.name.to_sym][sym] = value
+          if cmd_opt.shared
+            sym = "shared#{pos}".to_sym if cmd_opt.key.nil?
+            @cmds[:shared] = {} if !@cmds.key?(:shared)
+            @cmds[:shared][sym] = value
+          end
         }
       end
     }
 
-    # Ensure specials (global) are always set
+    # Ensure specials (global, shared) are always set
     @cmds[:global] = {} if !@cmds[:global]
+    @cmds[:shared] = {} if !@cmds[:shared]
 
     # Ensure all options were consumed
     Log.die("invalid options #{ARGV}") if ARGV.any?
@@ -335,13 +353,13 @@ class Commander
     args = ARGV[0..-1]
     results = {}
     cmd_names = @config.map{|x| x.name }
-
+    
     chained = []
     while args.any? do
       if !(cmd = @config.find{|x| x.name == args.first}).nil?
         results[args.shift] = []                            # Add the command to the results
         cmd_names.reject!{|x| x == cmd.name}                # Remove command from possible commands
-        cmd_required = cmd.nodes.select{|x| x.required}
+        cmd_required = cmd.opts.select{|x| x.required}
 
         # Collect command options from args to compare against
         opts = args.take_while{|x| !cmd_names.include?(x)}
@@ -351,7 +369,7 @@ class Commander
         results[cmd.name].concat(opts) and next if cmd.name == 'global'
 
         # Chained case is when no options are given but some are required
-        if opts.size == 0 && cmd.nodes.any?{|x| x.required}
+        if opts.size == 0 && cmd.opts.any?{|x| x.required}
           chained << cmd
         else
           # Add cmd with options
@@ -359,7 +377,7 @@ class Commander
 
           # Check chained cmds against current cmd
           chained.each{|x|
-            other_required = x.nodes.select{|x| x.required}
+            other_required = x.opts.select{|x| x.required}
             !puts("Error: chained commands must satisfy required options!".colorize(:red)) && !puts(x.help) and
               exit if cmd_required.size < other_required.size
             other_required.each_with_index{|y,i|
@@ -382,7 +400,7 @@ class Commander
   # @return [OptionMatch]] struct with some helper functions
   def match_named(opt, cmd)
     match = OptionMatch.new(opt)
-    cmd_named_opts = cmd.nodes.select{|x| !x.key.nil? }
+    cmd_named_opts = cmd.opts.select{|x| !x.key.nil? }
 
     if opt.start_with?('-')
       short = opt[@short_regex, 1]
@@ -434,26 +452,25 @@ class Commander
   # Add a command to the command list
   # @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)
+  # @param opts [List] list of command options
   # @return [Command] new command
-  def add_cmd(cmd, desc, nodes)
-    #nodes.select{|x| x.class != Option}.each{|x| validate_sub_cmd.(x)}
+  def add_cmd(cmd, desc, options)
+    Log.die("command names must be pure lowercase letters") if cmd =~ /[^a-z]/
 
     # Build help for command
-    #---------------------------------------------------------------------------
     app = @app || @app_default
     help = "#{desc}\n"
     help += "\nUsage: ./#{app} #{cmd} [options]\n" if cmd != 'global'
     help = "#{banner}\n#{help}" if @app && cmd != 'global'
 
     # Add help option if not global command
-    nodes << @config.find{|x| x.name == 'global'}.nodes.find{|x| x.long == '--help'} if cmd != 'global'
+    options << @config.find{|x| x.name == 'global'}.opts.find{|x| x.long == '--help'} if cmd != 'global'
 
     # Add positional options first
-    sorted_options = nodes.select{|x| x.key.nil?}
-    sorted_options += nodes.select{|x| !x.key.nil?}.sort{|x,y| x.key <=> y.key}
+    sorted_options = options.select{|x| x.key.nil?}
+    sorted_options += options.select{|x| !x.key.nil?}.sort{|x,y| x.key <=> y.key}
     positional_index = -1
-    sorted_options.each{|x|
+    sorted_options.each{|x| 
       required = x.required ? ", Required" : ""
       allowed = x.allowed.empty? ? "" : " (#{x.allowed * ','})"
       positional_index += 1 if x.key.nil?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nub
 version: !ruby/object:Gem::Version
-  version: 0.0.54
+  version: 0.0.55
 platform: ruby
 authors:
 - Patrick Crummett