qtools-functional-library 1.1.11 → 1.1.12

package/README.md

@@ -4,17 +4,18 @@ This is a collection of tools that allow chained operations on various Javascrip
 
 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-clone: Does a deep clone of an object or array.
+- qtools-get-by-property: Operates on an array of objects. Retrieves one or more elements based on the value of an object property specified by a dotted path.
+- qtools-includes-regex: Operations on a simple array of strings. Retrieves one or more elements based on an regEx match.
+- qtools-log-output: Substitutes properties into a <!template!> string and send to log. (Note to self, verify array operation)
+- qtools-merge: Deep merge of two objects including array propterties.
+- qtools-number-iterator: Operates on a number. EG, (5).qtStart(7).qtIncrement(3).qtIterate(item=>item*100)
+- qtools-number-keys-to-array: Converts an object with properties that are numbers to an array, including subordinate properties.
+- qtools-object-sure-path: Gets or Sets the value of a property based on a dotted string path. No crash if intermediate elements are missing. Provides default. Predates and is prettier to use than optional chaining and supports setting the value.
+- qtools-pass-through: Sits in a declarative chain and executes an arbitrary function. It returns 'this' regardless of what the function does. 'this' is available to the function.
+- qtools-pop: Pops the last value off an array. If a default is supplied and there is nothing left on the list, that will be returned. Really good for ArrayOfObjects.qtPop({}).
+- qtools-qtLast: Delivers the element that would have been pop'd but does not change the array.
+- qtoolspush: Pushes a value onto an array and returns the array (unlike normal .push() which returns the length of the array)
 - qtools-print-debug
 - qtools-template-replace
 - qtools-to-key-value-array

package/lib/qtools-number-keys-to-array/test.js

