qtools-functional-library 1.1.4 → 1.1.9

package/README.md

@@ -0,0 +1,23 @@
+**qtools-functional-library**
+
+This is a collection of tools that allow chained operations on various Javascript datatypes. In each case, the primary operand is `this`. In most cases, the function takes parameteers to guide the operation. In all cases, `this` is returned for use by the next function in the chain. 
+
+Most of the functions included in this library (except, eg, qt.log()) are implemented on the prototype of the data type in question. For example, almost any element can take the .qtDump() function.
+
+- qtools-clone
+- qtools-get-by-property
+- qtools-includes-regex
+- qtools-log-output
+- qtools-merge
+- qtools-new-method-template
+- qtools-number-iterator
+- qtools-number-keys-to-array
+- qtools-object-sure-path
+- qtools-pass-through
+- qtools-pop
+- qtools-print-debug
+- qtools-template-replace
+- qtools-to-key-value-array
+- qtools-to-string
+
+DESCRIPTION

package/lib/qtools-log-output/qtools-log-output.js

@@ -26,7 +26,7 @@ var moduleFunction = function(args = {}) {
 				}
 
 				this.log = function(message, options = {}) {
-					options.suffixCallStackDepth = 4;
+					options.suffixCallStackDepth = options.suffixCallStackDepth?options.suffixCallStackDepth:4;
 					return ({}.qtLog(message, options));
 				};
 
@@ -65,13 +65,21 @@ var moduleFunction = function(args = {}) {
 					noSuffix = false,
 					label = '',
 					substitutions = {},
-					destination = 'stderr'
+					destination = 'stderr',
+					removeFromSuffix,
+					replacementForSuffix='...'
 				} = options;
 
 				const callerName = commonFunctions.callerName(true, options);
 
 				const showLabel = label.replace(/\n/g, '');
-				const suffix = noSuffix ? '' : ` [${callerName}]`;
+				let suffix = noSuffix ? '' : ` [${callerName}]`;
+				
+				if (removeFromSuffix){
+					suffix=suffix.replace(new RegExp(removeFromSuffix), replacementForSuffix);
+				}
+				
+				
 				const outputMessage =
 					message
 						.qtTemplateReplace(typeof this == 'object' ? this : {})

package/lib/qtools-number-iterator/qtools-number-iterator.js

@@ -98,7 +98,7 @@ var moduleFunction = function(args = {}) {
 	const firstMethodFunction = commonFunctions => {
 		const functionObject = new Map(); // prettier-ignore
 		functionObject.set('qtIterate', {
-			description: `count.qtIterate((currentValue, count, startValue, incrementValue)=>{}`,
+			description: `eg, (5).qtStart(7).qtIncrement(3).qtIterate(item=>item*100)`,
 			supportedTypeList: [Number],
 			method: () => iterator
 		});

package/lib/qtools-object-sure-path/qtools-object-sure-path.js

@@ -101,6 +101,9 @@ var moduleFunction = function(args = {}) {
 			if (!dottedPathString) {
 				return baseObj;
 			}
+			if (dottedPathString.match(/(__proto__|constructor|prototype)/)){
+				return baseObj; //avoid prototype pollution
+			}
 
 			if (elements.length < 2) {
 				baseObj[dottedPathString] = value;

package/lib/qtools-object-sure-path/test.js

@@ -16,7 +16,7 @@ const moduleFunction = function(args) {
 			console.log(`FAIL TEST: ${thisStepMessage} in ...${moduleName}`);
 		}
 		if (verbose) {
-			console.log(`Result for: ${methodName} (${thisStepPass?'PASS':'FAIL'}):`);
+			console.log(`Result for: ${methodName} ${thisStepMessage} (${thisStepPass?'PASS':'FAIL'}):`);
 			console.dir(thisStepResult);
 			console.log('\n\n');
 		}
@@ -320,6 +320,20 @@ const moduleFunction = function(args) {
 	
 	
 	
+	methodName = 'qtPutSurePath';
+	thisStepMessage = 'avoid prototype polution';
+	thisStepResult = testArray[methodName]('__proto__', 9999);
+	thisStepEvalFunction = item => item.qtGetSurePath('__proto__')!=9999;
+	passingTests =
+		completeStep(
+			methodName,
+			thisStepMessage,
+			thisStepResult,
+			thisStepEvalFunction
+		) && passingTests;
+	
+	
+	
 
 	return passingTests;
 };

package/lib/qtools-pop/qtools-pop.js

@@ -68,6 +68,40 @@ var moduleFunction = function(args = {}) {
 			method
 		};
 	};
+	//third method definition function ==========================
+	const thirdMethodFunction = commonFunctions => {
+		const methodName = 'qtPush';
+		const description = `operand.qtPush(value) pushes to the array and returns the array`;
+		const supportedTypeList = [Array];
+
+		const method = () =>
+			function(value) {
+				const inData = this;
+				if (typeof inData.length == 'undefined') {
+					throw 'array.qtPush(defaultValue=undefined) works for Arrays only';
+				}
+				
+				inData.push(value);
+				return inData;
+			};
+
+		const test = args => {
+			return require('./test.js')({
+				...args,
+				...{
+					moduleName: module.id.replace(module.path, '')
+				}
+			});
+		};
+
+		return {
+			methodName,
+			description,
+			supportedTypeList,
+			method,
+			test
+		};
+	};
 	
 	const functionObject = new Map(); // prettier-ignore
 	const addFunction = definition => {
@@ -95,6 +129,7 @@ var moduleFunction = function(args = {}) {
 	
 	addFunction(firstMethodFunction());
 	addFunction(secondMethodFunction());
+	addFunction(thirdMethodFunction());
 
 	this.addToPrototype = addToPrototypeActual(functionObject);
 	

package/lib/qtools-pop/test.js

@@ -87,6 +87,15 @@ const moduleFunction = function(args) {
 		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
 		passingTests;
 	
+	//TEST ITEM ------------------------------------------------------
+	methodName='qtPush'
+	thisStepMessage = "element was not added";
+	thisStepResult = emptyArray[methodName]('test value');
+	thisStepEvalFunction = item => (item=>item.qtPop()=='test value');
+	passingTests =
+		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
+		passingTests;
+	
 	
 	
 

package/lib/qtools-print-debug/qtools-print-debug.js

@@ -19,6 +19,12 @@ var moduleFunction = function(args = {}) {
 		let returnn = '';
 		let showLabel = '';
 		let suffix = '';
+		let cancelDump = args.cancelDump ? args.cancelDump : false;
+		
+		if (cancelDump){
+			return this;
+		}
+		
 		const recursionDepth =
 			typeof args.recursionDepth != 'undefined' ? args.recursionDepth : null;
 		const addCliColors =

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qtools-functional-library",
-  "version": "1.1.4",
+  "version": "1.1.9",
   "description": "Useful additions to JS prototypes to facilliate chainable, functional (mostly) style. Also make life more convenient.\"",
   "main": "qtools-functional-library.js",
   "scripts": {

package/README

@@ -1,2 +0,0 @@
-qtools-functional-library
-