fable 3.1.2 → 3.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fable",
-    "version": "3.1.2",
+    "version": "3.1.4",
     "description": "A service dependency injection, configuration and logging library.",
     "main": "source/Fable.js",
     "scripts": {
@@ -50,7 +50,7 @@
     },
     "homepage": "https://github.com/stevenvelozo/fable",
     "devDependencies": {
-        "quackage": "^1.0.38"
+        "quackage": "^1.0.41"
     },
     "dependencies": {
         "async.eachlimit": "^0.5.2",

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

@@ -41,6 +41,90 @@ class DateManipulation extends libFableServiceProviderBase
 		// const localeDE = require('dayjs/locale/de');
 		// _Fable.Dates.dayJS.locale('de');
 	}
+
+	/**
+	 * Calculates the difference in days between two dates.
+	 *
+	 * @param {string|Date|number} pDateStart - The start date. Can be a string, Date object, or timestamp.
+	 * @param {string|Date|number} pDateEnd - The end date. Can be a string, Date object, or timestamp. Defaults to the current date if not provided.
+	 * @returns {number} The difference in days between the start and end dates. Returns NaN if the start date is invalid.
+	 */
+	dateDayDifference(pDateStart, pDateEnd)
+	{
+		// If there is not a valid start date, return NaN
+		if ((pDateStart === undefined) || (pDateStart === null) || (pDateStart === ''))
+		{
+			return NaN;
+		}
+		let tmpStartDate = this.dayJS(pDateStart);
+		// Without a valid end date, dayJS defaults to the current date
+		let tmpEndDate = this.dayJS(pDateEnd);
+		// Returns the difference in days between two dates
+		return tmpEndDate.diff(tmpStartDate, 'day');
+	}
+
+	/**
+	 * Calculates the difference in weeks between two dates.
+	 *
+	 * @param {string|Date|number} pDateStart - The start date. Can be a string, Date object, or timestamp.
+	 * @param {string|Date|number} pDateEnd - The end date. Can be a string, Date object, or timestamp. Defaults to the current date if not provided.
+	 * @returns {number} The difference in weeks between the two dates. Returns NaN if the start date is invalid.
+	 */
+	dateWeekDifference(pDateStart, pDateEnd)
+	{
+		// If there is not a valid start date, return NaN
+		if ((pDateStart === undefined) || (pDateStart === null) || (pDateStart === ''))
+		{
+			return NaN;
+		}
+		let tmpStartDate = this.dayJS(pDateStart);
+		// Without a valid end date, dayJS defaults to the current date
+		let tmpEndDate = this.dayJS(pDateEnd);
+		// Returns the difference in weeks between two dates
+		return tmpEndDate.diff(tmpStartDate, 'week');
+	}
+
+	/**
+	 * Calculates the difference in months between two dates.
+	 *
+	 * @param {string|Date|number} pDateStart - The start date. Can be a string, Date object, or timestamp.
+	 * @param {string|Date|number} pDateEnd - The end date. Can be a string, Date object, or timestamp. Defaults to the current date if not provided.
+	 * @returns {number} The difference in months between the two dates. Returns NaN if the start date is invalid.
+	 */
+	dateMonthDifference(pDateStart, pDateEnd)
+	{
+		// If there is not a valid start date, return NaN
+		if ((pDateStart === undefined) || (pDateStart === null) || (pDateStart === ''))
+		{
+			return NaN;
+		}
+		let tmpStartDate = this.dayJS(pDateStart);
+		// Without a valid end date, dayJS defaults to the current date
+		let tmpEndDate = this.dayJS(pDateEnd);
+		// Returns the difference in months between two dates
+		return tmpEndDate.diff(tmpStartDate, 'month');
+	}
+
+	/**
+	 * Calculates the difference in years between two dates.
+	 *
+	 * @param {string|Date|number} pDateStart - The start date. Can be a string, Date object, or timestamp.
+	 * @param {string|Date|number} pDateEnd - The end date. Can be a string, Date object, or timestamp. Defaults to the current date if not provided.
+	 * @returns {number} The difference in years between the two dates. Returns NaN if the start date is invalid.
+	 */
+	dateYearDifference(pDateStart, pDateEnd)
+	{
+		// If there is not a valid start date, return NaN
+		if ((pDateStart === undefined) || (pDateStart === null) || (pDateStart === ''))
+		{
+			return NaN;
+		}
+		let tmpStartDate = this.dayJS(pDateStart);
+		// Without a valid end date, dayJS defaults to the current date
+		let tmpEndDate = this.dayJS(pDateEnd);
+		// Returns the difference in years between two dates
+		return tmpEndDate.diff(tmpStartDate, 'year');
+	}
 }
 
 module.exports = DateManipulation;