@@ -5,24 +5,24 @@
 const moduleFunction = function(args) {
 	//this module is initialized with parameters spec'd in the main function module
 	
-	const completeStepActual = ({verbose=false, logErrors=false, moduleName}) => (
-		methodName,
-		thisStepMessage,
-		thisStepResult,
-		thisStepEvalFunction
-	) => {
-
+	const completeStepActual = ({
+		verbose = false,
+		logErrors = false,
+		moduleName
+	}) => (methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) => {
 		const thisStepPass = thisStepEvalFunction(thisStepResult);
-		
+
 		if (logErrors && !thisStepPass) {
 			console.log(`FAIL TEST: ${thisStepMessage} in ...${moduleName}`);
 		}
 		if (verbose) {
-			console.log(`Result for: ${methodName} (${thisStepPass?'PASS':'FAIL'}):`);
+			console.log(
+				`Result for: ${methodName} (${thisStepPass ? 'PASS' : 'FAIL'}):`
+			);
 			console.dir(thisStepResult);
 			console.log('\n\n');
 		}
-		
+
 		return passingTests && thisStepPass;
 	};
 
@@ -40,82 +40,133 @@ const moduleFunction = function(args) {
 	
 	
 	const testArray = {
-['0']:'zero',
-['1']:'one',
-['4']:'four',
-a:'b'
-
-}
+		['0']: 'zero',
+		['1']: 'one',
+		['4']: 'four',
+		a: 'b'
+	};
 
 	
 	
 	const testArray2 = {
-['0']:'zero',
-['1']:'one',
-['4']:'four',
-a:'b',
-subArray:{['0']:'zeroX',
-['1']:'oneX',
-['4']:'fourX'},
-
-}
+		['0']: 'zero',
+		['1']: 'one',
+		['4']: 'four',
+		a: 'b',
+		subArray: {
+			['0']: 'zeroX',
+			['1']: 'oneX',
+			['4']: 'fourX'
+		}
+	};
 
-const emptyArray={}
+	const emptyArray = {};
 	
 
 	//TEST ITEM ------------------------------------------------------
-	methodName='qtNumberKeysToArray'
-	thisStepMessage = "test #1, result is wrong, holes or length are wrong";
-	thisStepResult = testArray[methodName]({collapseHoles:false, omitNonNumeric:true});
-	thisStepEvalFunction = item => item=(item.length==5 && typeof(item[2])=='undefined' && typeof(item[3])=='undefined');
+	methodName = 'qtNumberKeysToArray';
+	thisStepMessage = 'test #1, result is wrong, holes or length are wrong';
+	thisStepResult = testArray[methodName]({
+		collapseHoles: false,
+		omitNonNumeric: true
+	});
+	thisStepEvalFunction = item =>
+		(item =
+			item.length == 5 &&
+			typeof item[2] == 'undefined' &&
+			typeof item[3] == 'undefined');
 	passingTests =
-		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
-		passingTests;
+		completeStep(
+			methodName,
+			thisStepMessage,
+			thisStepResult,
+			thisStepEvalFunction
+		) && passingTests;
 	
 	
 	//TEST ITEM ------------------------------------------------------
-	methodName='qtNumberKeysToArray'
-	thisStepMessage = "test #2, result is wrong, has holes or length is wrong";
-	thisStepResult = testArray[methodName]({collapseHoles:true, omitNonNumeric:true});
-	thisStepEvalFunction = item => item=(item.length==3 && item.reduce((item, result)=>(typeof(item!='undefined') && result), true));
+	methodName = 'qtNumberKeysToArray';
+	thisStepMessage = 'test #2, result is wrong, has holes or length is wrong';
+	thisStepResult = testArray[methodName]({
+		collapseHoles: true,
+		omitNonNumeric: true
+	});
+	thisStepEvalFunction = item =>
+		(item =
+			item.length == 3 &&
+			item.reduce(
+				(item, result) => typeof (item != 'undefined') && result,
+				true
+			));
 	passingTests =
-		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
-		passingTests;
+		completeStep(
+			methodName,
+			thisStepMessage,
+			thisStepResult,
+			thisStepEvalFunction
+		) && passingTests;
 	
 	
 	
 	
 	//TEST ITEM ------------------------------------------------------
-	methodName='qtNumberKeysToArray'
-	thisStepMessage = "test #3, result is wrong, non-numeric element is missing or length is wrong";
-	thisStepResult = testArray[methodName]({collapseHoles:true, omitNonNumeric:false});
-	thisStepEvalFunction = item => item=(item.length==4 && typeof(item[3])=='object');
+	methodName = 'qtNumberKeysToArray';
+	thisStepMessage =
+		'test #3, result is wrong, non-numeric element is missing or length is wrong';
+	thisStepResult = testArray[methodName]({
+		collapseHoles: true,
+		omitNonNumeric: false
+	});
+	thisStepEvalFunction = item =>
+		(item = item.length == 4 && typeof item[3] == 'object');
 	passingTests =
-		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
-		passingTests;
+		completeStep(
+			methodName,
+			thisStepMessage,
+			thisStepResult,
+			thisStepEvalFunction
+		) && passingTests;
 	
 
 	
 	
 	
 	//TEST ITEM ------------------------------------------------------
-	methodName='qtNumberKeysToArray'
-	thisStepMessage = "test #4, subordinate element was not converted properly";
-	thisStepResult = testArray2[methodName]({collapseHoles:true, omitNonNumeric:false});
-	thisStepEvalFunction = item => item=(item.length==5 && typeof(item[4])=='object' && item[4].value.length==3);
+	methodName = 'qtNumberKeysToArray';
+	thisStepMessage = 'test #4, subordinate element was not converted properly';
+	thisStepResult = testArray2[methodName]({
+		collapseHoles: true,
+		omitNonNumeric: false
+	});
+	thisStepEvalFunction = item =>
+		(item =
+			item.length == 5 &&
+			typeof item[4] == 'object' &&
+			item[4].value.length == 3);
 	passingTests =
-		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
-		passingTests;
+		completeStep(
+			methodName,
+			thisStepMessage,
+			thisStepResult,
+			thisStepEvalFunction
+		) && passingTests;
 	
 	
 	//TEST ITEM ------------------------------------------------------
-	methodName='qtNumberKeysToArray'
-	thisStepMessage = "test #5, empty object returns empty array";
-	thisStepResult = emptyArray[methodName]({collapseHoles:true, omitNonNumeric:false});
-	thisStepEvalFunction = item => item=(item.length===0);
+	methodName = 'qtNumberKeysToArray';
+	thisStepMessage = 'test #5, empty object returns empty array';
+	thisStepResult = emptyArray[methodName]({
+		collapseHoles: true,
+		omitNonNumeric: false
+	});
+	thisStepEvalFunction = item => (item = item.length === 0);
 	passingTests =
-		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
-		passingTests;
+		completeStep(
+			methodName,
+			thisStepMessage,
+			thisStepResult,
+			thisStepEvalFunction
+		) && passingTests;
 	
 	
 	

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

@@ -102,6 +102,41 @@ var moduleFunction = function(args = {}) {
 			test
 		};
 	};
+	//fourth method definition function ==========================
+	const fourthMethodFunction = commonFunctions => {
+		const methodName = 'qtFirst';
+		const description = `operand.qtFirst(value) gets element zero or default`;
+		const supportedTypeList = [Array];
+
+		const method = () =>
+			function(value) {
+				const inData = this;
+				if (typeof inData.length == 'undefined') {
+					throw 'array.qtFirst(defaultValue=undefined) works for Arrays only';
+				}
+				const arrayValue = inData[0]?inData[0]:void('');
+				const result =
+					typeof arrayValue != 'undefined' ? arrayValue : defaultValue;
+				return result;
+			};
+
+		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 => {
@@ -130,6 +165,7 @@ var moduleFunction = function(args = {}) {
 	addFunction(firstMethodFunction());
 	addFunction(secondMethodFunction());
 	addFunction(thirdMethodFunction());
+	addFunction(fourthMethodFunction());
 
 	this.addToPrototype = addToPrototypeActual(functionObject);
 	

package/lib/qtools-pop/test.js

@@ -96,6 +96,15 @@ const moduleFunction = function(args) {
 		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
 		passingTests;
 	
+	//TEST ITEM ------------------------------------------------------
+	methodName='qtFirst'
+	thisStepMessage = "element was not added";
+	thisStepResult = testArray[methodName]();
+	thisStepEvalFunction = item => (item=='allocute' && item.length==2);
+	passingTests =
+		completeStep(methodName, thisStepMessage, thisStepResult, thisStepEvalFunction) &&
+		passingTests;
+	
 	
 	
 

package/package.json

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