meadow 1.1.2 → 2.0.2

package/gulpfile.js

@@ -0,0 +1,83 @@
+'use strict';
+
+// We aren't abstracting this yet but here's the ... "Config"
+const _CONFIG = (
+	{
+		// The input source file that should be passed to browserify:
+		// (if you need to auto-instantiate an object, for instance)
+		EntrypointInputSourceFile: `${__dirname}/source/Meadow-Browser-Shim.js`,
+
+		// The name of the packaged object to be passed to browserify:
+		// (browserify sets this to global scope and window.SOMEOBJECTNAMEHERE where SOMEOBJECTNAMEHERE is the string below)
+		LibraryObjectName: `Meadow`,
+
+		// The folder to write the library files and maps out to:
+		LibraryOutputFolder: `${__dirname}/dist/`,
+
+		// The name of the unminified version of the packaged library, for easy debugging:
+		LibraryUniminifiedFileName: `meadow.js`,
+
+		// The name of the minified version of the packaged library, for production release:
+		LibraryMinifiedFileName: `meadow.min.js`
+	});
+
+// --->  Boilerplate Browser Uglification and Packaging  <--- \\
+
+const libBrowserify = require('browserify');
+const libGulp = require('gulp');
+
+const libVinylSourceStream = require('vinyl-source-stream');
+const libVinylBuffer = require('vinyl-buffer');
+
+const libSourcemaps = require('gulp-sourcemaps');
+const libGulpUtil = require('gulp-util');
+const libBabel = require('gulp-babel');
+const libTerser = require('gulp-terser');
+
+// Build the module for the browser
+libGulp.task('minified',
+() => {
+	// set up the custom browserify instance for this task
+	var tmpBrowserify = libBrowserify(
+	{
+		entries: _CONFIG.EntrypointInputSourceFile,
+		standalone: _CONFIG.LibraryObjectName,
+		debug: true
+	});
+
+	return tmpBrowserify.bundle()
+		.pipe(libVinylSourceStream(_CONFIG.LibraryMinifiedFileName))
+		.pipe(libVinylBuffer())
+		.pipe(libSourcemaps.init({loadMaps: true}))
+				// Add transformation tasks to the pipeline here.
+				.pipe(libBabel())
+				.pipe(libTerser())
+				.on('error', libGulpUtil.log)
+		.pipe(libSourcemaps.write('./'))
+		.pipe(libGulp.dest(_CONFIG.LibraryOutputFolder));
+});
+
+// Build the module for the browser
+libGulp.task('debug',
+	() => {
+		// set up the custom browserify instance for this task
+		var tmpBrowserify = libBrowserify(
+		{
+			entries: _CONFIG.EntrypointInputSourceFile,
+			standalone: _CONFIG.LibraryObjectName,
+			debug: true
+		});
+
+		return tmpBrowserify.bundle()
+			.pipe(libVinylSourceStream(_CONFIG.LibraryUniminifiedFileName))
+			.pipe(libVinylBuffer())
+					.pipe(libBabel())
+					.on('error', libGulpUtil.log)
+			.pipe(libGulp.dest(_CONFIG.LibraryOutputFolder));
+	});
+
+libGulp.task
+(
+	'build',
+	libGulp.series('debug', 'minified')
+);

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "meadow",
-  "version": "1.1.2",
+  "version": "2.0.2",
   "description": "A data access library.",
   "main": "source/Meadow.js",
   "scripts": {
     "start": "node source/Meadow.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",
-    "tests": "./node_modules/mocha/bin/_mocha -u tdd -R spec --grep",
-    "docker-dev-build-image": "docker build ./ -t retold/meadow:local",
-    "docker-dev-run": "docker run -it -d --name meadow-dev -p 127.0.0.1:12342:8080 -p 12302:3306 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/meadow\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold/meadow:local"
+    "coverage": "./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -u tdd --exit -R spec",
+    "test": "./node_modules/mocha/bin/_mocha -u tdd --exit -R spec",
+    "tests": "./node_modules/mocha/bin/_mocha -u tdd --exit -R spec --grep",
+    "build": "./node_modules/.bin/gulp build --full-paths",
+    "docker-dev-build-image": "docker build ./ -f Dockerfile_LUXURYCode -t retold/meadow:local",
+    "docker-dev-run": "docker run -it -d --name meadow-dev -p 127.0.0.1:12342:8080 -p 12106:3306 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/meadow\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold/meadow:local"
   },
   "mocha": {
     "diff": true,
@@ -44,18 +45,24 @@
   },
   "homepage": "https://github.com/stevenvelozo/meadow",
   "devDependencies": {
-    "chai": "4.3.6",
-    "istanbul": "0.4.1",
-    "mocha": "9.2.2",
-    "alasql": "^0.4.0",
-    "mysql2": "1.2.0"
+    "alasql": "^3.1.0",
+    "browserify": "^17.0.0",
+    "chai": "4.3.7",
+    "gulp": "^4.0.2",
+    "gulp-babel": "^8.0.0",
+    "gulp-sourcemaps": "^3.0.0",
+    "gulp-terser": "^2.1.0",
+    "fable": "^3.0.11",
+    "gulp-util": "^3.0.8",
+    "mocha": "10.2.0",
+    "nyc": "^15.1.0",
+    "vinyl-buffer": "^1.0.1",
+    "vinyl-source-stream": "^2.0.0",
+    "mysql2": "^3.1.2"
   },
   "dependencies": {
-    "async": "2.4.0",
-    "fable": "~1.0.1",
-    "foxhound": "~1.0.36",
-    "is-my-json-valid": "2.16.0",
-    "simple-get": "^4.0.1",
-    "underscore": "^1.8.3"
+    "async": "3.2.4",
+    "foxhound": "^2.0.2",
+    "is-my-json-valid": "2.20.6"
   }
 }