package/source/services/Fable-Service-ExpressionParser/Fable-Service-ExpressionParser-FunctionMap.json

@@ -4,6 +4,16 @@
 		"Address": "fable.Math.sqrtPrecise"
 	},
 
+	"percent": {
+		"Name": "Compute Percent (in IS over OF format)",
+		"Address": "fable.Math.percentagePrecise"
+	},
+
+	"compare": {
+		"Name": "Compare",
+		"Address": "fable.Math.comparePrecise"
+	},
+
 	"abs": {
 		"Name": "Absolute Value",
 		"Address": "fable.Math.absPrecise"
@@ -26,6 +36,11 @@
 		"Name": "Pi",
 		"Address": "fable.Math.piPrecise"
 	},
+	"euler": {
+		"Name": "Euler",
+		"Address": "fable.Math.eulerPrecise"
+	},
+
 	"sin": {
 		"Name": "Sine",
 		"Address": "fable.Math.sin"
@@ -43,7 +58,10 @@
 		"Name": "Count Set Elements",
 		"Address": "fable.Math.countSetElements"
 	},
-
+	"countset": {
+		"Name": "Count Set Elements",
+		"Address": "fable.Math.countSetElements"
+	},
 	"sortset": {
 		"Name": "Sort Set",
 		"Address": "fable.Math.sortSetPrecise"
@@ -91,6 +109,10 @@
 		"Name": "Round",
 		"Address": "fable.Math.roundPrecise"
 	},
+	"tofixed": {
+		"Name": "To Fixed",
+		"Address": "fable.Math.toFixedPrecise"
+	},
 
 	"cumulativesummation": {
 		"Name": "Count Set Elements in a Histogram or Value Map",
@@ -107,6 +129,19 @@
 		"Address": "fable.Utility.getInternalValueByHash"
 	},
 
+	"entryinset": {
+		"Name": "Entry in Set",
+		"Address": "fable.Math.entryInSet"
+	},
+	"smallestInSet": {
+		"Name": "Smallest in Set",
+		"Address": "fable.Math.smallestInSet"
+	},
+	"largestInSet": {
+		"Name": "Largest in Set",
+		"Address": "fable.Math.largestInSet"
+	},
+
 	"aggregationhistogram": {
 		"Name": "Generate a Histogram by Exact Value Aggregation",
 		"Address": "fable.Math.histogramAggregationByExactValueFromInternalState"
@@ -116,6 +151,11 @@
 		"Address": "fable.Math.histogramDistributionByExactValueFromInternalState"
 	},
 
