/ajax/libs//0.2/accounting.js
JavaScript | 361 lines | 171 code | 56 blank | 134 comment | 30 complexity | 15bf36d11987858a657bedb256b2e792 MD5 | raw file
- /*!
- * accounting.js javascript library v0.2
- * https://josscrowcroft.github.com/accounting.js/
- *
- * Copyright 2011 by Joss Crowcroft
- * Licensed under GPL v3 | http://www.gnu.org/licenses/gpl-3.0.txt
- */
- var accounting = (function () {
- /* ===== Library Settings ===== */
- /**
- * The library's settings configuration object
- *
- * Contains default parameters for currency and number formatting
- */
- var settings = {
- currency: {
- symbol : "$", // default currency symbol is '$'
- format: "%s%v", // controls output: %s = symbol, %v = value (can be object, see docs)
- decimal : ".", // decimal point separator
- thousand: ",", // thousands separator
- precision : 2, // decimal places
- grouping : 3 // digit grouping (not implemented yet)
- },
- number: {
- precision : 0, // default precision on numbers is 0
- grouping : 3, // digit grouping (not implemented yet)
- thousand: ",",
- decimal : "."
- }
- };
- /* ===== Internal Helper Methods ===== */
- // Store reference to possibly-available ECMAScript 5 methods for later:
- var nativeMap = Array.prototype.map,
- nativeIsArray = Array.isArray,
- toString = Object.prototype.toString;
- /**
- * Tests whether supplied parameter is a string
- * from underscore.js
- */
- function isString(obj) {
- return !!(obj === '' || (obj && obj.charCodeAt && obj.substr));
- }
- /**
- * Tests whether supplied parameter is a string
- * from underscore.js, delegates to ECMA5's native Array.isArray
- */
- function isArray(obj) {
- return nativeIsArray ? nativeIsArray(obj) : toString.call(obj) === '[object Array]';
- }
- /**
- * Tests whether supplied parameter is a true object
- * from underscore.js, delegates to ECMA5's native Array.isArray
- */
- function isObject(obj) {
- return toString.call(obj) === '[object Object]';
- }
- /**
- * Extends an object with a defaults object, similar to underscore's _.defaults
- *
- * Used for abstracting parameter handling from API methods
- */
- function defaults(object, defs) {
- var key;
- // Iterate over object non-prototype properties:
- for (key in defs) {
- if (defs.hasOwnProperty(key)) {
- // Replace values with defaults only if undefined (allow empty/zero values):
- if (object[key] == null) object[key] = defs[key];
- }
- }
- return object;
- }
- /**
- * Implementation of `Array.map()` for iteration loops
- *
- * Returns a new Array as a result of calling `iterator` on each array value.
- * Defers to native Array.map if available
- */
- function map(obj, iterator, context) {
- var results = [], i, j;
- if (!obj) return results;
- // Use native .map method if it exists:
- if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
- // Fallback for native .map:
- for (i = 0, j = obj.length; i < j; i++ ) {
- results[i] = iterator.call(context, obj[i], i, obj);
- }
- return results;
- }
- /**
- * Check and normalise the value of precision (must be positive integer):
- */
- function checkPrecision(val, base) {
- val = Math.round(Math.abs(val));
- return isNaN(val)? base : val;
- }
- /**
- * Parses a format string or object and returns format obj for use in rendering
- *
- * `format` is either a string with the default (positive) format, or object
- * containing `pos` (required), `neg` and `zero` values (or a function returning
- * either a string or object)
- *
- * Either string or format.pos must contain "%v" (value) to be valid
- */
- function checkCurrencyFormat(format) {
- var defaults = settings.currency.format;
- // Allow function as format parameter (should return string or object):
- if ( typeof format === "function" ) format = format();
- // Format can be a string, in which case `value` ("%v") must be present:
- if ( isString( format ) && format.match("%v") ) {
- // Create and return positive, negative and zero formats:
- return {
- pos: format,
- neg: format.replace("-", "").replace("%v", "-%v"),
- zero:format
- };
- // If no format, or object is missing valid positive value, use defaults:
- } else if ( !format || !format.pos || !format.pos.match("%v") ) {
- // If defaults is a string, casts it to an object for faster checking next time:
- return ( !isString( defaults ) ) ? defaults : settings.currency.format = {
- pos: defaults,
- neg: defaults.replace("%v", "-%v"),
- zero:defaults
- };
- }
- // Otherwise, assume format was fine:
- return format;
- }
- /* ===== API Methods ===== */
- /**
- * Removes currency formatting from a number/array of numbers, returning numeric values
- *
- * Decimal must be included in the regular expression to match floats (default: ".")
- * To do: rewrite this to be a little more elegant and maybe throw useful errors.
- */
- function unformat(number, decimal) {
- // Recursively unformat arrays:
- if (isArray(number)) {
- return map(number, function(val) {
- return unformat(val, decimal);
- });
- }
- // Fails silently (need decent errors):
- number = number || 0;
- // Default decimal point is "." but could be set to eg. "," in opts:
- decimal = decimal || ".";
- // Build regex to strip out everything except digits, decimal point and minus sign:
- var regex = new RegExp("[^0-9-" + decimal + "]", ["g"]),
- unformatted = parseFloat(("" + number).replace(regex, '').replace(decimal, '.'));
- // This will fail silently which may cause trouble, let's wait and see:
- return !isNaN(unformatted) ? unformatted : 0;
- }
- /**
- * Implementation of toFixed() that treats floats more like decimals
- *
- * Fixes binary rounding issues (eg. (0.615).toFixed(2) === "0.61") that present
- * problems for accounting- and finance-related software.
- */
- function toFixed(value, precision) {
- precision = checkPrecision(precision, settings.number.precision);
- var power = Math.pow(10, precision);
- // Multiply up by precision, round accurately, then divide and use native toFixed():
- return (Math.round(value * power) / power).toFixed(precision);
- }
- /**
- * Format a number, with comma-separated thousands and custom precision/decimal places
- *
- * Localise by overriding the precision and thousand / decimal separators
- * 2nd parameter `precision` can be an object matching `settings.number`
- */
- function formatNumber(number, precision, thousand, decimal) {
- // Resursively format arrays:
- if (isArray(number)) {
- return map(number, function(val) {
- return formatNumber(val, precision, thousand, decimal);
- });
- }
- // Number isn't an array - do the formatting:
- var result, opts;
- // Second param precision can be an object matching settings.number:
- opts = isObject(precision) ? precision : {
- precision: precision,
- thousand : thousand,
- decimal : decimal
- };
- // Extend opts with the default values in settings.number:
- opts = defaults(opts, settings.number);
- // Clean up number and precision:
- number = unformat(number);
- opts.precision = checkPrecision(opts.precision);
- // Do some calc:
- var negative = number < 0 ? "-" : "",
- base = parseInt(toFixed(Math.abs(number || 0), opts.precision), 10) + "",
- mod = base.length > 3 ? base.length % 3 : 0;
- // Format the number:
- return negative + (mod ? base.substr(0, mod) + opts.thousand : "") + base.substr(mod).replace(/(\d{3})(?=\d)/g, "$1" + opts.thousand) + (opts.precision ? opts.decimal + toFixed(Math.abs(number), opts.precision).split('.')[1] : "");
- }
- /**
- * Format a number into currency
- *
- * Usage: accounting.formatMoney(number, precision, symbol, thousandsSep, decimalSep, format)
- * defaults: (0, 2, "$", ",", ".", "%s%v")
- *
- * Localise by overriding the symbol, precision, thousand / decimal separators and format
- * Second param can be an object matching `settings.currency` which is the easiest way.
- *
- * To do: tidy up the parameters
- */
- function formatMoney(number, symbol, precision, thousand, decimal, format) {
- // Resursively format arrays:
- if (isArray(number)) {
- return map(number, function(val){
- return formatMoney(val, symbol, precision, thousand, decimal, format);
- });
- }
- // Build options object from second param (if object) or all params, extending defaults:
- var opts = defaults(
- (isObject(symbol) ? symbol : {
- symbol : symbol,
- precision : precision,
- thousand : thousand,
- decimal : decimal,
- format : format
- }),
- settings.currency
- );
- // Clean up number and precision:
- number = unformat(number);
- opts.precision = checkPrecision(opts.precision);
- // Check format (returns object with `pos`, `neg` and `zero`):
- opts.format = checkCurrencyFormat(opts.format);
- // Choose which format to use for this value (pos, neg or zero):
- opts.format = number > 0 ? opts.format.pos : number < 0 ? opts.format.neg : opts.format.zero;
- // Return with currency symbol added:
- return opts.format.replace('%s', opts.symbol).replace('%v', formatNumber(Math.abs(number), opts.precision, opts.thousand, opts.decimal));
- }
- /**
- * Format a list of numbers into an accounting column, padding with whitespace
- * to line up currency symbols, thousand separators and decimals places
- *
- * List should be an array of numbers
- * Second parameter can be an object containing keys that match the params
- *
- * Returns array of accouting-formatted number strings of same length
- *
- * NB: `white-space:pre` CSS rule is required on the list container to prevent
- * browsers from collapsing the whitespace in the output strings.
- */
- function formatColumn(list, symbol, precision, thousand, decimal, format) {
- if (!list) return [];
- // Build options object from second param (if object) or all params, extending defaults:
- var opts = defaults(
- (isObject(symbol) ? symbol : {
- symbol : symbol,
- precision : precision,
- thousand : thousand,
- decimal : decimal,
- format : format
- }),
- settings.currency
- );
- // Check format (returns object with `pos`, `neg` and `zero`), only need 'pos' for now:
- opts.format = checkCurrencyFormat(opts.format);
- // Clean up precision:
- opts.precision = checkPrecision(opts.precision);
- var maxLength = 0,
- // Whether to pad at start of string or after currency symbol:
- padAfterSymbol = opts.format.pos.indexOf("%s") < opts.format.pos.indexOf("%v") ? true : false,
- // Format the list according to options, store the length of the longest string:
- formatted = map(list, function(val, i) {
- if (isArray(val)) {
- // Recursively format columns if list is a multi-dimensional array:
- return formatColumn(val, opts);
- } else {
- // Clean up the value
- val = unformat(val);
- // Choose which format to use for this value (pos, neg or zero):
- var format = val > 0 ? opts.format.pos : val < 0 ? opts.format.neg : opts.format.zero,
- // Format this value, push into formatted list and save the length:
- fVal = format.replace('%s', opts.symbol).replace('%v', formatNumber(Math.abs(val), opts.precision, opts.thousand, opts.decimal));
- if (fVal.length > maxLength) maxLength = fVal.length;
- return fVal;
- }
- });
- // Pad each number in the list and send back the column of numbers:
- return map(formatted, function(val, i) {
- // Only if this is a string (not a nested array, which would have already been padded):
- if (isString(val) && val.length < maxLength) {
- // Depending on symbol position, pad after symbol or at index 0:
- return padAfterSymbol ? val.replace(opts.symbol, opts.symbol+(new Array(maxLength - val.length + 1).join(" "))) : (new Array(maxLength - val.length + 1).join(" ")) + val;
- }
- return val;
- });
- }
- // Return the library's API:
- return {
- settings: settings,
- formatMoney: formatMoney,
- formatNumber: formatNumber,
- formatColumn: formatColumn,
- toFixed: toFixed,
- unformat: unformat
- };
- }());