fable 3.1.16 → 3.1.18

package/package.json

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

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

@@ -35,8 +35,11 @@ class DataFormat extends libFableServiceProviderBase
 
 		this._UseEngineStringStartsWith = (typeof(String.prototype.startsWith) === 'function');
 		this._UseEngineStringEndsWith = (typeof(String.prototype.endsWith) === 'function');
-	}
 
+		this._SanitizeObjectKeyRegex = /[^a-zA-Z0-9_]/gi;
+		this._SanitizeObjectKeyReplacement = '_';
+		this._SanitizeObjectKeyInvalid = 'INVALID';
+	}
 
 	/*************************************************************************
 	 * String Manipulation and Comparison Functions
@@ -370,6 +373,21 @@ class DataFormat extends libFableServiceProviderBase
 		return '';
 	}
 
+	/**
+	 * Clean a string of any characters to create a consistent object key.
+	 *
+	 * @param {string} pString  The string to clean.
+	 * @return {string} the cleaned string, or a placeholder if the input is invalid
+	 */
+	sanitizeObjectKey(pString)
+	{
+		if (typeof pString !== 'string' || pString.length < 1)
+		{
+			return this._SanitizeObjectKeyInvalid;
+		}
+		return pString.replace(this._SanitizeObjectKeyRegex, this._SanitizeObjectKeyReplacement);
+	}
+
 
 	/*************************************************************************
 	 * Number Formatting Functions

package/source/services/Fable-Service-MetaTemplate/MetaTemplate-StringParser.js

@@ -84,11 +84,12 @@ class StringParser
 	 * @param {string} pCharacter - The character to append
 	 * @param {Object} pParserState - The state object for the current parsing task
 	 * @param {any} pData - The data available to the template
-	 * @param {any} pDataContext - The history of data objects/context already passed in
+	 * @param {Array<any>} pDataContext - The history of data objects/context already passed in
 	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
+	 * @param {any} [pState] - A catchall state object for plumbing data through template processing.
 	 * @private
 	 */
-	parseCharacter (pCharacter, pParserState, pData, pDataContext, pScope)
+	parseCharacter (pCharacter, pParserState, pData, pDataContext, pScope, pState)
 	{
 		// If we are already in a pattern match traversal
 		if (pParserState.PatternMatch)
@@ -112,11 +113,11 @@ class StringParser
 					let tmpFunctionContext = ('ParserContext' in pParserState.Pattern) ? pParserState.Pattern.ParserContext : false;
 					if (tmpFunctionContext)
 					{
-						pParserState.OutputBuffer = pParserState.Pattern.Parse.call(tmpFunctionContext, pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope);
+						pParserState.OutputBuffer = pParserState.Pattern.Parse.call(tmpFunctionContext, pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope, pState);
 					}
 					else
 					{
-						pParserState.OutputBuffer = pParserState.Pattern.Parse(pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope);
+						pParserState.OutputBuffer = pParserState.Pattern.Parse(pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope, pState);
 					}
 					return this.resetOutputBuffer(pParserState);
 				}
@@ -155,11 +156,11 @@ class StringParser
 						let tmpFunctionContext = ('ParserContext' in pParserState.Pattern) ? pParserState.Pattern.ParserContext : false;
 						if (tmpFunctionContext)
 						{
-							pParserState.OutputBuffer = pParserState.Pattern.Parse.call(tmpFunctionContext, pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope);
+							pParserState.OutputBuffer = pParserState.Pattern.Parse.call(tmpFunctionContext, pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope, pState);
 						}
 						else
 						{
-							pParserState.OutputBuffer = pParserState.Pattern.Parse(pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope);
+							pParserState.OutputBuffer = pParserState.Pattern.Parse(pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope, pState);
 						}
 						return this.resetOutputBuffer(pParserState);
 					}
@@ -192,7 +193,15 @@ class StringParser
 		return false;
 	}
 
-	executePatternAsync(pParserState, pData, fCallback, pDataContext, pScope)
+	/**
+	 * @param {Object} pParserState - The state object for the current parsing task
+	 * @param {Object} pData - The data to pass to the function as a second parameter
+	 * @param {function} fCallback - The callback function to call when the parse is complete
+	 * @param {array} pDataContext - The history of data objects/context already passed in
+	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
+	 * @param {any} [pState] - A catchall state object for plumbing data through template processing.
+	 */
+	executePatternAsync(pParserState, pData, fCallback, pDataContext, pScope, pState)
 	{
 		// ... this is the end of a pattern, cut off the end tag and parse it.
 		// Trim the start and end tags off the output buffer now
@@ -213,7 +222,7 @@ class StringParser
 						pParserState.OutputBuffer = pAsyncOutput;
 						this.resetOutputBuffer(pParserState);
 						return fCallback();
-					}, pDataContext, pScope);
+					}, pDataContext, pScope, pState);
 			}
 			else
 			{
@@ -228,7 +237,7 @@ class StringParser
 						pParserState.OutputBuffer = pAsyncOutput;
 						this.resetOutputBuffer(pParserState);
 						return fCallback();
-					}, pDataContext, pScope);
+					}, pDataContext, pScope, pState);
 			}
 		}
 		else