+	"setconcatenate": {
+		"Name": "Set Concatenate",
+		"Address": "fable.Math.setConcatenate"
+	},
+
 	"getvaluearray": {
 		"Name": "Get Value Array from Application State or Services (AppData, etc.)",
 		"Address": "fable.Utility.createValueArrayByHashParametersFromInternal"
@@ -157,5 +197,27 @@
 	"randomfloatupto": {
 		"Name": "Random Float",
 		"Address": "fable.DataGeneration.randomFloatUpTo"
+	},
+
+	"datedaydifference": {
+		"Name": "Date Difference in Days",
+		"Address": "fable.Dates.dateDayDifference"
+	},
+	"dateweekdifference": {
+		"Name": "Date Difference in Weeks",
+		"Address": "fable.Dates.dateWeekDifference"
+	},
+	"datemonthdifference": {
+		"Name": "Date Difference in Months",
+		"Address": "fable.Dates.dateMonthDifference"
+	},
+	"dateyeardifference": {
+		"Name": "Date Difference in Years",
+		"Address": "fable.Dates.dateYearDifference"
+	},
+
+	"createValueObjectByHashes": {
+		"Name": "Create Value Object by Hashes",
+		"Address": "fable.Utility.createValueObjectByHashes"
 	}
 }

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

@@ -22,6 +22,8 @@ class FableServiceMath extends libFableServiceBase
 		this.serviceType = 'Math';
 
 		this.pi = '3.1415926535897932384626433832795028841971693993751058209749445923078164062862089986280348253421170679';
+		// From NASA: https://apod.nasa.gov/htmltest/gifcity/e.2mil
+		this.euler = '2.7182818284590452353602874713526624977572470936999595749669676277240766303535475945713821785251664';
 
 //		this.manifest = this.fable.newManyfest();
 	}
@@ -428,6 +430,24 @@ class FableServiceMath extends libFableServiceBase
 		}
 	}
 
+	/**
+	 * Calculates the value of euler with the specified precision.
+	 *
+	 * @param {number} [pPrecision] - The precision to use for calculating E.
+	 * @returns {number} - The calculated value of E.
+	 */
+	eulerPrecise(pPrecision)
+	{
+		if (typeof (pPrecision) === 'undefined')
+		{
+			return this.euler;
+		}
+		else
+		{
+			return this.roundPrecise(this.euler, pPrecision);
+		}
+	}
+
 	/**
 	 * Calculates the sine of the given angle in radians.
 	 *
@@ -729,6 +749,14 @@ class FableServiceMath extends libFableServiceBase
 		return tmpHistogram;
 	}
 
+	/**
+	 * Aggregates a histogram by exact value from an internal state object.
+	 *
+	 * @param {string} pValueObjectSetAddress - The address of the internal value object set.
+	 * @param {string} pValueAddress - The address of the value to aggregate by.
+	 * @param {string} pValueAmountAddress - The address of the amount to aggregate.
+	 * @returns {Object} The aggregated histogram object. Returns an empty object if the value object set address is not provided.
+	 */
 	histogramAggregationByExactValueFromInternalState(pValueObjectSetAddress, pValueAddress, pValueAmountAddress)
 	{
 		if (!pValueObjectSetAddress)
@@ -769,11 +797,25 @@ class FableServiceMath extends libFableServiceBase
 		return tmpValueArray[tmpIndex];
 	}
 
+	/**
+	 * Finds the smallest value in a set of objects based on a specified value address.
+	 *
+	 * @param {Object[]} pValueObjectSet - An array of objects to search through.
+	 * @param {string} pValueAddress - The key or path used to access the value within each object.
+	 * @returns {*} The smallest value found in the set at the specified value address.
+	 */
 	smallestInSet(pValueObjectSet, pValueAddress)
 	{
 		return this.entryInSet(pValueObjectSet, pValueAddress, 0);
 	}
 
+	/**
+	 * Finds the largest value in a set of objects based on a specified value address.
+	 *
+	 * @param {Object[]} pValueObjectSet - An array of objects to search through.
+	 * @param {string} pValueAddress - The address (key or path) within each object to compare values.
+	 * @returns {*} The largest value found at the specified address in the set of objects.
+	 */
 	largestInSet(pValueObjectSet, pValueAddress)
 	{
 		return this.entryInSet(pValueObjectSet, pValueAddress, -1);

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

@@ -217,7 +217,7 @@ class FableServiceUtility extends libFableServiceBase
 	 * @param {object} pObject - The object to get the value from
 	 * @param {string} pValueAddress - The manyfest hash/address of the value to get
 	 * @param {object} [pManifest] - The manyfest object to use; constructs one inline if not provided
-	 * @returns {Array} - The value object built from the hash list
+	 * @returns {object} - The value object built from the hash list
 	 */
 	createValueObjectByHashes(pObject, pValueHashes, pManifest)
 	{
@@ -338,6 +338,70 @@ class FableServiceUtility extends libFableServiceBase
 			return false;
 		}
 	}
