fable 3.0.10 → 3.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fable",
-  "version": "3.0.10",
+  "version": "3.0.12",
   "description": "An entity behavior management and API bundling library.",
   "main": "source/Fable.js",
   "scripts": {

package/source/Fable-Operation.js

@@ -0,0 +1,119 @@
+const _OperationStatePrototype = JSON.stringify(
+{
+	"Metadata": {
+		"GUID": false,
+		"Hash": false,
+
+		"Title": "",
+		"Summary": "",
+
+		"Version": 0
+	},
+	"Status": {
+        "Completed": false,
+
+        "CompletionProgress": 0,
+        "CompletionTimeElapsed": 0,
+
+        "Steps": 1,
+        "StepsCompleted": 0,
+
+        "StartTime": 0,
+        "EndTime": 0
+	},
+	"Errors": [],
+	"Log": []
+});
+
+class FableOperation
+{
+	constructor(pFable, pOperationName, pOperationHash)
+	{
+		this.fable = pFable;
+
+		this.state = JSON.parse(_OperationStatePrototype);
+
+		this.state.Metadata.GUID = this.fable.getUUID();
+		this.state.Metadata.Hash = this.state.GUID;
+
+		if (typeof(pOperationHash) == 'string')
+		{
+			this.state.Metadata.Hash = pOperationHash;
+		}
+	}
+
+	get GUID()
+	{
+		return this.state.Metadata.GUID;
+	}
+
+	get Hash()
+	{
+		return this.state.Metadata.Hash;
+	}
+
+	get log()
+	{
+		return this;
+	}
+
+	writeOperationLog(pLogLevel, pLogText, pLogObject)
+	{
+		this.state.Log.push(`${new Date().toUTCString()} [${pLogLevel}]: ${pLogText}`);
+
+		if (typeof(pLogObject) == 'object')
+		{
+			this.state.Log.push(JSON.stringify(pLogObject));
+		}
+	}
+
+	writeOperationErrors(pLogText, pLogObject)
+	{
+		this.state.Errors.push(`${pLogText}`);
+
+		if (typeof(pLogObject) == 'object')
+		{
+			this.state.Errors.push(JSON.stringify(pLogObject));
+		}
+	}
+
+	trace(pLogText, pLogObject)
+	{
+		this.writeOperationLog('TRACE', pLogText, pLogObject);
+		this.fable.log.trace(pLogText, pLogObject);
+	}
+
+	debug(pLogText, pLogObject)
+	{
+		this.writeOperationLog('DEBUG', pLogText, pLogObject);
+		this.fable.log.debug(pLogText, pLogObject);
+	}
+
+	info(pLogText, pLogObject)
+	{
+		this.writeOperationLog('INFO', pLogText, pLogObject);
+		this.fable.log.info(pLogText, pLogObject);
+	}
+
+	warn(pLogText, pLogObject)
+	{
+		this.writeOperationLog('WARN', pLogText, pLogObject);
+		this.fable.log.warn(pLogText, pLogObject);
+	}
+
+	error(pLogText, pLogObject)
+	{
+		this.writeOperationLog('ERROR', pLogText, pLogObject);
+		this.writeOperationErrors(pLogText, pLogObject);
+		this.fable.log.error(pLogText, pLogObject);
+	}
+
+	fatal(pLogText, pLogObject)
+	{
+		this.writeOperationLog('FATAL', pLogText, pLogObject);
+		this.writeOperationErrors(pLogText, pLogObject);
+		this.fable.log.fatal(pLogText, pLogObject);
+	}
+}
+
+module.exports = FableOperation;

package/source/Fable-Utility.js

@@ -1,4 +1,5 @@
 const libFableUtilityTemplate = require('./Fable-Utility-Template.js');
+// TODO: These are still pretty big -- consider the smaller polyfills
 const libAsyncWaterfall = require('async/waterfall');
 const libAsyncEachLimit = require('async/eachLimit');
 

package/source/Fable.js

@@ -9,6 +9,8 @@ const libFableLog = require('fable-log');
 
 const libFableUtility = require('./Fable-Utility.js')
 
+const libFableOperation = require('./Fable-Operation.js');
+
 class Fable
 {
 	constructor(pSettings)
@@ -23,13 +25,17 @@ class Fable
 		this.log = new libFableLog(this.settingsManager.settings);
 		this.log.initialize();
 
+		// Built-in utility belt functions
 		this.Utility = new libFableUtility(this);
 
-		// Built-in dependencies ... more can be added here.
+		// Built-in dependencies
 		this.Dependencies = (
 			{
 				precedent: libFableSettings.precedent
 			});
+
+		// Location for Operation state
+		this.Operations = {};
 	}
 
 	get settings()
@@ -46,6 +52,35 @@ class Fable
 	{
 		return this.libUUID.getUUID();
 	}
+
+	createOperation(pOperationName, pOperationHash)
+	{
+		let tmpOperation = new libFableOperation(this, pOperationName, pOperationHash);
+
+		if (this.Operations.hasOwnProperty(tmpOperation.Hash))
+		{
+			// Uh Oh ...... Operation Hash Collision!
+			// TODO: What to do?!
+		}
+		else
+		{
+			this.Operations[tmpOperation.Hash] = tmpOperation;
+		}
+
+		return tmpOperation;
+	}
+
+	getOperation(pOperationHash)
+	{
+		if (!this.Operations.hasOwnProperty(pOperationHash))
+		{
+			return false;
+		}
+		else
+		{
+			return this.pOperations[pOperationHash];
+		}
+	}
 }
 
 // This is for backwards compatibility

