nub 0.0.25 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8cba0302ba890a2a1332cd5e1e9696ccee3ac8a4235bc86d3d4292de23efa56
-  data.tar.gz: a35b6c9a6d0925873e19325d903a417c56df346790bcc1f8d96f72f197e7d637
+  metadata.gz: 9d5f8ebb6c991951280634bd778890442ead23922928d9a113f6f04449660c5d
+  data.tar.gz: 49b25510286dcd087882043bd49209b63bb2688bb338054c1dd3a7d34d5da97c
 SHA512:
-  metadata.gz: ca6ff75a2f4e7cf35d9dd0b7440bb82d48946081a01a4646913b0ee1a06da219ffa478d097a7b0dfc2a9dd5356c7cd885adb22985b2cd92115c0f98d2fd7ad7b
-  data.tar.gz: 0340f674692f7840f4f33a0323d9fce5598991031b26e3b1164f54ec351cc4a7117bb1d24462e8d22e5e99a588a1545b0d5f6a406316af2b00d9e2754aec3630
+  metadata.gz: ae5491f1c835a8d9de56127c1b486a875195fd12259834a928c5bc9dd915964114a11c6c8a0b1d795c99d9c121386a72f271d9e48c2b6a66014777a8058c8b77
+  data.tar.gz: 1d19f786cfda8a5f21b4913ce42b6b22ad38a4a62bacafb3b72ddea9a4b14556be2d923a3194fb660f82a75977e8ade4573412863caa4993e122d33dba294965

data/lib/nub.rb

@@ -22,7 +22,7 @@
 
 # Nub is the top level module useful for requiring all sub-modules at once.
 module Nub
-  require 'nub/cmds'
+  require 'nub/commander'
   require 'nub/config'
   require 'nub/log'
   require 'nub/net'

data/lib/nub/commander.rb

