@jdeighan/coffee-utils 7.0.53 → 7.0.56

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "7.0.53",
+	"version": "7.0.56",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {

package/src/call_stack.coffee

@@ -160,5 +160,5 @@ export class CallStack
 			LOG "   <EMPTY>"
 		else
 			for item, i in @lStack
-				LOG "   #{i}: #{JSON.stringify(item)}"
+				LOG "   #{i}: #{item.fullName} #{item.isLogged}"
 		return

package/src/call_stack.js

@@ -168,7 +168,7 @@ export var CallStack = class CallStack {
       ref = this.lStack;
       for (i = j = 0, len = ref.length; j < len; i = ++j) {
         item = ref[i];
-        LOG(`   ${i}: ${JSON.stringify(item)}`);
+        LOG(`   ${i}: ${item.fullName} ${item.isLogged}`);
       }
     }
   }

package/src/debug_utils.coffee

@@ -2,7 +2,7 @@
 
 import {
 	assert, undef, error, croak, warn, defined,
-	isString, isFunction, isBoolean, sep_dash,
+	isString, isFunction, isBoolean,
 	OL, escapeStr, isNumber, isArray, words, pass,
 	} from '@jdeighan/coffee-utils'
 import {blockToArray} from '@jdeighan/coffee-utils/block'
@@ -13,7 +13,7 @@ import {
 	getPrefix, addArrow, removeLastVbar,
 	} from '@jdeighan/coffee-utils/arrow'
 import {
-	log, logItem, LOG, shortEnough,
+	log, logItem, LOG, shortEnough, dashes,
 	} from '@jdeighan/coffee-utils/log'
 
 callStack = new CallStack()
@@ -38,6 +38,9 @@ export debug = (label, lObjects...) ->
 		LOG "debug(): type = #{OL(type)}"
 		LOG "debug(): funcName = #{OL(funcName)}"
 
+	# --- function shouldLog() returns the (possibly modified) label
+	#     if we should log this, else it returns undef
+
 	switch type
 		when 'enter'
 			callStack.enter funcName
@@ -64,25 +67,27 @@ export debug = (label, lObjects...) ->
 	if doLog
 		level = callStack.getLevel()
 		prefix = getPrefix(level)
+		itemPrefix = removeLastVbar(prefix)
 
 		if doDebugDebug
 			LOG "callStack", callStack
 			LOG "level = #{OL(level)}"
 			LOG "prefix = #{OL(prefix)}"
+			LOG "itemPrefix = #{OL(itemPrefix)}"
 
 		switch type
 			when 'enter'
 				log label, {prefix}
 				for obj,i in lObjects
 					if (i > 0)
-						log sep_dash, {prefix: removeLastVbar(prefix)}
-					logItem undef, obj, {prefix: removeLastVbar(prefix)}
+						log dashes(itemPrefix, 40)
+					logItem undef, obj, {itemPrefix}
 			when 'return'
 				log label, {prefix: addArrow(prefix)}
 				for obj,i in lObjects
 					if (i > 0)
-						log sep_dash, {prefix: removeLastVbar(prefix)}
-					logItem undef, obj, {prefix: removeLastVbar(prefix)}
+						log dashes(itemPrefix, 40)
+					logItem undef, obj, {itemPrefix}
 			when 'string'
 				log label, {prefix}
 			when 'objects'
@@ -95,7 +100,7 @@ export debug = (label, lObjects...) ->
 					for obj in lObjects
 						logItem undef, obj, {prefix}
 
-	if (type == 'enter') && doLog
+	if (type == 'enter') && doLog && (label.indexOf('call') == -1)
 		callStack.logCurFunc()
 	else if (type == 'return')
 		callStack.returnFrom funcName
@@ -119,20 +124,25 @@ export stdShouldLog = (label, type, funcName, stack) ->
 	else
 		assert funcName == undef, "func name #{OL(funcName)} not undef"
 	assert stack instanceof CallStack, "not a call stack object"
+
 	if doDebugDebug
 		LOG "stdShouldLog(#{OL(label)}, #{OL(type)}, #{OL(funcName)}, stack)"
 		LOG "stack", stack
 		LOG "lFuncList", lFuncList
+
 	switch type
 		when 'enter'
 			if funcMatch(stack, lFuncList)
 				return label
 
-			# --- As a special case, if we enter a function where we will not
-			#     be logging, but we were logging in the calling function,
-			#     we'll log out the call itself
-			else if stack.isLoggingPrev()
-				return label.replace('enter', 'call')
+			else
+				# --- As a special case, if we enter a function where we will not
+				#     be logging, but we were logging in the calling function,
+				#     we'll log out the call itself
+
+				prevLogged = stack.isLoggingPrev()
+				if prevLogged
+					return label.replace('enter', 'call')
 		else
 			if funcMatch(stack, lFuncList)
 				return label

package/src/debug_utils.js

