Number & Currency: Add format to parts support

- Currency: Fix code style
- Currency: pluralGenerator better error handling

Fixes #679
Fixes #680

README.md

@@ -475,6 +475,21 @@ Return a function that formats a number according to the given options or locale
 
 [Read more...](doc/api/number/number-formatter.md)
 
+#### `.numberToPartsFormatter( [options] )`
+
+Return a function that formats a number into parts tokens according to the given options or locale's defaults.
+
+```javascript
+.numberToPartsFormatter()( new Date() )
+// > [
+//   { "type": "integer", "value": "3" },
+//   { "type": "decimal", "value": "." },
+//   { "type": "fraction", "value": "142" }
+// ]
+```
+
+[Read more...](doc/api/number/number-to-parts-formatter.md)
+
 #### `.numberParser( [options] )`
 
 Return a function that parses a string representing a number according to the given options or locale's defaults.
@@ -496,6 +511,10 @@ Return a function that parses a string representing a number according to the gi
 
 Alias for `.numberFormatter( [options] )( value )`.
 
+#### `.formatNumberToParts( value [, options] )`
+
+Alias for `.numberToPartsFormatter( [options] )( value )`.
+
 #### `.parseNumber( value [, options] )`
 
 Alias for `.numberParser( [options] )( value )`.
@@ -525,10 +544,33 @@ Return a function that formats a currency according to the given options or loca
 
 [Read more...](doc/api/currency/currency-formatter.md)
 
+#### `.currencyToPartsFormatter( currency [, options] )`
+
+Return a function that formats a currency into parts tokens according to the given options or locale's defaults.
+
+```javascript
+.currencyToPartsFormatter()( new Date() )
+// > [
+//   { "type": "currency", "value": "USD" },
+//   { "type": "literal", "value": " " },
+//   { "type": "integer", "value": "69" },
+//   { "type": "group", "value": "," },
+//   { "type": "integer", "value": "900" },
+//   { "type": "decimal", "value": "." },
+//   { "type": "fraction", "value": "00" }
+// ]
+```
+
+[Read more...](doc/api/currency/currency-to-parts-formatter.md)
+
 #### `.formatCurrency( value, currency [, options] )`
 
 Alias for `.currencyFormatter( currency [, options] )( value )`.
 
+#### `.formatCurrencyToParts( value, currency [, options] )`
+
+Alias for `.currencyToPartsFormatter( currency [, options] )( value )`.
+
 ### Plural module
 
 #### `.pluralGenerator( [options] )`

src/build/intro-currency-runtime.js

@@ -41,7 +41,9 @@
 
 "use strict";
 
-var formatMessage = Globalize._formatMessage,
+var formatMessageToParts = Globalize._formatMessageToParts,
+	partsJoin = Globalize._partsJoin,
+	partsPush = Globalize._partsPush,
 	runtimeKey = Globalize._runtimeKey,
 	validateParameterPresence = Globalize._validateParameterPresence,
 	validateParameterTypeNumber = Globalize._validateParameterTypeNumber;

src/build/intro-currency.js

