right-pad-values/index.js

Right pad the values of a given property for each object in an array. Useful for creating text columns or tables.

/*!
 * right-pad-values <https://github.com/jonschlinkert/right-pad-values>
 *
 * Copyright (c) 2015, Jon Schlinkert.
 * Licensed under the MIT License.
 */

'use strict';

var isObject = require('isobject');
var longest = require('longest-value');
var pad = require('pad-right');

module.exports = function rightPadValues(obj, prop) {
  if (typeof obj === 'string' && prop && typeof prop === 'object') {
    var temp = prop;
    prop = obj;
    obj = temp;
  }
  if (!obj || typeof obj !== 'object') {
    throw new TypeError('right-pad-values expects an object or array.');
  }
  if (Array.isArray(obj)) {
    return arrayValues(obj, prop);
  }
  return objectValues(obj, prop);
};

function arrayValues(arr, prop) {
  var max = longest(arr, prop).length;
  var len = arr.length;
  var res = new Array(len);

  while (len--) {
    var ele = arr[len];
    var val = ele[prop].toString();
    ele[prop] = pad(val, max, ' ');
    res[len] = ele;
  }
  return res;
}

function objectValues(obj, prop) {
  if (typeof prop !== 'undefined') {
    return objectProperties(obj, prop);
  }

  var max = longest(obj).length;
  var res = {};

  for (var key in obj) {
    if (obj.hasOwnProperty(key)) {
      var val = obj[key];
      res[key] = pad(val, max, ' ');
    }
  }
  return res;
}

function objectProperties(obj, prop) {
  var longest = 0;
  var res = {};

  for (var key in obj) {
    if (obj.hasOwnProperty(key)) {
      var val = obj[key];
      if (isObject(val) && val.hasOwnProperty(prop)) {
        var len = val[prop].length;
        if (len > longest) {
          longest = len;
        }
      }
    }
  }

  Object.keys(obj).forEach(function(key) {
    var val = obj[key];
    res[key] = val;

    if (isObject(val) && val.hasOwnProperty(prop)) {
      res[key][prop] = pad(val[prop], longest, ' ');
    }
  });

  return res;
}