qtools-functional-library 2.0.0 → 2.0.2

package/lib/qtools-ai-thought-processor/lib/assemble-configuration-show-help-maybe-exit/lib/figure-out-config-path/figure-out-config-path.js

@@ -0,0 +1,103 @@
+#!/usr/bin/env node
+'use strict';
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+/*
+
+From system to system, this file is almost always customized for particular needs.
+However, this particular one is pretty close to universal.
+
+*/
+
+//START OF moduleFunction() ============================================================
+const moduleFunction = function ({ xxx } = {}) {
+	let { xLog, applicationBasePath } = process.global;
+	
+
+	
+
+	const findProjectRoot = ({
+		rootFolderName = 'system',
+		closest = true,
+	} = {}) =>
+		__dirname.replace(
+			new RegExp(`^(.*${closest ? '' : '?'}\/${rootFolderName}).*$`),
+			'$1',
+		);
+	
+
+	applicationBasePath = applicationBasePath
+		? applicationBasePath
+		: findProjectRoot(); // call with {closest:false} if there are nested rootFolderName directories and you want the top level one
+
+	const getConfigPath = ({ fileString, configFileBaseName } = {}) => {
+		const configFilePath = path.join(
+			applicationBasePath,
+			'configs',
+			'systemParameters.ini',
+		);
+		const moduleNameFilePath = path.join(
+			applicationBasePath,
+			'configs',
+			configFileBaseName ? `${configFileBaseName}.ini` : 'systemParameters.ini',
+		);
+
+		const qbookFilePath = path.join(
+			applicationBasePath,
+			'configs',
+			'instanceSpecific',
+			'qbook',
+			configFileBaseName ? `${configFileBaseName}.ini` : 'systemParameters.ini',
+		); //deployment copies target config to 'configs'; if qbook exists, it's dev system
+
+		const homeUserNameFilePath = path.join(
+			applicationBasePath,
+			'configs',
+			'instanceSpecific',
+			os.userInfo().username,
+			configFileBaseName ? `${configFileBaseName}.ini` : 'systemParameters.ini',
+		); //deployment copies target config to 'configs'; if qbook exists, it's dev system
+		
+		let outString;
+
+		if (fileString && fs.existsSync(fileString)) {
+			outString=fileString; //return user override config file path
+		}
+
+		if (fs.existsSync(qbookFilePath)) {
+			outString=qbookFilePath; // this one is special for TQ
+		}
+
+		if (fs.existsSync(homeUserNameFilePath)) {
+			outString=homeUserNameFilePath; // this one is any other developers
+		}
+
+		if (fs.existsSync(moduleNameFilePath)) {
+			outString=moduleNameFilePath; // This is more specific for special (cli) situations
+		}
+
+		if (fs.existsSync(configFilePath)) {
+			outString=configFilePath; // normal deployment has config data at top level of directory so other config's secrets are preserved
+		}
+		
+		if (outString){
+			return outString;
+		}
+		
+		const filePaths = [
+			fileString,
+			qbookFilePath,
+			homeUserNameFilePath,
+			moduleNameFilePath,
+			configFilePath,
+		];
+		
+		xLog.status(`No configuration file found at any of these paths:\n    ${filePaths.join('\n    ')}\n`);
+		
+		throw 'No configuration file found';
+	};
+	return { getConfigPath };
+};
+//END OF moduleFunction() ============================================================
+module.exports = moduleFunction;

package/lib/qtools-ai-thought-processor/lib/assemble-configuration-show-help-maybe-exit/lib/figure-out-config-path/package-lock.json

@@ -0,0 +1,29 @@
+{
+  "name": "figure-out-config-path",
+  "version": "1.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "lodash": {
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+      "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+    },
+    "multi-ini": {
+      "version": "2.1.2",
+      "resolved": "https://registry.npmjs.org/multi-ini/-/multi-ini-2.1.2.tgz",
+      "integrity": "sha512-m7G4SF3bo/VM+iyeiIlCvBVD0GY2NQ/PHh+H6y3sEYaRJ3fFeKo5/6e0O15B17+KpqDZ9ia+JBo8d7ZUYiEucw==",
+      "requires": {
+        "lodash": "^4.0.0"
+      }
+    },
+    "qtools-config-file-processor": {
+      "version": "1.0.10",
+      "resolved": "https://registry.npmjs.org/qtools-config-file-processor/-/qtools-config-file-processor-1.0.10.tgz",
+      "integrity": "sha512-T7wMtzEPRblbi8JRXmavrcYbrN4t5pueQEPvJcsQBOgS4zelPr+WIdhlMyMHVfmc+8rt4u5R9lKC6XKC79Z4Ng==",
+      "requires": {
+        "multi-ini": "^2.1.2"
+      }
+    }
+  }
+}

