nub 0.0.43 → 0.0.44

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e9121a0f51826a76f7c76172ad12a543fdc1ed177e2faafd226c4748ee1c55
-  data.tar.gz: b2d67cc335778e825742b6d9778026e47c07a166243b0a0909b6c5318f740812
+  metadata.gz: e625dfb52c0c38897732f0cf25ff675663f18c6db457485f7e8714badb74f9e1
+  data.tar.gz: 89b640564741b907642fe67aa50ff36a003f7963a4401d5964ced50933f06178
 SHA512:
-  metadata.gz: 1cc75cd89bf288b25b600f4a1f922dd4e8af61cc12c77c61ae798bfb0d20ca2dccc6712cb7ba6d3ca70cea4fd8685519e254f539ef177d893c12a1c3350ae6e0
-  data.tar.gz: b910fb8b96b7475db9d7d1b691eb118ee27220f78a0647cecea89c221ba3b29c92630f3058cf435abc70a586e6fc472aef73866890f643af9598533fda6f39b1
+  metadata.gz: 78e202387517087c8c2daee6d44616fd8dbb507a352663f60c3e4d8975513c4ea0ed1778748fa10b233bebb7ea185c722a8b2edca808fccbc5e205bee4f9b445
+  data.tar.gz: eb7d0bbf9bc53ec9d4fdd5941a854c1a9160ffb37253db98124ac8989522468d6418b889087e82c94f64a6b8b2bc4f7e4e9ffe4ec0d51a497d81ce0757e03c9b

data/lib/nub/commander.rb

@@ -20,6 +20,7 @@
 #SOFTWARE.
 
 require 'colorize'
+require_relative 'log'
 require_relative 'sys'
 require_relative 'string'
 
@@ -52,9 +53,8 @@ class Option
     #https://bneijt.nl/pr/ruby-regular-expressions/
     # Valid forms to look for with chars [a-zA-Z0-9-_=|] 
     # --help, --help=HINT, -h|--help, -h|--help=HINT
-    !puts("Error: invalid option key #{key}".colorize(:red)) and
-      exit 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?)
+    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?)
     @key = key
     if key
       @hint = key[/.*=(.*)$/, 1]
@@ -66,10 +66,8 @@ class Option
     end
 
     # Validate and set type
-    !puts("Error: invalid option type #{type}".colorize(:red)) and
-      exit if ![String, Integer, Array, nil].any?{|x| type == x}
-    !puts("Error: option type must be set".colorize(:red)) and
-      exit if @hint && !type
+    Log.die("invalid option type #{type}") if ![String, Integer, Array, nil].any?{|x| type == x}
+    Log.die("option type must be set") if @hint && !type
     @type = String if !key && !type
     @type = FalseClass if key and !type
     @type = type if type
@@ -77,8 +75,7 @@ class Option
     # Validate allowed
     if @allowed.any?
       allowed_type = @allowed.first.class
-      !puts("Error: mixed allowed types".colorize(:red)) and
-        exit if @allowed.any?{|x| x.class != allowed_type}
+      Log.die("mixed allowed types") if @allowed.any?{|x| x.class != allowed_type}
     end
   end
 end
@@ -101,15 +98,22 @@ class Commander
     @app_default = Sys.caller_filename
     @version = version
     @examples = examples
-    @help_opt = Option.new('-h|--help', 'Print command/options help')
     @just = 40
 
-    # Configuration - ordered list of commands
-    @config = []
+    # Regexps
+    @short_regex = /^(-\w).*$/
+    @long_regex = /(--[\w\-]+)(=.+)*$/
+    @value_regex = /.*=(.*)$/
 
     # Incoming user set commands/options
     # {command_name => {}}
     @cmds = {}
+
+    # Configuration - ordered list of commands
+    @config = []
+
+    # Configure default global options
+    add_global(Option.new('-h|--help', 'Print command/options help'))
   end
 
   # Hash like accessor for checking if a command or option is set
@@ -122,30 +126,25 @@ class Commander
   # @param desc [String] description of the command
   # @param opts [List] list of command options
   def add(cmd, desc, options:[])
-    !puts("Error: command names must be pure lowercase letters".colorize(:red)) and
-      exit if cmd =~ /[^a-z]/
+    Log.die("'global' is a reserved command name") if cmd == 'global'
+    Log.die("'help' is a reserved option name") if options.any?{|x| !x.key.nil? && x.key.include?('help')}
 
-    # Build help for command
-    app = @app || @app_default
-    help = "#{desc}\n\nUsage: ./#{app} #{cmd} [options]\n"
-    help = "#{banner}\n#{help}" if @app
-    options << @help_opt
+    cmd = add_cmd(cmd, desc, options)
+    @config << cmd
+  end
 
-    # Add positional options first
-    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| 
-      required = x.required ? ", Required" : ""
-      allowed = x.allowed.empty? ? "" : " (#{x.allowed * ','})"
-      positional_index += 1 if x.key.nil?
-      key = x.key.nil? ? "#{cmd}#{positional_index}" : x.key
-      type = x.type == FalseClass ? "Flag" : x.type
-      help += "    #{key.ljust(@just)}#{x.desc}#{allowed}: #{type}#{required}\n"
-    }
+  # Add global options
+  # @param option/s [Array/Option] array or single option/s
+  def add_global(options)
+    options = [options] if options.class == Option
+    Log.die("only named global options are allowed") if options.any?{|x| x.key.nil?}
 
