Message: add support for custom formatters

Most globalize modules can now be used directly
from within messages.

Also fixes selectOrdinal not using the correct plural function.

The messageformat compiler and runtime are forked from
messageformat.js.

Fixes #563

Author: nkovacs

Gruntfile.js

@@ -132,7 +132,8 @@ module.exports = function( grunt ) {
 				paths: {
 					cldr: "../external/cldrjs/dist/cldr",
 					"make-plural": "../external/make-plural/make-plural",
-					messageformat: "../external/messageformat/messageformat",
+					"messageformat-parser": "../node_modules/messageformat-parser/parser",
+					"reserved-words": "../node_modules/reserved-words/lib/reserved-words",
 					"zoned-date-time": "../node_modules/zoned-date-time/src/zoned-date-time"
 				},
 				shim: {
@@ -151,8 +152,7 @@ module.exports = function( grunt ) {
 				//    Only for root id's (the ones in src, not in src's subpaths). Note there's no
 				//    conditional code checking for this type.
 				onBuildWrite: function( id, path, contents ) {
-					var messageformat,
-						name = camelCase( id.replace( /util\/|common\//, "" ) );
+					var name = camelCase( id.replace( /util\/|common\//, "" ) );
 
 					// MakePlural
 					if ( ( /make-plural/ ).test( id ) ) {
@@ -200,68 +200,39 @@ module.exports = function( grunt ) {
 								"/* jshint ignore:end */"
 							].join( "\n" ) );
 
-					// messageformat
-					} else if ( ( /messageformat/ ).test( id ) ) {
-						return contents
+					// messageformat-parser
+					} else if ( ( /messageformat-parser/.test( id ) ) ) {
 
-							// Remove browserify wrappers.
-							.replace( /^\(function\(f\)\{if\(typeof exports==="object"&&type.*/, "" )
-							.replace( "},{}],2:[function(require,module,exports){", "" )
-							.replace( /\},\{"\.\/messageformat-parser":1,"make-plural\/plural.*/, "" )
-							.replace( /\},\{\}\]\},\{\},\[2\]\)\(2\)[\s\S]*?$/, "" )
-
-							// Set `MessageFormat.plurals` and remove `make-plural/plurals`
-							// completely. This is populated by Globalize on demand.
-							.replace( /var _cp = \[[\s\S]*?$/, "" )
-							.replace(
-								"MessageFormat.plurals = require('make-plural/plurals')",
-								"MessageFormat.plurals = {}"
-							)
-
-							// Set `MessageFormat._parse`
-							.replace(
-								"MessageFormat._parse = require('./messageformat-parser').parse;",
-								""
-							)
-							.replace( /module\.exports = \(function\(\) \{([\s\S]*?)\n\}\)\(\);/, [
-								"MessageFormat._parse = (function() {",
-								"$1",
-								"}()).parse;"
+						return contents
+							.replace( /^/, [
+								"var Parser;",
+								"/* jshint ignore:start */\n",
+								"Parser = (function() {"
 							].join( "\n" ) )
+							.replace( "module.exports = ", "return " )
+							.replace( /$/, [
+								"}());",
+								"/* jshint ignore:end */"
+							].join( "\n" ) );
 
-							// Remove unused code.
-							.replace( /if \(!pluralFunc\) \{\n[\s\S]*?\n  \}/, "" )
-							.replace( /if \(!locale\) \{\n[\s\S]*?  \}\n/, "this.lc = [locale];" )
-							.replace( /(MessageFormat\.formatters) = \{[\s\S]*?\n\};/, "$1 = {};" )
-							.replace( /MessageFormat\.prototype\.setIntlSupport[\s\S]*?\n\};/, "" )
+					// reserved-words
+					} else if ( ( /reserved-words/.test( id ) ) ) {
 
-							// Wrap everything into a var assignment.
-							.replace( "module.exports = MessageFormat;", "" )
+						return contents
 							.replace( /^/, [
-								"var MessageFormat;",
-								"/* jshint ignore:start */",
-								"MessageFormat = (function() {"
+								"var reserved;",
+								"/* jshint ignore:start */\n",
+								"reserved = (function() {",
+								"var exports = {};"
 							].join( "\n" ) )
+							.replace( "var assert = require\('assert'\);", "" )
+							.replace( /^\s*assert\(.*;\s*$/gm, "" )
 							.replace( /$/, [
-								"return MessageFormat;",
+								"return exports;",
 								"}());",
 								"/* jshint ignore:end */"
 							].join( "\n" ) );
 
-					// message-runtime
-					} else if ( ( /message-runtime/ ).test( id ) ) {
-						messageformat = require( "./external/messageformat/messageformat" );
-						delete messageformat.prototype.runtime.fmt;
-						delete messageformat.prototype.runtime.pluralFuncs;
-						contents = contents.replace( "Globalize._messageFormat = {};", [
-							"/* jshint ignore:start */",
-							"Globalize._messageFormat = (function() {",
-							messageformat.prototype.runtime.toString(),
-							"return {number: number, plural: plural, select: select};",
-							"}());",
-							"/* jshint ignore:end */"
-						].join( "\n" ) );
-
 					// ZonedDateTime
 					} else if ( ( /zoned-date-time/ ).test( id ) ) {
 						contents = contents.replace(

examples/amd-bower/main.js

@@ -41,6 +41,7 @@ require([
 	"json!cldr-data/supplemental/likelySubtags.json",
 	"json!cldr-data/supplemental/metaZones.json",
 	"json!cldr-data/supplemental/plurals.json",
+	"json!cldr-data/supplemental/ordinals.json",
 	"json!cldr-data/supplemental/timeData.json",
 	"json!cldr-data/supplemental/weekData.json",
 	"json!messages/en.json",
@@ -54,9 +55,8 @@ require([
 	"globalize/plural",
 	"globalize/relative-time",
 	"globalize/unit"
-], function( Globalize, enGregorian, enCurrencies, enDateFields, enNumbers,
-	enTimeZoneNames, enUnits, currencyData, likelySubtags, metaZones,
-	pluralsData, timeData, weekData, messages, ianaTzData ) {
+], function( Globalize, enGregorian, enCurrencies, enDateFields, enNumbers, enUnits, currencyData,
+	likelySubtags, pluralsData, ordinalsData, timeData, weekData, messages ) {
 
 	var en, like, number;
 
@@ -72,6 +72,7 @@ require([
 		likelySubtags,
 		metaZones,
 		pluralsData,
+		ordinalsData,
 		timeData,
 		weekData
 	);

examples/node-npm/main.js

@@ -13,6 +13,7 @@ Globalize.load(
 	require( "cldr-data/supplemental/likelySubtags" ),
 	require( "cldr-data/supplemental/metaZones" ),
 	require( "cldr-data/supplemental/plurals" ),
+	require( "cldr-data/supplemental/ordinals" ),
 	require( "cldr-data/supplemental/timeData" ),
 	require( "cldr-data/supplemental/weekData" )
 );

examples/plain-javascript/index.html

@@ -267,6 +267,14 @@ <h2>Demo output</h2>
             "pluralRule-count-one": "i = 1 and v = 0 @integer 1",
             "pluralRule-count-other": " @integer 0, 2~16, 100, 1000, 10000, 100000, 1000000, … @decimal 0.0~1.5, 10.0, 100.0, 1000.0, 10000.0, 100000.0, 1000000.0, …"
           }
+        },
+        "plurals-type-ordinal": {
+          "en": {
+            "pluralRule-count-one": "n % 10 = 1 and n % 100 != 11 @integer 1, 21, 31, 41, 51, 61, 71, 81, 101, 1001, …",
+            "pluralRule-count-two": "n % 10 = 2 and n % 100 != 12 @integer 2, 22, 32, 42, 52, 62, 72, 82, 102, 1002, …",
+            "pluralRule-count-few": "n % 10 = 3 and n % 100 != 13 @integer 3, 23, 33, 43, 53, 63, 73, 83, 103, 1003, …",
+            "pluralRule-count-other": " @integer 0, 4~18, 100, 1000, 10000, 100000, 1000000, …"
+          }
         }
       }
     });

package.json

@@ -95,7 +95,9 @@
     "iana-tz-data": ">=2017.0.0",
     "matchdep": "0.3.0",
     "mocha": "^3.3.0",
-    "zoned-date-time": "0.0.4"
+    "zoned-date-time": "0.0.4",
+    "messageformat-parser": "^1.0.0",
+    "reserved-words": "^0.1.1"
   },
   "commitplease": {
     "nohook": true

src/common/validate/parameter-type/plural-type.js

@@ -6,8 +6,8 @@ return function( value, name ) {
 	validateParameterType(
 		value,
 		name,
-		value === undefined || value === "cardinal" || value === "ordinal",
-		"String \"cardinal\" or \"ordinal\""
+		value === undefined || value === "cardinal" || value === "ordinal" || value === "both",
+		"String \"cardinal\" or \"ordinal\" or \"both\""
 	);
 };
 

src/core.js

@@ -86,6 +86,12 @@ Globalize.locale = function( locale ) {
 	return this.cldr;
 };
 
+Globalize._messageFmts = {};
+
+Globalize.addMessageFormatterFunction = function( name, fn ) {
+	Globalize._messageFmts[name] = fn;
+};
+
 /**
  * Optimization to avoid duplicating some internal functions across modules.
  */

src/currency.js

@@ -91,6 +91,14 @@ Globalize.prototype.currencyFormatter = function( currency, options ) {
 	return returnFn;
 };
 
+Globalize.addMessageFormatterFunction( "currency", function( currency, style ) {
+	var options = {};
+	if ( style ) {
+		options.style = style;
+	}
+	return this.currencyFormatter( currency, options );
+});
+
 /**
  * .currencyParser( currency [, options] )
  *

src/date.js

@@ -210,6 +210,16 @@ Globalize.prototype.dateToPartsFormatter = function( options ) {
 	return returnFn;
 };
 
+[ "date", "time", "datetime" ].map(function( type ) {
+	Globalize.addMessageFormatterFunction( type, function( p ) {
+		var options = {};
+		if ( p ) {
+			options[type] = p;
+		}
+		return this.dateFormatter( options );
+	});
+});
+
 /**
  * .dateParser( options )
  *

src/message-runtime.js

@@ -2,11 +2,14 @@ define([
 	"./common/runtime-key",
 	"./common/validate/parameter-type/message-variables",
 	"./core-runtime",
-	"./message/formatter-fn"
-], function( runtimeKey, validateParameterTypeMessageVariables, Globalize, messageFormatterFn ) {
+	"./message/formatter-fn",
+	"./message/formatter-runtime"
+], function( runtimeKey, validateParameterTypeMessageVariables, Globalize, messageFormatterFn,
+	messageFormatterRuntime
+) {
 
 Globalize._messageFormatterFn = messageFormatterFn;
-Globalize._messageFormat = {};
+Globalize._messageFormat = new messageFormatterRuntime(); // TODO setStrictNumber
 Globalize._validateParameterTypeMessageVariables = validateParameterTypeMessageVariables;
 
 Globalize.messageFormatter =