fable 3.1.2 → 3.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fable",
-    "version": "3.1.2",
+    "version": "3.1.3",
     "description": "A service dependency injection, configuration and logging library.",
     "main": "source/Fable.js",
     "scripts": {

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

@@ -157,5 +157,22 @@
 	"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"
 	}
 }

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

@@ -729,6 +729,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 +777,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/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();
 					}
 				);