package/source/Meadow-Browser-Shim.js

@@ -0,0 +1,14 @@
+/**
+* Simple browser shim loader - assign the npm module to a window global automatically
+*
+* @license MIT
+* @author <steven@velozo.com>
+*/
+var libNPMModuleWrapper = require('./Meadow.js');
+
+if ((typeof(window) === 'object') && !window.hasOwnProperty('Meadow'))
+{
+	window.Meadow = libNPMModuleWrapper;
+}
+
+module.exports = libNPMModuleWrapper;

package/source/Meadow-Package.json

@@ -2,7 +2,7 @@
 	"Scope": "Package",
 
 	"DefaultIdentifier": "IDPackage",
-	
+
 	"Domain": "Domain",
 
 	"Schema": [],

package/source/Meadow.js

@@ -3,7 +3,6 @@
 * @license MIT
 * @author <steven@velozo.com>
 */
-var libUnderscore = require('underscore');
 var libFoxHound = require('foxhound');
 
 /**
@@ -43,6 +42,7 @@ var Meadow = function()
 		var _ReadsBehavior = require('./behaviors/Meadow-Reads.js');
 		var _UpdateBehavior = require('./behaviors/Meadow-Update.js');
 		var _DeleteBehavior = require('./behaviors/Meadow-Delete.js');
+		var _UndeleteBehavior = require('./behaviors/Meadow-Undelete.js');
 		var _CountBehavior = require('./behaviors/Meadow-Count.js');
 
 		// The data provider
@@ -70,12 +70,12 @@ var Meadow = function()
 		/**
 		 * Load a Meadow Package JSON from file, create a Meadow object from it.
 		 */