-    # Create the command in the command config
-    @config << Command.new(cmd, desc, sorted_options, help)
+    # Process the global options, removed the old ones and add new ones
+    if (global = @config.find{|x| x.name == 'global'})
+      global.opts.each{|x| options << x}
+      @config.reject!{|x| x.name == 'global'}
+    end
+    @config << add_cmd('global', 'Global options:', options)
   end
 
   # Returns banner string
@@ -166,9 +165,9 @@ class Commander
     end
     app = @app || @app_default
     help += "Usage: ./#{app} [commands] [options]\n"
-    help += "    #{'-h|--help'.ljust(@just)}Print command/options help: Flag\n"
+    help += @config.find{|x| x.name == 'global'}.help
     help += "COMMANDS:\n"
-    @config.each{|x| help += "    #{x.name.ljust(@just)}#{x.desc}\n" }
+    @config.select{|x| x.name != 'global'}.each{|x| help += "    #{x.name.ljust(@just)}#{x.desc}\n" }
     help += "\nsee './#{app} COMMAND --help' for specific command help\n"
 
     return help
@@ -183,8 +182,7 @@ class Commander
     # Process global options
     #---------------------------------------------------------------------------
     cmd_names = @config.map{|x| x.name }
-    globals = ARGV.take_while{|x| !cmd_names.include?(x)}
-    !puts(help) and exit if globals.any?
+    ARGV.unshift('global') if ARGV.take_while{|x| !cmd_names.include?(x)}.any?
     
     # Process command options
     #---------------------------------------------------------------------------
@@ -219,23 +217,23 @@ class Commander
             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 optiosn".colorize(:red)) && !puts(cmd.help) and
+            !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
+              !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
+        !puts("Error: positional option required!".colorize(:red)) && !puts(cmd.help) and
           exit if opts.size < cmd_pos_opts.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
+          !puts("Error: required option #{x.key} not given!".colorize(:red)) && !puts(cmd.help) and
             exit if !named_opts.find{|y| y.start_with?(x.short) || y.start_with?(x.long)}
         }
 
@@ -252,14 +250,18 @@ class Commander
           # --------------------------------------------------------------------
           # e.g. -s, --skip, --skip=VALUE
           if opt.start_with?('-')
-            short = opt[/^(-\w).*$/, 1]
-            long = opt[/(--[\w\-]+)(=.+)*$/, 1]
-            value = opt[/.*=(.*)$/, 1]
+            short = opt[@short_regex, 1]
+            long = opt[@long_regex, 1]
+            value = opt[@value_regex, 1]
 
             # Set symbol converting dashes to underscores for named options
             if (cmd_opt = cmd_named_opts.find{|x| x.short == short || x.long == long})
               sym = cmd_opt.long[2..-1].gsub("-", "_").to_sym
 
+              # Handle help for the command
+              !puts(help) and exit if cmd.name == 'global' && sym == :help
+              !puts(cmd.help) and exit if sym == :help
+
               # Collect value
               if cmd_opt.type == FalseClass
                 value = true if !value
@@ -273,8 +275,8 @@ class Commander
           else
             pos += 1
             cmd_opt = cmd_pos_opts.shift
-            !puts("Error: invalid positional option '#{opt}'".colorize(:red)) && !puts(cmd.help) and
-              exit if cmd_opt.nil?
+            !puts("Error: invalid positional option '#{opt}'!".colorize(:red)) && !puts(cmd.help) and
+              !puts("START:#{ARGV}:END") and exit if cmd_opt.nil?
             value = opt
             sym = "#{cmd.name}#{pos}".to_sym
           end
@@ -284,20 +286,20 @@ class Commander
           if value
             if cmd_opt.type == String
               if cmd_opt.allowed.any?
-                !puts("Error: invalid string value '#{value}'".colorize(:red)) && !puts(cmd.help) and
+                !puts("Error: invalid string value '#{value}'!".colorize(:red)) && !puts(cmd.help) and
                   exit if !cmd_opt.allowed.include?(value)
               end
             elsif cmd_opt.type == Integer
               value = value.to_i
               if cmd_opt.allowed.any?
-                !puts("Error: invalid integer value '#{value}'".colorize(:red)) && !puts(cmd.help) and
+                !puts("Error: invalid integer value '#{value}'!".colorize(:red)) && !puts(cmd.help) and
                   exit if !cmd_opt.allowed.include?(value)
               end
             elsif cmd_opt.type == Array
               value = value.split(',')
               if cmd_opt.allowed.any?
                 value.each{|x|
-                  !puts("Error: invalid array value '#{x}'".colorize(:red)) && !puts(cmd.help) and
+                  !puts("Error: invalid array value '#{x}'!".colorize(:red)) && !puts(cmd.help) and
                     exit if !cmd_opt.allowed.include?(x)
                 }
               end
