locutus
Version:
Locutus other languages' standard libraries to JavaScript for fun and educational purposes
276 lines (275 loc) • 13.3 kB
JavaScript
import { getPhpLocaleGroup } from "../_helpers/_phpRuntimeState.js";
import { setlocale } from "../strings/setlocale.js";
const toStringField = (value) => (typeof value === 'string' ? value : '');
const toNumberField = (value) => (typeof value === 'number' ? value : 0);
const toNumberArray = (value) => Array.isArray(value) ? value.filter((item) => typeof item === 'number') : [];
const toMonetaryLocale = (value) => {
return {
mon_thousands_sep: toStringField(value.mon_thousands_sep),
mon_grouping: toNumberArray(value.mon_grouping),
mon_decimal_point: toStringField(value.mon_decimal_point),
int_frac_digits: toNumberField(value.int_frac_digits),
frac_digits: toNumberField(value.frac_digits),
int_curr_symbol: toStringField(value.int_curr_symbol),
currency_symbol: toStringField(value.currency_symbol),
n_sign_posn: toNumberField(value.n_sign_posn),
p_sign_posn: toNumberField(value.p_sign_posn),
n_sep_by_space: toNumberField(value.n_sep_by_space),
p_sep_by_space: toNumberField(value.p_sep_by_space),
n_cs_precedes: toNumberField(value.n_cs_precedes),
p_cs_precedes: toNumberField(value.p_cs_precedes),
positive_sign: toStringField(value.positive_sign),
negative_sign: toStringField(value.negative_sign),
};
};
export function money_format(format, number) {
// discuss at: https://locutus.io/php/money_format/
// parity verified: PHP 8.3
// original by: Brett Zamir (https://brett-zamir.me)
// input by: daniel airton wermann (https://wermann.com.br)
// bugfixed by: Brett Zamir (https://brett-zamir.me)
// note 1: This depends on setlocale having the appropriate
// note 1: locale (these examples use 'en_US')
// example 1: money_format('%i', 1234.56)
// returns 1: ' USD 1,234.56'
// example 2: money_format('%14#8.2n', 1234.5678)
// returns 2: ' $ 1,234.57'
// example 3: money_format('%14#8.2n', -1234.5678)
// returns 3: '-$ 1,234.57'
// example 4: money_format('%(14#8.2n', 1234.5678)
// returns 4: ' $ 1,234.57 '
// example 5: money_format('%(14#8.2n', -1234.5678)
// returns 5: '($ 1,234.57)'
// example 6: money_format('%=014#8.2n', 1234.5678)
// returns 6: ' $000001,234.57'
// example 7: money_format('%=014#8.2n', -1234.5678)
// returns 7: '-$000001,234.57'
// example 8: money_format('%=*14#8.2n', 1234.5678)
// returns 8: ' $*****1,234.57'
// example 9: money_format('%=*14#8.2n', -1234.5678)
// returns 9: '-$*****1,234.57'
// example 10: money_format('%=*^14#8.2n', 1234.5678)
// returns 10: ' $****1234.57'
// example 11: money_format('%=*^14#8.2n', -1234.5678)
// returns 11: ' -$****1234.57'
// example 12: money_format('%=*!14#8.2n', 1234.5678)
// returns 12: ' *****1,234.57'
// example 13: money_format('%=*!14#8.2n', -1234.5678)
// returns 13: '-*****1,234.57'
// example 14: money_format('%i', 3590)
// returns 14: ' USD 3,590.00'
// Per PHP behavior, there seems to be no extra padding
// for sign when there is a positive number, though my
// understanding of the description is that there should be padding;
// need to revisit examples
// Helpful info at https://ftp.gnu.org/pub/pub/old-gnu/Manuals/glibc-2.2.3/html_chapter/libc_7.html
// and https://publib.boulder.ibm.com/infocenter/zos/v1r10/index.jsp?topic=/com.ibm.zos.r10.bpxbd00/strfmp.htm
if (typeof number !== 'number') {
return null;
}
const numericValue = number;
// 1: flags, 3: width, 5: left, 7: right, 8: conversion
const regex = /%((=.|[+^(!-])*?)(\d*?)(#(\d+))?(\.(\d+))?([in%])/g;
// Ensure the locale data we need is set up
setlocale('LC_ALL', 0);
const monetaryGroup = getPhpLocaleGroup('LC_MONETARY', 'LC_MONETARY');
if (!monetaryGroup) {
return null;
}
const monetary = toMonetaryLocale(monetaryGroup);
const doReplace = function (_n0, flags = '', _n2, width = '', _n4, left = '', _n6, right = '', conversion) {
let value = '';
let repl = '';
if (conversion === '%') {
// Percent does not seem to be allowed with intervening content
return '%';
}
const fillMatch = flags && /=./.test(flags) ? flags.match(/=(.)/) : null;
const fill = fillMatch?.[1] ?? ' '; // flag: =f (numeric fill)
// flag: ! (suppress currency symbol)
const showCurrSymbol = !flags || !flags.includes('!');
// field width: w (minimum field width)
const widthNum = parseInt(width, 10) || 0;
const neg = numericValue < 0;
// Convert to string
let numberString = String(numericValue);
// We don't want negative symbol represented here yet
numberString = neg ? numberString.slice(1) : numberString;
const decpos = numberString.indexOf('.');
// Get integer portion
let integer = decpos !== -1 ? numberString.slice(0, decpos) : numberString;
// Get decimal portion
let fraction = decpos !== -1 ? numberString.slice(decpos + 1) : '';
const _strSplice = function (integerStr, idx, thouSep) {
const integerArr = integerStr.split('');
integerArr.splice(idx, 0, thouSep);
return integerArr.join('');
};
const intLen = integer.length;
const leftNum = parseInt(left, 10) || 0;
const filler = intLen < leftNum;
const fillnum = filler ? leftNum - intLen : 0;
if (filler) {
integer = new Array(fillnum + 1).join(fill) + integer;
}
if (!flags.includes('^')) {
// flag: ^ (disable grouping characters (of locale))
// use grouping characters
// ','
let thouSep = monetary.mon_thousands_sep;
// [3] (every 3 digits in U.S.A. locale)
const monGrouping = monetary.mon_grouping;
let i = 0;
let idx = integer.length;
if ((monGrouping[0] ?? 0) < integer.length) {
for (; i < monGrouping.length; i++) {
// e.g., 3
idx -= monGrouping[i] ?? 0;
if (idx <= 0) {
break;
}
if (filler && idx < fillnum) {
thouSep = fill;
}
integer = _strSplice(integer, idx, thouSep);
}
}
if ((monGrouping[i - 1] ?? 0) > 0) {
// Repeating last grouping (may only be one) until highest portion of integer reached
while (idx > (monGrouping[i - 1] ?? 0)) {
idx -= monGrouping[i - 1] ?? 0;
if (filler && idx < fillnum) {
thouSep = fill;
}
integer = _strSplice(integer, idx, thouSep);
}
}
}
// left, right
if (right === '0') {
// No decimal or fractional digits
value = integer;
}
else {
// '.'
let decPt = monetary.mon_decimal_point;
let rightNum = parseInt(right, 10);
if (right === '') {
rightNum = Number(conversion === 'i' ? monetary.int_frac_digits : monetary.frac_digits);
}
rightNum = Number.isNaN(rightNum) ? 0 : rightNum;
if (rightNum === 0) {
// Only remove fractional portion if explicitly set to zero digits
fraction = '';
decPt = '';
}
else if (rightNum < fraction.length) {
const rounded = Math.round(parseFloat(fraction.slice(0, rightNum) + '.' + fraction.substring(rightNum, rightNum + 1)));
fraction = String(rounded);
if (rightNum > fraction.length) {
fraction = new Array(rightNum - fraction.length + 1).join('0') + fraction; // prepend with 0's
}
}
else if (rightNum > fraction.length) {
fraction += new Array(rightNum - fraction.length + 1).join('0'); // pad with 0's
}
value = integer + decPt + fraction;
}
let symbol = '';
if (showCurrSymbol) {
// 'i' vs. 'n' ('USD' vs. '$')
symbol = conversion === 'i' ? monetary.int_curr_symbol : monetary.currency_symbol;
}
const signPosn = neg ? monetary.n_sign_posn : monetary.p_sign_posn;
// 0: no space between curr. symbol and value
// 1: space sep. them unless symb. and sign are adjacent then space sep. them from value
// 2: space sep. sign and value unless symb. and sign are adjacent then space separates
const sepBySpace = neg ? monetary.n_sep_by_space : monetary.p_sep_by_space;
// p_cs_precedes, n_cs_precedes
// positive currency symbol follows value = 0; precedes value = 1
const csPrecedes = neg ? monetary.n_cs_precedes : monetary.p_cs_precedes;
// Assemble symbol/value/sign and possible space as appropriate
if (flags.includes('(')) {
// flag: parenth. for negative
// @todo: unclear on whether and how sepBySpace, signPosn, or csPrecedes have
// an impact here (as they do below), but assuming for now behaves as signPosn 0 as
// far as localized sepBySpace and signPosn behavior
repl =
(csPrecedes ? symbol + (sepBySpace === 1 ? ' ' : '') : '') +
value +
(!csPrecedes ? (sepBySpace === 1 ? ' ' : '') + symbol : '');
if (neg) {
repl = '(' + repl + ')';
}
else {
repl = ' ' + repl + ' ';
}
}
else {
// '+' is default
// ''
const posSign = monetary.positive_sign;
// '-'
const negSign = monetary.negative_sign;
const sign = neg ? negSign : posSign;
const otherSign = neg ? posSign : negSign;
let signPadding = '';
if (signPosn) {
// has a sign
signPadding = new Array(otherSign.length - sign.length + 1).join(' ');
}
let valueAndCS = '';
switch (signPosn) {
// 0: parentheses surround value and curr. symbol;
// 1: sign precedes them;
// 2: sign follows them;
// 3: sign immed. precedes curr. symbol; (but may be space between)
// 4: sign immed. succeeds curr. symbol; (but may be space between)
case 0:
valueAndCS = csPrecedes
? symbol + (sepBySpace === 1 ? ' ' : '') + value
: value + (sepBySpace === 1 ? ' ' : '') + symbol;
repl = '(' + valueAndCS + ')';
break;
case 1:
valueAndCS = csPrecedes
? symbol + (sepBySpace === 1 ? ' ' : '') + value
: value + (sepBySpace === 1 ? ' ' : '') + symbol;
repl = signPadding + sign + (sepBySpace === 2 ? ' ' : '') + valueAndCS;
break;
case 2:
valueAndCS = csPrecedes
? symbol + (sepBySpace === 1 ? ' ' : '') + value
: value + (sepBySpace === 1 ? ' ' : '') + symbol;
repl = valueAndCS + (sepBySpace === 2 ? ' ' : '') + sign + signPadding;
break;
case 3:
repl = csPrecedes
? signPadding + sign + (sepBySpace === 2 ? ' ' : '') + symbol + (sepBySpace === 1 ? ' ' : '') + value
: value + (sepBySpace === 1 ? ' ' : '') + sign + signPadding + (sepBySpace === 2 ? ' ' : '') + symbol;
break;
case 4:
repl = csPrecedes
? symbol + (sepBySpace === 2 ? ' ' : '') + signPadding + sign + (sepBySpace === 1 ? ' ' : '') + value
: value + (sepBySpace === 1 ? ' ' : '') + symbol + (sepBySpace === 2 ? ' ' : '') + sign + signPadding;
break;
}
}
const paddingWidth = widthNum - repl.length;
if (paddingWidth > 0) {
const padding = new Array(paddingWidth + 1).join(' ');
// @todo: How does p_sep_by_space affect the count if there is a space?
// Included in count presumably?
if (flags.includes('-')) {
// left-justified (pad to right)
repl += padding;
}
else {
// right-justified (pad to left)
repl = padding + repl;
}
}
return repl;
};
return format.replace(regex, doReplace);
}