qtools-library-dot-d 1.0.7 → 1.0.9

package/libDotD_Working_Example/node_modules/qtools-library-dot-d/qtools-library-dot-d.js

@@ -0,0 +1,239 @@
+#!/usr/bin/env node
+'use strict';
+
+const moduleName = __filename.replace(__dirname + '/', '').replace(/.js$/, ''); //this just seems to come in handy a lot
+
+// const qt = require('qtools-functional-library'); //also exposes qtLog(); qt.help({printOutput:true, queryString:'.*', sendJson:false});
+
+const os = require('os');
+const path = require('path');
+const fs = require('fs');
+
+const qt = require('qtools-functional-library');
+
+//START OF moduleFunction() ============================================================
+const moduleFunction =
+	({ moduleName } = {}) =>
+	({ libraryName='libraryDotD' }) => {
+		// ======================================================================================
+		// SETTERS
+
+		// --------------------------------------------------------------------------------
+		// 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;
+			}
+		};
+
+		// --------------------------------------------------------------------------------
+		// 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;
+			}
+		};
+
+		let add = defaultAdd;
+
+		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>.*?\))/);
+					const args = result.qtGetSurePath('groups.args', 'function');
+					outString = `(${args == ')' ? args + ' # function takes no arguments' : args}`;
+				}
+				return outString;
+			};
+
+			const libString = 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 Elements\n\t`,
+				)
+				.replace(/\n\t$/, '');
+
+			const exceptionString = '\n\t' + exceptionList.join('\n\t');
+
+			return `${libString}${exceptionString}`;
+		};
+
+		// ======================================================================================
+		// 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;
+
+			const taskList = new taskListPlus();
+
+			// --------------------------------------------------------------------------------
+			// INTERNAL UTILITIES
+
+			const mergeArgs = (args, next, propertyName) => (err, result) =>
+				next(err, {
+					...args,
+					...(propertyName ? { [propertyName]: result } : result),
+				});
+
+			const forwardArgs =
+				({ next, args }) =>
+				(err) =>
+					next(err, args);
+
+			// --------------------------------------------------------------------------------
+			// INITIALIZE COMMON ADDED MODULE PARAMETERS
+
+			const dotD = { logList, library };
+
+			const moduleArgs = {
+				dotD,
+				passThroughParameters,
+			};
+
+			fs.readdirSync(libraryPath)
+				//.filter(file => path.extname(file) === '.js')
+				.forEach((file) => {
+					const endpointPath = path.join(libraryPath, file);
+
+					add({
+						endpointPath,
+						moduleArgs,
+						exceptionList,
+					});
+				});
+
+			// --------------------------------------------------------------------------------
+			// INIT AND EXECUTE THE PIPELINE
+
+			if (typeof callback == 'function') {
+				if (exceptionList.length) {
+					callback(exceptionList);
+				} else {
+					callback();
+				}
+			} else {
+				if (exceptionList.length) {
+					return exceptionList;
+				} else {
+					return;
+				}}
+		};
+
+		const externalElements = {
+			setLibraryPath,
+			setCustomAddFunction,
+			logList,
+			library,
+			loadModules,
+			toString,
+			qtdProcessLog: logList.formatList,
+		};
+		externalElements.seal = sealActual(externalElements);
+		return externalElements;
+	};
+
+//END OF moduleFunction() ============================================================
+
+module.exports = moduleFunction({ moduleName });
+

package/libDotD_Working_Example/package-lock.json

@@ -0,0 +1,37 @@
+{
+  "name": "libdotd_example",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "libdotd_example",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "qtools-library-dot-d": "^1.0.5"
+      }
+    },
+    "node_modules/qtools-asynchronous-pipe-plus": {
+      "version": "1.0.5",
+      "resolved": "https://registry.npmjs.org/qtools-asynchronous-pipe-plus/-/qtools-asynchronous-pipe-plus-1.0.5.tgz",
+      "integrity": "sha512-ejueK++dNl6AJL0OK14zTewXDg1+Wq8zFknI83THmgR9rNTB7EfngLt031/hkkc3/VpnqdaeO7mNqnu6YAzgIQ=="
+    },
+    "node_modules/qtools-functional-library": {
+      "version": "2.0.4",
+      "resolved": "https://registry.npmjs.org/qtools-functional-library/-/qtools-functional-library-2.0.4.tgz",
+      "integrity": "sha512-noztSkJI37xcOTer5HVgOnuY/eZ1FeqtSvlpzhmSq7jjT6dQCQjIzwjoe1GqHc5Dt9Os+OFawAUz3hMpO4V1ng==",
+      "license": "ISC"
+    },
+    "node_modules/qtools-library-dot-d": {
+      "version": "1.0.5",
+      "resolved": "https://registry.npmjs.org/qtools-library-dot-d/-/qtools-library-dot-d-1.0.5.tgz",
+      "integrity": "sha512-MEkrc1NCk8OleAlUPrlJ4Pl8z9v4gOEQt6PIjTc7r16x4StnfQ/ntTfaFF2kS4pi6O1zY1YBpB8vG1q0rdwTcQ==",
+      "license": "ISC",
+      "dependencies": {
+        "qtools-asynchronous-pipe-plus": "^1.0.2",
+        "qtools-functional-library": "^2.0.4"
+      }
+    }
+  }
+}

package/libDotD_Working_Example/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "libdotd_example",
+  "version": "1.0.0",
+  "description": "Boilerplate for use of qtools-library-dot-d - demonstrates dynamic module loading",
+  "license": "ISC",
+  "author": "TQ White II",
+  "type": "commonjs",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "_comment_qtools-library-dot-d": "Core library for dynamic dotD module loading - provides qtLibDotD factory function",
+    "qtools-library-dot-d": "^1.0.5"
+  },
+  "_instructions": {
+    "usage": "Run 'npm start' to see both synchronous and asynchronous dotD library demos",
+    "creating_new_modules": "Add .js files to the demoModules_DotD directory - they'll automatically become library methods",
+    "module_naming": "Filename determines method name: 'myModule.js' becomes 'libraryInstance.myModule()'",
+    "shared_resources": "Use passThroughParameters in index.js to share config, utilities, database connections, etc. across all modules"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qtools-library-dot-d",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "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

@@ -14,7 +14,7 @@ const qt = require('qtools-functional-library');
 //START OF moduleFunction() ============================================================
 const moduleFunction =
 	({ moduleName } = {}) =>
-	({ libraryName }) => {
+	({ libraryName='libraryDotD' }) => {
 		// ======================================================================================
 		// SETTERS
 
@@ -27,7 +27,7 @@ const moduleFunction =
 			try {
 				libraryPath = fs.realpathSync(dirPath);
 			} catch (err) {
-				callback(err.toString());
+				throw err.toString();
 				return;
 			}