nub 0.0.51 → 0.0.52

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c58496cf243b60e9ca662e07c1e8c30a0dba10bb6cd290d748df9b9f93d7897b
-  data.tar.gz: 5a918972eb7de66173b9c2ec31eccb396804a900d2cf3b25cb9b3c046e863256
+  metadata.gz: dbb6012caafc7ba2ef97052b8f8577ab631565d7b5964e111f2a02b52139c092
+  data.tar.gz: 29895378b9e02eae31af58d792c36406fbee2cc5759ab84dca4ede07bf7015d8
 SHA512:
-  metadata.gz: 4eefd3a45e934ebc542d862ab1e867c3e88d8eb3f07fa5de50d525e305cb22e594027ba9523c280480ceaa37c62fe4021d2a4d820edcf8001ff8f49cb1dfa7e6
-  data.tar.gz: 53ae4e3e35ef1c7d496539bb2fb4649b79c021a663bddc6411d671ee10ea10ed9ed7af62f1152597ecdd97792f1bc9ea78e495871426bc1592acb607014635b4
+  metadata.gz: 2274e48efc5268a48fb3690fa0e85d487dbe69516160bd34fee2f76d10557ba72a1d8fdb42255846b14b1186df0ade53fa51cccec05abf093de17b1ed25964f0
+  data.tar.gz: 8c74aa5a469e44d0e710143ea3f553cf8d44133dfffc0129d0ccd18ccd4cf2029b2af4b512dae512ec35593a953e4f56bd8d4d6109db65ce0d46a8452a563211

data/README.md

@@ -46,15 +46,16 @@ more in a single command line expression. Each command in a chained command expr
 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 in the positional case or same
-type and name in the named case.
+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 commands results using the ***:global*** symbol. Global options are given on the command
-line before anything else in the case of positional, but anywhere in the case of named.
+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 before
-any commands and are added to all commands.
+***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.
@@ -100,14 +101,15 @@ Example command line expressions:
 ### Options <a name="options"></a>
 There are two kinds of options available for use, ***positional*** and ***named***. Positional
 options are identified by the absence of preceding dash/dashes and interpreted according to the
-order in which they were found. Positional options are a value being passed into the application.
-Named options have a name that is prefixed with a dash (short hand) or two dashes (long hand) e.g.
-***-h*** or ***--help*** and may simply be a flag or pass in a value. Option values require a
-***type*** so that Commander can interpret how to use them. The supported value types are
-***Flag, Integer, String, Array***. Values may be checked or not checked via the ***allowed***
-config param. Positional options default to type String while named options default to type Flag.
-Positional options are named internally with the command concatted with a an int for order ***e.g.
-clean0*** zero based. Positional params are always required.
+order and number in which they were found. Positional options are a value being passed into the
+application.  Named options have a name that is prefixed with a dash (short hand) or two dashes
+(long hand) e.g.  ***-h*** or ***--help*** and may simply be a flag or pass in a value. Option
+values require a ***type*** so that Commander can interpret how to use them. The supported value
+types are ***Flag, Integer, String, Array***. Values may be checked or not checked via the
+***allowed*** config param. Positional options default to type String while named options default to
+type Flag.  Positional options are named internally with the command concatted with a an int for
+order ***e.g.  clean0*** zero based. Positional options are given sequentially so you can't
+skip one and specify the second, it must be one then two etc...
 
 **Long Hand** form is always required for named options, short hand may or may not be given.
 

data/lib/nub/commander.rb

@@ -32,8 +32,8 @@ class Option
   attr_reader(:hint)
   attr_reader(:desc)
   attr_reader(:type)
-  attr_reader(:allowed)
-  attr_reader(:required)
+  attr_accessor(:allowed)
+  attr_accessor(:required)
   attr_accessor(:shared)
 
   # Create a new option instance
@@ -62,9 +62,6 @@ class Option
       @hint = key[/.*=(.*)$/, 1]
       @short = key[/^(-\w).*$/, 1]
       @long = key[/(--[\w\-]+)(=.+)*$/, 1]
-    else
-      # Always require positional options
-      @required = true
     end
 
     # Validate and set type
@@ -74,6 +71,9 @@ class Option
     @type = FalseClass if key and !type
     @type = type if type
 
+    # Validate hint is given for non flags
+    Log.die("option hint must be set") if @key && !@hint && @type != FalseClass
+
     # Validate allowed
     if @allowed.any?
       allowed_type = @allowed.first.class
@@ -169,6 +169,7 @@ class Commander
       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
