qtools-library-dot-d 1.0.0

package/README.md

@@ -0,0 +1,31 @@
+# qtools-library-dot-d
+
+# NOT READY. STILL WORKING IT OUT.
+
+NAME
+
+    qtools-library-dot-d
+
+DESCRIPTION
+
+Utility provides tools to scan a directory for NodeJS modules, require() them into existance with tools to connect them to a system.
+
+
+
+First use case is adding endpoints to an expressJS system. When instantiated, qtDotD
+
+scans a directory containing modules, dotLib.d. It requires it with two parameters,
+
+dotD and passThroughArgs. For this case, passThrough args has two properties, 
+
+expressApp and routingPrefix. The module uses these to construct one or more 
+
+expressJS endpoitns.
+
+
+
+the dotD object contains three parameters, add....
+
+
+
+

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "qtools-library-dot-d",
+  "version": "1.0.0",
+  "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": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "TQ White II",
+  "license": "ISC"
+}

package/qtools-library-dot-d.js

@@ -0,0 +1,168 @@
+#!/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');
+
+console.log(`HELLO FROM ${__dirname}/${moduleName}`);
+//START OF moduleFunction() ============================================================
+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;
+		}
+
+		callback('', libraryPath);
+	};
+
+	// --------------------------------------------------------------------------------
+	// SET CUSTOM MODULE ADDING FUNCTION
+
+	const defaultAdd = (item, callback) => {
+		require(item.endpointPath)(item.moduleArgs);
+		callback();
+	};
+	
+	let add = defaultAdd;
+	
+	const setCustomAddFunction = newFunction => (add = newFunction);
+	
+	
+	// ======================================================================================
+	// LOG LIST OBJECT
+	
+	const logList = (() => {
+		const list = [];
+		const push = item => list.push(item);
+		const toString = () => {
+			return list
+				.reduce(
+					(result, item) => `${result}${item}\n\t`,
+					`\n${libraryName} Log\n\t`
+				)
+				.replace(/\n\t$/, '');
+		};
+		return { push, toString };
+	})();
+	
+	
+	// ======================================================================================
+	// LIBRARY OBJECT
+
+	const library = (() => {
+		const list = {};
+		const add = (name, item) => (list[name] = item);
+		const toString = () => {
+			return Object.keys(list)
+				.reduce(
+					(result, name) => `${result}${name}: ${(typeof(list[name])).match(/(string|number)/i)?list[name]:typeof(list[name])}\n\t`,
+					`\n${libraryName} Library\n\t`
+				)
+				.replace(/\n\t$/, '');
+		};
+		return { add, toString };
+	})();
+	
+	// ======================================================================================
+	// 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
+		};
+
+		// --------------------------------------------------------------------------------
+		// BUILD TASKLIST
+
+		taskList.push((args, next) => {
+			const { libraryPath, passThroughParameters } = args;
+
+			const localCallback = (err, result) => {
+				next(err, { ...args, result });
+			};
+
+			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 })
+						);
+					});
+				});
+			localCallback('', args);
+		});
+
+		// --------------------------------------------------------------------------------
+		// INIT AND EXECUTE THE PIPELINE
+
+		const initialData = { libraryPath, passThroughParameters };
+		pipeRunner(taskList.getList(), initialData, (err, args) => {
+			const { libraryDotD } = args;
+
+			callback(err);
+		});
+	};
+
+	return {
+		setLibraryPath,
+		setCustomAddFunction,
+		logList,
+		library,
+		loadModules
+	};
+};
+
+//END OF moduleFunction() ============================================================
+
+module.exports = moduleFunction({ moduleName });
+