fable 3.0.45 → 3.0.47

package/test/MetaTemplating_tests.js

@@ -6,42 +6,46 @@
 * @author      Steven Velozo <steven@velozo.com>
 */
 
-var libFable = require('../source/Fable.js');
+const libFable = require('../source/Fable.js');
 
-var Chai = require("chai");
-var Expect = Chai.expect;
+const Chai = require("chai");
+const Expect = Chai.expect;
 
 
-var loadPrecedentModule = () =>
+const loadMetaTemplateModule = () =>
 {
 	let tmpFable = new libFable();
 	return tmpFable.serviceManager.instantiateServiceProviderWithoutRegistration('MetaTemplate', {});
 };
 
-var configPrecedent = (pModule) =>
+const configMetaTemplate = (pModule) =>
 {
+
+
 	pModule.addPattern('<%', '%>', 'JUNKED_THIS_DATA');
 	// This one gets the count of the inner string...
 	pModule.addPattern('<%#', '%>', (pData)=>{return pData.length});
 	// Replaces the string with the settings object...
 	pModule.addPattern('<%=', '%>', (pData)=>{return JSON.stringify(pModule.settings);});
+	// Custom expression hashes
+	pModule.addPattern('<*', '*>', (pHash, pData)=>{return `pData is [${pData}] with a hash of [${pHash}]`});
+	pModule.addPattern('<^', '^>', (pHash, pData)=>{return `hash of [${pHash}] from pData is ${pData[pHash]}`});
 	// This just escapes out pairs of $
 	pModule.addPattern('$');
+	pModule.addPatternAsync('<%Async', '%>',
+		(pHash, pData, fCallback)=>
+		{
+			return fCallback(null, `ASYNC DATA IS [${pHash}]`);
+		});
+
 };
 
 suite
 (
 	'Fable MetaTemplating',
-	function()
+	() =>
 	{
-		var testFable = false;
-
-		setup
-		(
-			function()
-			{
-			}
-		);
+		setup (() => {});
 
 		suite
 		(
@@ -53,11 +57,11 @@ suite
 					'No Matches...',
 					(fDone) =>
 					{
-						var tmpTestString = 'ABC123';
-						var tmpExpectedResult = tmpTestString;
-						var testPrecedent = loadPrecedentModule();
-						configPrecedent(testPrecedent);
-						var	tmpResult = testPrecedent.parseString(tmpTestString);
+						let tmpTestString = 'ABC123';
+						let tmpExpectedResult = tmpTestString;
+						let testMetaTemplate = loadMetaTemplateModule();
+						configMetaTemplate(testMetaTemplate);
+						let	tmpResult = testMetaTemplate.parseString(tmpTestString);
 						Expect(tmpResult).to.equal(tmpExpectedResult);
 						fDone();
 					}
@@ -67,11 +71,11 @@ suite
 					'Count function...',
 					(fDone) =>
 					{
-						var tmpTestString = 'There are <%#0123456789%> characters in here';
-						var tmpExpectedResult = 'There are 10 characters in here';
-						var testPrecedent = loadPrecedentModule();
-						configPrecedent(testPrecedent);
-						var	tmpResult = testPrecedent.parseString(tmpTestString);
+						let tmpTestString = 'There are <%#0123456789%> characters in here';
+						let tmpExpectedResult = 'There are 10 characters in here';
+						let testMetaTemplate = loadMetaTemplateModule();
+						configMetaTemplate(testMetaTemplate);
+						let	tmpResult = testMetaTemplate.parseString(tmpTestString);
 						Expect(tmpResult).to.equal(tmpExpectedResult);
 						fDone();
 					}
@@ -81,15 +85,223 @@ suite
 					'Multiple terms...',
 					(fDone) =>
 					{
-						var tmpTestString = 'There are <%#12345%> characters in here and a $comment$ as well.  And we <% Some data in here %> right up.';
-						var tmpExpectedResult = 'There are 5 characters in here and a comment as well.  And we JUNKED_THIS_DATA right up.';
-						var testPrecedent = loadPrecedentModule();
-						configPrecedent(testPrecedent);
-						var	tmpResult = testPrecedent.parseString(tmpTestString);
+						let tmpTestString = 'There are <%#12345%> characters in here and a $comment$ as well.  And we <% Some data in here %> right up.';
+						let tmpExpectedResult = 'There are 5 characters in here and a comment as well.  And we JUNKED_THIS_DATA right up.';
+						let testMetaTemplate = loadMetaTemplateModule();
+						configMetaTemplate(testMetaTemplate);
+						let	tmpResult = testMetaTemplate.parseString(tmpTestString);
+						Expect(tmpResult).to.equal(tmpExpectedResult);
+						fDone();
+					}
+				);
+				test
+				(
+					'Basic pattern replacement...',
+					(fDone) =>
+					{
+						let testMetaTemplate = loadMetaTemplateModule();
+
+						Expect(Object.keys(testMetaTemplate.ParseTree).length).to.equal(0, 'There should be an empty tree on initialization.');
+						configMetaTemplate(testMetaTemplate);
+						Expect(Object.keys(testMetaTemplate.ParseTree).length).to.equal(2, 'The tree should grow properly.');
+
+						//console.log(JSON.stringify(testMetaTemplate.tree,null,4));
+
+						let tmpResult = testMetaTemplate.parseString('');
+						Expect(tmpResult.length).to.equal(0, 'Parsing Empty Strings should Work...');
+
+						fDone();
+					}
+				);
+
+				test
+				(
+					'Leveraging pData a bit...',
+					(fDone) =>
+					{
+						let tmpTestString = 'The <*SomeValue*> pData up in here and a $comment$ as well.';
+						let tmpExpectedResult = 'The pData is [Yikes] with a hash of [SomeValue] pData up in here and a comment as well.';
+						let testMetaTemplate = loadMetaTemplateModule();
+						configMetaTemplate(testMetaTemplate);
+						let	tmpResult = testMetaTemplate.parseString(tmpTestString, 'Yikes');
+						Expect(tmpResult).to.equal(tmpExpectedResult);
+						fDone();
+					}
+				);
+				test
+				(
+					'Leveraging pData a using subobjects...',
+					(fDone) =>
+					{
+						let tmpTestString = 'The <^SomeValue^> pData up in here and a $comment$ as well.';
+						let tmpExpectedResult = 'The hash of [SomeValue] from pData is AirbornLight pData up in here and a comment as well.';
+						let testMetaTemplate = loadMetaTemplateModule();
+						configMetaTemplate(testMetaTemplate);
+						let	tmpResult = testMetaTemplate.parseString(tmpTestString, {SomeValue:'AirbornLight'});
 						Expect(tmpResult).to.equal(tmpExpectedResult);
 						fDone();
 					}
 				);
+				test
+				(
+					'Async Function',
+					(fDone) =>
+					{
+						let tmpTestString = 'The <^SomeValue^> pData and Async <%AsyncThe Funny String%> up in here and a $comment$ as well.';
+						let tmpExpectedResult = 'The hash of [SomeValue] from pData is AirbornLight pData up in here and a comment as well.';
+						let testMetaTemplate = loadMetaTemplateModule();
+						configMetaTemplate(testMetaTemplate);
+						let	tmpResult = testMetaTemplate.parseString(tmpTestString, {SomeValue:'AirbornLight'},
+							(pError, pValue) =>
+							{
+								Expect(pValue).to.equal('The hash of [SomeValue] from pData is AirbornLight pData and Async ASYNC DATA IS [The Funny String] up in here and a comment as well.');
+								return fDone();
+							});
+					}
+				);
+				test
+				(
+					'Bad pattern start parameter...',
+					(fDone) =>
+					{
+						let testMetaTemplate = loadMetaTemplateModule();
+						configMetaTemplate(testMetaTemplate);
+						Expect(testMetaTemplate.addPattern('', '>', 'SHORTEST_MATCH')).to.equal(false);
+						fDone();
+					}
+				);
+				test
+				(
+					'Bad pattern end parameter...',
+					(fDone) =>
+					{
+						let testMetaTemplate = loadMetaTemplateModule();
+						configMetaTemplate(testMetaTemplate);
+						Expect(testMetaTemplate.addPattern('<', '', 'SHORTEST_MATCH')).to.equal(false);
+						fDone();
+					}
+				);
+				test
+				(
+					'Identifier fallback...',
+					(fDone) =>
+					{
+						let testMetaTemplate = loadMetaTemplateModule();
+						testMetaTemplate.addPattern('<', '>', 'SHORTEST_MATCH');
+						testMetaTemplate.addPattern('<<', '>', 'MEDIUM_MATCH');
+						testMetaTemplate.addPattern('<<EXTRALONG', '>', 'EXTRA_LONG_MATCH');
+
+						let tmpTestStrings = [
+							'Match this <> and this <here> please.',
+							'Match this SHORTEST_MATCH and this SHORTEST_MATCH please.',
+
+							'Match this <<> and this <<here> please.',
+							'Match this MEDIUM_MATCH and this MEDIUM_MATCH please.',
+
+							'Match this <<EXTRA> and this <<here> please.',
+							'Match this MEDIUM_MATCH and this MEDIUM_MATCH please.',
+
+							'Match this <<EXTRALONG> and this <<here> please.',
+							'Match this EXTRA_LONG_MATCH and this MEDIUM_MATCH please.',
+
+							'Match this <<<<> and this <here> please.',
+							'Match this MEDIUM_MATCH and this SHORTEST_MATCH please.'
+						];
+
+						let	tmpResult = '';
+						// Test every pair in TestStrings
+						for (let i = 0; i < tmpTestStrings.length; i+=2)
+						{
+							tmpResult = testMetaTemplate.parseString(tmpTestStrings[i]);
+							Expect(tmpResult).to.equal(tmpTestStrings[i+1]);
+						}
+						fDone();
+					}
+				);
+				test
+				(
+					'Config magic example...',
+					(fDone) =>
+					{
+						// Use case is take a string with the following template expressions and translate them into the value from the environment variable if a default isn't passed in:
+						//	'Expressions like ${VariableWithDefault|DefaultValue} have a Default value after the pipe; others like ${VariableWithoutDefault} expressions do not have a Default value after the pipe. but should be processed properly.',
+						//	'Expressions like DefaultValue have a Default value after the pipe; others like VariableWithoutDefault expressions do not have a Default value after the pipe. but should be processed properly.',
+
+						// The usual case is just expressions in the string, but composability is fine.
+
+						let testMetaTemplate = loadMetaTemplateModule();
+
+						testMetaTemplate.addPattern('${', '}',
+							(pTemplateValue)=>
+							{
+								let tmpTemplateValue = pTemplateValue.trim();
+
+								let tmpSeparatorIndex = tmpTemplateValue.indexOf('|');
+
+								// If there is no pipe, the default value will end up being whatever the variable name is.
+								let tmpDefaultValue = tmpTemplateValue.substring(tmpSeparatorIndex+1);
+
+								let tmpEnvironmentVariableName = (tmpSeparatorIndex > -1) ? tmpTemplateValue.substring(0, tmpSeparatorIndex) : tmpTemplateValue;
+
+								if (process.env.hasOwnProperty(tmpEnvironmentVariableName))
+								{
+									return process.env[tmpEnvironmentVariableName];
+								}
+								else
+								{
+									return tmpDefaultValue;
+								}
+							});
+
+						let tmpTestStrings = [
+							'Expressions like ${VariableWithDefault|DefaultValue} have a Default value after the pipe; others like ${VariableWithoutDefault} expressions do not have a Default value after the pipe. but should be processed properly.',
+							'Expressions like DefaultValue have a Default value after the pipe; others like VariableWithoutDefault expressions do not have a Default value after the pipe. but should be processed properly.',
+
+							'${PATH}',
+							process.env.PATH,
+
+							'AAA ${PATH}',
+							'AAA '+process.env.PATH,
+
+							' ${PATH} AAA ${PATH}',
+							' '+process.env.PATH+' AAA '+process.env.PATH,
+
+							'AAA ${PATH} BBB',
+							'AAA '+process.env.PATH+' BBB',
+
+							'AAA ${PATH} } BBB',
+							'AAA '+process.env.PATH+' } BBB',
+
+							'AAA ${ ${PATH} BBB',
+							// Two start parameters isn't okay ---
+							// ...it passes the pattern processor the following (without quotes):
+							// " ${PATH"
+							// Which is not going to match an environment variable.  With the second
+							'AAA ${PATH BBB',
+
+							'${PATH|Malarky Default Value} ZZZ',
+							process.env.PATH+' ZZZ',
+
+							'${THISISNOTANENVIRONMENTVARIABLE|Real Default Value} ZZZed',
+							'Real Default Value ZZZed',
+
+							'${ THISISNOTANENVIRONMENTVARIABLETRIMMED|Real Trimmed Default Value } ZZZed',
+							'Real Trimmed Default Value ZZZed',
+
+							'${PATH} BBB',
+							process.env.PATH+' BBB'
+						];
+
+						let	tmpResult = '';
+						// Test every pair in TestStrings
+						for (let i = 0; i < tmpTestStrings.length; i+=2)
+						{
+							tmpResult = testMetaTemplate.parseString(tmpTestStrings[i]);
+							Expect(tmpResult).to.equal(tmpTestStrings[i+1]);
+						}
+						fDone();
+					}
+				);
 			}
 		);
 	}