package/lib/qtools-ai-thought-processor/lib/assemble-configuration-show-help-maybe-exit/lib/figure-out-config-path/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "figure-out-config-path",
+  "version": "1.0.0",
+  "description": "look for deploy-program metadata file and extract appropriate alias if present",
+  "main": "figure-out-config-path.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "TQ White II",
+  "license": "ISC",
+  "dependencies": {
+    "qtools-functional-library": "^1.0.10"
+  }
+}

package/lib/qtools-ai-thought-processor/lib/assemble-configuration-show-help-maybe-exit/lib/help-text.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+'use strict';
+
+
+const qt = require('qtools-functional-library');
+
+//START OF moduleFunction() ============================================================
+
+const moduleFunction = function(args={}) {
+
+
+const mainHelp=args=>{
+
+
+const {defaultRequestFilePath, errorMessage=''}=args;
+
+return `
+============================================================
+
+NAME
+
+	Uniuty Data Generator - Generate XML test data for A4L Unity Data model
+
+DESCRIPTION
+
+	unityDataGenerator.js MODELNAME
+	
+	Writes XML to file. Displays path of file.
+
+CONTROLS
+
+
+--thoughtProcess:	specify the name of the AI process sequence for generating XML
+--refinerName:	specify the name of the AI process sequence for refining XML
+--overrideConfigPath:	Specify a configuration file to override default (configs/systemParameters.ini)
+
+OUTPUT
+
+-outFile:	Override the default file path
+-echoAlso:	Show XML on command line as well as writing to file
+
+MESSAGES
+
+-help, --help	shows this help message. No processing is done.
+
+-showConfig	display the final configuration (pipe to jq, if you have it)
+
+-silent	turns off all message output
+-quiet	turns off all but error messages
+-verbose	shows additional messages that clarify what is going on
+-debug	shows all development debugging messages, plus verbose and everything else
+
+EXAMPLES
+
+unityDataGenerator.js LEAAccountabilitys; //smallest of the models
+unityDataGenerator.js --overrideConfigPath="FILEPATH/systemParamters.ini" --outFile=PATH/TO/FILE
+
+
+============================================================
+${errorMessage}
+`
+	;
+
+}
+
+	return ({mainHelp});
+};
+
+//END OF moduleFunction() ============================================================
+
+module.exports = moduleFunction();
+//moduleFunction().workingFunction().qtDump();
+

package/lib/qtools-ai-thought-processor/lib/assemble-configuration-show-help-maybe-exit/lib/tsv-to-json.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+'use strict';
+
+const util=require('util');
+
+
+//START OF moduleFunction() ============================================================
+
+const moduleFunction = function(inString) {
+	
+	inString = inString.replace(/  +/g, '\t');
+	const inputLines = inString
+		.trim()
+		.split(/\n/)
+		.map(item => item.split(/\t/));
+
+	const fieldNames = inputLines[0];
+	inputLines.splice(0, 1); //remove fieldnames, leaving only data
+	
+	const resultObject = inputLines.map(dataList =>
+		dataList.reduce((result, item, inx) => {
+			result[fieldNames[inx]] = item;
+			return result;
+		}, {})
+	);
+	
+	return resultObject;
+};
+
+//END OF moduleFunction() ============================================================
+
+module.exports = moduleFunction;

package/lib/qtools-ai-thought-processor/lib/assemble-configuration-show-help-maybe-exit/node_modules/qtools-asynchronous-pipe-plus/README