-		 var _MeadowPackageObjectLoader = require('./Meadow-PackageObjectLoader.js');
-		 var loadFromPackageObject = function(pPackage)
-		 {
-			 return _MeadowPackageObjectLoader(this, pPackage);
-		 };
- 
+		var _MeadowPackageObjectLoader = require('./Meadow-PackageObjectLoader.js');
+		var loadFromPackageObject = function(pPackage)
+		{
+			return _MeadowPackageObjectLoader(this, pPackage);
+		};
+
 		/**
 		* Pass relevant state into the provider
 		*
@@ -276,6 +276,14 @@ var Meadow = function()
 			return _DeleteBehavior(this, pQuery, fCallBack);
 		};
 
+		/**
+		 * Undelete a record
+		 */
+		var doUndelete = function(pQuery, fCallBack)
+		{
+			return _UndeleteBehavior(this, pQuery, fCallBack);
+		};
+
 		/**
 		 * Count multiple records
 		 */
@@ -321,7 +329,7 @@ var Meadow = function()
 		var marshalRecordFromSourceToObject = function(pRecord)
 		{
 			// Create an object from the default schema object
-			var tmpNewObject = libUnderscore.extend({}, _Schema.defaultObject);
+			var tmpNewObject = _Fable.Utility.extend({}, _Schema.defaultObject);
 			// Now marshal the values from pRecord into tmpNewObject, based on schema
 			_Provider.marshalRecordFromSourceToObject(tmpNewObject, pRecord, _Schema.schema);
 			// This turns on magical validation
@@ -366,6 +374,7 @@ var Meadow = function()
 			doReads: doReads,
 			doUpdate: doUpdate,
 			doDelete: doDelete,
+			doUndelete: doUndelete,
 			doCount: doCount,
 
 			validateObject: _Schema.validateObject,

package/source/behaviors/Meadow-Count.js

@@ -3,7 +3,7 @@
 * @license MIT
 * @author <steven@velozo.com>
 */
-var libAsync = require('async');
+var libAsyncWaterfall = require('async/waterfall');
 
 /**
 * Meadow Behavior - Count multiple records
@@ -15,7 +15,7 @@ var meadowBehaviorCount = function(pMeadow, pQuery, fCallBack)
 	var tmpProfileStart = new Date(); //for profiling query time
 
 	// Count the record(s) from the source
-	libAsync.waterfall(
+	libAsyncWaterfall(
 		[
 			// Step 1: Get the record countfrom the data source
 			function (fStageComplete)

package/source/behaviors/Meadow-Create.js

@@ -3,8 +3,7 @@
 * @license MIT
 * @author <steven@velozo.com>
 */
-var libAsync = require('async');
-var libUnderscore = require('underscore');
+var libAsyncWaterfall = require('async/waterfall');
 
 /**
 * Meadow Behavior - Create
@@ -13,7 +12,7 @@ var libUnderscore = require('underscore');
 */
 var meadowBehaviorCreate = function(pMeadow, pQuery, fCallBack)
 {
-	libAsync.waterfall(
+	libAsyncWaterfall(
 		[
 			// Step 0: If GUID is specified, make sure the record does not already exist
 			function (fStageComplete)
@@ -78,7 +77,7 @@ var meadowBehaviorCreate = function(pMeadow, pQuery, fCallBack)
 				}
 				
 				// Merge in the default record with the passed-in record for completeness
-				pQuery.query.records[0] = libUnderscore.extend({}, pMeadow.schemaFull.defaultObject, pQuery.query.records[0]);
+				pQuery.query.records[0] = pMeadow.fable.Utility.extend({}, pMeadow.schemaFull.defaultObject, pQuery.query.records[0]);
 				// Create override is too complex ... punting for now
 				// if (pMeadow.rawQueries.checkQuery('Create'))
 				//	pQuery.parameters.queryOverride = pMeadow.rawQueries.getQuery('Create');

package/source/behaviors/Meadow-Delete.js

@@ -3,7 +3,7 @@
 * @license MIT
 * @author <steven@velozo.com>
 */
-var libAsync = require('async');
+var libAsyncWaterfall = require('async/waterfall');
 
 /**
 * Meadow Behavior - Delete a single record
@@ -14,7 +14,7 @@ var meadowBehaviorDelete = function(pMeadow, pQuery, fCallBack)
 {
 	// TODO: Check if this recordset has implicit delete tracking, branch in this module.
 	// Delete the record(s) from the source
-	libAsync.waterfall(
+	libAsyncWaterfall(
 		[
 			// Step 1: Delete the record
 			function (fStageComplete)

package/source/behaviors/Meadow-Read.js

@@ -3,7 +3,7 @@
 * @license MIT
 * @author <steven@velozo.com>
 */
-var libAsync = require('async');
+var libAsyncWaterfall = require('async/waterfall');
 
 /**
 * Meadow Behavior - Read a single record
@@ -13,7 +13,7 @@ var libAsync = require('async');
 var meadowBehaviorRead = function(pMeadow, pQuery, fCallBack)
 {
 	// Read the record from the source
-	libAsync.waterfall(
+	libAsyncWaterfall(
 		[
 			// Step 1: Get the record from the data source
 			function (fStageComplete)
@@ -31,7 +31,7 @@ var meadowBehaviorRead = function(pMeadow, pQuery, fCallBack)
 				// Check that a record was returned
 				if (pQuery.parameters.result.value.length < 1)
 				{
-					return fStageComplete(false, pQuery, false);
+					return fStageComplete(undefined, pQuery, false);
 				}
 
 				var tmpRecord = pMeadow.marshalRecordFromSourceToObject(pQuery.result.value[0]);
@@ -39,7 +39,7 @@ var meadowBehaviorRead = function(pMeadow, pQuery, fCallBack)
 				fStageComplete(pQuery.result.error, pQuery, tmpRecord);
 			}
 		],
-		function(pError, pQuery, pRecord)
+		(pError, pQuery, pRecord)=>
 		{
 			if (pError)
 			{

package/source/behaviors/Meadow-Reads.js

@@ -3,7 +3,8 @@
 * @license MIT
 * @author <steven@velozo.com>
 */
-var libAsync = require('async');
+var libAsyncWaterfall = require('async/waterfall');
+var libAsyncEach = require('async/eachSeries');
 
 /**
 * Meadow Behavior - Read multiple records
@@ -15,7 +16,7 @@ var meadowBehaviorReads = function(pMeadow, pQuery, fCallBack)
 	var tmpProfileStart = new Date(); //for profiling query time
 
 	// Read the record(s) from the source
-	libAsync.waterfall(
+	libAsyncWaterfall(
 		[
 			// Step 1: Get the record(s) from the data source
 			function (fStageComplete)
@@ -38,7 +39,7 @@ var meadowBehaviorReads = function(pMeadow, pQuery, fCallBack)
 
 				var tmpRecords = [];
 
-				libAsync.each
+				libAsyncEach
 				(
 					pQuery.parameters.result.value,
 					function(pRow, pQueueCallback)

package/source/behaviors/Meadow-Undelete.js

@@ -0,0 +1,42 @@
+// ##### Part of the **[retold](https://stevenvelozo.github.io/retold/)** system
+/**
+* @license MIT
+* @author <steven@velozo.com>
+*/
+var libAsyncWaterfall = require('async/waterfall');
+
+/**
+* Meadow Behavior - Undelete a single record
+*
+* @function meadowBehaviorUndelete
+*/
+var meadowBehaviorUndelete = function(pMeadow, pQuery, fCallBack)
+{
+	// TODO: Check if this recordset has implicit delete tracking, branch in this module?
+	// Undelete the record(s) if they were deleted with a bit
+	libAsyncWaterfall(
+		[
+			// Step 1: Undelete the record
+			function (fStageComplete)
+			{
+				if (pMeadow.rawQueries.checkQuery('Undelete'))
+				{
+					pQuery.parameters.queryOverride = pMeadow.rawQueries.getQuery('Undelete');
+				}
+				pMeadow.provider.Undelete(pQuery, function(){ fStageComplete(pQuery.result.error, pQuery, pQuery.result.value); });
+			}
+		],
+		function(pError, pQuery, pRecord)
+		{
+			if (pError)
+			{
+				pMeadow.fable.log.warn('Error during the undelete waterfall', {Error:pError, Message: pError.message, Query: pQuery.query});
+			}
+			fCallBack(pError, pQuery, pRecord);
+		}
+	);
+
+	return pMeadow;
+};
+
+module.exports = meadowBehaviorUndelete;

package/source/behaviors/Meadow-Update.js

@@ -3,7 +3,7 @@
 * @license MIT
 * @author <steven@velozo.com>
 */
-var libAsync = require('async');
+var libAsyncWaterfall = require('async/waterfall');
 
 /**
 * Meadow Behavior - Update a single record
@@ -13,7 +13,7 @@ var libAsync = require('async');
 var meadowBehaviorUpdate = function(pMeadow, pQuery, fCallBack)
 {
 	// Update the record(s) from the source
-	libAsync.waterfall(
+	libAsyncWaterfall(
 		[
 			// Step 1: Update the record
 			function (fStageComplete)

package/source/providers/Meadow-Provider-ALASQL.js

@@ -304,6 +304,38 @@ var MeadowProvider = function()
 			fCallback();
 		};
 
+		var Undelete = function(pQuery, fCallback)
+		{
+			var tmpResult = pQuery.parameters.result;
+
+			checkDataExists(pQuery.parameters);
+
+			pQuery.setDialect('ALASQL').buildUndeleteQuery();
+			var fQuery = libALASQL.compile(pQuery.query.body);
+
+			if (pQuery.logLevel > 0 ||
+				_GlobalLogLevel > 0)
+			{
+				_Fable.log.trace(pQuery.query.body, pQuery.query.parameters);
+			}
+
+			try
+			{
+				tmpResult.error = undefined;
+				tmpResult.executed = false;
+
+				tmpResult.value =  fQuery(pQuery.query.parameters);
+
+				tmpResult.executed = true;
+			}
+			catch (pError)
+			{
+				tmpResult.error = pError;
+			}
+
+			fCallback();
+		};
+
 		var Count = function(pQuery, fCallback)
 		{
 			var tmpResult = pQuery.parameters.result;
@@ -463,6 +495,7 @@ var MeadowProvider = function()
 			Read: Read,
 			Update: Update,
 			Delete: Delete,
+			Undelete: Undelete,
 			Count: Count,
 
 			new: createNew

package/source/providers/Meadow-Provider-MeadowEndpoints.js

@@ -4,7 +4,6 @@
 * @author <steven@velozo.com>
 */
 var libSimpleGet = require('simple-get');
-var libUnderscore = require('underscore');
 
 var MeadowProvider = function()
 {
@@ -50,12 +49,12 @@ var MeadowProvider = function()
 			let tmpRequestOptions = (
 			{
 				url: tmpURL,
-				headers: libUnderscore.extend({cookie: ''}, _Headers)
+				headers: _Fable.Utility.extend({cookie: ''}, _Headers)
 			});
-	
+
 			tmpRequestOptions.headers.cookie = _Cookies.join(';');
 
-				
+
 			if (pQuery.logLevel > 0 ||
 				_GlobalLogLevel > 0)
 				_Fable.log.debug(`Request options built...`,tmpRequestOptions);

package/source/providers/Meadow-Provider-MySQL.js

@@ -189,6 +189,45 @@ var MeadowProvider = function()
 			});
 		};
 
+		var Undelete = function(pQuery, fCallback)
+		{
+			var tmpResult = pQuery.parameters.result;
+
+			pQuery.setDialect('MySQL').buildUndeleteQuery();
+
+			if (pQuery.logLevel > 0 ||
+				_GlobalLogLevel > 0)
+			{
+				_Fable.log.trace(pQuery.query.body, pQuery.query.parameters);
+			}
+
+			getSQLPool().getConnection(function(pError, pDBConnection)
+			{
+				pDBConnection.query
+				(
+					pQuery.query.body,
+					pQuery.query.parameters,
+					// The MySQL library also returns the Fields as the third parameter
+					function(pError, pRows)
+					{
+						pDBConnection.release();
+						tmpResult.error = pError;
+						tmpResult.value = false;
+						try
+						{
+							tmpResult.value = pRows.affectedRows;
+						}
+						catch(pErrorGettingRowcount)
+						{
+							_Fable.log.warn('Error getting affected rowcount during delete query',{Body:pQuery.query.body, Parameters:pQuery.query.parameters});
+						}
+						tmpResult.executed = true;
+						return fCallback();
+					}
+				);
+			});
+		};
+
 		var Count = function(pQuery, fCallback)
 		{
 			var tmpResult = pQuery.parameters.result;
@@ -235,6 +274,7 @@ var MeadowProvider = function()
 			Read: Read,
 			Update: Update,
 			Delete: Delete,
+			Undelete: Undelete,
 			Count: Count,
 
 			new: createNew

package/source/providers/Meadow-Provider-None.js

@@ -52,6 +52,13 @@ var MeadowProvider = function()
 			fCallback();
 		};
 
+		var Undelete = function(pQuery, fCallback)
+		{
+			// This does nothing because it's the none data provider!
+			pQuery.parameters.result.executed = true;
+			fCallback();
+		};
+
 		var Count = function(pQuery, fCallback)
 		{
 			// This does nothing because it's the none data provider!
@@ -67,6 +74,7 @@ var MeadowProvider = function()
 			Read: Read,
 			Update: Update,
 			Delete: Delete,
+			Undelete: Undelete,
 			Count: Count,
 
 			new: createNew

package/test/Meadow-Provider-ALASQL.js

@@ -12,20 +12,20 @@ var Chai = require("chai");
 var Expect = Chai.expect;
 var Assert = Chai.assert;
 
-var libAsync = require('async');
 var libALASQL = require('alasql');
 
-var libFable = require('fable').new({
+var libFable = new (require('fable'))({
 	LogStreams:
 	[
-	    {
-	        level: 'fatal',
-	        streamtype:'process.stdout',
-	    },
-	    {
-	        level: 'trace',
-	        path: __dirname+'/../tests.log'
-	    }
+		{
+			level: 'fatal',
+			streamtype:'process.stdout',
+		},
+		{
+			streamtype: 'simpleflatfile',
+			level: 'trace',
+			path: __dirname+'/../tests.log'
+		}
 	]
 });
 
@@ -291,6 +291,30 @@ suite
 					}
 				);
 				test
+				(
+					'Undelete a record in the database',
+					function(fDone)
+					{
+						var testMeadow = newMeadow();
+
+						testMeadow.fable.settings.QueryThresholdWarnTime = 1;
+						var tmpQuery = testMeadow.query.addFilter('IDAnimal',3);
+
+						testMeadow.doUndelete(tmpQuery,
+							function(pError, pQuery, pRecord)
+							{
+								// TODO: Research why this is working but not returning the row count
+								Expect(pRecord)
+									.to.equal(1);
+
+								testMeadow.fable.settings.QueryThresholdWarnTime = 1000;
+
+								fDone();
+							}
+						)
+					}
+				);
+				test
 				(
 					'Count all records from the database',
 					function(fDone)
@@ -303,9 +327,9 @@ suite
 						testMeadow.doCount(testMeadow.query,
 							function(pError, pQuery, pRecord)
 							{
-								// There should be 5 records
+								// There should be 6 records
 								Expect(pRecord)
-									.to.equal(5);
+									.to.equal(6);
 								Expect(pQuery.parameters.result.executed)
 									.to.equal(true);
 								testMeadow.fable.settings.QueryThresholdWarnTime = 1000;
@@ -518,9 +542,9 @@ suite
 						testMeadow.doCount(testMeadow.query.setLogLevel(5),
 							function(pError, pQuery, pRecord)
 							{
-								// There should be 6 records
+								// There should be 7 records .. we undeleted one!
 								Expect(pRecord)
-									.to.equal(6);
+									.to.equal(7);
 								fDone();
 							}
 						)