Code coverage report for options-parser/parser.js

Statements: 100% (177 / 177)      Branches: 100% (147 / 147)      Functions: 100% (15 / 15)      Lines: 100% (167 / 167)      Ignored: 1 branch     

All files » options-parser/ » parser.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 3761 1   1       1   1   1   1               1   48   48             1   9 4 5 1 4 1   3 3                   1   41   41   41   7     34     41   41 41 41     41   44   39 39 39   5   4 6   2 2 2     3       41   36   6 3     30       41 76     76   17 16 14       59   30 29 29 29 1 28 1   27   13 4 4       14   7 7 3 4 3     1     7       29   1 1       28   14 14         14       34   2       32 32   37 2   37 1     32   2     30                       1   41 41   46   6     6   4       41                   1   41 41   32 5   4 4 2   4 2       32                 1   61 61 878 61                 1   29                   1   37 37   10 10   11 11     11   4     4   3 3     8 8   7 7                 1   9 1   9 9 9 1     9 29 29   9 9 9   29       9   9 9   9   9   29 29 29 29 29 9   29   29 29 27 27 27   27 27 4         1    
var util = require('util');
var tokenizer = require('./tokenizer');
 
var OptionsParser = function()
{
};
 
OptionsParser.prototype.err_unknown = "Unknown option %s";
 
OptionsParser.prototype.err_required = "Option %s missing required argument";
 
OptionsParser.prototype.err_argument = "Options %s does not take an argument";
 
OptionsParser.prototype.err_missing = "Options %s are required";
 
/**
 * Returns true if the character at offset i in str is in [a-z0-9]
 * @param {String} str
 * @param {number} i
 * @returns {boolean}
 */
OptionsParser.prototype.isalnum = function(str, i)
{
    var code = str.charCodeAt(i);
    //        "0" <= code <= "9"           "A" <= code <= "Z"         "a" <= code <= "z"
    return ((code > 47 && code < 58) || (code > 64 && code < 91) || code > 96 && code < 123);
};
 
/**
 * Default error handler. Throws exception.
 * @param {Object} err
 */
OptionsParser.prototype.defaultErrorHandler = function(err)
{
    if(err.required)
        throw new Error(util.format(this.err_required, err.required));
    if(err.argument)
        throw new Error(util.format(this.err_argument, err.argument));
    if(err.missing)
        throw new Error(util.format(this.err_missing, err.missing.join(', ')));
    /* istanbul ignore else */
    Eif(err.unknown)
        throw new Error(util.format(this.err_unknown, err.unknown));
};
 
/**
 * Parses command-line arguments
 * @param {object} opts
 * @param {?Array|String} argv argument array (default: process.argv(2..))
 * @param {?Function} error callback handler for missing options etc (default: throw exception)
 * @returns {{opt: {}, args: Array}}
 */
OptionsParser.prototype.parse_ = function(opts, argv, error)
{
    opts = opts || {};
    // error can be passed as second argument if argv is left out
    error = (argv instanceof Function) ? /** @type {Function} */ (argv) : (error || this.defaultErrorHandler.bind(this));
    
    if(typeof argv == "string" || argv instanceof String)
    {
        argv = tokenizer.create(argv).allTokens();
    } else 
    {
        argv = Array.isArray(argv) ? argv :  process.argv.slice(2);
    }
 
    var result = {};
 
    var args = [];
    var last = null;
    var expectsArg = false;
 
    // helper function for handling argument aliases and values
    var lookupArg = function(arg)
    {
        if(arg in opts)
        {
            expectsArg = (opts[arg] === 1) || !opts[arg].flag;
            last = arg;
            return arg;
        }
        else if (arg.length == 1)
        {
            for(var key in opts)
                if(opts[key].short == arg)
                {
                    expectsArg = !(opts[key].flag);
                    last = key;
                    return arg;
                }
        }
        return false;
    }
 
    // helper function for setting arguments in result
    var setResult = function(arg, value)
    {
        if(opts[arg].multi)
        {
            if(!result[arg]) result[arg] = [value];
            else result[arg].push(value);
        }
        else
            result[arg] = value;
    }
 
    // loop over all arguments
    for(var i = 0; i < argv.length; i++) {
        var arg = argv[i];
 
        // short param
        if(arg.length == 2 && arg[0] == '-' && this.isalnum(arg, 1))
        {
            if(expectsArg) return error({required: last});
            if(!lookupArg(arg[1])) return error({unknown: arg});
            if(!expectsArg) setResult(last, true);
        }
 
        // long param
        else if(arg.length > 2 && arg[0] == '-' && arg[1] == '-' && this.isalnum(arg, 2))
        {
            if(expectsArg) return error({required: last});
            var parts = arg.substr(2).split('=');
            arg = parts.shift();
            if(arg.length < 2)
                return error({unknown: '--' + arg});
            if(!lookupArg(arg))
                return error({unknown: '--' + arg});
 
            if(expectsArg) {
                // is parameter of type --param=value ?
                if(parts.length > 0) {
                    setResult(arg, parts.join('='));
                    expectsArg = false;
                }
            } else {
                // is parameter of type --param=value?
                if(parts.length > 0)
                {
                    var a = parts.join('=');
                    if(/^(false|0|no)$/i.test(a))
                        setResult(arg, false);
                    else if(/^(true|1|yes)$/i.test(a))
                        setResult(arg, true);
                    else
                        // is parameter of type --param=value but shouldn't?
                        return error({argument: arg});
                }
                else
                    setResult(arg, true);
            }
        }
 
        else if (arg == '--')
        {
            args = args.concat(argv.slice(i+1));
            break;
        }
 
        // required argument
        else if(expectsArg)
        {
            setResult(last, arg);
            expectsArg = false;
        }
 
        // arg that isn't an option or value
        else {
            args.push(arg);
        }
    }
 
    if(expectsArg)
    {
        return error({required: last});
    }
 
    // look for missing parameters that have been marked as required
    var requiredParams = [];
    for(var arg in opts)
    {
        if(opts[arg].required && !(arg in result))
            requiredParams.push(arg);
 
        if(opts[arg].default && !(arg in result))
            result[arg] = opts[arg].default;
    }
 
    if(requiredParams.length > 0)
    {
        return error({missing: requiredParams});
    }
 
    return {
        opt: result,
        args: args
    };
};
 
