fable 3.0.83 → 3.0.84

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fable",
-    "version": "3.0.83",
+    "version": "3.0.84",
     "description": "An entity behavior management and API bundling library.",
     "main": "source/Fable.js",
     "scripts": {
@@ -58,6 +58,7 @@
         "cachetrax": "^1.0.4",
         "cookie": "^0.5.0",
         "data-arithmatic": "^1.0.7",
+        "dayjs": "^1.11.10",
         "fable-log": "^3.0.12",
         "fable-serviceproviderbase": "^3.0.10",
         "fable-settings": "^3.0.8",

package/source/Fable.js

@@ -46,6 +46,7 @@ class Fable
 		this.serviceManager.addServiceType('Template', require('./services/Fable-Service-Template.js'));
 		this.serviceManager.addServiceType('MetaTemplate', require('./services/Fable-Service-MetaTemplate.js'));
 		this.serviceManager.addServiceType('Anticipate', require('./services/Fable-Service-Anticipate.js'));
+		this.serviceManager.addAndInstantiateServiceType('Dates', require('./services/Fable-Service-DateManipulation.js'));
 		this.serviceManager.addAndInstantiateServiceType('DataFormat', require('./services/Fable-Service-DataFormat.js'));
 		this.serviceManager.addAndInstantiateServiceType('DataGeneration', require('./services/Fable-Service-DataGeneration.js'));
 		this.serviceManager.addAndInstantiateServiceType('Utility', require('./services/Fable-Service-Utility.js'));

package/source/services/Fable-Service-DateManipulation.js

@@ -0,0 +1,46 @@
+const libFableServiceProviderBase = require('fable-serviceproviderbase');
+/**
+* Date management a la Moment using days.js
+*
+* @class DateManipulation
+*/
+class DateManipulation extends libFableServiceProviderBase
+{
+	constructor(pFable, pOptions, pServiceHash)
+	{
+		super(pFable, pOptions, pServiceHash)
+
+		this.serviceType = 'Dates';
+
+		this.dayJS = require('dayjs');
+
+		// Include the `weekOfYear` plugin
+		this.plugin_weekOfYear = require('dayjs/plugin/weekOfYear');
+		this.dayJS.extend(this.plugin_weekOfYear);
+		// Include the `weekday` plugin
+		this.plugin_weekday = require('dayjs/plugin/weekday');
+		this.dayJS.extend(this.plugin_weekday);
+		// Include the `isoWeek` plugin
+		this.plugin_isoWeek = require('dayjs/plugin/isoWeek');
+		this.dayJS.extend(this.plugin_isoWeek);
+		// Include the `timezone` plugin
+		this.plugin_timezone = require('dayjs/plugin/timezone');
+		this.dayJS.extend(this.plugin_timezone);
+		// Include the `relativetime` plugin
+		this.plugin_relativetime = require('dayjs/plugin/relativetime');
+		this.dayJS.extend(this.plugin_relativetime);
+		// Include the `utc` plugin
+		this.plugin_utc = require('dayjs/plugin/utc');
+		this.dayJS.extend(this.plugin_utc);
+		// Include the `advancedFormat` plugin
+		this.plugin_advancedFormat = require('dayjs/plugin/advancedFormat');
+		this.dayJS.extend(this.plugin_advancedFormat);
+
+		// A developer can include locales if they want
+		// You would do the following:
+		// const localeDE = require('dayjs/locale/de');
+		// _Fable.Dates.dayJS.locale('de');
+	}
+}
+
+module.exports = DateManipulation;

package/source/services/Fable-Service-Operation.js

@@ -84,7 +84,7 @@ class FableOperation extends libFableServiceBase
 		this.writeOperationErrors(pLogText, pLogObject);
 		this.fable.log.fatal(pLogText, pLogObject);
 	}
-	
+
 	/************************************************************************
 	 * BEGINNING OF -->  Telemetry Helpers
 	 */
@@ -94,21 +94,21 @@ class FableOperation extends libFableServiceBase
 		this.timeStamps[tmpTimeStampHash] = +new Date();
 		return this.timeStamps[tmpTimeStampHash];
 	}