@@ -0,0 +1,124 @@
+asynchronousPipe() takes an array of asynchronous functions and executes
+them in sequence. As each completes, the next is called with the return
+result of the previous function.
+
+The purpose of the package is to create a joint scope for a series of
+asynchronous operations.
+
+The parameters are:
+
+	workList: an array of functions
+	initialValue:	optional initial value passed to the first function
+	callback:		optional function called after all the other functions are finished
+
+The workList functions must have the signature:
+
+	(args, next)={
+		const result= "some functionOf(args), probably the result of an I/O function";
+		next(err, result); //mandatory
+	}
+
+As of 6/7/19, there is a special value of err, skipRestOfPipe, eg:
+
+next('skipRestOfPipe', result);
+
+This will do as the symbol says, skip the rest of the pipe. It serves
+the role of 'continue' in loops. Practically speaking, it calls the
+callback with the current value of result and no error.
+
+It is often good to have special code in the final callback to change a
+skipRestOfPipe error status for the next callback in case it's not an
+asynchronousPipe and  treats it as an error. Eg,
+callback(err=='skipRestOfPipe'?'':err, result)
+
+The optional callback function is called as:
+
+	callback(err, result);
+
+asynchronousPipe() does not return anything.
+
+
+
+=============================================================================
+EG, from test.js 
+
+
+#!/usr/local/bin/node
+'use strict';
+
+const asynchronousPipePlus = new require('qtools-asynchronous-pipe-plus')();
+const pipeRunner = asynchronousPipePlus.pipeRunner;
+const taskListPlus = asynchronousPipePlus.taskListPlus; 
+
+ const pipeFunction = (inData, callback) => {
+	const taskList = new taskListPlus();
+	
+	taskList.push((args, next) => {
+		const localCallback = (err, localResult1) => {
+			if (err == 'someParticularError') {
+				next('skipRestOfPipe', err);
+				return;
+			}
+			console.dir({ 'only inboundData so far': args });
+			
+			args.localResult1 = localResult1;
+			next(err, args);
+		};
+		localCallback('', 'localResult1_value');
+	});
+	
+	
+	taskList.push((args, next) => {
+		const localCallback = (err, localResult3) => {
+			args.localResult3 = localResult3;
+			next(err, args);
+		};
+		console.dir({ 'shows localResult1 and inboundData': args });
+		localCallback('', 'localResult3_value');
+	});
+	
+	taskList.push(
+		(args, next) => {
+			const localCallback = (err, localResult2) => {
+				args.localResult2 = localResult2;
+				next(err, args);
+			};
+			console.dir({ 'shows localResult1 only': args });
+			localCallback('', 'localResult2_value');
+		},
+		['localResult1']
+	);
+	
+	taskList.push(taskList.restoreGlobalScope());
+	
+	taskList.push((args, next) => {
+		const localCallback = (err, localResult3) => {
+			args.localResult3 = localResult3;
+			next(err, args);
+		};
+		console.dir({ 'shows all incoming values, 1, 2, hiding test': args });
+		localCallback('', 'localResult3_value');
+	});
+	
+	taskList.push(
+		(args, next) => {
+			const localCallback = (err, localResult4) => {
+				args.localResult4 = localResult4;
+				next(err, args);
+			};
+			console.dir({ 'shows localResult1 and inboundData': args });
+			localCallback('', 'localResult2_value');
+		},
+		['localResult3', 'inboundData']
+	);
+	
+	const initialData = typeof inData != 'undefined' ? inData : {};
+	pipeRunner(taskList.getList(), initialData, (err, finalResult) => {
+		console.dir({ 'final: shows localResult3, inboundData, and localResult4': finalResult });
+		callback(err, finalResult);
+	});
+};
+
+pipeFunction({ inboundData: 'inboundData_value' }, (err, result) => {
+	console.log('if you do not see errors, it works');
+});

package/lib/qtools-ai-thought-processor/lib/assemble-configuration-show-help-maybe-exit/node_modules/qtools-asynchronous-pipe-plus/package.json

@@ -0,0 +1,52 @@
+{
+  "_from": "qtools-asynchronous-pipe-plus",
+  "_id": "qtools-asynchronous-pipe-plus@1.0.1",
+  "_inBundle": false,
+  "_integrity": "sha512-eELsDrzpyKbAgYpY76ET7BK3hsfd5tF98sKoabItKS12PVSs2rGTfp5iavrmzGJedcueFPbvrpKr3aORKA6Deg==",
+  "_location": "/qtools-asynchronous-pipe-plus",
+  "_phantomChildren": {},
+  "_requested": {
+    "type": "tag",
+    "registry": true,
+    "raw": "qtools-asynchronous-pipe-plus",
+    "name": "qtools-asynchronous-pipe-plus",
+    "escapedName": "qtools-asynchronous-pipe-plus",
+    "rawSpec": "",
+    "saveSpec": null,
+    "fetchSpec": "latest"
+  },
+  "_requiredBy": [
+    "#USER",
+    "/"
+  ],
+  "_resolved": "https://registry.npmjs.org/qtools-asynchronous-pipe-plus/-/qtools-asynchronous-pipe-plus-1.0.1.tgz",
+  "_shasum": "2e87be28c9d102bc32b642c90c13a66fc641e708",
+  "_spec": "qtools-asynchronous-pipe-plus",
+  "_where": "/Users/tqwhite/Library/Mobile Documents/com~apple~CloudDocs/tq_usr_bin/bin/js/deployPrograms/system/code/deploy-programs/lib/assemble-configuration-show-help-maybe-exit",
+  "author": {
+    "name": "TQ White II"
+  },
+  "bugs": {
+    "url": "https://github.com/tqwhite/qtools-asynchronous-pipe-plus/issues"
+  },
+  "bundleDependencies": false,
+  "deprecated": false,
+  "description": "Asynchronous-pipe for the future. Includes taskListPlus and utility functions I have learned to like\"",
+  "homepage": "https://github.com/tqwhite/qtools-asynchronous-pipe-plus#readme",
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://github.com/evangelion1204/multi-ini/blob/master/LICENSE"
+    }
+  ],
+  "main": "qtools-asynchronous-pipe-plus.js",
+  "name": "qtools-asynchronous-pipe-plus",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tqwhite/qtools-asynchronous-pipe-plus.git"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "version": "1.0.1"
+}

