Message: Provide Bidi structured text support

Ref globalizejs#539
Ref globalizejs#599

doc/api/message/message-formatter.md

@@ -1,4 +1,4 @@
-## .messageFormatter( path ) ➡ function([ variables ])
+## .messageFormatter( path, options ) ➡ function([ variables ])
 
 Return a function that formats a message (using ICU message format pattern)
 given its path and a set of variables into a user-readable string. It supports
@@ -14,6 +14,18 @@ messages data.
 String or Array containing the path of the message content, eg.
 `"greetings/bye"`, or `[ "greetings", "bye" ]`.
 
+**options** (optional)
+
+Options should be an Objects, where each property can be referenced by name.
+The possible property having name recognizable by messageFormatter is "setBiDiSupport".
+It should have Boolean value indicating whether Bidi structuring is to be imposed on formatted 
+message (like {"setBiDiSupport": true}).
+Special Unicode Bidi marks are inserted depending on locale in order to preserve the text 
+flow of structured message which corresponds give local (from right-to-left for Bidi scripts 
+like Arabic, Hebrew or Pharsi and left-to-right otherwise.
+For more info on Bidi structured text see: 
+http://cldr.unicode.org/development/development-process/design-proposals/bidi-handling-of-structured-text
+
 **variables** (optional)
 
 Variables can be Objects, where each property can be referenced by name inside a
@@ -212,6 +224,15 @@ likeFormatter( 2 );
 likeFormatter( 3 );
 // > "You and 2 others liked this"
 ```
+#### Bidi structured meessage
+	Globalize.loadMessages({
+		ar: { breadcrumb: "{0} >> {1} >> {2}" }		
+	}); 
+bidiFormatter = Globalize( "ar" ).messageFormatter( "breadcrumb", {"setBiDiSupport": true} );
+
+bidiFormatter( "First", "Second", "Third" );
+// > "Third << Second << First"
+
 
 Read on [SlexAxton/messageFormatter.js][] for more information on regard of ICU
 MessageFormat.

src/message.js

@@ -58,10 +58,12 @@ Globalize.loadMessages = function( json ) {
  *
  * @path [String or Array]
  *
+ * @options [object]
+ *
  * Format a message given its path.
  */
 Globalize.messageFormatter =
-Globalize.prototype.messageFormatter = function( path ) {
+Globalize.prototype.messageFormatter = function( path, options ) {
 	var cldr, formatter, message, pluralGenerator, returnFn,
 		args = slice.call( arguments, 0 );
 
@@ -85,6 +87,9 @@ Globalize.prototype.messageFormatter = function( path ) {
 	validateMessageType( path, message );
 
 	var compiler = new messageCompiler( this, Globalize._messageFmts );
+	if ( options && ( options.setBiDiSupport === true ) ) {
+		compiler.setBiDiSupport( true );
+	}
 	var formatterSrc = compiler
 		.compile( message, cldr.locale );
 
@@ -149,7 +154,9 @@ Globalize.prototype.messageFormatter = function( path ) {
  */
 Globalize.formatMessage =
 Globalize.prototype.formatMessage = function( path /* , variables */ ) {
-	return this.messageFormatter( path ).apply( {}, slice.call( arguments, 1 ) );
+	return ( arguments[ 1 ] && arguments[ 1 ].setBiDiSupport === true ) ?
+		this.messageFormatter( path, arguments[ 1 ] ).apply( {}, slice.call( arguments, 2 ) ) :
+		this.messageFormatter( path ).apply( {}, slice.call( arguments, 1 ) );
 };
 
 return Globalize;

test/functional/message/format-message.js

@@ -1,4 +1,4 @@
-define([
+define([
 	"globalize",
 	"json!cldr-data/supplemental/likelySubtags.json",
 	"json!cldr-data/supplemental/plurals.json",
@@ -19,6 +19,9 @@ QUnit.module( ".formatMessage( path [, variables] )", {
 				greetings: {
 					hello: "Hello, {name}"
 				}
+			},
+			he: {
+				breadcrumb: "{0} >> {1} >> {2}",
 			}
 		});
 	},
@@ -49,4 +52,16 @@ QUnit.test( "should format a message", function( assert ) {
 	}), "Hello, Beethoven" );
 });
 
+QUnit.test( "should format a message", function( assert ) {
+	assert.equal( Globalize( "en" ).formatMessage( "greetings/hello", {
+		name: "Beethoven"
+	}), "Hello, Beethoven" );
+});
+
+QUnit.test( "should support Bidi structured text", function( assert ) {
+	assert.equal( Globalize( "he" ).formatMessage( "breadcrumb", {"setBiDiSupport": true},
+	[ "Mozart", "Bethoven", "Dvorzak" ]
+	), "\u200FMozart\u200F >> \u200FBethoven\u200F >> \u200FDvorzak\u200F" );
+});
+
 });

test/functional/message/message-formatter.js

@@ -70,6 +70,9 @@ QUnit.module( ".messageFormatter( path )", {
 			},
 			"en-GB": {},
 			fr: {},
+			he: {
+				helloArray: "Hello, {0} & {1}"
+			},
 			pt: {
 				amen: "Amém"
 			},
@@ -198,6 +201,13 @@ QUnit.test( "should support ICU message format", function( assert ) {
 	}, "4th category" );
 });
 
+QUnit.test( "should support Bidi structured text", function( assert ) {
+	assert.equal(
+		Globalize( "he" ).messageFormatter( "helloArray", {"setBiDiSupport": true} )( "Beethoven", "Mozart" ),
+		"Hello, \u200FBeethoven\u200F & \u200FMozart\u200F"
+	);
+});
+
 // Reference #473
 QUnit.test( "should NOT merge array data", function( assert ) {
 	// Re-loading a message that uses array syntax.