@jdeighan/coffee-utils 11.0.3 → 11.0.5

package/src/log.coffee

@@ -1,186 +0,0 @@
-# log.coffee
-
-import {LOG, assert, croak} from '@jdeighan/exceptions'
-import {
-	undef, isNumber, isInteger, isString, isHash, isFunction,
-	escapeStr, sep_eq, sep_dash, pass, OL,
-	} from '@jdeighan/coffee-utils'
-import {toArray} from '@jdeighan/coffee-utils/block'
-import {toTAML} from '@jdeighan/coffee-utils/taml'
-
-# --- This logger only ever gets passed a single string argument
-putstr = undef
-doDebugLog = false
-
-export stringify = undef
-fourSpaces  = '    '
-
-# ---------------------------------------------------------------------------
-
-export debugLog = (flag=true) ->
-
-	doDebugLog = flag
-	if doDebugLog
-		LOG "doDebugLog = #{flag}"
-	return
-
-# ---------------------------------------------------------------------------
-
-export setStringifier = (func) ->
-
-	orgStringifier = stringify
-	assert isFunction(func), "setStringifier() arg is not a function"
-	stringify = func
-	return orgStringifier
-
-# ---------------------------------------------------------------------------
-
-export resetStringifier = () ->
-
-	setStringifier orderedStringify
-
-# ---------------------------------------------------------------------------
-
-export setLogger = (func) ->
-
-	assert isFunction(func), "setLogger() arg is not a function"
-	orgLogger = putstr
-	putstr = func
-	return orgLogger
-
-# ---------------------------------------------------------------------------
-
-export resetLogger = () ->
-
-	setLogger console.log
-
-# ---------------------------------------------------------------------------
-
-export tamlStringify = (obj, escape=false) ->
-
-	return toTAML(obj, {
-		useTabs: false
-		sortKeys: false
-		escape
-		})
-
-# ---------------------------------------------------------------------------
-
-export orderedStringify = (obj, escape=false) ->
-
-	return toTAML(obj, {
-		useTabs: false
-		sortKeys: true
-		escape
-		})
-
-# ---------------------------------------------------------------------------
-
-maxOneLine = 32
-
-# ---------------------------------------------------------------------------
-
-export log = (str, prefix='') ->
-
-	assert isString(prefix), "not a string: #{OL(prefix)}"
-	assert isString(str),      "log(): not a string: #{OL(str)}"
-	assert isFunction(putstr), "putstr not properly set"
-	prefix = fixForTerminal(prefix)
-
-	if doDebugLog
-		LOG "CALL log(#{OL(str)}), prefix = #{OL(prefix)}"
-
-	putstr "#{prefix}#{str}"
-	return true   # to allow use in boolean expressions
-
-# ---------------------------------------------------------------------------
-
-export logBareItem = (item, pre='') ->
-
-	logItem undef, item, pre
-	return
-
-# ---------------------------------------------------------------------------
-
-export logItem = (label, item, pre='', itemPre=undef) ->
-
-	assert isString(pre), "not a string: #{OL(pre)}"
-	assert isFunction(putstr), "putstr not properly set"
-	assert !label || isString(label), "label a non-string"
-	if (itemPre == undef)
-		itemPre = pre
-
-	assert pre.indexOf("\t") == -1, "pre has TAB"
-	assert itemPre.indexOf("\t") == -1, "itemPre has TAB"
-
-	if doDebugLog
-		LOG "CALL logItem(#{OL(label)}, #{OL(item)})"
-		LOG "pre = #{OL(pre)}"
-		LOG "itemPre = #{OL(itemPre)}"
-
-	if label
-		labelStr = "#{label} = "
-	else
-		labelStr = ""
-
-	if (item == undef)
-		putstr "#{pre}#{labelStr}undef"
-	else if (item == null)
-		putstr "#{pre}#{labelStr}null"
-	else if isNumber(item)
-		putstr "#{pre}#{labelStr}#{item}"
-	else if isString(item)
-		if (item.length <= maxOneLine)
-			result = escapeStr(item)
-			hasApos = (result.indexOf("'") >= 0)
-			if hasApos
-				putstr "#{pre}#{labelStr}\"#{result}\""
-			else
-				putstr "#{pre}#{labelStr}'#{result}'"
-		else
-			if label
-				putstr "#{pre}#{label}:"
-			putBlock item, itemPre
-	else
-		if label
-			putstr "#{pre}#{label}:"
-
-		# --- escape special chars
-		for str in toArray(stringify(item, true))
-			putstr "#{itemPre}#{str}"
-
-	return true
-
-# ---------------------------------------------------------------------------
-
-export shortEnough = (label, value) ->
-
-	return (value == undef)
-
-# ---------------------------------------------------------------------------
-# --- needed because Windows Terminal handles TAB chars badly
-
-fixForTerminal = (str) ->
-
-	if !str
-		return ''
-
-	# --- convert TAB char to 4 spaces
-	return str.replace(/\t/g, fourSpaces)
-
-# ---------------------------------------------------------------------------
-
-putBlock = (item, prefix='') ->
-
-	putstr "#{prefix}#{sep_eq}"
-	for line in toArray(item)
-		putstr "#{prefix}#{escapeStr(line)}"
-	putstr "#{prefix}#{sep_eq}"
-	return
-
-# ---------------------------------------------------------------------------
-
-if ! loaded
-	setStringifier orderedStringify
-	resetLogger()
-loaded = true

