ethernity/ethernity.js

Persist time as true time.

"use strict";

/*;
	@module-license:
		The MIT License (MIT)
		@mit-license

		Copyright (@c) 2017 Richeve Siodina Bebedor
		@email: richeve.bebedor@gmail.com

		Permission is hereby granted, free of charge, to any person obtaining a copy
		of this software and associated documentation files (the "Software"), to deal
		in the Software without restriction, including without limitation the rights
		to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
		copies of the Software, and to permit persons to whom the Software is
		furnished to do so, subject to the following conditions:

		The above copyright notice and this permission notice shall be included in all
		copies or substantial portions of the Software.

		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
		IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
		FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
		AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
		LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
		OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
		SOFTWARE.
	@end-module-license

	@module-configuration:
		{
			"package": "ethernity",
			"path": "ethernity/ethernity.js",
			"file": "ethernity.js",
			"module": "ethernity",
			"author": "Richeve S. Bebedor",
			"eMail": "richeve.bebedor@gmail.com",
			"contributors": [
				"John Lenon Maghanoy <johnlenonmaghanoy@gmail.com>",
				"Vinse Vinalon <vinsevinalon@gmail.com>"
			],
			"repository": "https://github.com:volkovasystems/ethernity.git",
			"test": "ethernity-test.js",
			"global": true,
			"class": true,
		}
	@end-module-configuration

	@module-documentation:
		Persist time as true time.

		This will discard milliseconds value.
	@end-module-documentation

	@include:
		{
			"clazof": "clazof",
			"depher": "depher",
			"diatom": "diatom",
			"doubt": "doubt",
			"falze": "falze",
			"falzy": "falzy",
			"harden": "harden",
			"moment": "moment",
			"optfor": "optfor",
			"raze": "raze",
			"stringe": "stringe",
			"truly": "truly",
			"U200b": "u200b"
		}
	@end-include
*/

const clazof = require( "clazof" );
const depher = require( "depher" );
const diatom = require( "diatom" );
const doubt = require( "doubt" );
const falze = require( "falze" );
const falzy = require( "falzy" );
const harden = require( "harden" );
const moment = require( "moment" );
const optfor = require( "optfor" );
const raze = require( "raze" );
const stringe = require( "stringe" );
const truly = require( "truly" );
const U200b = require( "u200b" );

const COMPACT_FORMAT = "YYYYMMDDHHmmss";
const DEFAULT_SEPARATOR = " | ";
const ISO8601_FORMAT = "YYYY-MM-DDTHH:mm:ss";
const NUMERIC_PATTERN = /\d+/;
const SIMPLE_DATE_FORMAT = "MMMM DD, YYYY";
const SIMPLE_TIME_FORMAT = "hh:mm:ss A";
const TRUE_TIME_PATTERN = /^\-[\d\u200b]{26}|^[\d\u200b]{27}$/;

const Ethernity = diatom( "Ethernity" );

harden( "now", function now( ){
	return Ethernity( ).compact( );
}, Ethernity );

Ethernity.prototype.toString = function toString( ){
	return this.trueTime;
};

Ethernity.prototype.valueOf = function valueOf( ){
	return this.trueTime;
};

Ethernity.prototype.initialize = function initialize( date ){
	/*;
		@meta-configuration:
			{
				"date:required": [
					[ "number", "number" ],
					"string",
					Date
				]
			}
		@end-meta-configuration
	*/

	if( doubt( date, ARRAY ) &&
		typeof date[ 0 ] == "number" &&
		typeof date[ 1 ] == "number" &&
		stringe( date[ 0 ] ).length == 14 )
	{
		this.offset = date[ 1 ];

		this.date = moment.utc( date[ 0 ], COMPACT_FORMAT )
			.millisecond( 0 )
			.utcOffset( this.offset );

		this.persist( );

	}else if( typeof date == "string" && date.length == 27 && TRUE_TIME_PATTERN.test( date ) ){
		this.date = date;

		this.parse( );

	}else if( truly( date ) && typeof date == "string" ){
		try{
			date = moment( date );

			if( date.isValid( ) ){
				this.initialize( date.toDate( ) );

			}else{
				throw new Error( `invalid date format, ${ arguments[ 0 ] }` );
			}

		}catch( error ){
			throw new Error( `error encountered while parsing date, ${ error.stack }` );
		}

	}else if( clazof( date, Date ) ){
		this.date = moment( date );

		this.persist( );

	}else{
		this.date = moment( new Date( ) );

		this.persist( );
	}

	return this;
};

