retold 1.0.6 → 4.0.1

package/package.json

@@ -1,37 +1,32 @@
 {
-  "name": "retold",
-  "version": "1.0.6",
-  "description": "Common Application Services",
-  "main": "source/Retold.js",
-  "scripts": {
-    "start": "node source/Retold.js",
-    "coverage": "./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -u tdd -R spec",
-    "test": "./node_modules/mocha/bin/_mocha -u tdd -R spec"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/stevenvelozo/retold.git"
-  },
-  "keywords": [
-    "logging"
-  ],
-  "author": "Steven Velozo <steven@velozo.com> (http://velozo.com/)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/stevenvelozo/retold/issues"
-  },
-  "homepage": "https://github.com/stevenvelozo/retold",
-  "devDependencies": {
-    "async": "0.9.0",
-    "chai": "2.0.0",
-    "codeclimate-test-reporter": "0.0.4",
-    "coveralls": "2.11.2",
-    "istanbul": "0.3.5",
-    "mocha": "2.1.0"
-  },
-  "dependencies": {
-    "fable": "~1.0.1",
-    "meadow": "~1.0.29",
-    "meadow-endpoints": "~2.0.1"
-  }
+    "name": "retold",
+    "version": "4.0.1",
+    "description": "The pict and fable node ecosystem.",
+    "main": "source/Retold.cjs",
+    "scripts": {
+        "start": "node source/Retold.cjs",
+        "coverage": "./node_modules/.bin/nyc --reporter=lcov --reporter=text-lcov ./node_modules/mocha/bin/_mocha -- -u tdd -R spec",
+        "test": "./node_modules/.bin/mocha -u tdd -R spec",
+		"build-docs": "npx quack prepare-docs ./docs -d ./modules",
+		"serve-docs": "npx pict-docuserve serve ./docs",
+        "docker-dev-build": "docker build ./ -f Dockerfile_LUXURYCode -t retold-image:local",
+        "docker-dev-run": "docker run -it -d --name retold-dev -p 30001:8080 -p 38086:8086 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/retold\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold-image:local",
+        "docker-dev-shell": "docker exec -it retold-dev /bin/bash"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/stevenvelozo/retold.git"
+    },
+    "keywords": [],
+    "author": "Steven Velozo <steven@velozo.com> (http://velozo.com/)",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/stevenvelozo/retold/issues"
+    },
+    "homepage": "https://github.com/stevenvelozo/retold",
+    "devDependencies": {
+        "indoctrinate": "^1.0.4",
+        "pict-docuserve": "^0.0.7",
+        "quackage": "^1.0.47"
+    }
 }

package/source/Retold.cjs

@@ -0,0 +1,2 @@
+
+

package/test/Retold_tests.js

@@ -1,54 +1,36 @@
 /**
 * Unit tests for Retold
-*
-* @license     MIT
-*
-* @author      Steven Velozo <steven@velozo.com>
+* @author Steven Velozo <steven@velozo.com>
 */
 
-var Chai = require("chai");
-var Expect = Chai.expect;
-var Assert = Chai.assert;
+const Chai = require("chai");
+const Expect = Chai.expect;
 
-
-var _MockSettings = (
-{
-	Product: 'MockRetold',
-	ProductVersion: '0.0.0'
-});
+const libRetold = require('../source/Retold.js');
 
 suite
-(
-	'Retold',
-	function()
-	{
-		var _Fable;
-
-		setup
-		(
-			function()
-			{
-				_Fable = require('fable').new(_MockSettings);
-			}
-		);
+	(
+		'Retold',
+		() =>
+		{
+			setup(() => { });
 
 
-		suite
-		(
-			'Object Sanity',
-			function()
-			{
-				test
+			suite
 				(
-					'The class should initialize itself into a happy little object.',
-					function()
+					'Object Sanity',
+					() =>
 					{
-						testFable = require('../source/Retold.js').new();
-						// Instantiate the logger
-						Expect(testFable).to.be.an('object', 'Retold should initialize as an object directly from the require statement.');
+						test
+							(
+								'The class should initialize itself into a happy little object.',
+								function ()
+								{
+									testRetold = new libRetold();
+									Expect(testRetold).to.be.an('object', 'Go class go.');
+								}
+							);
 					}
 				);
-			}
-		);
-	}
-);
+		}
+	);