@@ -209,51 +210,25 @@ class Commander
     # Process command options
     #---------------------------------------------------------------------------
     order_globals!
+    expand_chained_options!
     loop {
       break if ARGV.first.nil?
 
       if !(cmd = @config.find{|x| x.name == ARGV.first}).nil?
-        @cmds[ARGV.shift.to_sym] = {}
-        cmd_names.reject!{|x| x == cmd.name}
-
-        # Command options as defined in configuration
-        cmd_pos_opts = cmd.opts.select{|x| x.key.nil? }
-        cmd_named_opts = cmd.opts.select{|x| !x.key.nil? }
+        @cmds[ARGV.shift.to_sym] = {}             # Create command results entry
+        cmd_names.reject!{|x| x == cmd.name}      # Remove command from possible commands
 
         # Collect command options from args to compare against
         opts = ARGV.take_while{|x| !cmd_names.include?(x) }
         ARGV.shift(opts.size)
+ 
+        # Check that all required options were given
+        cmd_pos_opts = cmd.opts.select{|x| x.key.nil? }
+        cmd_named_opts = cmd.opts.select{|x| !x.key.nil? }
 
-        # All positional options are required. If they are not given then check for the 'chained
-        # command expression' case for positional options in the next command that satisfy the
-        # previous command's requirements and so on and so forth.
-        if opts.size == 0 && (cmd_pos_opts.any? || cmd_named_opts.any?{|x| x.required})
-          i = 0
-          while (i += 1) < ARGV.size do
-            opts = ARGV[i..-1].take_while{|x| !cmd_names.include?(x) }
-            break if opts.any? 
-          end
-
-          # Check that the chained command options at least match types and size
-          if opts.any?
-            cmd_required = cmd.opts.select{|x| x.key.nil? || x.required}
-            other = @config.find{|x| x.name == ARGV[i-1]}
-            other_required = other.opts.select{|x| x.key.nil? || x.required}
-
-            !puts("Error: chained commands must have equal numbers of required options!".colorize(:red)) && !puts(cmd.help) and
-              exit if cmd_required.size != other_required.size
-            cmd_required.each_with_index{|x,i|
-              !puts("Error: chained command options are not type consistent!".colorize(:red)) && !puts(cmd.help) and
-                exit if x.type != other_required[i].type || x.key != other_required[i].key
-            }
-          end
-        end
-
-        # Check that all positional options were given
         !puts("Error: positional option required!".colorize(:red)) && !puts(cmd.help) and
-          exit if opts.size < cmd_pos_opts.size
+          exit if opts.select{|x| !x.start_with?('-')}.size < cmd_pos_opts.select{|x| x.required}.size
 
-        # Check that all required named options where given
         named_opts = opts.select{|x| x.start_with?('-')}
         cmd_named_opts.select{|x| x.required}.each{|x|
           !puts("Error: required option #{x.key} not given!".colorize(:red)) && !puts(cmd.help) and
@@ -369,6 +344,52 @@ class Commander
     end
   end
 
+  # Find chained options, copy and insert as needed.
+  # Globals should have already been ordered before calling this function
+  # Fail if validation doesn't pass
+  def expand_chained_options!
+    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.opts.select{|x| x.required}
+
+        # Collect command options from args to compare against
+        opts = args.take_while{|x| !cmd_names.include?(x)}
+        args.shift(opts.size)
+
+        # Globals are not to be considered for chaining
+        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.opts.any?{|x| x.required}
+          chained << cmd
+        else
+          results[cmd.name].concat(opts)
+
+          chained.each{|x|
+            other_required = x.opts.select{|x| x.required}
+            !puts("Error: chained commands must have equal numbers of required options!".colorize(:red)) && !puts(x.help) and
+              exit if cmd_required.size != other_required.size
+            cmd_required.each_with_index{|y,i|
+              !puts("Error: chained command options are not type consistent!".colorize(:red)) && !puts(x.help) and
+                exit if y.type != other_required[i].type || y.key != other_required[i].key
+            }
+            results[x.name].concat(opts)
+          }
+        end
+      end
+    end
+
+    # Set results as new ARGV command line expression
+    ARGV.clear and results.each{|k, v| ARGV << k; ARGV.concat(v)}
+  end
+
   # Match the given command line arg with a configured named option
   # @param opt [String] the command line argument given
   # @param cmd [Command] configured command to match against

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nub
 version: !ruby/object:Gem::Version
-  version: 0.0.51
+  version: 0.0.52
 platform: ruby
 authors:
 - Patrick Crummett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize