Add date formatter time zone support

Author: rxaviers

README.md

@@ -29,6 +29,8 @@ Use the command line interface as a convenience over using the API directly. It'
 
 **`-c, --cldr CLDR_FILE`** Optional. All necessary CLDR data for given locale (JSON format).
 
+**`-z, --tz TIME_ZONE_FILE`** Optional. All necessary time zone data (JSON format).
+
 **`-m, --messages MESSAGES_FILE`** Optional. Translation messages for given locale (JSON format).
 
 **`-o, --output DEST_FILE`** Destination JavaScript file, e.g., `app-en.js`.
@@ -139,6 +141,8 @@ globalize.formatNumber( ... );
 
     **cldr** optional. It's an *Object* with CLDR data (in the JSON format) or a *Function* taking one argument: locale, a *String*; returning an *Object* with the CLDR data for the passed locale. Defaults to the entire supplemental data plus the entire main data for the defaultLocale.
 
+    **timeZoneData** optional. It's an *Object* with IANA time zone data (in the JSON format) or a *Function* returning an *Object* with the IANA time zone data. Defaults to the entire IANA time zone data from `[iana-tz-data](https://github.com/rxaviers/iana-tz-data)` package.
+
     **messages** optional. It's an *Object* with messages data (in the JSON format) or a *Function* taking one argument: locale, a *String*; returning an *Object* with the messages data for the passed locale. Defaults to `{}`.
 
     **template** optional. A function that replaces the default template. See [`.compile()`][] for more details.

bin/globalize-compiler.js

@@ -6,7 +6,7 @@ var nopt = require( "nopt" );
 var path = require( "path" );
 var pkg = require( "../package.json" );
 
-var bundle, cldr, extracts, extraOptions, input, locale, messages, opts, output, requiredOpts;
+var bundle, cldr, extracts, extraOptions, timeZoneData, input, locale, messages, opts, output, requiredOpts;
 
 function help() {
 	var out = [
@@ -41,6 +41,7 @@ opts = nopt( {
 	v: "--version",
 	l: "--locale",
 	c: "--cldr",
+	z: "--tz",
 	m: "--messages",
 	o: "--output"
 });
@@ -69,10 +70,12 @@ if ( opts.help || !requiredOpts || extraOptions.length ) {
 input = opts.argv.remain;
 locale = opts.locale;
 cldr = opts.cldr;
+timeZoneData = opts.tz;
 messages = opts.messages;
 output = opts.output;
 
 cldr = cldr ? JSON.parse( fs.readFileSync( cldr ) ) : null;
+timeZoneData = timeZoneData ? JSON.parse( fs.readFileSync( timeZoneData ) ) : null;
 messages = messages ? JSON.parse( fs.readFileSync( messages ) ) : null;
 
 extracts = input.map(function( input ) {
@@ -82,6 +85,7 @@ extracts = input.map(function( input ) {
 bundle = GlobalizeCompiler.compileExtracts({
 	defaultLocale: locale,
 	cldr: cldr,
+	timeZoneData: timeZoneData,
 	messages: messages,
 	extracts: extracts
 });

lib/compile-extracts.js

@@ -5,7 +5,7 @@ function alwaysArray( itemOrArray ) {
 }
 
 function compileExtracts( attributes ) {
-	var cldr, cldrObject, defaultLocale, extracts, formattersAndParsers, messages, messagesObject;
+	var cldr, cldrObject, defaultLocale, extracts, formattersAndParsers, timeZoneData, timeZoneDataObject, messages, messagesObject;
 	var Globalize = require( "globalize" );
 
 	attributes = attributes || {};
@@ -48,12 +48,23 @@ function compileExtracts( attributes ) {
 		};
 	}
 
+	timeZoneData = attributes.timeZoneData || function() {
+		return require( "iana-tz-data" );
+	};
+	if ( typeof timeZoneData === "object" ) {
+		timeZoneDataObject = timeZoneData;
+		timeZoneData = function() {
+			return timeZoneDataObject;
+		};
+	}
+
 	// TODO
 	//assert( defaultLocale )
 	//assert( extracts )
 
 	Globalize.load( cldr( defaultLocale ) );
 	Globalize.loadMessages( messages( defaultLocale ) );
+	Globalize.loadTimeZone( timeZoneData() );
 	Globalize.locale( defaultLocale );
 	formattersAndParsers = alwaysArray( extracts ).reduce(function( sum, extract ) {
 		[].push.apply( sum, extract( Globalize ) );

lib/compile.js

@@ -1,6 +1,5 @@
-var COMPILED_ORDER, DEPENDENCIES, DEPENDENCIES_VARS, fnPlaceholder, fnPlaceholderRe,
-	regexpPlaceholder, regexpPlaceholderRe, template, undefinedPlaceholder,
-	undefinedPlaceholderRe,
+var COMPILED_ORDER, DEPENDENCIES, DEPENDENCIES_VARS, dataCache, fnPlaceholder, fnPlaceholderRe,
+	regexpPlaceholder, regexpPlaceholderRe, template, undefinedPlaceholder, undefinedPlaceholderRe,
 	extend = require( "util" )._extend,
 	fs = require( "fs" );
 
@@ -97,6 +96,8 @@ DEPENDENCIES_VARS = {
 	}
 };
 
+dataCache = {};
+
 template = fs.readFileSync( __dirname + "/compile.template" ).toString( "utf-8" );
 
 function functionName( fn ) {
@@ -130,6 +131,9 @@ function stringifyIncludingFunctionsAndRegExpsAndUndefined( object ) {
 		var fn = fns.shift();
 		if ( "generatorString" in fn ) {
 			return fn.generatorString();
+		} else if ( "dataCacheKey" in fn ) {
+			dataCache[ fn.dataCacheKey ] = fn();
+			return "getCache(\"" + fn.dataCacheKey + "\")";
 		} else {
 			return fn.toString();
 		}
@@ -181,10 +185,8 @@ function defaultTemplate( properties ) {
  * @param {options} object
  */
 function compiler( formattersAndParsers, options ) {
-	var dependencies,
-		code,
-		dependenciesVars,
-		templateFn,
+	var code, dependencies, dependenciesVars, templateFn,
+		dataCacheCode = "",
 		extractedFormattersAndParsers = [],
 		formattersAndParsersKeys = [];
 
@@ -225,6 +227,16 @@ function compiler( formattersAndParsers, options ) {
 		return COMPILED_ORDER.indexOf( a ) - COMPILED_ORDER.indexOf( b );
 	}).map( compile ).join( "\n" );
 
+	// Generate the optional dataCache.
+	if ( Object.keys( dataCache ).length ) {
+		dataCacheCode = "var dataCache = " + JSON.stringify( dataCache ) + ";\n" +
+			"function getCache(key) {\n" +
+			"	return function() {\n" +
+			"		return dataCache[key];\n" +
+			"	};\n" +
+			"}\n";
+	}
+
 	// Generate dependency assignments and requirements.
 	dependencies = Object.keys( extractedFormattersAndParsers.map( functionName ).reduce(function( sum, i ) {
 		return extend( sum, DEPENDENCIES[ i ] );
@@ -243,7 +255,7 @@ function compiler( formattersAndParsers, options ) {
 			return "var " + dependency + " = Globalize._" + dependency + ";";
 		}).join( "\n" );
 
-	code = dependenciesVars + "\n\n" + code;
+	code = dependenciesVars + "\n\n" + dataCacheCode + code;
 
 	/*
 	// Generate exports.

package.json

@@ -39,7 +39,8 @@
   },
   "peerDependencies": {
     "cldr-data": ">=25",
-    "globalize": ">=1.3.0-a <2.0.0"
+    "globalize": ">=1.3.0-a <2.0.0",
+    "iana-tz-data": ">=2017.0.0"
   },
   "devDependencies": {
     "babel": "^5.6.14",
@@ -48,6 +49,7 @@
     "eslint": "^3.19.0",
     "eslint-config-defaults": "^9.0.0",
     "globalize": ">=1.3.0-a <2.0.0",
+    "iana-tz-data": ">=2017.0.0",
     "jshint": "2.6.x",
     "mocha": "2.1.0"
   }

test/functional/index.js

@@ -16,6 +16,11 @@ describe("The compiled `basic.js`", function() {
 		expect(result).to.have.string("2017");
 	});
 
+	it("should include formatDate with timeZone support", function() {
+		var result = Globalize.formatDate(new Date("2017-04-15T12:00:00Z"), {datetime: "full", timeZone: "America/Sao_Paulo"});
+		expect(result).to.equal("Saturday, April 15, 2017 at 9:00:00 AM Brasilia Standard Time");
+	});
+
 	it("should include formatDateToParts", function() {
 		var result = Globalize.formatDateToParts(new Date(2017, 3, 15), {datetime: "medium"});
 		expect(result).to.include({type: "month", value: "Apr"});
@@ -58,4 +63,9 @@ describe("The compiled `basic.js`", function() {
 		expect(result.getMonth()).to.equal(0);
 		expect(result.getDate()).to.equal(2);
 	});
+
+	it("should include parseDate with timeZone support", function() {
+		var result = Globalize.parseDate("January 1, 2000 at 12:00:00 AM EST", {datetime: "long", timeZone: "America/New_York"});
+		expect(result).to.deep.equal(new Date("2000-01-01T05:00:00Z"));
+	});
 });

test/unit/fixtures/basic.js

@@ -7,6 +7,12 @@ console.log( dateFormatter( new Date() ) );
 
 console.log( Globalize.formatDate( new Date(), { date: "medium" } ) );
 
+// Use Globalize to format dates in specific time zones.
+console.log( Globalize.formatDate( new Date(), {
+	datetime: "full",
+	timeZone: "America/Sao_Paulo"
+}));
+
 // Use Globalize to format dates to parts.
 console.log( Globalize.formatDateToParts( new Date(), { datetime: "medium" } ) );
 
@@ -37,3 +43,9 @@ console.log( Globalize.parseNumber( "12345.6789" ) );
 
 // Use Globalize to parse a date.
 console.log( Globalize.parseDate( "1/2/1982" ) );
+
+// Use Globalize to parse a date in specific time zones.
+console.log( Globalize.parseDate( "January 1, 2000 at 12:00:00 AM EST", {
+	datetime: "long",
+	timeZone: "America/New_York"
+}));