@@ -0,0 +1,277 @@
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is
+#furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#SOFTWARE.
+
+require 'colorize'
+
+# Command option encapsulation
+class Option
+  attr_reader(:key)
+  attr_reader(:short)
+  attr_reader(:long)
+  attr_reader(:hint)
+  attr_reader(:desc)
+  attr_reader(:type)
+  attr_reader(:allowed)
+  attr_reader(:required)
+
+  # Create a new option instance
+  # @param key [String] option short hand, long hand and hint e.g. -s|--skip=COMPONENTS
+  # @param desc [String] the option's description
+  # @param type [Type] the option's type
+  # @param required [Bool] require the option if true else optional
+  # @param allowed [Array] array of allowed string values
+  def initialize(key, desc, type:nil, required:false, allowed:[])
+    @hint = nil
+    @long = nil
+    @short = nil
+    @desc = desc
+    @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-_=|] 
+    # --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?)
+    @key = key
+    if key
+      @hint = key[/.*=(.*)$/, 1]
+      @short = key[/^(-\w).*$/, 1]
+      @long = key[/(--[\w\-]+)(=.+)*$/, 1]
+    else
+      # Always require positional options
+      @required = true
+    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
+    @type = String if !key && !type
+    @type = FalseClass if key and !type
+    @type = type if type
+
+    # 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}
+    end
+  end
+end
+
+# An implementation of git like command syntax for ruby applications:
+# see https://github.com/phR0ze/ruby-nub
+class Commander
+  attr_accessor(:cmds)
+  attr_reader(:config)
+  attr_reader(:banner)
+
+  Command = Struct.new(:name, :desc, :opts, :help)
+
+  # Initialize the commands for your application
+  # @param app [String] application name e.g. reduce
+  # @param version [String] version of the application e.g. 1.0.0
+  # @param examples [String] optional examples to list after the title before usage
+  def initialize(app, version, examples:nil)
+    @app = app
+    @version = version
+    @examples = examples
+    !puts("Error: app name and version are required".colorize(:red)) and
+      exit if @app.nil? or @app.empty? or @version.nil? or @version.empty?
+
+    @help_opt = Option.new('-h|--help', 'Print command/options help')
+    @just = 40
+
+    # Configuration - ordered list of commands
+    @config = []
+
+    # Incoming user set commands/options
+    # {command_name => {}}
+    @cmds = {}
+  end
+
+  # Hash like accessor for checking if a command or option is set
+  def [](key)
+    return @cmds[key] if @cmds[key]
+  end
+
+  # 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
+  def add(cmd, desc, options:[])
+    !puts("Error: command names must be pure lowercase letters".colorize(:red)) and
+      exit if cmd =~ /[^a-z]/
+
+    # Build help for command
+    help = "#{banner}\n#{desc}\n\nUsage: ./#{@app} #{cmd} [options]\n"
+    options << @help_opt
+
+    # 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
+    @config << Command.new(cmd, desc, sorted_options, help)
+  end
+
+  # Returns banner string
+  # @returns [String] the app's banner
+  def banner
+    banner = "#{@app}_v#{@version}\n#{'-' * 80}".colorize(:light_yellow)
+    return banner
+  end
+
+  # Return the app's help string
+  # @returns [String] the app's help string
+  def help
+    help = "#{banner}\n"
+    help += "Examples:\n#{@examples}\n\n" if !@examples.nil? && !@examples.empty?
+    help += "Usage: ./#{@app} [commands] [options]\n"
+    help += "    #{'-h|--help'.ljust(@just)}Print command/options help: Flag\n"
+    help += "COMMANDS:\n"
+    @config.each{|x| help += "    #{x.name.ljust(@just)}#{x.desc}\n" }
+    help += "\nsee './#{@app} COMMAND --help' for specific command help\n"
+
+    return help
+  end
+
+  # Construct the command line parser and parse
+  def parse!
+
+    # Set help if nothing was given
+    ARGV.clear and ARGV << '-h' if ARGV.empty?
+
+    # 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?
+    
+    # Process command 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}
+
+        # Collect command options
+        opts = ARGV.take_while{|x| !cmd_names.include?(x) }
+        ARGV.shift(opts.size)
+        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.size < cmd_pos_opts.size
+
+        # Process command options
+        pos = -1
+        loop {
+          break if opts.first.nil?
+          opt = opts.shift
+          cmd_opt = nil
+          value = nil
+          sym = nil
+
+          # Validate/set named options
+          # --------------------------------------------------------------------
+          # e.g. -s, --skip, --skip=VALUE
+          if opt.start_with?('-')
+            short = opt[/^(-\w).*$/, 1]
+            long = opt[/(--[\w\-]+)(=.+)*$/, 1]
+            value = opt[/.*=(.*)$/, 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
+
+              # Collect value
+              if cmd_opt.type == FalseClass
+                value = true if !value
+              elsif !value
+                value = opts.shift
+              end
+            end
+
+          # Validate/set positional options
+          # --------------------------------------------------------------------
+          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?
+            value = opt
+            sym = "#{cmd.name}#{pos}".to_sym
+          end
+
+          # Convert value to appropriate type
+          # --------------------------------------------------------------------
+          if value
+            if cmd_opt.type == Integer
+              value = value.to_i
+
+              # Validate allowed values
+              if cmd_opt.allowed.any?
+                !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(',')
+
+              # Validate allowed values
+              if cmd_opt.allowed.any?
+                value.each{|x|
+                  !puts("Error: invalid array value '#{x}'".colorize(:red)) && !puts(cmd.help) and
+                    exit if !cmd_opt.allowed.include?(x)
+                }
+              end
+            end
+          end
+
+          # Set option with value
+          # --------------------------------------------------------------------
+          !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?
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/sys.rb

@@ -20,11 +20,26 @@
 #SOFTWARE.
 
 require 'io/console'
+require 'ostruct'
+require 'stringio'
 
-class Sys
+module Sys
+
+  # Capture STDOUT to a string
+  # @returns [String] the redirected output
+  def self.capture(&block)
+    stdout, stderr = StringIO.new, StringIO.new
+    $stdout, $stderr = stdout, stderr
+
+    result = block.call
+
+    $stdout, $stderr = STDOUT, STDERR
+
+    return OpenStruct.new(result: result, stdout: stdout.string, stderr: stderr.string)
+  end
 
   # Wait for any key to be pressed  
-  def any_key?
+  def self.any_key?
     begin
       state = `stty -g`
       `stty raw -echo -icanon isig`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nub
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.27
 platform: ruby
 authors:
 - Patrick Crummett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -101,7 +101,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/nub.rb
-- lib/nub/cmds.rb
+- lib/nub/commander.rb
 - lib/nub/config.rb
 - lib/nub/log.rb
 - lib/nub/net.rb

data/lib/nub/cmds.rb

@@ -1,146 +0,0 @@
-#MIT License
-#Copyright (c) 2018 phR0ze
-#
-#Permission is hereby granted, free of charge, to any person obtaining a copy
-#of this software and associated documentation files (the "Software"), to deal
-#in the Software without restriction, including without limitation the rights
-#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-#copies of the Software, and to permit persons to whom the Software is
-#furnished to do so, subject to the following conditions:
-#
-#The above copyright notice and this permission notice shall be included in all
-#copies or substantial portions of the Software.
-#
-#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-#SOFTWARE.
-
-require 'optparse'
-require 'colorize'
-
-# Command option class provides a way to encapsulate a command with
-# any additional properties.
-class CmdOpt
-  attr_reader(:key)
-  attr_reader(:conf)
-  attr_reader(:type)
-  attr_reader(:desc)
-  attr_reader(:required)
-  def initialize(conf, desc, type:nil, required:false)
-    @conf = conf.gsub(' ', '=')
-    @key = conf.gsub('-', '').split('=').first.to_sym
-    @type = type
-    @desc = desc
-    @required = required
-  end
-end
-
-# Simple command wrapper around options parsing
-# When multiple commands are given they share the options passed along with them
-class Cmds
-
-  # Option and command names have all hyphens removed
-  attr_accessor(:cmds)
-  attr_accessor(:opts)
-
-  # Initialize the commands for your application
-  # Params:
-  # +app+:: application name e.g. reduce
-  # +version+:: version of the application e.g. 1.0.0
-  # +examples+:: optional examples to list after the title before usage
-  def initialize(app, version, examples)
-    @opts = {}
-    @cmds = {}
-    @cmds_config = {}
-
-    @app = app
-    @version = version
-    @examples = examples || ''
-  end
-
-  # Hash like accessor for checking if a command is set
-  def [](key)
-    return @cmds[key] if @cmds[key]
-    return @opts[key] if @opts[key]
-  end
-
-  # Hash like accessor for editing options
-  def []=(key, value)
-    @opts[key] = value
-  end
-
-  # Add a command to the command list
-  # Params:
-  # +cmd+:: name of the command
-  # +desc+:: description of the command
-  # +opts+:: list of command options
-  def add(cmd, desc, opts)
-    @cmds_config[cmd] = {desc: desc, inopts: opts, outopts: OptionParser.new{|parser|
-      required = opts.map{|x| x.conf if x.required}.compact * ' '
-      required += ' ' if not required.empty?
-      parser.banner = "#{banner}\nUsage: ./#{@app} #{cmd} #{required}[options]"
-      opts.each{|opt| parser.on(opt.conf, opt.type, opt.desc){|x| @opts[opt.key] = x }}
-    }}
-  end
-
-  # Returns banner string
-  def banner
-    banner = "#{@app}_v#{@version}\n#{'-' * 80}".colorize(:light_yellow)
-    return banner
-  end
-
-  # Construct the command line parser and parse
-  def parse!
-
-    # Construct help for the application
-    help = "COMMANDS:\n"
-    @cmds_config.each{|k,v| help += "    #{k.ljust(33, ' ')}#{v[:desc]}\n" }
-    help += "\nsee './#{@app} COMMAND --help' for specific command info"
-
-    # Construct top level option parser
-    @optparser = OptionParser.new do |parser|
-      parser.banner = "#{banner}\n#{@examples}Usage: ./#{@app} commands [options]"
-      parser.on('-h', '--help', 'Print command/options help') {|x| !puts(parser) and exit }
-      parser.separator(help)
-    end
-
-    # Invoke the option parser with help if any un-recognized commands are given
-    cmds = ARGV.select{|x| not x.start_with?('-')}
-    ARGV.clear and ARGV << '-h' if ARGV.empty? or cmds.any?{|x| not @cmds_config[x]}
-    cmds.each{|x| puts("Error: Invalid command '#{x}'".colorize(:red)) if not @cmds_config[x]}
-    @optparser.order!
-
-    # Now remove them from ARGV leaving only options
-    ARGV.reject!{|x| not x.start_with?('-')}
-
-    # Parse each command which will consume options from ARGV
-    cmds.each do |cmd|
-      begin
-        @cmds[cmd.gsub('-', '_').to_sym] = true
-        @cmds_config[cmd][:outopts].order!
-
-        # Ensure that all required options were given
-        @cmds_config[cmd][:inopts].each{|x|
-          if x.required and not @opts[x.key]
-            puts("Error: Missing required option '#{x.key}'".colorize(:red))
-            ARGV.clear and ARGV << "-h"
-            @cmds_config[cmd][:outopts].order!
-          end
-        }
-      rescue OptionParser::InvalidOption => e
-        # Options parser will raise an invalid exception if it doesn't recognize something
-        # However we want to ignore that as it may be another command's option
-        ARGV << e.to_s[/(-.*)/, 1]
-      end
-    end
-
-    # Ensure all options were consumed
-    !puts("Error: invalid options #{ARGV}".colorize(:red)) and exit if ARGV.any?
-  end
-end
-
-# vim: ft=ruby:ts=2:sw=2:sts=2