skyflow-cli/src/Request.js

Environment manager for your projects.

const Helper = require('./Helper.js');

/**
 * Parse console request values.
 *
 * @class Request
 * @module Default
 * @constructor
 * @author Skyflow
 * @requires Helper
 * @example
 *      let request = new Request();
 *      request.parse(['command', '--long', 'value', '-a', 'value']);
 *      console.log(request.command); // Parsed command
 *      console.log(request.options); // Parsed options
 *      console.log(request.shortOptions); // Parsed short options
 *      console.log(request.longOptions); // Parsed long options
 */
module.exports = class Request {

    constructor(container) {

        /**
         * Parsed command.
         *
         * @property command
         * @type String
         * @default null
         */
        this.command = null;

        /**
         * Parsed commands.
         *
         * @property commands
         * @type Array
         * @default []
         */
        this.commands = [];

        /**
         * Parsed arguments.
         *
         * @property args
         * @type Array
         * @default []
         */
        this.args = [];

        /**
         * Parsed options.
         *
         * @property options
         * @type Object
         * @default {}
         */
        this.options = {};

        /**
         * Parsed short options.
         *
         * @property shortOptions
         * @type Object
         * @default {}
         */
        this.shortOptions = {};

        /**
         * Parsed long options.
         *
         * @property longOptions
         * @type Object
         * @default {}
         */
        this.longOptions = {};

        this.container = container;

        this.parse(process.argv.slice(2));

    }

    /**
     * Parses arguments.
     *
     * @method parse
     * @param {Array} args Request arguments.
     * @return {Request} Returns the current Request object.
     */
    parse(args){
        const {Helper, config} = this.container;

        this.command = null;
        this.commands = [];
        this.args = [];
        this.options = {};
        this.shortOptions = {};
        this.longOptions = {};
        let option = null;

        for (let i=0; i < args.length; i++) {

            let value = args[i];
            let first = value.charAt(0);

            if(first !== '-' && !option){
                this.commands.push(value);
            }

            if(first !== '-' && !option && this.command){
                this.args.push(value);
            }

            if(first !== '-' && !option && !this.command){
                this.command = value.replace(/^\-+/, '');
                let commands = this.command.split(':');
                this.command = commands.pop();
                this.commands = this.commands.concat(commands);
                this.args = this.args.concat(commands);
                continue;
            }

            if(first === '-'){
                option = value;
                let opt = option.replace(/^\-+/, '');
                this.options[opt] = true;
                if(option.charAt(1) === '-'){
                    this.longOptions[opt] = true;
                }else {
                    if(opt.length === 1){
                        this.shortOptions[opt] = true;
                    }
                }
                continue;
            }

            if(first !== '-' && option){
                value = value.replace(/^\-+/, '');
                let opt = option.replace(/^\-+/, '');
                this.options[opt] = value;
                if(option.charAt(0) === '-' && option.charAt(1) === '-'){
                    this.longOptions[opt] = value;
                }
                if(option.charAt(0) === '-' && option.charAt(1) !== '-'){
                    if(opt.length === 1){
                        this.shortOptions[opt] = value;
                    }
                }
                option = null;
            }

        }

        if(Helper.hasProperty(config.value.alias, this.command)){
            this.command = config.value.alias[this.command]
        }

        return this;
    }

    /**
     * Checks if options array is empty.
     *
     * @method hasOption
     * @return {Boolean} Returns true if options array is empty and false otherwise.
     */
    isOptionsEmpty(){
        return Helper.isEmpty(this.options);
    }

    /**
     * Checks if an option exists.
     *
     * @method hasOption
     * @param {String} option Option to check.
     * @return {Boolean} Returns true if an option exists and false otherwise.
     */
    hasOption(option){
        return Helper.hasProperty(this.options, option);
    }

    /**
     * Gets an option.
     *
     * @method getOption
     * @param {String} option Option to get.
     * @return {String} Returns option value.
     */
    getOption(option){
        return this.options[option];
    }

    /**
     * Removes an option.
     *
     * @method removeOption
     * @param {String} option Option to get.
     * @return {Request} Returns the current Request object.
     */
    removeOption(option){
        delete this.options[option];
        delete this.shortOptions[option];
        delete this.longOptions[option];
        return this;
    }

    /**
     * Adds an option.
     *
     * @method addOption
     * @param {String} option Option name.
     * @param {String} value Option value.
     * @return {Request} Returns the current Request object.
     */
    addOption(option, value){
        this.options[option] = value;
        return this;
    }

    /**
     * Checks if short option exists.
     *
     * @method hasShortOption
     * @param {String} option Option to check.
     * @return {Boolean} Returns true if short option exists and false otherwise.
     */
    hasShortOption(option){
        return Helper.hasProperty(this.shortOptions, option);
    }

    /**
     * Adds a short option.
     *
     * @method addShortOption
     * @param {String} option Option name.
     * @param {String} value Option value.
     * @return {Request} Returns the current Request object.
     */
    addShortOption(option, value){
        this.shortOptions[option] = value;
        return this;
    }

    /**
     * Checks if long option exists.
     *
     * @method hasLongOption
     * @param {String} option Option to check.
     * @return {Boolean} Returns true if long option exists and false otherwise.
     */
    hasLongOption(option){
        return Helper.hasProperty(this.longOptions, option);
    }

    /**
     * Adds a long option.
     *
     * @method addLongOption
     * @param {String} option Option name.
     * @param {String} value Option value.
     * @return {Request} Returns the current Request object.
     */
    addLongOption(option, value){
        this.longOptions[option] = value;
        return this;
    }

    /**
     * Contacts short and long options as string.
     *
     * @method getStringOptions
     * @return {String} Returns true if long option exists and false otherwise.
     */
    getStringOptions() {
        let options = '';
        Object.keys(this.shortOptions).map((option) => {
            if (Helper.isBoolean(this.shortOptions[option])) {
                options += ' -' + option
            } else {
                options += ' -' + option + ' ' + this.shortOptions[option]
            }
        });
        Object.keys(this.longOptions).map((option) => {
            if (Helper.isBoolean(this.longOptions[option])) {
                options += ' --' + option
            } else {
                options += ' --' + option + ' ' + this.longOptions[option]
            }
        });

        return options.trim();
    }

};