package/test/RestClient_test.js

@@ -43,7 +43,7 @@ suite
 							{
 								Expect(pBody).to.be.an('object');
 								Expect(pBody.hasOwnProperty('Name')).to.equal(true);
-								Expect(pBody.Name).to.equal('Suzanne Collins');
+								Expect(pBody.Name).to.equal('John Green');
 								fTestComplete();
 							});
 					}

package/retold-harness/Bookstore-Import-Books.sh

@@ -1,4 +0,0 @@
-#/bin/bash
-
-# Eventually this will delete the database too!
-node ./bookstore-import-books-run.js

package/retold-harness/bookstore-configuration.json

@@ -1,28 +0,0 @@
-{
-	"Product": "MeadowEndpointsTestBookStore",
-	"ProductVersion": "1.0.0",
-
-	"UUID":
-		{
-			"DataCenter": 0,
-			"Worker": 0
-		},
-	"LogStreams":
-		[
-			{
-				"streamtype": "console"
-			}
-		],
-
-	"APIServerPort": 8086,
-
-	"MySQL":
-		{
-			"Server": "127.0.0.1",
-			"Port": 3306,
-			"User": "root",
-			"Password": "123456789",
-			"Database": "bookstore",
-			"ConnectionPoolLimit": 20
-		}
-}