package/.travis.yml

@@ -1,13 +0,0 @@
-language: node_js
-node_js:
-  - "0.12"
-addons:
-  code_climate:
-    repo_token: 6d316c5a0e98ac8a4f7a71362e80df2861882af98c1443bf0bdb56383bc45458
-after_success:
-  - npm run coverage
-after_script:
-  - cat coverage/lcov.info | ./node_modules/codeclimate-test-reporter/bin/codeclimate.js
-  - cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
-notifications:
-  slack: paviateam:C1q99hL9XXpiPpau2PUrVZPC

package/source/Retold-Meadow-Macros.js

@@ -1,269 +0,0 @@
-// ##### Part of the **[retold](https://stevenvelozo.github.io/retold/)** system
-/**
-* @license MIT
-* @author <steven@velozo.com>
-*/
-
-/**
-* Meadow Macro Functions
-*
-* @class MeadowMacros
-*/
-var MeadowMacros = function()
-{
-	function createNew(pFable)
-	{
-		// If a valid Fable object isn't passed in, return a constructor
-		if (typeof(pFable) !== 'object')
-		{
-			return {new: createNew};
-		}
-
-		var _Fable = pFable;
-
-
-		var libMeadow = require('meadow').new(pFable);
-		var libMeadowEndpoints = require('meadow-endpoints');
-
-		// The DAL cache object
-		var _DALCache = {};
-		var _MeadowEndpointCache = false;
-
-		/**
-		 * Get a DAL for a particular schema.
-		 *
-		 * @method getDAL
-		 * @param {String} pSchemaName The string schema to get
-		 */
-		var getDAL = function(pSchemaName)
-		{
-			var tmpSchemaJSONPath = _Fable.settings.MeadowSchemaFilePrefix+pSchemaName+'.json';
-			if (_DALCache.hasOwnProperty(pSchemaName))
-			{
-				return _DALCache[pSchemaName];
-			}
-			else
-			{
-				try
-				{
-					// TODO: These need to be cached so we aren't loading them every request.  Maybe?
-					return libMeadow.loadFromPackage(tmpSchemaJSONPath);
-				}
-				catch(pError)
-				{
-					_Fable.log.error('Schema Load Error: '+pError, {Schema:pSchemaName});
-					return false;
-				}
-			}
-		};
-
-		/**
-		 * Get the Meadow Endpoints for a particular DAL.
-		 *
-		 * @method getMeadowEndpoints
-		 * @param {Object} pDAL A Meadow DAL (or a string for a DAL to load)
-		 */
-		var getMeadowEndpoints = function(pDAL, pOrator)
-		{
-			var tmpDAL = pDAL;
-			if (typeof(tmpDAL) === 'string')
-			{
-				// Automatically try to load the DAL if a string was passed in
-				tmpDAL = getDAL(pDAL);
-			}
-
-			if (typeof(tmpDAL) !== 'object')
-			{
-				_Fable.log.error('Meadow Endpoint Load Error: DAL was not a valid object', {DAL: pDAL});
-				return false;
-			}
-
-			try
-			{
-				var tmpEndPoints = libMeadowEndpoints.new(tmpDAL);
-
-				if ((typeof(pOrator) === 'object') && pOrator.hasOwnProperty('webServer'))
-				{
-					// Automatically connect the routes, since orator was passed in
-					tmpEndPoints.connectRoutes(pOrator.webServer);
-				}
-
-				return tmpEndPoints;
-			}
-			catch(pError)
-			{
-				_Fable.log.error('Schema Load Error: '+pError, {Schema:pSchema});
-				return false;
-			}
-		};
-
-
-		/**
-		 * Create a record.
-		 *
-		 * A one-line create:
-		 *    _CommonServices.doDALCreate({SchemaName:'ObservationTag', IDUser:15, Record:{Tag:'Accident',TagType:'User',IDCustomer:1}}, function(){});
-		 */
-		var doDALCreate = function(pBundle, fCallBack)
-		{
-			// pBundle has: SchemaName, Record, IDUser
-			// TODO: Validate pBundle
-			var tmpDAL = getDAL(pBundle.SchemaName)
-							.setIDUser(pBundle.IDUser);
-			tmpDAL.doCreate(tmpDAL.query.addRecord(pBundle.Record), fCallBack);
-		};
-
-		/**
-		 * Read a record.
-		 *
-		 * A one-line read (do something with pRecord eh):
-		 *    _CommonServices.doDALRead({SchemaName:'ObservationTag', IDRecord:3, IDUser:15}, function(pError, pQuery, pRecord){});
-		 */
-		var doDALRead = function(pBundle, fCallBack)
-		{
-			// pBundle has: SchemaName, IDRecord
-			// TODO: Validate pBundle
-			var tmpDAL = getDAL(pBundle.SchemaName);
-
-			var tmpQuery = tmpDAL.query;
-
-			var tmpFilterString = (typeof(pBundle.Filter) === 'string') ? pBundle.Filter : null;
-			if (tmpFilterString !== null)
-			{
-				// Lazily create an endpoint object with an empty DAL to use for parseFilter
-				if (!_MeadowEndpointCache)
-				{
-					_MeadowEndpointCache = libMeadowEndpoints.new(libMeadow);
-				}
-				// Parse the filter
-				_MeadowEndpointCache.parseFilter(tmpFilterString, tmpQuery);
-			}
-			else
-			{
-				// Expect an IDRecord otherwise.
-				tmpQuery.addFilter(tmpDAL.defaultIdentifier, pBundle.IDRecord);
-			}
-
-			tmpDAL.doRead(tmpQuery, fCallBack);
-		};
-
-		/**
-		 * Read multiple records.
-		 *
-		 * A one-line read (do something with pRecords eh):
-		 *    		 _CommonServices.doDALReads({SchemaName:'ObservationTag', Cap:25, Begin:0, Filter:''}, function(pError, pQuery, pRecords){});
-		 */
-		var doDALReads = function(pBundle, fCallBack)
-		{
-			// pBundle has: SchemaName, Cap, Begin, FilterString
-			// TODO: Validate pBundle
-			var tmpDAL = getDAL(pBundle.SchemaName);
-
-			var tmpQuery = tmpDAL.query;
-
-			if (0 === pBundle.Cap % (!isNaN(parseFloat(pBundle.Cap)) && 0 <= ~~pBundle.Cap))
-				tmpQuery.setCap(pBundle.Cap);
-
-			if (0 === pBundle.Begin % (!isNaN(parseFloat(pBundle.Begin)) && 0 <= ~~pBundle.Begin))
-				tmpQuery.setBegin(pBundle.Begin);
-
-			var tmpFilterString = (typeof(pBundle.Filter) === 'string') ? pBundle.Filter : null;
-			if (tmpFilterString !== null)
-			{
-				// Lazily create an endpoint object with an empty DAL to use for parseFilter
-				if (!_MeadowEndpointCache)
-				{
-					_MeadowEndpointCache = libMeadowEndpoints.new(libMeadow);
-				}
-				// Parse the filter
-				_MeadowEndpointCache.parseFilter(tmpFilterString, tmpQuery);
-			}
-
-			tmpDAL.doReads(tmpQuery, fCallBack);
-		};
-
-		/**
-		 * Update a record.
-		 *
-		 * A one-line Update (pRecord will have the updated record in it):
-		 *    		 _CommonServices.doDALUpdate({SchemaName:'ObservationTag', IDUser:15, Record:{IDObservationTag:2,Tag:'ABC Contracting'}}, function(pError, pQuery, pReadQuery, pRecord){});
-		 */
-		var doDALUpdate = function(pBundle, fCallBack)
-		{
-			// pBundle has: SchemaName, IDUser, Record
-			// TODO: Validate pBundle
-			var tmpDAL = getDAL(pBundle.SchemaName)
-							.setIDUser(pBundle.IDUser);
-
-			var tmpQuery = tmpDAL.query
-							.addRecord(pBundle.Record);
-
-			tmpDAL.doUpdate(tmpQuery, fCallBack);
-		};
-
-		/**
-		 * Delete a record.
-		 *
-		 * A one-line Delete (pRecord will have the updated record in it):
-		 *    		 _CommonServices.doDALDelete({SchemaName:'ObservationTag', IDUser:15, IDRecord:2}, function(pError, pQuery, pCount){});
-		 */
-		var doDALDelete = function(pBundle, fCallBack)
-		{
-			// pBundle has: SchemaName, IDUser, Record
-			// TODO: Validate pBundle
-			var tmpDAL = getDAL(pBundle.SchemaName)
-							.setIDUser(pBundle.IDUser);
-			var tmpQuery = tmpDAL.query.addFilter(tmpDAL.defaultIdentifier, pBundle.IDRecord);
-			tmpDAL.doDelete(tmpQuery, fCallBack);
-		};
-
-		/**
-		 * Count records
-		 *
-		 * A one-line count (do something with pRecords eh):
-		 *    		 _CommonServices.doDALCount({SchemaName:'ObservationTag', Filter:''}, function(pError, pQuery, pCount){});
-		 */
-		var doDALCount = function(pBundle, fCallBack)
-		{
-			// pBundle has: SchemaName, Cap, Begin, FilterString
-			// TODO: Validate pBundle
-			var tmpDAL = getDAL(pBundle.SchemaName);
-
-			var tmpQuery = tmpDAL.query;
-
-			var tmpFilterString = (typeof(pBundle.Filter) === 'string') ? pBundle.Filter : null;
-			if (tmpFilterString !== null)
-			{
-				// Lazily create an endpoint object with an empty DAL to use for parseFilter
-				if (!_MeadowEndpointCache)
-				{
-					_MeadowEndpointCache = libMeadowEndpoints.new(libMeadow);
-				}
-				// Parse the filter
-				_MeadowEndpointCache.parseFilter(tmpFilterString, tmpQuery);
-			}
-
-			tmpDAL.doCount(tmpQuery, fCallBack);
-		};
-
-		var oMeadowMacros = (
-		{
-
-			getDAL: getDAL,
-			getMeadowEndpoints: getMeadowEndpoints,
-
-			doDALCreate: doDALCreate,
-			doDALRead: doDALRead,
-			doDALReads: doDALReads,
-			doDALUpdate: doDALUpdate,
-			doDALDelete: doDALDelete,
-			doDALCount: doDALCount
-		});
-
-		return oMeadowMacros;
-	}
-
-	return createNew();
-};
-
-module.exports = new MeadowMacros();

package/source/Retold.js

@@ -1,48 +0,0 @@
-// ##### Part of the **[retold](https://stevenvelozo.github.io/retold/)** system
-/**
-* @license MIT
-* @author <steven@velozo.com>
-*/
-
-/**
-* Retold Common Services Library
-*
-* @class Retold
-*/
-var Retold = function()
-{
-	function createNew(pFable)
-	{
-		// If a valid Fable object isn't passed in, return a constructor
-		if (typeof(pFable) !== 'object')
-		{
-			return {new: createNew};
-		}
-		var _Fable = pFable;
-
-		// Setup the Meadow macro functions
-		var _MeadowMacros = require('./Retold-Meadow-Macros.js').new(_Fable);
-
-		var oRetold = (
-		{
-			new: createNew
-		});
-
-		/**
-		 * Meadow Macros
-		 *
-		 * @property DALMacros
-		 */
-		Object.defineProperty(oRetold, 'DALMacros',
-			{
-				get: function() { return _MeadowMacros; },
-				enumerable: false
-			});
-
-		return oRetold;
-	}
-
-	return createNew();
-};
-
-module.exports = new Retold();