@@ -12,7 +12,6 @@ import {
   isString,
   isFunction,
   isBoolean,
-  sep_dash,
   OL,
   escapeStr,
   isNumber,
@@ -47,7 +46,8 @@ import {
   log,
   logItem,
   LOG,
-  shortEnough
+  shortEnough,
+  dashes
 } from '@jdeighan/coffee-utils/log';
 
 callStack = new CallStack();
@@ -60,7 +60,7 @@ export var lFuncList = [];
 
 // ---------------------------------------------------------------------------
 export var debug = function(label, ...lObjects) {
-  var doLog, funcName, i, j, k, l, len1, len2, len3, level, nObjects, obj, prefix, type;
+  var doLog, funcName, i, itemPrefix, j, k, l, len1, len2, len3, level, nObjects, obj, prefix, type;
   assert(isString(label), `1st arg ${OL(label)} should be a string`);
   // --- We want to allow objects to be undef. Therefore, we need to
   //     distinguish between 1 arg sent vs. 2 or more args sent
@@ -71,6 +71,8 @@ export var debug = function(label, ...lObjects) {
     LOG(`debug(): type = ${OL(type)}`);
     LOG(`debug(): funcName = ${OL(funcName)}`);
   }
+  // --- function shouldLog() returns the (possibly modified) label
+  //     if we should log this, else it returns undef
   switch (type) {
     case 'enter':
       callStack.enter(funcName);
@@ -99,10 +101,12 @@ export var debug = function(label, ...lObjects) {
   if (doLog) {
     level = callStack.getLevel();
     prefix = getPrefix(level);
+    itemPrefix = removeLastVbar(prefix);
     if (doDebugDebug) {
       LOG("callStack", callStack);
       LOG(`level = ${OL(level)}`);
       LOG(`prefix = ${OL(prefix)}`);
+      LOG(`itemPrefix = ${OL(itemPrefix)}`);
     }
     switch (type) {
       case 'enter':
@@ -110,13 +114,9 @@ export var debug = function(label, ...lObjects) {
         for (i = j = 0, len1 = lObjects.length; j < len1; i = ++j) {
           obj = lObjects[i];
           if (i > 0) {
-            log(sep_dash, {
-              prefix: removeLastVbar(prefix)
-            });
+            log(dashes(itemPrefix, 40));
           }
-          logItem(undef, obj, {
-            prefix: removeLastVbar(prefix)
-          });
+          logItem(undef, obj, {itemPrefix});
         }
         break;
       case 'return':
@@ -126,13 +126,9 @@ export var debug = function(label, ...lObjects) {
         for (i = k = 0, len2 = lObjects.length; k < len2; i = ++k) {
           obj = lObjects[i];
           if (i > 0) {
-            log(sep_dash, {
-              prefix: removeLastVbar(prefix)
-            });
+            log(dashes(itemPrefix, 40));
           }
-          logItem(undef, obj, {
-            prefix: removeLastVbar(prefix)
-          });
+          logItem(undef, obj, {itemPrefix});
         }
         break;
       case 'string':
@@ -153,7 +149,7 @@ export var debug = function(label, ...lObjects) {
         }
     }
   }
-  if ((type === 'enter') && doLog) {
+  if ((type === 'enter') && doLog && (label.indexOf('call') === -1)) {
     callStack.logCurFunc();
   } else if (type === 'return') {
     callStack.returnFrom(funcName);
@@ -164,6 +160,7 @@ export var debug = function(label, ...lObjects) {
 
 // ---------------------------------------------------------------------------
 export var stdShouldLog = function(label, type, funcName, stack) {
+  var prevLogged;
   // --- if type is 'enter', then funcName won't be on the stack yet
   //     returns the (possibly modified) label to log
 
@@ -187,11 +184,14 @@ export var stdShouldLog = function(label, type, funcName, stack) {
     case 'enter':
       if (funcMatch(stack, lFuncList)) {
         return label;
-      // --- As a special case, if we enter a function where we will not
-      //     be logging, but we were logging in the calling function,
-      //     we'll log out the call itself
-      } else if (stack.isLoggingPrev()) {
-        return label.replace('enter', 'call');
+      } else {
+        // --- As a special case, if we enter a function where we will not
+        //     be logging, but we were logging in the calling function,
+        //     we'll log out the call itself
+        prevLogged = stack.isLoggingPrev();
+        if (prevLogged) {
+          return label.replace('enter', 'call');
+        }
       }
       break;
     default:

package/src/log_utils.coffee

@@ -20,6 +20,12 @@ fourSpaces  = '    '
 
 # ---------------------------------------------------------------------------
 
+export dashes = (prefix, totalLen=64, ch='-') ->
+
+	return prefix + ch.repeat(totalLen - prefix.length)
+
+# ---------------------------------------------------------------------------
+
 export debugLog = (flag=true) ->
 
 	doDebugLog = flag

package/src/log_utils.js

@@ -39,6 +39,11 @@ export var stringify = undef;
 
 fourSpaces = '    ';
 
+// ---------------------------------------------------------------------------
+export var dashes = function(prefix, totalLen = 64, ch = '-') {
+  return prefix + ch.repeat(totalLen - prefix.length);
+};
+
 // ---------------------------------------------------------------------------
 export var debugLog = function(flag = true) {
   doDebugLog = flag;