/**
 * Finds help arguments in opts
 * @param {object} opts
 * @return Array
 * @remarks changes the opts in place to imply "flag" on help params
 */
OptionsParser.prototype.processHelpArgs_ = function(opts)
{
    var helpArgs = [];
    for(var argName in opts)
    {
        if(opts[argName].showHelp) 
        {
            helpArgs.push({ name: argName, options: opts[argName].showHelp });
            
            // set flag to true if omitted from help params
            if(!('flag' in opts[argName]))
            {
                opts[argName].flag = true;
            }
       }
    }
    return helpArgs;
};
 
/**
 * Parses command-line arguments
 * @param {object} opts
 * @param {?Array|String} argv argument array (default: process.argv(2..))
 * @param {?Function} error callback handler for missing options etc (default: throw exception)
 * @returns {{opt: {}, args: Array}}
 */
OptionsParser.prototype.parse = function(opts, argv, error)
{
    var helpArgs = this.processHelpArgs_(opts);
    var result = this.parse_(opts, argv, error);
 
    helpArgs.some(function(arg){
        if(result.opt[arg.name])
        {
            this.help(opts, arg.options);
            if(typeof arg.options.callback === "function")
                arg.options.callback.call();
 
            if(!arg.options.noExit)
                process.exit(0);
        }
    }, this);
 
    return result;
};
 
/**
 * Create new string with ch repeated count times
 * @param {String} ch character to repeat (should have length = 1)
 * @param {Number} count number of repetitions of ch
 * @return {String}
 */
OptionsParser.prototype.repeatChar_ = function(ch, count)
{
    var s = '';
    for(var i = 0; i < count; i++)
        s += ch;
    return s;
};
 
/**
 * Pad a string with spaces up to a minimum length 
 * @param {String} s string to pad
 * @param {Number} len minimum length
 * @return {String} s right-padded with spaces up to len
 */
OptionsParser.prototype.padString_ = function(s, len)
{
    return s + this.repeatChar_(' ', len - s.length);
};
 
/**
 * Break a string into lines of len characters and break on spaces
 * @param {String} s 
 * @param {Number} len
 * @return {Array.<String>}
 * @remarks it might return longers lines if s contains words longer than len
 */
OptionsParser.prototype.fitString_ = function(s, len)
{
    s = s.trim();
    if(s.length <= len) return [s];
 
    var result = [];
    while(s.length > len)
    {
        var i = len
        for(; s[i] != ' ' && i >= 0; i--) 
            /* empty loop */ ;
 
        if(i == -1)
        {
            for(i = len + 1; s[i] != ' ' && i < s.length; i++) 
                /* empty loop */ ;
            
            if(i == s.length)
            {
                result.push(s);
                return result;
            }
        }
        result.push(s.substr(0, i));
        s = s.substr(i).trimLeft();
    }
    result.push(s);
    return result;
};
 
 
/**
 * Show help for options
 * @param {object} opts
 * @param {object} options
 */
OptionsParser.prototype.help = function(opts, options)
{
    if(typeof options !== 'object')
        options = {};
 
    var output = options.output || util.puts;
    var paddingLeft = '  ';
    if(typeof options.paddingLeft === "number" && options.paddingLeft >= 0)
        paddingLeft = this.repeatChar_(' ', options.paddingLeft);
 
    // compute maximum argument length
    var maxArgLength = Object.keys(opts).reduce(function(prev, optName){
        var len = optName.length + (opts[optName].short ? 4 : 0);
        if(opts[optName].flag !== true)
        {
            var valLen = (opts[optName].varName ? opts[optName].varName.length : 3) + 1;
            if(opts[optName].short) valLen *= 2;
            len += valLen;
        }
        return (prev < len) ? len : prev;
    }, 0);
    
    // make room for "--" before arguments and 2 spaces for left padding
    maxArgLength += 2 + paddingLeft.length;
 
    var middlePadding = options.separator || '   ' ;
    var maxTextLength = (options.columns || process.stdout.columns) - maxArgLength - middlePadding.length;
 
    if(options.banner) output(options.banner);
 
    for(var optName in opts)
    {
        var append = "";
        var shortName = "";
        var name = paddingLeft + (optName.length == 1 ? '-' : '--') + optName;
        if(opts[optName].short) shortName = ', -' + opts[optName].short;
        if(opts[optName].flag !== true)
            append = " " + (opts[optName].varName || "VAL");
 
        var name = name + append + (shortName ? shortName + append : "");
 
        var helpText = this.fitString_(opts[optName].help || '', maxTextLength);
        if(helpText == '' && options.skipEmpty) continue;
        var firstLine = helpText.shift();
        var line = this.padString_(name, maxArgLength) + middlePadding + firstLine
        output(line);
 
        var padString = this.repeatChar_(' ', maxArgLength + middlePadding.length);
        helpText.forEach(function(line){
            output(padString + line);
        }, this);
    }
};
 
module.exports = new OptionsParser();