/*
	@method-documentation:
		This should be persisted on the machine where the timezone is persisted.

		It will save the true time in utc format + the machine timezone.
	@end-method-documentation
*/
Ethernity.prototype.persist = function persist( ){
	if( truly( this.trueTime ) ){
		return this.trueTime;
	}

	let date = this.date.toDate( );

	let offset = this.offset || this.date.utcOffset( );
	try{
		offset = parseInt( offset );

	}catch( error ){
		throw new Error( `invalid timezone offset, ${ error.stack }` );
	}

	let polarity = 0;
	if( offset != 0 ){
		polarity = offset / Math.abs( offset );
	}

	let trueTime = U200b( [
		//: positive / negative offset
		stringe( polarity ).replace( NUMERIC_PATTERN, "" ) || "0",

		//: year
		date.getUTCFullYear( ),

		//: month
		( "0" + ( date.getUTCMonth( ) + 1 ) ).slice( -2 ),

		//: day
		( "0" + ( date.getUTCDate( ) ) ).slice( -2 ),

		//: hour
		( "0" + ( date.getUTCHours( ) ) ).slice( -2 ),

		//: minute
		( "0" + ( date.getUTCMinutes( ) ) ).slice( -2 ),

		//: second
		( "0" + ( date.getUTCSeconds( ) ) ).slice( -2 ),

		//: offset
		( "000" + Math.abs( offset ) ).slice( -5 )
	] ).join( );

	this.trueTime = trueTime;

	this.offset = offset;

	return trueTime;
};

/*;
	@method-documentation:
		Decompose true time to a moment object.
	@end-method-documentation
*/
Ethernity.prototype.parse = function parse( ){
	let date = this.date;

	if( typeof this.date == "string" ){
		date = U200b( this.date ).separate( );

	}else if( truly( this.trueTime ) ){
		date = U200b( this.trueTime ).separate( );

	}else{
		throw new Error( "date not specified" );
	}

	try{
		let polarity = parseInt( date[ 0 ] + 1 );

		this.offset = polarity * parseInt( date[ 7 ] );

		date = moment.utc( )
			.year( parseInt( date[ 1 ] ) )
			.month( parseInt( date[ 2 ] ) - 1 )
			.date( parseInt( date[ 3 ] ) )
			.hour( parseInt( date[ 4 ] ) )
			.minute( parseInt( date[ 5 ] ) )
			.second( parseInt( date[ 6 ] ) )
			.millisecond( 0 );

	}catch( error ){
		throw new Error( `error parsing true time, ${ error.stack }` );
	}

	//: This will set the timezone of the Date object to the machine timezone.
	this.date = date;

	this.persist( );

	return this;
};

/*;
	@method-documentation:
		Relative time is the time applied with UTC offset.

		This will return the time in ISO8601 format format with milliseconds dropped.
			@code:YYYY-MM-DDTHH:mm.ss;

		Do not use this to reference true time.
	@end-method-documentation
*/
Ethernity.prototype.relativeTime = function relativeTime( ){
	if( falze( this.date ) ){
		throw new Error( "internal date empty" );
	}

	if( falzy( this.offset ) ){
		throw new Error( "internal timezone offset empty" );
	}

	return this.date.utc( ).utcOffset( this.offset ).format( ISO8601_FORMAT );
};

/*;
	@method-documentation:
		Real time is the time with no UTC offset applied.

		This will return the time in ISO8601 format with milliseconds dropped.

		`YYYY-MM-DDTHH:mm.ss`
	@end-method-documentation
*/
Ethernity.prototype.realTime = function realTime( ){
	if( falze( this.date ) ){
		throw new Error( "internal date empty" );
	}

	return this.date.utc( ).format( ISO8601_FORMAT );
};

/*;
	@method-documentation:
		Returns a simple human readable representation of time in 12 hour format.

		Time will be relative.
	@end-method-documentation
*/
Ethernity.prototype.getTime = function getTime( ){
	if( falze( this.date ) ){
		throw new Error( "internal date empty" );
	}

	if( falzy( this.offset ) ){
		throw new Error( "internal timezone offset empty" );
	}

	return this.date.utc( ).utcOffset( this.offset ).format( SIMPLE_TIME_FORMAT );
};

/*;
	@method-documentation:
		Returns a simple human readable representation of date.

		Date will be relative.
	@end-method-documentation
*/
Ethernity.prototype.getDate = function getDate( ){
	if( falzy( this.date ) ){
		throw new Error( "internal date empty" );
	}

	if( falzy( this.offset ) ){
		throw new Error( "internal timezone offset empty" );
	}

	return this.date.utc( ).utcOffset( this.offset ).format( SIMPLE_DATE_FORMAT );
};

/*;
	@method-documentation:
		Returns a simple human readable representation of time and date.

		Time and date will be relative.

		Setting complete will append true time format.
	@end-method-documentation
*/
Ethernity.prototype.printTime = function printTime( separator, complete ){
	/*;
		@meta-configuration:
			{
				"separator": "string",
				"complete": "boolean"
			}
		@end-meta-configuration
	*/

	let parameter = raze( arguments );

	separator = optfor( parameter, STRING );

	separator = separator || DEFAULT_SEPARATOR;
	if( typeof separator != "string" ){
		separator = DEFAULT_SEPARATOR;
	}

	complete = depher( arguments, BOOLEAN, false );

	if( complete === true ){
		return [ this.getDate( ), this.getTime( ), this.trueTime ].join( separator );

	}else{
		return [ this.getDate( ), this.getTime( ) ].join( separator );
	}
};

/*;
	@method-documentation:
		Returns a numerical representation of true time.
	@end-method-documentation
*/
Ethernity.prototype.compact = function compact( ){
	return [ this.date.utc( ).format( COMPACT_FORMAT ), this.offset ]
		.map( function onEachToken( token ){ return parseInt( stringe( token ) ); } );
};



module.exports = Ethernity;