@@ -306,18 +308,57 @@ class Commander
 
           # Set option with value
           # --------------------------------------------------------------------
-          !puts("Error: unknown named option '#{opt}' given".colorize(:red)) && !puts(cmd.help) and exit if !sym
+          !puts("Error: unknown named option '#{opt}' given!".colorize(:red)) && !puts(cmd.help) and exit if !sym
           @cmds[cmd.name.to_sym][sym] = value
         }
       end
     }
 
     # Ensure all options were consumed
-    !puts("Error: invalid options #{ARGV}".colorize(:red)) and exit if ARGV.any?
+    Log.die("invalid options #{ARGV}") if ARGV.any?
 
     # Print banner on success
     puts(banner) if @app
   end
+
+  #-----------------------------------------------------------------------------
+  # Private methods
+  #-----------------------------------------------------------------------------
+  private
+
+  # Add a command to the command list
+  # @param cmd [String] name of the command
+  # @param desc [String] description of the command
+  # @param opts [List] list of command options
+  # @returns cmd [Command] new command
+  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
+    options << @config.find{|x| x.name == 'global'}.opts.find{|x| x.long == '--help'} if cmd != 'global'
+
+    # Add positional options first
+    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| 
+      required = x.required ? ", Required" : ""
+      allowed = x.allowed.empty? ? "" : " (#{x.allowed * ','})"
+      positional_index += 1 if x.key.nil?
+      key = x.key.nil? ? "#{cmd}#{positional_index}" : x.key
+      type = x.type == FalseClass ? "Flag" : x.type
+      help += "    #{key.ljust(@just)}#{x.desc}#{allowed}: #{type}#{required}\n"
+    }
+
+    # Create the command in the command config
+    return Command.new(cmd, desc, sorted_options, help)
+  end
 end
 
 # vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/log.rb

@@ -60,6 +60,7 @@ module Log
     @@_level = level
     @@_queue = queue ? Queue.new : nil
     @@_stdout = stdout
+    $stdout.sync = true
 
     # Open log file creating as needed
     if @path
@@ -162,47 +163,58 @@ module Log
   end
 
   def error(*args)
-    opts = args.find{|x| x.is_a?(Hash)}
-    opts[:loc] = true and opts[:type] = 'E' if opts
-    args << {:loc => true, :type => 'E'} if !opts
+    @@_monitor.synchronize{
+      opts = args.find{|x| x.is_a?(Hash)}
+      opts[:loc] = true and opts[:type] = 'E' if opts
+      args << {:loc => true, :type => 'E'} if !opts
 
-    return self.puts(*args)
+      return self.puts(*args)
+    }
   end
 
   def warn(*args)
-    if LogLevel.warn <= @@_level
-      opts = args.find{|x| x.is_a?(Hash)}
-      opts[:type] = 'W' if opts
-      args << {:type => 'W'} if !opts
-      return self.puts(*args)
-    end
-    return true
+    @@_monitor.synchronize{
+      if LogLevel.warn <= @@_level
+        opts = args.find{|x| x.is_a?(Hash)}
+        opts[:type] = 'W' if opts
+        args << {:type => 'W'} if !opts
+        return self.puts(*args)
+      end
+      return true
+    }
   end
 
   def info(*args)
-    if LogLevel.info <= @@_level
-      opts = args.find{|x| x.is_a?(Hash)}
-      opts[:type] = 'I' if opts
-      args << {:type => 'I'} if !opts
-      return self.puts(*args)
-    end
-    return true
+    @@_monitor.synchronize{
+      if LogLevel.info <= @@_level
+        opts = args.find{|x| x.is_a?(Hash)}
+        opts[:type] = 'I' if opts
+        args << {:type => 'I'} if !opts
+        return self.puts(*args)
+      end
+      return true
+    }
   end
 
   def debug(*args)
-    if LogLevel.debug <= @@_level
-      opts = args.find{|x| x.is_a?(Hash)}
-      opts[:type] = 'D' if opts
-      args << {:type => 'D'} if !opts
-      return self.puts(*args)
-    end
-    return true
+    @@_monitor.synchronize{
+      if LogLevel.debug <= @@_level
+        opts = args.find{|x| x.is_a?(Hash)}
+        opts[:type] = 'D' if opts
+        args << {:type => 'D'} if !opts
+        return self.puts(*args)
+      end
+      return true
+    }
   end
 
   # Log the given message in red and exit
   # @param msg [String] message to log
   def die(msg)
-    self.puts("Error: #{msg}".colorize(:red), stamp: false) and exit
+    @@_monitor.synchronize{
+      msg += "!" if msg.is_a?(String) && msg[-1] != "!"
+      self.puts("Error: #{msg}".colorize(:red), stamp: false) and exit
+    }
   end
 
   # Remove an item from the queue, block until one exists

data/lib/nub/sys.rb

@@ -64,6 +64,8 @@ module Sys
     result = block.call
 
     $stdout, $stderr = STDOUT, STDERR
+    $stdout.flush
+    $stderr.flush
 
     return OpenStruct.new(result: result, stdout: stdout.string, stderr: stderr.string)
   end

metadata

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