-	
+
 	getTimeDelta(pTimeStampHash)
 	{
 		let tmpTimeStampHash = (typeof(pTimeStampHash) == 'string') ? pTimeStampHash : 'Default';
 		if (this.timeStamps.hasOwnProperty(tmpTimeStampHash))
 		{
 			let tmpEndTime = +new Date();
-			return tmpEndTime-this.timeStamps[tmpTimeStampHash];	
+			return tmpEndTime-this.timeStamps[tmpTimeStampHash];
 		}
 		else
 		{
 			return -1;
 		}
 	}
-	
+
 	logTimeDelta(pTimeStampHash, pMessage)
 	{
 		let tmpTimeStampHash = (typeof(pTimeStampHash) == 'string') ? pTimeStampHash : 'Default';
@@ -117,12 +117,12 @@ class FableOperation extends libFableServiceBase
 		this.info(tmpMessage +' ('+tmpOperationTime+'ms)');
 		return tmpOperationTime;
 	}
-	
+
 	createProgressTracker(pTotalOperations, pProgressTrackerHash)
 	{
 		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
 		let tmpTotalOperations = (typeof(pTotalOperations) == 'number') ? pTotalOperations : 100;
-	
+
 		let tmpProgressTracker = (
 			{
 				Hash: tmpProgressTrackerHash,
@@ -135,92 +135,92 @@ class FableOperation extends libFableServiceBase
 				TotalCount: tmpTotalOperations,
 				CurrentCount:-1
 			});
-	
+
 		this.progressTrackers[tmpProgressTrackerHash] = tmpProgressTracker;
-	
+
 		return tmpProgressTracker;
 	}
-	
+
 	solveProgressTrackerStatus(pProgressTrackerHash)
 	{
 		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
-	
+
 		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
 		{
 			this.createProgressTracker(100, tmpProgressTrackerHash);
 		}
-	
+
 		let tmpProgressTracker = this.progressTrackers[tmpProgressTrackerHash];
-	
+
 		tmpProgressTracker.CurrentTime = this.getTimeDelta(tmpProgressTracker.Hash);
-	
+
 		if ((tmpProgressTracker.CurrentCount > 0) && (tmpProgressTracker.TotalCount > 0))
 		{
 			tmpProgressTracker.PercentComplete = (tmpProgressTracker.CurrentCount / tmpProgressTracker.TotalCount) * 100.0;
 		}
-	
+
 		if ((tmpProgressTracker.CurrentCount > 0) && (tmpProgressTracker.CurrentTime > 0))
 		{
 			tmpProgressTracker.AverageOperationTime = tmpProgressTracker.CurrentTime / tmpProgressTracker.CurrentCount;
 		}
-	
+
 		if ((tmpProgressTracker.CurrentCount < tmpProgressTracker.TotalCount) && (tmpProgressTracker.AverageOperationTime > 0))
 		{
 			tmpProgressTracker.EstimatedCompletionTime = (tmpProgressTracker.TotalCount - tmpProgressTracker.CurrentCount) * tmpProgressTracker.AverageOperationTime;
 		}
 	}
-	
+
 	updateProgressTrackerStatus(pProgressTrackerHash, pCurrentOperations)
 	{
 		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
 		let tmpCurrentOperations = parseInt(pCurrentOperations);
-	
+
 		if (isNaN(tmpCurrentOperations))
 		{
 			return false;
 		}
-	
+
 		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
 		{
 			this.createProgressTracker(100, tmpProgressTrackerHash);
 		}
-	
+
 		this.progressTrackers[tmpProgressTrackerHash].CurrentCount = tmpCurrentOperations;
 		this.progressTrackers[tmpProgressTrackerHash].CurrentTime = this.getTimeDelta(tmpProgressTrackerHash);
-	
+
 		this.solveProgressTrackerStatus(tmpProgressTrackerHash);
-	
+
 		return this.progressTrackers[tmpProgressTrackerHash];
 	}
-	
+
 	incrementProgressTrackerStatus(pProgressTrackerHash, pIncrementSize)
 	{
 		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
 		let tmpIncrementSize = parseInt(pIncrementSize);
-	
+
 		if (isNaN(tmpIncrementSize))
 		{
 			return false;
 		}
-	
+
 		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
 		{
 			this.createProgressTracker(100, tmpProgressTrackerHash);
 		}
-	
+
 		this.progressTrackers[tmpProgressTrackerHash].CurrentCount = this.progressTrackers[tmpProgressTrackerHash].CurrentCount + tmpIncrementSize;
 		this.progressTrackers[tmpProgressTrackerHash].CurrentTime = this.getTimeDelta(tmpProgressTrackerHash);
-	
+
 		this.solveProgressTrackerStatus(tmpProgressTrackerHash);
-	
+
 		return this.progressTrackers[tmpProgressTrackerHash];
 	}