package/lib/qtools-ai-thought-processor/lib/assemble-configuration-show-help-maybe-exit/node_modules/qtools-asynchronous-pipe-plus/qtools-asynchronous-pipe-plus.js

@@ -0,0 +1,265 @@
+'use strict';
+
+//START OF moduleFunction() ============================================================
+
+var moduleFunction = function(args) {
+	/* 
+
+asynchronousPipe() takes an array of asynchronous functions and executes them
+in sequence. As each completes, the next is called with the return result of the
+previous function.
+
+The parameters are:
+
+	workList: an array of functions
+	initialValue:	optional initial value passed to the first function
+	callback:		optional function called after all the other functions are finished
+
+The workList functions must have the signature:
+
+	(args, next)={
+		const result= "some functionOf(args), probably the result of an I/O function";
+		next(err, result); //mandatory
+	}
+
+As of 6/7/19, there is a special value of err, skipRestOfPipe, eg:
+
+next('skipRestOfPipe', result);
+
+This will do as the symbol says, skip the rest of the pipe. It serves the role of 'continue'
+in loops. Practically speaking, it calls the callback with the current value of result and no error.
+It is often good to have special code for in the final callback to 
+change the error status for the next callback in case it's not asynchronousPipe and 
+treats it as an error. Eg, callback(err=='skipRestOfPipe'?'':err, result)
+
+The optional callback function is called as:
+
+	callback(err, result);
+
+asynchronousPipe() does not return anything.
+
+ */
+ 
+ 
+	const isArray=item=>(typeof item=='object' && typeof item.length=='number');
+	
+	const logger=message=>{
+		const suffix='[asynchronousPipe.js]';
+		if (typeof message=='string'){
+			console.log(`${message} ${suffix}`)
+		}
+		else{
+		
+			console.log(`${suffix} =======`)
+			console.dir(message);		
+			console.log(`======= ${suffix}`)
+		}
+	
+	}
+
+	// asyncPipe(workList, [initialValue,] callback);
+	const asynchronousPipe = (...args) => {
+		const workList = args[0];
+		const callback = args[args.length - 1];
+
+		let initial;
+		if (args.length == 3) {
+			initial = args[1];
+		}
+
+		const recursion = (err, result, workListInx) => {
+			if (err) {
+				if (err == 'skipRestOfPipe') {
+					callback('skipRestOfPipe', result);
+					return;
+				} else {
+					callback(err, result);
+					return;
+				}
+			}
+
+			if (workListInx > workList.length - 1) {
+				if (typeof callback == 'function') {
+					callback('', result);
+				}
+				return;
+			}
+			workList[workListInx](result, (err, result) => {
+				recursion(err, result, workListInx + 1);
+			});
+		};
+		recursion('', initial, 0);
+	};
+	
+	const taskListPlus = function() {
+		const taskList = [];
+		const hiddenArgsName = `asyncPipeHideFromScope${new Date().getTime()}`;
+
+		const addOptions = options => {
+			if (options.debug) {
+				switch (options.debug) {
+					case 'properties':
+						//{debug:'properties', label:'identifier'}
+						taskList.push((args, next) => {
+							logger(
+								`\nLIST: args (${options.label ? options.label : ''}) =======`
+							);
+							logger(Object.keys(args));
+							logger('======= args\n');
+						});
+						break;
+					case 'fileMarker':
+						//{debug:'fileMarker', label:'identifier'}
+						taskList.push((args, next) => {
+							logger(
+								`\n=-========= (${
+									options.label ? options.label : ''
+								}) =======\n`
+							);
+						});
+						break;
+				}
+			}
+		};
+
+		this.push = function(item, propertyList, options) {
+			if (isArray(propertyList)) {
+				taskList.push(this.reduceToLocalScope(propertyList));
+			}
+
+			if (options) {
+				addOptions(options);
+			}
+			taskList.push(item);
+			this.length = taskList.length;
+		};
+
+		this.addFromDelegate = function(
+			targetFunction,
+			propertyList,
+			options = {}
+		) {
+			if (isArray(propertyList)) {
+				taskList.push(this.reduceToLocalScope(propertyList));
+			}
+
+			targetFunction();
+		};
+
+		this.getList = function() {
+			//returns this tasklist for use with pipeRunner()
+			return taskList;
+		};
+
+		const isScopeBad = (
+			args,
+			list,
+			strict = false,
+			originatingLine = 'no originating line given'
+		) => {
+			const missing = list.filter(name => typeof args[name] == 'undefined');
+			const extra = Object.keys(args).filter(name => !list.includes(name));
+			let result = '';
+
+			const missingString = missing.join(', ');
+			if (missingString && missingString != `${hiddenArgsName}`) {
+				result = `isScopeBad() found missing parameters: ${missingString} `;
+			}
+
+			const extraString = extra
+				.join(', ')
+				.replace(new RegExp(`(, )*${hiddenArgsName}*`), '');
+			if (strict && extraString && extraString != hiddenArgsName) {
+				result += `isScopeBad() found extra parameters: ${extraString} `;
+			}
+
+			if (result) {
+				result = `${result} ${originatingLine}`;
+				logger(result);
+			}
+			return result ? result : false;
+		};
+
+		this.returnGlobalArgs = args => {
+			const newArgs = Object.assign({}, args[hiddenArgsName], args);
+			delete newArgs[hiddenArgsName];
+			return newArgs;
+		};
+
+		this.getArgsValue = (args, nameList) => {
+			//extracts values from scope whether hidden or not
+			return nameList.reduce((result, name) => {
+				result[name] = args[hiddenArgsName][name]
+					? args[hiddenArgsName][name]
+					: args[name];
+				return result;
+			}, {});
+		};
+
+		this.enforceScope = (propertyList, strict = true) => {
+			//error if args has properties not allowed for local scope
+			let e = new Error();
+			const originatingLine = e.stack.split('\n')[2];
+			taskList.push((args, next) => {
+				next(isScopeBad(args, propertyList, strict, originatingLine), args);
+			});
+		};
+
+		this.reduceToLocalScope = requiredPropertyList => (args, next) => {
+			//changes (adds or substracts) elements from local scope
+			const localCallback = (err, cleanedArgs) => {
+				next(err, cleanedArgs);
+			};
+
+			if (args[hiddenArgsName]) {
+				const tmpArgs = Object.assign({}, args[hiddenArgsName], args);
+				delete tmpArgs[hiddenArgsName];
+				args = tmpArgs; //prevent recursing down globalArgs
+			}
+
+			const validFiles = true;
+			const cleanedArgs = {};
+
+			requiredPropertyList.forEach(item => {
+				cleanedArgs[item] = args[item];
+			});
+
+			const missingElements = requiredPropertyList
+				.filter(item => typeof cleanedArgs[item] == 'undefined')
+				.join(', ');
+
+				Object.defineProperty(cleanedArgs, hiddenArgsName, {
+					value: args,
+					writable: false,
+					enumerable: false
+				});
+					
+					
+			localCallback(
+				missingElements
+					? `MISSING ELEMENTS: ${missingElements} (by reduceToLocalScope())`
+					: '',
+				cleanedArgs
+			);
+		};
+		this.restoreGlobalScope = () => (args, next) => {
+			//returns all properties to the scope
+			const newArgs = Object.assign({}, args[hiddenArgsName], args);
+			delete newArgs[hiddenArgsName];
+			next('', newArgs);
+		};
+		return this;
+	};
+
+	return {
+		pipeRunner:asynchronousPipe,
+		asynchronousPipe,
+		taskListPlus
+	};
+};
+
+//END OF moduleFunction() ============================================================
+
+module.exports = moduleFunction;
+//module.exports = new moduleFunction();
+