@@ -237,11 +246,11 @@ class StringParser
 			let tmpFunctionContext = ('ParserContext' in pParserState.Pattern) ? pParserState.Pattern.ParserContext : false;
 			if (tmpFunctionContext)
 			{
-				pParserState.OutputBuffer = pParserState.Pattern.Parse.call(tmpFunctionContext, pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope);
+				pParserState.OutputBuffer = pParserState.Pattern.Parse.call(tmpFunctionContext, pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope, pState);
 			}
 			else
 			{
-				pParserState.OutputBuffer = pParserState.Pattern.Parse(pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope);
+				pParserState.OutputBuffer = pParserState.Pattern.Parse(pParserState.OutputBuffer.substr(pParserState.Pattern.PatternStartString.length, pParserState.OutputBuffer.length - (pParserState.Pattern.PatternStartString.length+pParserState.Pattern.PatternEndString.length)), pData, pDataContext, pScope, pState);
 			}
 			this.resetOutputBuffer(pParserState);
 			return fCallback();
@@ -258,9 +267,10 @@ class StringParser
 	 * @param {function} fCallback - The callback function to call when the parse is complete
 	 * @param {array} pDataContext - The history of data objects/context already passed in
 	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
+	 * @param {any} [pState] - A catchall state object for plumbing data through template processing.
 	 * @private
 	 */
-	parseCharacterAsync (pCharacter, pParserState, pData, fCallback, pDataContext, pScope)
+	parseCharacterAsync (pCharacter, pParserState, pData, fCallback, pDataContext, pScope, pState)
 	{
 		// If we are already in a pattern match traversal
 		if (pParserState.PatternMatch)
@@ -282,7 +292,7 @@ class StringParser
 					// If this last character is the end of the pattern, parse it.
 					if ('Parse' in pParserState.Pattern)
 					{
-						return this.executePatternAsync(pParserState, pData, fCallback, pDataContext, pScope);
+						return this.executePatternAsync(pParserState, pData, fCallback, pDataContext, pScope, pState);
 					}
 				}
 				else if (pCharacter in pParserState.PatternStartNode.PatternEnd)
@@ -316,7 +326,7 @@ class StringParser
 					// If this last character is the end of the pattern, parse it.
 					if ('Parse' in pParserState.Pattern)
 					{
-						return this.executePatternAsync(pParserState, pData, fCallback, pDataContext, pScope);
+						return this.executePatternAsync(pParserState, pData, fCallback, pDataContext, pScope, pState);
 					}
 				}
 			}
@@ -357,8 +367,9 @@ class StringParser
 	 * @param {function} fCallback - The callback function to call when the parse is complete
 	 * @param {array} pDataContext - The history of data objects/context already passed in
 	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
+	 * @param {any} [pState] - A catchall state object for plumbing data through template processing.
 	 */
-	parseString (pString, pParseTree, pData, fCallback, pDataContext, pScope)
+	parseString (pString, pParseTree, pData, fCallback, pDataContext, pScope, pState)
 	{
 		// TODO: There is danger here if a template function attempts to functionally recurse and doesn't pass this in.
 		let tmpPreviousDataContext = (Array.isArray(pDataContext)) ? pDataContext : [];
@@ -372,7 +383,7 @@ class StringParser
 			for (var i = 0; i < pString.length; i++)
 			{
 				// TODO: This is not fast.
-				this.parseCharacter(pString[i], tmpParserState, pData, tmpDataContext, pScope);
+				this.parseCharacter(pString[i], tmpParserState, pData, tmpDataContext, pScope, pState);
 			}
 
 			this.flushOutputBuffer(tmpParserState);
@@ -392,7 +403,7 @@ class StringParser
 				tmpAnticipate.anticipate(
 					(fCallback) =>
 					{
-						this.parseCharacterAsync(pString[i], tmpParserState, pData, fCallback, tmpDataContext, pScope);
+						this.parseCharacterAsync(pString[i], tmpParserState, pData, fCallback, tmpDataContext, pScope, pState);
 					});
 			}
 

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

@@ -43,15 +43,16 @@ class FableServiceMetaTemplate extends libFableServiceBase
 	 * @param {function} fCallback - The callback function to call when a pattern is matched
 	 * @param {array} pDataContext - The history of data objects already passed in
 	 * @param {any} [pScope] - A sticky scope that can be used to carry state and simplify template
+	 * @param {any} [pState] - A catchall state object for plumbing data through template processing.
 	 * @return {string} The result from the parser
 	 */
-	parseString(pString, pData, fCallback, pDataContext, pScope)
+	parseString(pString, pData, fCallback, pDataContext, pScope, pState)
 	{
 		if (this.LogNoisiness > 4)
 		{
 			this.fable.log.trace(`Metatemplate parsing template string [${pString}] where the callback is a ${typeof(fCallback)}`, {TemplateData:pData});
 		}
-		return this.StringParser.parseString(pString, this.ParseTree, pData, fCallback, pDataContext, pScope);
+		return this.StringParser.parseString(pString, this.ParseTree, pData, fCallback, pDataContext, pScope, pState);
 	}
 }
 

package/test/DataFormat-StringManipulation_tests.js

@@ -302,6 +302,25 @@ suite
 					}
 				);
 				test
+				(
+					'Test sanitizing object keys',
+					(fTestComplete)=>
+					{
+						let testFable = new libFable({LogStreams: false});
+						let _DataFormat = testFable.services.DataFormat;
+						Expect(_DataFormat
+							.sanitizeObjectKey('Dogs'))
+							.to.equal('Dogs');
+						Expect(_DataFormat
+							.sanitizeObjectKey('Dogs are cool'))
+							.to.equal('Dogs_are_cool');
+						Expect(_DataFormat
+							.sanitizeObjectKey('Dogs 123 are cool!'))
+							.to.equal('Dogs_123_are_cool_');
+						return fTestComplete();
+					}
+				);
+				test
 				(
 					'Pad the beginning of a string',
 					(fTestComplete)=>