-	
+
 	setProgressTrackerEndTime(pProgressTrackerHash, pCurrentOperations)
 	{
 		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
 		let tmpCurrentOperations = parseInt(pCurrentOperations);
-	
+
 		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
 		{
 			return false;
@@ -229,18 +229,18 @@ class FableOperation extends libFableServiceBase
 		{
 			this.updateProgressTrackerStatus(tmpProgressTrackerHash, tmpCurrentOperations);
 		}
-	
+
 		this.progressTrackers[tmpProgressTrackerHash].EndTime = this.getTimeDelta(tmpProgressTrackerHash);
-		
+
 		this.solveProgressTrackerStatus(tmpProgressTrackerHash);
-	
+
 		return this.progressTrackers[tmpProgressTrackerHash];
 	}
-	
+
 	printProgressTrackerStatus(pProgressTrackerHash)
 	{
 		let tmpProgressTrackerHash = (typeof(pProgressTrackerHash) == 'string') ? pProgressTrackerHash : 'DefaultProgressTracker';
-		
+
 		if (!this.progressTrackers.hasOwnProperty(tmpProgressTrackerHash))
 		{
 			this.info(`>> Progress Tracker ${tmpProgressTrackerHash} does not exist!  No stats to display.`);
@@ -248,7 +248,7 @@ class FableOperation extends libFableServiceBase
 		else
 		{
 			const tmpProgressTracker = this.progressTrackers[tmpProgressTrackerHash];
-	
+
 			if (tmpProgressTracker.CurrentCount < 1)
 			{
 				this.info(`>> Progress Tracker ${tmpProgressTracker.Hash} has no completed operations.  ${tmpProgressTracker.CurrentTime}ms have elapsed since it was started.`);
@@ -263,12 +263,12 @@ class FableOperation extends libFableServiceBase
 			}
 		}
 	}
-	
+
 	// logMemoryResourcesUsed()
 	// {
-	// 
+	//
 	// 	const tmpResourcesUsed = process.memoryUsage().heapUsed / 1024 / 1024;
-	// 	this.info(`Memory usage at ${Math.round(tmpResourcesUsed * 100) / 100} MB`);		
+	// 	this.info(`Memory usage at ${Math.round(tmpResourcesUsed * 100) / 100} MB`);
 	// }
 	/*
 	 * END OF       -->  Logging and Telemetry Helpers

package/test/DateManipulation_tests.js

@@ -0,0 +1,51 @@
+/**
+* Unit tests for Fable
+*
+* @license     MIT
+*
+* @author      Steven Velozo <steven@velozo.com>
+*/
+
+var libFable = require('../source/Fable.js');
+
+const libFS = require('fs');
+
+var Chai = require("chai");
+var Expect = Chai.expect;
+
+suite
+(
+	'Date Manipulation',
+	function()
+	{
+		suite
+		(
+			'Manipulate Dates',
+			function()
+			{
+				test
+				(
+					'Get a Date and Format it',
+					function(fDone)
+					{
+						let testFable = new libFable();
+						let tmpDates = testFable.serviceManager.instantiateServiceProvider('Dates');
+
+						testFable.log.info(`Guessing your timezone: ${tmpDates.dayJS.tz.guess()}`);
+
+//						tmpDates.dayJS.tz('Etc/UTC');
+
+						let tmpDate = tmpDates.dayJS.utc("2023-08-10T05:00:00.000Z");
+						testFable.log.trace(`Date formats to: ${tmpDate.format()}`);
+						let tmpDateCentral = tmpDate.tz("America/Chicago");
+						testFable.log.trace(`Date Central formats to: ${tmpDateCentral.format()}`);
+						let tmpDatePacific = tmpDate.tz("America/Los_Angeles");
+						testFable.log.trace(`Date Pacific formats to: ${tmpDatePacific.format()}`);
+
+						return fDone();
+					}
+				);
+			}
+		);
+	}
+);