package/test/FableOperations_tests.js

@@ -0,0 +1,66 @@
+/**
+* Unit tests for Fable
+*
+* @license     MIT
+*
+* @author      Steven Velozo <steven@velozo.com>
+*/
+
+var libFable = require('../source/Fable.js');
+
+var Chai = require("chai");
+var Expect = Chai.expect;
+var Assert = Chai.assert;
+
+suite
+(
+	'Fable Operations',
+	function()
+	{
+		suite
+		(
+			'Utility',
+			function()
+			{
+				test
+				(
+					'Create a basic Integration Operation',
+					function()
+					{
+						let testFable = new libFable();
+						let tmpOperation = testFable.createOperation('Big Complex Integration Operation', 'INTEGRATION-123');
+						Expect(tmpOperation).to.be.an('object');
+						Expect(testFable.Operations.hasOwnProperty('INTEGRATION-123')).to.equal(true);
+						tmpOperation.log.info('Test 123');
+						Expect(tmpOperation.state.Log.length).to.equal(1);
+						Expect(tmpOperation.state.Log[0]).to.contain('Test 123');
+					}
+				);
+				test
+				(
+					'Create a basic Integration Operation without a Hash',
+					function()
+					{
+						let testFable = new libFable();
+						let tmpOperation = testFable.createOperation('Another Big Complex Integration Operation');
+						Expect(tmpOperation).to.be.an('object');
+						Expect(testFable.Operations.hasOwnProperty(tmpOperation.Hash)).to.equal(true);
+						Expect(tmpOperation.state.Log.length).to.equal(0);
+						let tmpText = `Operation ${tmpOperation.Hash} starting up...`;
+						tmpOperation.log.info(tmpText);
+						Expect(tmpOperation.state.Log.length).to.equal(1);
+						Expect(tmpOperation.state.Log[0]).to.contain(tmpText);
+						tmpOperation.log.trace('And the traces are gone...');
+						tmpOperation.log.debug('Debug something.', {TestData:'Ignition Complete'});
+						tmpOperation.log.warn('Something was almost bad.');
+						tmpOperation.log.error('This was an error!');
+						tmpOperation.log.fatal('It was fatal.');
+						Expect(tmpOperation.state.Log.length).to.equal(7);
+						Expect(tmpOperation.state.Log[3]).to.equal('{"TestData":"Ignition Complete"}')
+						Expect(tmpOperation.state.Errors.length).to.equal(2);
+					}
+				);
+			}
+		);
+	}
+);

package/test/FableUtility_tests.js

@@ -14,7 +14,7 @@ var Assert = Chai.assert;
 
 suite
 (
-	'FableUtility',
+	'Fable Utility',
 	function()
 	{
 		var testFable = false;
@@ -195,7 +195,8 @@ suite
 								fDone();
 							})
 					}
-				);			}
+				);
+			}
 		);
 	}
 );

package/test/Fable_tests.js

@@ -40,11 +40,11 @@ suite
 						// Instantiate the logger
 						Expect(testFable).to.be.an('object', 'Fable should initialize as an object directly from the require statement.');
 						Expect(testFable).to.have.a.property('log')
-						.that.is.a('object');
+							.that.is.a('object');
 						Expect(testFable).to.have.a.property('settings')
-						.that.is.a('object');
+							.that.is.a('object');
 						Expect(testFable).to.have.a.property('fable')
-						.that.is.a('object');
+							.that.is.a('object');
 						Expect(testFable.settings.Product)
 							.to.equal('ApplicationNameHere')
 					}