package/retold-harness/bookstore-import-books-run.js

@@ -1,9 +0,0 @@
-let tmpRun = require('./bookstore-import-books.js')(
-    (pError)=>
-    {
-        if (pError)
-        {
-            console.log(`ERROR: ${pError}`, pError);
-        }
-        process.exit();
-    });

package/retold-harness/bookstore-import-books.js

@@ -1,214 +0,0 @@
-/*
-    Import Books directly from CSV to SQL.
-
-    An example of how to use the Meadow DALs directly.
-*/
-/**
-* @author <steven@velozo.com>
-*/
-
-// Server Settings
-const _Settings = require('./bookstore-configuration.json');
-// Fable is logging and settings
-const libFable = require('fable');
-// Official MySQL Client
-const libMySQL = require('mysql2');
-// Meadow is the DAL
-const libMeadow = require('meadow');
-
-const libAsync = require('async');
-
-let _Fable = libFable.new(_Settings);
-let _Meadow = libMeadow.new(_Fable);
-
-_Fable.log.info("Application is starting up...");
-
-_Fable.log.info("...Creating SQL Connection pools at "+_Fable.settings.MySQL.Server+"...");
-// Setup SQL Connection Pool
-_Fable.MeadowMySQLConnectionPool = libMySQL.createPool
-	(
-		{
-			connectionLimit: _Fable.settings.MySQL.ConnectionPoolLimit,
-			host: _Fable.settings.MySQL.Server,
-			port: _Fable.settings.MySQL.Port,
-			user: _Fable.settings.MySQL.User,
-			password: _Fable.settings.MySQL.Password,
-			database: _Fable.settings.MySQL.Database,
-			namedPlaceholders: true
-		}
-	);
-
-// Create DAL objects
-let _DAL = {};
-const _BookStoreModel = require (__dirname+'/model/json_schema/BookStore-Extended.json');
-const _BookStoreTableList = Object.keys(_BookStoreModel.Tables);
-_Fable.log.info(`...Creating ${_BookStoreTableList.length} DAL entries...`);
-for (let i = 0; i < _BookStoreTableList.length; i++)
-{
-	let tmpDALEntityName = _BookStoreTableList[i];
-	_Fable.log.info(`   -> Creating the ${tmpDALEntityName} DAL...`);
-	_DAL[tmpDALEntityName] = _Meadow.loadFromPackage(__dirname+'/model/meadow_schema/BookStore-MeadowSchema-'+tmpDALEntityName+'.json');
-	_DAL[tmpDALEntityName].setProvider('MySQL');
-	_DAL[tmpDALEntityName].setIDUser(99999);
-}
-
-const libPapa = require('papaparse');
-const libFS = require('fs');
-
-const _BookData = libFS.readFileSync(`${__dirname}/data/books.csv`, 'utf8');
-
-let tmpBookMap = {};
-let tmpAuthorMap = {};
-
-let fImportBooks = (fCallback) =>
-{
-    console.log('Import operation executing...');
-    let tmpCallback = (typeof(fCallback) == 'function') ? fCallback : ()=>{};
-
-    libPapa.parse(_BookData,
-        {
-            delimiter: ",",
-            header: true,
-            complete:
-                (pResults) =>
-                {
-                    libAsync.waterfall([
-                        (fStageComplete) =>
-                        {
-                            // Enumerate and insert each book
-                            libAsync.eachLimit(pResults.data, 10,
-                                (pBookDataRow, fCallback) =>
-                                {
-                                    let tmpRecordToCreate = (
-                                        {
-                                            Title: pBookDataRow.original_title,
-                                            PublicationYear: isNaN(parseInt(pBookDataRow.original_publication_year, 10)) ? 0 : parseInt(pBookDataRow.original_publication_year, 10),
-                                            ISBN: pBookDataRow.isbn,
-                                            Type: 'Paper',
-                                            Genre: 'UNKNOWN',
-                                            Language: pBookDataRow.language_code,
-                                            ImageURL: pBookDataRow.image_url
-                                        });
-                                    let tmpQuery = _DAL.Book.query;
-                                    //tmpQuery.setLogLevel(5);
-                                    tmpQuery.addRecord(tmpRecordToCreate);
-                                    _DAL.Book.doCreate(tmpQuery,
-                                        (pError, pQuery, pQueryRead, pRecord)=>
-                                        {
-                                            // Add it to the book map
-                                            if (!pError)
-                                            {
-                                                tmpBookMap[pBookDataRow.id] = pRecord.IDBook;
-                                                //_Fable.log.info('Imported book ID '+pRecord.IDBook+' title ['+pRecord.Title+']');
-                                            }
-                                            fCallback(pError);
-                                        });
-
-                                },
-                                (pError)=>
-                                {
-                                    _Fable.log.info('...Book Import operation complete!');
-                                    fStageComplete()
-                                });
-                        },
-                        (fStageComplete) =>
-                        {
-                            // Enumerate and insert each author
-                            libAsync.eachLimit(pResults.data, 10,
-                                (pBookDataRow, fCallback) =>
-                                {
-                                    if (!pBookDataRow.hasOwnProperty('authors'))
-                                        return fCallback();
-
-                                    let tmpAuthorsToCreate = pBookDataRow.authors.split(',');
-
-                                    libAsync.eachLimit(tmpAuthorsToCreate, 1,
-                                        (pAuthor, fAuthorInsertCallback)=>
-                                        {
-                                            if (tmpAuthorMap.hasOwnProperty(pAuthor))
-                                            {
-                                                return fAuthorInsertCallback();
-                                            }
-                                            else
-                                            {
-                                                tmpAuthorMap[pAuthor] = false;
-                                            }
-                                            let tmpRecordToCreate = (
-                                                {
-                                                    Name: pAuthor
-                                                });
-                                            let tmpQuery = _DAL.Author.query.addRecord(tmpRecordToCreate);
-                                            _DAL.Author.doCreate(tmpQuery,
-                                                (pError, pQuery, pQueryRead, pRecord)=>
-                                                {
-                                                    if (!pError)
-                                                    {
-                                                        tmpAuthorMap[pRecord.Name] = pRecord.IDAuthor;
-                                                        //_Fable.log.info('Imported Author ID '+pRecord.IDAuthor+' named ['+pRecord.Name+']');
-                                                    }
-                                                    return fAuthorInsertCallback(pError);
-                                                });
-                                        },
-                                        (pError)=>
-                                        {
-                                            return fCallback(pError);
-                                        });
-                                },
-                                (pError)=>
-                                {
-                                    _Fable.log.info('...Author Import operation complete!');
-                                    fStageComplete();
-                                });
-                        },
-                        (fStageComplete) =>
-                        {
-                            // Create Book->Author joins
-                            libAsync.eachLimit(pResults.data, 10,
-                                (pBookDataRow, fCallback) =>
-                                {
-                                    if (!pBookDataRow.hasOwnProperty('authors'))
-                                        return fCallback();
-
-                                    let tmpAuthorJoinsToCreate = pBookDataRow.authors.split(',');
-
-                                    libAsync.eachLimit(tmpAuthorJoinsToCreate, 1,
-                                        (pAuthor, fAuthorJoinInsertCallback)=>
-                                        {
-                                            let tmpRecordToCreate = (
-                                                {
-                                                    IDBook: tmpBookMap[pBookDataRow.id],
-                                                    IDAuthor: tmpAuthorMap[pAuthor]
-                                                });
-                                            let tmpQuery = _DAL.BookAuthorJoin.query.addRecord(tmpRecordToCreate);
-                                            _DAL.BookAuthorJoin.doCreate(tmpQuery,
-                                                (pError, pQuery, pQueryRead, pRecord)=>
-                                                {
-                                                    if (!pError)
-                                                    {
-                                                        //_Fable.log.info(`Joined author ${pAuthor} ID ${pRecord.IDAuthor} to book ID ${pRecord.IDBook}`);
-                                                    }
-                                                    return fAuthorJoinInsertCallback(pError);
-                                                });
-                                        },
-                                        (pError)=>
-                                        {
-                                            return fCallback(pError);
-                                        });
-                                },
-                                (pError)=>
-                                {
-                                    _Fable.log.info('...Join Import operation complete!');
-                                    return fStageComplete(pError);
-                                });
-                        }
-                    ],
-                    (pError)=>
-                    {
-                        _Fable.log.info('Full import operation has completed!')
-                        tmpCallback(pError);
-                    });
-                }
-        });
-}
-
-module.exports = fImportBooks;