cli.js 2.6 KB
/*!
 * Casper is a navigation utility for PhantomJS.
 *
 * Documentation: http://n1k0.github.com/casperjs/
 * Repository:    http://github.com/n1k0/casperjs
 *
 * Copyright (c) 2011 Nicolas Perriault
 *
 * 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.
 *
 */

var utils = require('utils');

/**
 * Extracts, normalize ad organize PhantomJS CLI arguments in a dedicated
 * Object.
 *
 * @param  array  phantomArgs  phantom.args value
 * @return Object
 */
exports.parse = function(phantomArgs) {
    if (!utils.isType(phantomArgs, "runtimearray")) {
        throw new Error('parse() can only process a phantomjs arguments array');
    }
    var extract = {
        args: [],
        options: {},
        get: function(what) {
            if (typeof what === "number") {
                return this.args[what];
            } else if (typeof what === "string") {
                return this.options[what];
            } else {
                throw new Error("Unsupported cli arg getter " + typeof what);
            }
        }
    };
    phantomArgs.forEach(function(arg) {
        if (arg.indexOf('--') === 0) {
            // named option
            var optionMatch = arg.match(/^--(.*)=(.*)/i);
            if (optionMatch) {
                extract.options[optionMatch[1]] = optionMatch[2];
            } else {
                // flag
                var flagMatch = arg.match(/^--(.*)/);
                if (flagMatch) {
                    extract.options[flagMatch[1]] = true;
                }
            }
        } else {
            // positional arg
            extract.args.push(arg);
        }
    });
    return extract;
};