+
+	/**
+	 * Find the first value in an object that contains a specific value
+	 * @param {array} pObjectArray - The array of objects to search
+	 * @param {string} pValueToMatchAddress - The manyfest hash/address of the value to match
+	 * @param {string} pValueToMatch - The value to match
+	 * @param {string} pValueAddress - The manyfest hash/address of the value to return
+	 * @returns {any} - The value from the object
+	 */
+	findFirstValueByStringIncludes(pObjectArray, pValueToMatchAddress, pValueToMatch, pValueAddress)
+	{
+		// Lazily create a manifest if it doesn't exist
+		if (!this.manifest)
+		{
+			this.manifest = this.fable.newManyfest();
+		}
+
+		if (!Array.isArray(pObjectArray))
+		{
+			return undefined;
+		}
+		for (let i = 0; i < pObjectArray.length; i++)
+		{
+			let tmpValueToMatch = this.manifest.getValueByHash(pObjectArray[i], pValueToMatchAddress);
+			if (tmpValueToMatch && (tmpValueToMatch.includes(pValueToMatch)))
+			{
+				return this.manifest.getValueByHash(pObjectArray[i], pValueAddress);
+			}
+		}
+
+		return undefined;
+	}
+
+	/**
+	 * Find the first value in an object that contains a specific value
+	 * @param {array} pObjectArray - The array of objects to search
+	 * @param {string} pValueToMatchAddress - The manyfest hash/address of the value to match
+	 * @param {string} pValueToMatch - The value to match
+	 * @param {string} pValueAddress - The manyfest hash/address of the value to return
+	 * @returns {any} - The value from the object
+	 */
+	findFirstValueByExactMatch(pObjectArray, pValueToMatchAddress, pValueToMatch, pValueAddress)
+	{
+		// Lazily create a manifest if it doesn't exist
+		if (!this.manifest)
+		{
+			this.manifest = this.fable.newManyfest();
+		}
+
+		if (!Array.isArray(pObjectArray))
+		{
+			return undefined;
+		}
+		for (let i = 0; i < pObjectArray.length; i++)
+		{
+			let tmpValueToMatch = this.manifest.getValueByHash(pObjectArray[i], pValueToMatchAddress);
+			if (tmpValueToMatch && (tmpValueToMatch == pValueToMatch))
+			{
+				return this.manifest.getValueByHash(pObjectArray[i], pValueAddress);
+			}
+		}
+
+		return undefined;
+	}
 }
 
 module.exports = FableServiceUtility;

package/test/DataFormat-StringDateFormatting_tests.js