package/src/log.js

@@ -1,206 +0,0 @@
-// Generated by CoffeeScript 2.7.0
-// log.coffee
-var doDebugLog, fixForTerminal, fourSpaces, loaded, maxOneLine, putBlock, putstr;
-
-import {
-  LOG,
-  assert,
-  croak
-} from '@jdeighan/exceptions';
-
-import {
-  undef,
-  isNumber,
-  isInteger,
-  isString,
-  isHash,
-  isFunction,
-  escapeStr,
-  sep_eq,
-  sep_dash,
-  pass,
-  OL
-} from '@jdeighan/coffee-utils';
-
-import {
-  toArray
-} from '@jdeighan/coffee-utils/block';
-
-import {
-  toTAML
-} from '@jdeighan/coffee-utils/taml';
-
-// --- This logger only ever gets passed a single string argument
-putstr = undef;
-
-doDebugLog = false;
-
-export var stringify = undef;
-
-fourSpaces = '    ';
-
-// ---------------------------------------------------------------------------
-export var debugLog = function(flag = true) {
-  doDebugLog = flag;
-  if (doDebugLog) {
-    LOG(`doDebugLog = ${flag}`);
-  }
-};
-
-// ---------------------------------------------------------------------------
-export var setStringifier = function(func) {
-  var orgStringifier;
-  orgStringifier = stringify;
-  assert(isFunction(func), "setStringifier() arg is not a function");
-  stringify = func;
-  return orgStringifier;
-};
-
-// ---------------------------------------------------------------------------
-export var resetStringifier = function() {
-  return setStringifier(orderedStringify);
-};
-
-// ---------------------------------------------------------------------------
-export var setLogger = function(func) {
-  var orgLogger;
-  assert(isFunction(func), "setLogger() arg is not a function");
-  orgLogger = putstr;
-  putstr = func;
-  return orgLogger;
-};
-
-// ---------------------------------------------------------------------------
-export var resetLogger = function() {
-  return setLogger(console.log);
-};
-
-// ---------------------------------------------------------------------------
-export var tamlStringify = function(obj, escape = false) {
-  return toTAML(obj, {
-    useTabs: false,
-    sortKeys: false,
-    escape
-  });
-};
-
-// ---------------------------------------------------------------------------
-export var orderedStringify = function(obj, escape = false) {
-  return toTAML(obj, {
-    useTabs: false,
-    sortKeys: true,
-    escape
-  });
-};
-
-// ---------------------------------------------------------------------------
-maxOneLine = 32;
-
-// ---------------------------------------------------------------------------
-export var log = function(str, prefix = '') {
-  assert(isString(prefix), `not a string: ${OL(prefix)}`);
-  assert(isString(str), `log(): not a string: ${OL(str)}`);
-  assert(isFunction(putstr), "putstr not properly set");
-  prefix = fixForTerminal(prefix);
-  if (doDebugLog) {
-    LOG(`CALL log(${OL(str)}), prefix = ${OL(prefix)}`);
-  }
-  putstr(`${prefix}${str}`);
-  return true; // to allow use in boolean expressions
-};
-
-
-// ---------------------------------------------------------------------------
-export var logBareItem = function(item, pre = '') {
-  logItem(undef, item, pre);
-};
-
-// ---------------------------------------------------------------------------
-export var logItem = function(label, item, pre = '', itemPre = undef) {
-  var hasApos, i, labelStr, len, ref, result, str;
-  assert(isString(pre), `not a string: ${OL(pre)}`);
-  assert(isFunction(putstr), "putstr not properly set");
-  assert(!label || isString(label), "label a non-string");
-  if (itemPre === undef) {
-    itemPre = pre;
-  }
-  assert(pre.indexOf("\t") === -1, "pre has TAB");
-  assert(itemPre.indexOf("\t") === -1, "itemPre has TAB");
-  if (doDebugLog) {
-    LOG(`CALL logItem(${OL(label)}, ${OL(item)})`);
-    LOG(`pre = ${OL(pre)}`);
-    LOG(`itemPre = ${OL(itemPre)}`);
-  }
-  if (label) {
-    labelStr = `${label} = `;
-  } else {
-    labelStr = "";
-  }
-  if (item === undef) {
-    putstr(`${pre}${labelStr}undef`);
-  } else if (item === null) {
-    putstr(`${pre}${labelStr}null`);
-  } else if (isNumber(item)) {
-    putstr(`${pre}${labelStr}${item}`);
-  } else if (isString(item)) {
-    if (item.length <= maxOneLine) {
-      result = escapeStr(item);
-      hasApos = result.indexOf("'") >= 0;
-      if (hasApos) {
-        putstr(`${pre}${labelStr}\"${result}\"`);
-      } else {
-        putstr(`${pre}${labelStr}'${result}'`);
-      }
-    } else {
-      if (label) {
-        putstr(`${pre}${label}:`);
-      }
-      putBlock(item, itemPre);
-    }
-  } else {
-    if (label) {
-      putstr(`${pre}${label}:`);
-    }
-    ref = toArray(stringify(item, true));
-    // --- escape special chars
-    for (i = 0, len = ref.length; i < len; i++) {
-      str = ref[i];
-      putstr(`${itemPre}${str}`);
-    }
-  }
-  return true;
-};
-
-// ---------------------------------------------------------------------------
-export var shortEnough = function(label, value) {
-  return value === undef;
-};
-
-// ---------------------------------------------------------------------------
-// --- needed because Windows Terminal handles TAB chars badly
-fixForTerminal = function(str) {
-  if (!str) {
-    return '';
-  }
-  // --- convert TAB char to 4 spaces
-  return str.replace(/\t/g, fourSpaces);
-};
-
-// ---------------------------------------------------------------------------
-putBlock = function(item, prefix = '') {
-  var i, len, line, ref;
-  putstr(`${prefix}${sep_eq}`);
-  ref = toArray(item);
-  for (i = 0, len = ref.length; i < len; i++) {
-    line = ref[i];
-    putstr(`${prefix}${escapeStr(line)}`);
-  }
-  putstr(`${prefix}${sep_eq}`);
-};
-
-if (!loaded) {
-  setStringifier(orderedStringify);
-  resetLogger();
-}
-
-loaded = true;

