qtools-library-dot-d 1.0.2 → 1.0.4

package/README.md

@@ -26,6 +26,31 @@ expressJS endpoitns.
 
 the dotD object contains three parameters, add....
 
+ASYNCHRONOUS CODE SAMPLE
 
+const promptObjects = require('qtools-library-dot-d')({
+	libraryName: 'promptObjects',
+}, callback);
+promptObjects.setLibraryPath(path.join(__dirname, 'prompts.d'), callback);
 
+const passThroughParameters = {};
+promptObjects.loadModules({ passThroughParameters }, callback);
+promptObjects.seal(); //make the library immutable
 
+
+
+NEW SYNCHROMOUS CODE SAMPLE:
+
+const promptObjects = require('qtools-library-dot-d')({
+	libraryName: 'promptObjects',
+});
+promptObjects.setLibraryPath(path.join(__dirname, 'prompts.d'));
+
+const passThroughParameters = {};
+promptObjects.loadModules({ passThroughParameters });
+promptObjects.seal(); //make the library immutable
+
+
+HISTORY
+
+v1.04 - Now tolerates (and reports) directories and files that are not modules.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qtools-library-dot-d",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Scan a directory for JS modules that can execute and addMe() that attaches it to some form of name/value list, eg, a Map() with functions as values or an xPressJS route/endpoint list.",
   "main": "qtools-library-dot-d.js",
   "scripts": {

package/qtools-library-dot-d.js

@@ -10,213 +10,218 @@ const path = require('path');
 const fs = require('fs');
 
 //START OF moduleFunction() ============================================================
-const moduleFunction = ({ moduleName } = {}) => ({ libraryName }) => {
-	// ======================================================================================
-	// SETTERS
+const moduleFunction =
+	({ moduleName } = {}) =>
+	({ libraryName }) => {
+		// ======================================================================================
+		// SETTERS
 
-	// --------------------------------------------------------------------------------
-	// SET LIBRARY PATH
-
-	let libraryPath;
-
-	const setLibraryPath = (dirPath, callback) => {
-		try {
-			libraryPath = fs.realpathSync(dirPath);
-		} catch (err) {
-			callback(err.toString());
-			return;
-		}
+		// --------------------------------------------------------------------------------
+		// SET LIBRARY PATH
+
+		let libraryPath;
+
+		const setLibraryPath = (dirPath, callback) => {
+			try {
+				libraryPath = fs.realpathSync(dirPath);
+			} catch (err) {
+				callback(err.toString());
+				return;
+			}
+
+			if (typeof callback == 'function') {
+				callback('', libraryPath);
+			} else {
+				return libraryPath;
+			}
+		};
 
-		callback('', libraryPath);
-	};
+		// --------------------------------------------------------------------------------
+		// SET CUSTOM MODULE ADDING FUNCTION
+
+		const defaultAdd = (item, callback) => {
+			let error;
+			try {
+				require(item.endpointPath)(item.moduleArgs); //calls module with dotD object, including library.add()
+			} catch (err) {
+				item.exceptionList.push(
+					`${path.basename(item.endpointPath)}: ${err.toString().split('\n').qtFirst('n/a')}`,
+				);
+			}
+
+			if (typeof callback == 'function') {
+				callback(error);
+			} else {
+				return;
+			}
+		};
 
-	// --------------------------------------------------------------------------------
-	// SET CUSTOM MODULE ADDING FUNCTION
+		let add = defaultAdd;
 
-	const defaultAdd = (item, callback) => {
-		require(item.endpointPath)(item.moduleArgs);
-		callback();
-	};
+		const setCustomAddFunction = (newFunction) => (add = newFunction);
 
-	let add = defaultAdd;
+		// ======================================================================================
+		// LOG LIST OBJECT
 
-	const setCustomAddFunction = newFunction => (add = newFunction);
-
-	// ======================================================================================
-	// LOG LIST OBJECT
+		const logList = (() => {
+			const list = [];
+			const push = (item) => list.push(item);
+			const formatList = () => {
+				return list
+					.reduce(
+						(result, item) => `${result}${item}\n\t`,
+						`\n${libraryName} Log\n\t`,
+					)
+					.replace(/\n\t$/, '');
+			};
+			return { push, formatList };
+		})();
+
+		// ======================================================================================
+		// LIBRARY OBJECT
+
+		const libraryObject = {}; //used only for producing display listings
+		const exceptionList = [];
+		const library = (() => {
+			const add = (name, item) => {
+				libraryObject[name] = item; //used only for producing display listings
+				externalElements[name] = item;
+			};
+			return { add };
+		})();
+
+		// ======================================================================================
+		// LIBRARY OBJECT
+
+		const toString = () => {
+			const formatProperty = (item) => {
+				let outString = typeof item;
+				if (typeof item == 'function') {
+					const result = item.toString().match(/\((?<args>.*?\))/);
+					outString = `(${result.qtGetSurePath('groups.args', 'function')})`;
+				}
+				return outString;
+			};
 
-	const logList = (() => {
-		const list = [];
-		const push = item => list.push(item);
-		const formatList = () => {
-			return list
+			const libString = Object.keys(libraryObject)
 				.reduce(
-					(result, item) => `${result}${item}\n\t`,
-					`\n${libraryName} Log\n\t`
+					(result, name) =>
+						`${result}${name}: ${
+							(typeof libraryObject[name]).match(/(string|number)/i)
+								? libraryObject[name]
+								: formatProperty(libraryObject[name])
+						}\n\t`,
+					`\n${libraryName} Library\n\t`,
 				)
 				.replace(/\n\t$/, '');
-		};
-		return { push, formatList };
-	})();
 
-	// ======================================================================================
-	// LIBRARY OBJECT
+			const exceptionString = '\n\t' + exceptionList.join('\n\t');
 
-	const libraryObject = {}; //used only for producing display listings
-	const library = (() => {
-		const add = (name, item) => {
-			libraryObject[name] = item; //used only for producing display listings
-			externalElements[name] = item;
+			return `${libString}${exceptionString}`;
 		};
-		return { add };
-	})();
-
-	// ======================================================================================
-	// LIBRARY OBJECT
-
-	const toString = () => {
-	
-	const formatProperty=item=>{
-		let outString=typeof(item);
-	 if (typeof(item)=='function'){
-	 	const result=item.toString().match(/\((?<args>.*?\))/);
-	 	outString=`(${result.qtGetSurePath('groups.args', 'function')})`
-
-	 }
-	return outString;
-	}
-	
-		return Object.keys(libraryObject)
-			.reduce(
-				(result, name) =>
-					`${result}${name}: ${
-						(typeof libraryObject[name]).match(/(string|number)/i)
-							? libraryObject[name]
-							: formatProperty(libraryObject[name])
-					}\n\t`,
-				`\n${libraryName} Library\n\t`
-			)
-			.replace(/\n\t$/, '');
-	};
-
-	// ======================================================================================
-	// SEAL OBJECT (make immutable)
-
-	const sealActual = externalElements => () => {
-		Object.assign(
-			externalElements.library.qtSelectProperties(['add'], {
-				excludeMode: true
-			})
-		);
-		Object.assign(
-			externalElements.logList.qtSelectProperties(['push'], {
-				excludeMode: true
-			})
-		);
-
-		Object.assign(
-			externalElements.qtSelectProperties(
-				[
-					'setLibraryPath',
-					'loadModules',
-					'seal',
-					'setCustomAddFunction',
-					'library',
-					'logList'
-				],
-				{ excludeMode: true }
-			)
-		);
-		Object.freeze(externalElements);
-		Object.seal(externalElements);
-	};
-
-	// ======================================================================================
-	// LOAD MODULES (actual execution)
 
-	const loadModules = ({ passThroughParameters }, callback) => {
-		const asynchronousPipePlus = new require('qtools-asynchronous-pipe-plus')();
-		const pipeRunner = asynchronousPipePlus.pipeRunner;
-		const taskListPlus = asynchronousPipePlus.taskListPlus;
+		// ======================================================================================
+		// SEAL OBJECT (make immutable)
+
+		const sealActual = (externalElements) => () => {
+			Object.assign(
+				externalElements.library.qtSelectProperties(['add'], {
+					excludeMode: true,
+				}),
+			);
+			Object.assign(
+				externalElements.logList.qtSelectProperties(['push'], {
+					excludeMode: true,
+				}),
+			);
+
+			Object.assign(
+				externalElements.qtSelectProperties(
+					[
+						'setLibraryPath',
+						'loadModules',
+						'seal',
+						'setCustomAddFunction',
+						'library',
+						'logList',
+					],
+					{ excludeMode: true },
+				),
+			);
+			Object.freeze(externalElements);
+			Object.seal(externalElements);
+		};
 
-		const taskList = new taskListPlus();
+		// ======================================================================================
+		// LOAD MODULES (actual execution)
 
-		// --------------------------------------------------------------------------------
-		// INTERNAL UTILITIES
+		const loadModules = ({ passThroughParameters }, callback) => {
+			const asynchronousPipePlus = new require(
+				'qtools-asynchronous-pipe-plus',
+			)();
+			const pipeRunner = asynchronousPipePlus.pipeRunner;
+			const taskListPlus = asynchronousPipePlus.taskListPlus;
 
-		const mergeArgs = (args, next, propertyName) => (err, result) =>
-			next(err, {
-				...args,
-				...(propertyName ? { [propertyName]: result } : result)
-			});
+			const taskList = new taskListPlus();
 
-		const forwardArgs = ({ next, args }) => err => next(err, args);
+			// --------------------------------------------------------------------------------
+			// INTERNAL UTILITIES
 
-		// --------------------------------------------------------------------------------
-		// INITIALIZE COMMON ADDED MODULE PARAMETERS
+			const mergeArgs = (args, next, propertyName) => (err, result) =>
+				next(err, {
+					...args,
+					...(propertyName ? { [propertyName]: result } : result),
+				});
 
-		const dotD = { logList, library };
+			const forwardArgs =
+				({ next, args }) =>
+				(err) =>
+					next(err, args);
 
-		const moduleArgs = {
-			dotD,
-			passThroughParameters
-		};
+			// --------------------------------------------------------------------------------
+			// INITIALIZE COMMON ADDED MODULE PARAMETERS
 
-		// --------------------------------------------------------------------------------
-		// BUILD TASKLIST
+			const dotD = { logList, library };
 
-		taskList.push((args, next) => {
-			const { libraryPath, passThroughParameters } = args;
-
-			const localCallback = (err, result) => {
-				next(err, { ...args, result });
+			const moduleArgs = {
+				dotD,
+				passThroughParameters,
 			};
 
-			fs
-				.readdirSync(libraryPath)
+			fs.readdirSync(libraryPath)
 				//.filter(file => path.extname(file) === '.js')
-				.forEach(file => {
-					// --------------------------------------------------------------------------------
-					// TASKLIST ITEM TEMPLATE
-					taskList.push((args, next) => {
-						const { libraryPath, passThroughParameters } = args;
-
-						const endpointPath = path.join(libraryPath, file);
-						add(
-							{
-								endpointPath,
-								moduleArgs
-							},
-							forwardArgs({ next, args })
-						);
+				.forEach((file) => {
+					const endpointPath = path.join(libraryPath, file);
+
+					add({
+						endpointPath,
+						moduleArgs,
+						exceptionList,
 					});
 				});
-			localCallback('', args);
-		});
-
-		// --------------------------------------------------------------------------------
-		// INIT AND EXECUTE THE PIPELINE
 
-		const initialData = { libraryPath, passThroughParameters };
-		pipeRunner(taskList.getList(), initialData, (err, args) => {
-			const { libraryDotD } = args;
+			// --------------------------------------------------------------------------------
+			// INIT AND EXECUTE THE PIPELINE
 
-			callback(err);
-		});
-	};
+			if (typeof callback == 'function') {
+				callback();
+			} else {
+				return;
+			}
+		};
 
-	const externalElements = {
-		setLibraryPath,
-		setCustomAddFunction,
-		logList,
-		library,
-		loadModules,
-		toString,
-		qtdProcessLog: logList.formatList
+		const externalElements = {
+			setLibraryPath,
+			setCustomAddFunction,
+			logList,
+			library,
+			loadModules,
+			toString,
+			qtdProcessLog: logList.formatList,
+		};
+		externalElements.seal = sealActual(externalElements);
+		return externalElements;
 	};
-	externalElements.seal = sealActual(externalElements);
-	return externalElements;
-};
 
 //END OF moduleFunction() ============================================================