@@ -20,9 +20,65 @@ suite
 
 		suite
 		(
-			'Format Dates and Times',
+			'Format and Calculate Dates and Times',
 			()=>
 			{
+				test
+				(
+					'Calculate the difference in days between two dates',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						Expect(testFable.Dates.dateDayDifference('2021-03-12', '2023-09-01'))
+							.to.equal(903);
+						Expect(testFable.Dates.dateDayDifference('2023-08-01', '2023-09-01'))
+							.to.equal(31);
+						Expect(testFable.Dates.dateDayDifference('2023-09-01', '2023-10-01'))
+							.to.equal(30);
+						Expect(testFable.Dates.dateDayDifference('2023-9-1', '2023-10-01'))
+							.to.equal(30);
+						Expect(testFable.Dates.dateWeekDifference('2023-9-1', '2023-10-01'))
+							.to.equal(4);
+						Expect(testFable.Dates.dateMonthDifference('1986-10-01', '2023-09-01'))
+							.to.equal(443);
+						Expect(testFable.Dates.dateYearDifference('1986-10-01', '2023-09-01'))
+							.to.equal(36);
+						Expect(testFable.Dates.dateYearDifference('1986-08-01', '2023-09-01'))
+							.to.equal(37);
+						Expect(testFable.Dates.dateYearDifference('1986-08-31', '2023-09-01'))
+							.to.equal(37);
+						let tmpValue = testFable.Dates.dateDayDifference('BadDatesIncoming', '2023-09-01');
+						Expect(tmpValue)
+							.to.be.NaN;
+
+						tmpValue = testFable.Dates.dateDayDifference();
+						Expect(tmpValue)
+							.to.be.NaN;
+						return fTestComplete();
+					}
+				);
+				test
+				(
+					'Format a time span in milliseconds to a human readable string',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataFormat = testFable.services.DataFormat;
+						Expect(_DataFormat
+							.formatTimeSpan(1000))
+							.to.equal('00:00:01.000');
+						Expect(_DataFormat
+							.formatTimeSpan(100243231))
+							.to.equal('27:50:43.231');
+						Expect(_DataFormat
+							.formatTimeSpan(100299211))
+							.to.equal('27:51:39.211');
+						Expect(_DataFormat
+							.formatTimeSpan())
+							.to.equal('');
+						return fTestComplete();
+					}
+				);
 				test
 				(
 					'Format a time span in milliseconds to a human readable string',

package/test/ExpressionParser_tests.js

@@ -256,6 +256,11 @@ suite
 						Expect(tmpResult).to.equal("1545");
 						tmpResult = _Parser.solve('Area = ROUND(X * Y  * Z, 3, 3)', tmpDataObject, tmpSolveResults);
 						Expect(tmpResult).to.equal("1545.2");
+						// Test the getvaluarray function]
+						// TODO: Fix the return values for these expression return functions
+						//tmpResult = _Parser.solve('NewSet = GETVALUEARRAY(X, Y, Z)', tmpDataObject, tmpSolveResults);
+						//tmpResult = _Parser.solve('NewSetAverage = SUM(NewSet)', tmpDataObject, tmpSolveResults);
+						//Expect(tmpResult).to.equal("84.115923423");
 						return fDone();
 					}
 				);

package/test/Math_test.js

@@ -116,6 +116,7 @@ suite
 						return fDone();
 					}
 				);
+
 				test
 				(
 					'Parse Numbers',
@@ -132,6 +133,18 @@ suite
 					}
 				);
 