package/src/stack.coffee

@@ -1,169 +0,0 @@
-# stack.coffee
-
-import {assert, croak} from '@jdeighan/exceptions'
-import {
-	undef, defined, OL,  escapeStr, deepCopy,
-	isArray, isBoolean,
-	} from '@jdeighan/coffee-utils'
-
-doDebugStack = false
-
-# ---------------------------------------------------------------------------
-
-export debugStack = (flag=true) ->
-
-	doDebugStack = flag
-	return
-
-# ---------------------------------------------------------------------------
-
-export class CallStack
-
-	constructor: () ->
-
-		@lStack = []
-
-	# ........................................................................
-
-	reset: () ->
-
-		if doDebugStack
-			console.log "RESET STACK"
-		@lStack = []
-		return
-
-	# ........................................................................
-
-	indent: () ->
-
-		return '   '.repeat(@lStack.length)
-
-	# ........................................................................
-
-	enter: (funcName, lArgs=[], isLogged) ->
-		# --- funcName might be <object>.<method>
-
-		assert isArray(lArgs), "missing lArgs"
-		assert isBoolean(isLogged), "missing isLogged"
-
-		if doDebugStack
-			console.log @indent() + "[--> ENTER #{funcName}]"
-
-		lMatches = funcName.match(///^
-				([A-Za-z_][A-Za-z0-9_]*)
-				(?:
-					\.
-					([A-Za-z_][A-Za-z0-9_]*)
-					)?
-				$///)
-		assert defined(lMatches), "Bad funcName: #{OL(funcName)}"
-		[_, ident1, ident2] = lMatches
-		if ident2
-			hStackItem = {
-				fullName: funcName     #    "#{ident1}.#{ident2}"
-				funcName: ident2
-				isLogged
-				lArgs: deepCopy(lArgs)
-				}
-		else
-			hStackItem = {
-				fullName: funcName
-				funcName: ident1
-				isLogged
-				lArgs: deepCopy(lArgs)
-				}
-		@lStack.push hStackItem
-		return hStackItem
-
-	# ........................................................................
-
-	getLevel: () ->
-
-		level = 0
-		for item in @lStack
-			if item.isLogged
-				level += 1
-		return level
-
-	# ........................................................................
-
-	isLogging: () ->
-
-		if (@lStack.length == 0)
-			return false
-		else
-			return @lStack[@lStack.length - 1].isLogged
-
-	# ........................................................................
-	# --- if stack is empty, log the error, but continue
-
-	returnFrom: (fName) ->
-
-		if @lStack.length == 0
-			console.log "ERROR: returnFrom('#{fName}') but stack is empty"
-			return
-		{fullName, isLogged} = @lStack.pop()
-		if doDebugStack
-			console.log @indent() + "[<-- BACK #{fName}]"
-		if (fullName != fName)
-			console.log "ERROR: returnFrom('#{fName}') but TOS is #{fullName}"
-			return
-
-		return
-
-	# ........................................................................
-
-	curFunc: () ->
-
-		if (@lStack.length == 0)
-			return 'main'
-		else
-			return @lStack[@lStack.length - 1].funcName
-
-	# ........................................................................
-
-	isActive: (funcName) ->
-		# --- funcName won't be <obj>.<method>
-		#     but the stack might contain that form
-
-		for h in @lStack
-			if (h.funcName == funcName)
-				return true
-		return false
-
-	# ........................................................................
-
-	dump: (label="CALL STACK") ->
-
-		lLines = [label]
-		if @lStack.length == 0
-			lLines.push "   <EMPTY>"
-		else
-			for item, i in @lStack
-				lLines.push "   " + @callStr(i, item)
-		return lLines.join("\n")
-
-	# ........................................................................
-
-	callStr: (i, item) ->
-
-		sym = if item.isLogged then '*' else '-'
-		str = "#{i}: #{sym}#{item.fullName}"
-		for arg in item.lArgs
-			str += " #{OL(arg)}"
-		return str
-
-	# ........................................................................
-
-	sdump: (label='CALL STACK') ->
-
-		lFuncNames = []
-		for item in @lStack
-			if item.isLogged
-				lFuncNames.push '*' + item.fullName
-			else
-				lFuncNames.push item.fullName
-		if @lStack.length == 0
-			return "#{label} <EMPTY>"
-		else
-			return "#{label} #{lFuncNames.join(' ')}"