@@ -34,9 +34,12 @@
 }(this, function( Cldr, Globalize ) {
 
 var alwaysArray = Globalize._alwaysArray,
-	formatMessage = Globalize._formatMessage,
+	createError = Globalize._createError,
+	formatMessageToParts = Globalize._formatMessageToParts,
 	numberNumberingSystem = Globalize._numberNumberingSystem,
 	numberPattern = Globalize._numberPattern,
+	partsJoin = Globalize._partsJoin,
+	partsPush = Globalize._partsPush,
 	runtimeBind = Globalize._runtimeBind,
 	stringPad = Globalize._stringPad,
 	validateCldr = Globalize._validateCldr,

src/build/intro-date-runtime.js

@@ -43,6 +43,8 @@
 
 var createErrorUnsupportedFeature = Globalize._createErrorUnsupportedFeature,
 	looseMatching = Globalize._looseMatching,
+	partsJoin = Globalize._partsJoin,
+	partsPush = Globalize._partsPush,
 	regexpEscape = Globalize._regexpEscape,
 	removeLiteralQuotes = Globalize._removeLiteralQuotes,
 	runtimeKey = Globalize._runtimeKey,

src/build/intro-date.js

@@ -44,6 +44,8 @@ var createError = Globalize._createError,
 	looseMatching = Globalize._looseMatching,
 	numberNumberingSystemDigitsMap = Globalize._numberNumberingSystemDigitsMap,
 	numberSymbol = Globalize._numberSymbol,
+	partsJoin = Globalize._partsJoin,
+	partsPush = Globalize._partsPush,
 	regexpEscape = Globalize._regexpEscape,
 	removeLiteralQuotes = Globalize._removeLiteralQuotes,
 	runtimeBind = Globalize._runtimeBind,

src/build/intro-number-runtime.js

@@ -38,6 +38,8 @@
 "use strict";
 
 var createError = Globalize._createError,
+	partsJoin = Globalize._partsJoin,
+	partsPush = Globalize._partsPush,
 	regexpEscape = Globalize._regexpEscape,
 	runtimeKey = Globalize._runtimeKey,
 	stringPad = Globalize._stringPad,

src/build/intro-number.js

@@ -37,6 +37,8 @@
 }(this, function( Cldr, Globalize ) {
 
 var createError = Globalize._createError,
+	partsJoin = Globalize._partsJoin,
+	partsPush = Globalize._partsPush,
 	regexpEscape = Globalize._regexpEscape,
 	runtimeBind = Globalize._runtimeBind,
 	stringPad = Globalize._stringPad,

src/common/format-message-to-parts.js

@@ -0,0 +1,44 @@
+define([
+	"./parts/push"
+], function( partsPush ) {
+
+/**
+ * formatMessage( message, data )
+ *
+ * @message [String] A message with optional {vars} to be replaced.
+ *
+ * @data [Array or JSON] Object with replacing-variables content.
+ *
+ * Return the formatted message. For example:
+ *
+ * - formatMessage( "{0} second", [ 1 ] );
+ * > [{type: "variable", value: "1", name: "0"}, {type: "literal", value: " second"}]
+ *
+ * - formatMessage( "{0}/{1}", ["m", "s"] );
+ * > [
+ *     { type: "variable", value: "m", name: "0" },
+ *     { type: "literal", value: " /" },
+ *     { type: "variable", value: "s", name: "1" }
+ *   ]
+ */
+return function( message, data ) {
+
+	var lastOffset = 0,
+		parts = [];
+
+	// Create parts.
+	message.replace( /{[0-9a-zA-Z-_. ]+}/g, function( nameIncludingBrackets, offset ) {
+		var name = nameIncludingBrackets.slice( 1, -1 );
+		partsPush( parts, "literal", message.slice( lastOffset, offset ));
+		partsPush( parts, "variable", data[ name ] );
+		parts[ parts.length - 1 ].name = name;
+		lastOffset += offset + nameIncludingBrackets.length;
+	});
+
+	// Skip empty ones such as `{ type: 'literal', value: '' }`.
+	return parts.filter(function( part ) {
+		return part.value !== "";
+	});
+};
+
+});

src/common/parts/join.js

@@ -0,0 +1,12 @@
+define(function() {
+
+/**
+ * Returns joined parts values.
+ */
+return function( parts ) {
+	return parts.map( function( part ) {
+		return part.value;
+	}).join( "" );
+};
+
+});

src/common/parts/push.js

@@ -0,0 +1,17 @@
+define(function() {
+
+/**
+ * Pushes part to parts array, concat two consecutive parts of the same type.
+ */
+return function( parts, type, value ) {
+
+		// Concat two consecutive parts of same type
+		if ( parts.length && parts[ parts.length - 1 ].type === type ) {
+			parts[ parts.length - 1 ].value += value;
+			return;
+		}
+
+		parts.push( { type: type, value: value } );
+};
+
+});

src/core-runtime.js

@@ -1,14 +1,18 @@
 define([
 	"./common/create-error",
 	"./common/format-message",
+	"./common/format-message-to-parts",
+	"./common/parts/join",
+	"./common/parts/push",
 	"./common/runtime-key",
 	"./common/validate/parameter-presence",
 	"./common/validate/parameter-type",
 	"./common/validate/parameter-type/string",
 	"./util/regexp/escape",
 	"./util/string/pad"
-], function( createError, formatMessage, runtimeKey, validateParameterPresence,
-	validateParameterType, validateParameterTypeString, regexpEscape, stringPad ) {
+], function( createError, formatMessage, formatMessageToParts, partsJoin, partsPush, runtimeKey,
+	validateParameterPresence, validateParameterType, validateParameterTypeString, regexpEscape,
+	stringPad ) {
 
 function Globalize( locale ) {
 	if ( !( this instanceof Globalize ) ) {
@@ -32,6 +36,9 @@ Globalize.locale = function( locale ) {
 
 Globalize._createError = createError;
 Globalize._formatMessage = formatMessage;
+Globalize._formatMessageToParts = formatMessageToParts;
+Globalize._partsJoin = partsJoin;
+Globalize._partsPush = partsPush;
 Globalize._regexpEscape = regexpEscape;
 Globalize._runtimeKey = runtimeKey;
 Globalize._stringPad = stringPad;

src/core.js

@@ -2,6 +2,9 @@ define([
 	"cldr",
 	"./common/create-error",
 	"./common/format-message",
+	"./common/format-message-to-parts",
+	"./common/parts/join",
+	"./common/parts/push",
 	"./common/runtime-bind",
 	"./common/validate",
 	"./common/validate/cldr",
@@ -19,10 +22,11 @@ define([
 	"./util/string/pad",
 
 	"cldr/event"
-], function( Cldr, createError, formatMessage, runtimeBind, validate, validateCldr,
-	validateDefaultLocale, validateParameterPresence, validateParameterRange, validateParameterType,
-	validateParameterTypeLocale, validateParameterTypePlainObject, alwaysArray, alwaysCldr,
-	isPlainObject, objectExtend, regexpEscape, stringPad ) {
+], function( Cldr, createError, formatMessage, formatMessageToParts, partsJoin, partsPush,
+	runtimeBind, validate, validateCldr, validateDefaultLocale, validateParameterPresence,
+	validateParameterRange, validateParameterType, validateParameterTypeLocale,
+	validateParameterTypePlainObject, alwaysArray, alwaysCldr, isPlainObject, objectExtend,
+	regexpEscape, stringPad ) {
 
 function validateLikelySubtags( cldr ) {
 	cldr.once( "get", validateCldr );
@@ -92,8 +96,11 @@ Globalize.locale = function( locale ) {
 Globalize._alwaysArray = alwaysArray;
 Globalize._createError = createError;
 Globalize._formatMessage = formatMessage;
+Globalize._formatMessageToParts = formatMessageToParts;
 Globalize._isPlainObject = isPlainObject;
 Globalize._objectExtend = objectExtend;
+Globalize._partsJoin = partsJoin;
+Globalize._partsPush = partsPush;
 Globalize._regexpEscape = regexpEscape;
 Globalize._runtimeBind = runtimeBind;
 Globalize._stringPad = stringPad;

src/currency-runtime.js

@@ -5,20 +5,30 @@ define([
 	"./core-runtime",
 	"./currency/formatter-fn",
 	"./currency/name-format",
+	"./currency/to-parts-formatter-fn",
 
 	"./number-runtime"
 ], function( runtimeKey, validateParameterPresence, validateParameterTypeNumber, Globalize,
-	currencyFormatterFn, currencyNameFormat ) {
+	currencyFormatterFn, currencyNameFormat, currencyToPartsFormatterFn ) {
 
 Globalize._currencyFormatterFn = currencyFormatterFn;
 Globalize._currencyNameFormat = currencyNameFormat;
+Globalize._currencyToPartsFormatterFn = currencyToPartsFormatterFn;
 
 Globalize.currencyFormatter =
 Globalize.prototype.currencyFormatter = function( currency, options ) {
 	options = options || {};
 	return Globalize[ runtimeKey( "currencyFormatter", this._locale, [ currency, options ] ) ];
 };
 
+Globalize.currencyToPartsFormatter =
+Globalize.prototype.currencyToPartsFormatter = function( currency, options ) {
+	options = options || {};
+	return Globalize[
+		runtimeKey( "currencyToPartsFormatter", this._locale, [ currency, options ] )
+	];
+};
+
 Globalize.formatCurrency =
 Globalize.prototype.formatCurrency = function( value, currency, options ) {
 	validateParameterPresence( value, "value" );
@@ -27,6 +37,14 @@ Globalize.prototype.formatCurrency = function( value, currency, options ) {
 	return this.currencyFormatter( currency, options )( value );
 };
 
+Globalize.formatCurrencyToParts =
+Globalize.prototype.formatCurrencyToParts = function( value, currency, options ) {
+	validateParameterPresence( value, "value" );
+	validateParameterTypeNumber( value, "value" );
+
+	return this.currencyToPartsFormatter( currency, options )( value );
+};
+
 return Globalize;
 
 });