+				test
+				(
+					'Eulers Number',
+					function(fDone)
+					{
+						let testFable = new libFable();
+
+						Expect(testFable.Math.eulerPrecise()).to.equal('2.7182818284590452353602874713526624977572470936999595749669676277240766303535475945713821785251664');
+						return fDone();
+					}
+				);
+
 				test
 				(
 					'Histograms by Count',

package/test/RestClient_test.js

@@ -35,10 +35,10 @@ suite
 								{
 									let testFable = new libFable();
 									// Instantiate the RestClient Service Provider
-									let tmpRestClient = testFable.instantiateServiceProvider('RestClient', { TraceLog: true }, 'RestClient-99');
+									testFable.instantiateServiceProvider('RestClient', { TraceLog: true });
 
 									// Download the wiktionary entry for dog!
-									tmpRestClient.getJSON('http://localhost:8086/1.0/Author/1',
+									testFable.RestClient.getJSON('http://localhost:8086/1.0/Author/1',
 										(pError, pResponse, pBody) =>
 										{
 											Expect(pBody).to.be.an('object');

package/test/Utility_tests.js

@@ -343,6 +343,74 @@ suite
 							})
 					}
 				);
+				test
+				(
+					'findFirstValueByStringIncludes returns values from an array of objects',
+					function(fDone)
+					{
+						testFable = new libFable();
+
+						let tmpState = [
+							{ "Name":"The Pixies", "Type":"Band", "AlbumCount":5, "SongCount": 103, "MarketValue":"83500011.24", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"The Beatles", "Type":"Band", "AlbumCount":35, "SongCount": 876, "MarketValue":"183942892.24", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"Modest Mouse", "Type":"Band", "AlbumCount":9, "SongCount": 299, "MarketValue":"332432324.99", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"The Doors", "Type":"Band", "AlbumCount":6, "SongCount": 133, "MarketValue":"324783294732.32", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"The Who", "Type":"Band", "AlbumCount":7, "SongCount": 110, "MarketValue":"7500.30", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"The Cure", "Type":"Band", "AlbumCount":13, "SongCount": 213, "MarketValue":"34230.10", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } }
+							];
+						let tmpResult = testFable.services.Utility.findFirstValueByStringIncludes(tmpState, 'Name', 'The', 'SongCount');
+						Expect(tmpResult).to.be.a('number');
+						Expect(tmpResult).to.equal(103);
+
+						tmpResult = testFable.services.Utility.findFirstValueByStringIncludes(tmpState, 'Name', 'The Cure', 'SongCount');
+						Expect(tmpResult).to.be.a('number');
+						Expect(tmpResult).to.equal(213);
+
+						// Missing Key
+						tmpResult = testFable.services.Utility.findFirstValueByStringIncludes(tmpState, 'Name', 'The Fleet Foxes', 'SongCount');
+						Expect(tmpResult).to.be.a('undefined');
+
+						// Missing Value
+						tmpResult = testFable.services.Utility.findFirstValueByStringIncludes(tmpState, 'Name', 'The Cure', 'No good Value');
+						Expect(tmpResult).to.be.a('undefined');
+
+						return fDone();
+					}
+				);
+				test
+				(
+					'findFirstValueByExactMatch returns values from an array of objects',
+					function(fDone)
+					{
+						testFable = new libFable();
+
+						let tmpState = [
+							{ "Name":"The Pixies", "Type":"Band", "AlbumCount":5, "SongCount": 103, "MarketValue":"83500011.24", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"The Beatles", "Type":"Band", "AlbumCount":35, "SongCount": 876, "MarketValue":"183942892.24", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"Modest Mouse", "Type":"Band", "AlbumCount":9, "SongCount": 299, "MarketValue":"332432324.99", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"The Doors", "Type":"Band", "AlbumCount":6, "SongCount": 133, "MarketValue":"324783294732.32", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"The Who", "Type":"Band", "AlbumCount":7, "SongCount": 110, "MarketValue":"7500.30", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } },
+							{ "Name":"The Cure", "Type":"Band", "AlbumCount":13, "SongCount": 213, "MarketValue":"34230.10", "Studios": { "Primary": { "Name":"Swamp Record Studios", "Location":"Boston"} } }
+							];
+						let tmpResult = testFable.services.Utility.findFirstValueByExactMatch(tmpState, 'Name', 'The Who', 'SongCount');
+						Expect(tmpResult).to.be.a('number');
+						Expect(tmpResult).to.equal(110);
+
+						tmpResult = testFable.services.Utility.findFirstValueByExactMatch(tmpState, 'SongCount', 133, 'MarketValue');
+						Expect(tmpResult).to.be.a('string');
+						Expect(tmpResult).to.equal('324783294732.32');
+
+						// Missing Key
+						tmpResult = testFable.services.Utility.findFirstValueByExactMatch(tmpState, 'Name', 'The Fleet Foxes', 'SongCount');
+						Expect(tmpResult).to.be.a('undefined');
+
+						// Missing Value
+						tmpResult = testFable.services.Utility.findFirstValueByExactMatch(tmpState, 'Name', 'The Cure', 'No good Value');
+						Expect(tmpResult).to.be.a('undefined');
+
+						return fDone();
+					}
+				);
 			}
 		);
 	}