inflection.js

'use strict';

var utils = require('./utils');
var indexOf = require('./utils/indexOf');

/**
 * Expose `helpers`
 */

var helpers = module.exports;

/**
 * @name .inflect
 * @param {type} `count`
 * @param {type} `singular`
 * @param {type} `plural`
 * @param {type} `include`
 * @return {String}
 * @api public
 */

helpers.inflect = function(count, singular, plural, include) {
  var word = count > 1 || count === 0
    ? plural
    : singular;

  if (utils.isUndefined(include) || include === false) {
    return word;
  } else {
    return ''
      + count
      + ' '
      + word;
  }
};

/**
 * Returns an ordinalized number (as a string).
 *
 * ```js
 * {{ordinalize 1}}
 * //=> '1st'
 * {{ordinalize 21}}
 * //=> '21st'
 * {{ordinalize 29}}
 * //=> '29th'
 * {{ordinalize 22}}
 * //=> '22nd'
 * ```
 *
 * @param {String} `val` The value to ordinalize.
 * @return {String} The ordinalized number
 * @api public
 */

helpers.ordinalize = function(val) {
  var num = Math.abs(Math.round(val));
  var res;

  if (res = num % 100, indexOf.call([11, 12, 13], res) >= 0) {
    return '' + val + 'th';
  }

  switch (num % 10) {
    case 1:
      return '' + val + 'st';
    case 2:
      return '' + val + 'nd';
    case 3:
      return '' + val + 'rd';
    default:
      return '' + val + 'th';
  }
};