Gazebo_simulation-Frontend/node_modules/clean/index.js

'use strict';

module.exports = clean;
clean.Clean = Clean;

var minimist = require('minimist');
var Cleaner = require('./lib/cleaner');
var mix = require('mix2');
var async = require('async');


function clean(options) {
  return new Clean(options);
}


// @param {schema} schema
// @param {Object} options
// - offset: {Number} the offset of the argv at which we should begin to parse
// - schema: {Object}
// - shorthands: {Object}
// X - context: {Object} the context of the helper functions
// - parallel: {boolean=false} whether checker should check the properties in parallel, default to false
// - limit: {boolean=false} limit to the schema
function Clean(options) {
  this.options = options = options || {};

  if (typeof options.offset !== 'number') {
    options.offset = clean.PARSE_ARGV_OFFSET;
  }

  this.schema = options.schema || {};
  this.keys = Object.keys(this.schema);

  this._reverseShorthands();
}

function map (map, interator, context) {
  var key;

  for (key in map) {
    interator.call(context || null, map[key], key);
  }
};


// @returns {object|undefined}
Clean.prototype._get_cleaner = function(key, context) {
  var rule = this.schema[key];
  if (!rule) {
    return;
  }

  return new Cleaner(rule, context, key);
};


Clean.prototype._reverseShorthands = function() {
  var reversed = this._reversed = {};
  if (this.options.shorthands) {
    map(this.options.shorthands, function (arg, shorthand) {
      reversed[arg] = shorthand;
    });
  }
};


//  0       1           2          3
// ['node', __filename, <command>, [options] ]
clean.PARSE_ARGV_OFFSET = 2;


// Parse and clean
Clean.prototype.parse = function(argv, callback) {
  var data = this.argv(argv);
  this.clean(data, callback);
};


// Gets the argv object without sanitizing
Clean.prototype.argv = function(argv) {
  var minimist_options = this._parseArgvOptions();
  var sliced = argv.slice(this.options.offset);
  var data = minimist(sliced, minimist_options);

  // #13
  // We should clean the data, that we should stay the data clean and untouched.
  // If user have not define the argument in argv,
  // `data` object should not contain the argument key.
  this._cleanMinimist(data, sliced);

  return data;
};


Clean.prototype._parseArgvOptions = function() {
  var o = {
    string: [],
    boolean: [],
    alias: this.options.shorthands
  };
  map(this.schema, function (rule, name) {
    if (rule.type === Boolean) {
      o.boolean.push(name);
    }
  });

  mix(o, this.options, false);
  return o;
};


Clean.prototype.clean = function(object, callback) {
  var type = this.options.parallel
    ? 'each'
    : 'eachSeries';

  var cleaned = {};
  var context = {
    set: function (key, value) {
      object[key] = cleaned[key] = value;
    },

    get: function (key) {
      if (key in cleaned) {
        return cleaned[key];
      }

      return object[key];
    }
  };

  var self = this;
  async[type](this.keys, function (key, done) {
    var cleaner = self._get_cleaner(key, context);
    cleaner.clean(object[key], [!(key in object)], function (err, value) {
      if (err) {
        return done(mangle_error(err, key));
      }

      cleaned[key] = value;
      done(null);
    });

  }, function (err) {
    if (err) {
      return callback(err);
    }

    if (!self.options.limit) {
      mix(cleaned, object, false);
    }

    callback(null, cleaned);
  });
};


function mangle_error (error, key) {
  var prefix = 'Invalid option: --' + key

  // No error message, just `return false` in validator
  if (error === true) {
    return prefix;
  }

  if (typeof error === 'string') {
    return prefix + ': ' + error;
  }

  if (error.message) {
    error.message = prefix + ': ' + error.message;
  }

  if (error.stack) {
    error.stack = prefix + ': ' + error.stack;
  }

  return error;
}


// ```pseudo javascript
// If options.boolean: ['flag']
// minimist('--abc') -> 
// {
//   flag: false,
//   abc: true
// }
// Then, we can not figure out whether user define `flag` explicitly or just use the default value
// So, clean the result of minimist.
Clean.prototype._cleanMinimist = function(data, argv) {
  Object.keys(data).forEach(function (key) {
    // We should not delete `'_'`
    if (key === '_') {
      return;
    }

    if (!this._argvExists(key, argv)) {
      delete data[key];
    }
  }.bind(this));
};


var REGEX_IS_SHORT = /^-[a-z0-9]+/i;
Clean.prototype._argvExists = function(key, argv) {

  // 'cwd' -> 'c'
  var shorthand = this._reversed[key];
  return argv.some(function (arg) {
    if (REGEX_IS_SHORT.test(arg)) {
      // '-c' -> 'c'
      arg = arg.slice(1);
      // 'c' -> match
      // 'cf' -> combined shorthands, match
      return shorthand && ~arg.indexOf(shorthand);
    }

    // '--no-cwd'
    var negative_key = '--no-' + key;

    // '--cwd'
    // '--cwd=abc'
    var regexp = new RegExp('^--' + key + '(=.*)?$');

    return regexp.test(arg)
      || arg === negative_key;
  });
};