@jdeighan/coffee-utils 4.0.23 → 4.1.3

package/.save/utils.test.js

@@ -0,0 +1,319 @@
+// Generated by CoffeeScript 2.6.1
+// utils.test.coffee
+var hEsc, simple;
+
+import {
+  UnitTester
+} from '@jdeighan/coffee-utils/test';
+
+import {
+  say,
+  undef,
+  error,
+  warn,
+  isString,
+  isObject,
+  isArray,
+  isHash,
+  isEmpty,
+  nonEmpty,
+  isComment,
+  getClassName,
+  isNumber,
+  isFunction,
+  isInteger,
+  rtrim,
+  ltrunc,
+  rtrunc,
+  extractMatches,
+  words,
+  escapeStr,
+  titleLine,
+  removeCR,
+  CWS,
+  isArrayOfHashes,
+  oneline,
+  croak,
+  isRegExp
+} from '@jdeighan/coffee-utils';
+
+import {
+  setLogger
+} from '@jdeighan/coffee-utils/log';
+
+import {
+  setDebugging
+} from '@jdeighan/coffee-utils/debug';
+
+import {
+  arrayToBlock
+} from '@jdeighan/coffee-utils/block';
+
+simple = new UnitTester();
+
+// ---------------------------------------------------------------------------
+simple.truthy(19, isEmpty(''));
+
+simple.truthy(20, isEmpty('  \t\t'));
+
+simple.truthy(21, isEmpty([]));
+
+simple.truthy(22, isEmpty({}));
+
+simple.truthy(24, nonEmpty('a'));
+
+simple.truthy(25, nonEmpty('.'));
+
+simple.truthy(26, nonEmpty([2]));
+
+simple.truthy(27, nonEmpty({
+  width: 2
+}));
+
+simple.truthy(29, isComment("# a comment"));
+
+simple.truthy(30, isComment("### a comment"));
+
+simple.truthy(31, isComment("#\ta comment"));
+
+simple.truthy(32, isComment("###\ta comment"));
+
+simple.truthy(33, isComment("   # a comment"));
+
+simple.truthy(34, isComment("   ### a comment"));
+
+simple.falsy(35, isComment("not much"));
+
+simple.falsy(36, isComment("#foreach x in lItems"));
+
+simple.truthy(37, isComment('#'));
+
+simple.truthy(38, isComment('   #'));
+
+simple.truthy(39, isComment('   ###'));
+
+simple.falsy(40, isComment('#for'));
+
+simple.falsy(41, isComment('   #for'));
+
+simple.falsy(42, isComment('#for line in lLines'));
+
+simple.equal(44, titleLine('a thing').length, 42);
+
+simple.equal(45, titleLine('a thing', '-', 5, 90).length, 90);
+
+// ---------------------------------------------------------------------------
+simple.equal(80, rtrim("abc"), "abc");
+
+simple.equal(81, rtrim("  abc"), "  abc");
+
+simple.equal(82, rtrim("abc  "), "abc");
+
+simple.equal(83, rtrim("  abc  "), "  abc");
+
+// ---------------------------------------------------------------------------
+simple.equal(87, words('a b c'), ['a', 'b', 'c']);
+
+simple.equal(88, words('  a   b   c  '), ['a', 'b', 'c']);
+
+// ---------------------------------------------------------------------------
+simple.equal(92, escapeStr("\t\tXXX\n"), "\\t\\tXXX\\n");
+
+hEsc = {
+  "\n": "\\n",
+  "\t": "\\t",
+  "\"": "\\\""
+};
+
+simple.equal(64, escapeStr("\thas quote: \"\nnext line", hEsc), "\\thas quote: \\\"\\nnext line");
+
+// ---------------------------------------------------------------------------
+simple.equal(130, rtrunc('/user/lib/.env', 5), '/user/lib');
+
+simple.equal(131, ltrunc('abcdefg', 3), 'defg');
+
+simple.equal(133, removeCR("abc\r\ndef\r\n"), "abc\ndef\n");
+
+simple.equal(139, CWS(`abc
+def
+		ghi`), "abc def ghi");
+
+// ---------------------------------------------------------------------------
+simple.truthy(147, isArrayOfHashes([]));
+
+simple.truthy(148, isArrayOfHashes([{}, {}]));
+
+simple.truthy(149, isArrayOfHashes([
+  {
+    a: 1,
+    b: 2
+  },
+  {}
+]));
+
+simple.truthy(150, isArrayOfHashes([
+  {
+    a: 1,
+    b: 2,
+    c: [1,
+  2,
+  3]
+  },
+  {}
+]));
+
+simple.falsy(152, isArrayOfHashes({}));
+
+simple.falsy(153, isArrayOfHashes([1, 2, 3]));
+
+simple.falsy(154, isArrayOfHashes([
+  {
+    a: 1,
+    b: 2,
+    c: [1,
+  2,
+  3]
+  },
+  4
+]));
+
+simple.falsy(155, isArrayOfHashes([
+  {
+    a: 1,
+    b: 2,
+    c: [1,
+  2,
+  3]
+  },
+  {},
+  [1,
+  2]
+]));
+
+// ---------------------------------------------------------------------------
+(function() {
+  var NewClass, h, l, n, n2, o, s, s2;
+  NewClass = class NewClass {};
+  h = {
+    a: 1,
+    b: 2
+  };
+  l = [1, 2, 2];
+  o = new NewClass();
+  n = 42;
+  n2 = new Number(42);
+  s = 'simple';
+  s2 = new String('abc');
+  simple.truthy(170, isHash(h));
+  simple.falsy(171, isHash(l));
+  simple.falsy(172, isHash(o));
+  simple.falsy(173, isHash(n));
+  simple.falsy(174, isHash(n2));
+  simple.falsy(175, isHash(s));
+  simple.falsy(176, isHash(s2));
+  simple.falsy(178, isArray(h));
+  simple.truthy(179, isArray(l));
+  simple.falsy(180, isArray(o));
+  simple.falsy(181, isArray(n));
+  simple.falsy(182, isArray(n2));
+  simple.falsy(183, isArray(s));
+  simple.falsy(184, isArray(s2));
+  simple.falsy(186, isString(h));
+  simple.falsy(187, isString(l));
+  simple.falsy(188, isString(o));
+  simple.falsy(189, isString(n));
+  simple.falsy(190, isString(n2));
+  simple.truthy(191, isString(s));
+  simple.truthy(192, isString(s2));
+  simple.falsy(194, isObject(h));
+  simple.falsy(195, isObject(l));
+  simple.truthy(196, isObject(o));
+  simple.falsy(197, isObject(n));
+  simple.falsy(198, isObject(n2));
+  simple.falsy(199, isObject(s));
+  simple.falsy(200, isObject(s2));
+  simple.falsy(202, isNumber(h));
+  simple.falsy(203, isNumber(l));
+  simple.falsy(204, isNumber(o));
+  simple.truthy(205, isNumber(n));
+  simple.truthy(206, isNumber(n2));
+  simple.falsy(207, isNumber(s));
+  return simple.falsy(208, isNumber(s2));
+})();
+
+// ---------------------------------------------------------------------------
+simple.truthy(214, isFunction(function() {
+  return pass;
+}));
+
+simple.falsy(215, isFunction(23));
+
+simple.truthy(217, isInteger(42));
+
+simple.truthy(218, isInteger(new Number(42)));
+
+simple.falsy(219, isInteger('abc'));
+
+simple.falsy(220, isInteger({}));
+
+simple.falsy(221, isInteger([]));
+
+// ---------------------------------------------------------------------------
+simple.equal(233, oneline(undef), "undef");
+
+simple.equal(234, oneline("\t\tabc\nxyz"), "'\\t\\tabc\\nxyz'");
+
+simple.equal(235, oneline({
+  a: 1,
+  b: 'xyz'
+}), '{"a":1,"b":"xyz"}');
+
+// ---------------------------------------------------------------------------
+simple.equal(239, CWS(`a simple
+error message`), "a simple error message");
+
+// ---------------------------------------------------------------------------
+// test croak()
+(function() {
+  var lLines, obj;
+  lLines = [];
+  setLogger(function(line) {
+    return lLines.push(line);
+  });
+  obj = {
+    a: 1,
+    b: 2
+  };
+  try {
+    croak("bad stuff", "An Object", obj);
+  } catch (error1) {}
+  simple.equal(255, arrayToBlock(lLines), `ERROR: bad stuff
+An Object = {"a":1,"b":2}`);
+  return setLogger();
+})();
+
+// ---------------------------------------------------------------------------
+// test isRegExp()
+simple.truthy(265, isRegExp(/^abc$/));
+
+simple.truthy(266, isRegExp(/^\s*where\s+areyou$/));
+
+simple.falsy(272, isRegExp(42));
+
+simple.falsy(272, isRegExp('abc'));
+
+simple.falsy(272, isRegExp([1, 'a']));
+
+simple.falsy(272, isRegExp({
+  a: 1,
+  b: 'ccc'
+}));
+
+simple.falsy(272, isRegExp(undef));
+
+simple.truthy(278, isRegExp(/\.coffee/));
+
+// ---------------------------------------------------------------------------
+simple.equal(212, extractMatches("..3 and 4 plus 5", /\d+/g, parseInt), [3, 4, 5]);
+
+simple.equal(214, extractMatches("And This Is A String", /A/g), ['A', 'A']);

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "4.0.23",
+	"version": "4.1.3",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {
@@ -20,10 +20,10 @@
 		"node": ">=12.0.0"
 	},
 	"scripts": {
-		"build": "cls && coffee -c .",
-		"pretest": "cls && coffee -c .",
+		"build": "cls && rm -f ./src/*.js && coffee -c ./src",
+		"pretest": "npm run build && rm -f ./test/*.js && rm -f ./test/*.coffee && cielo -fq ./test",
 		"test": "ava ./test/*.test.js",
-		"prefinaltest": "cls && coffee -c .",
+		"prefinaltest": "npm run pretest",
 		"finaltest": "cross-env FINALTEST=yes ava ./test/*.test.js"
 	},
 	"repository": {
@@ -42,6 +42,7 @@
 	"dependencies": {
 		"ava": "^3.15.0",
 		"cross-env": "^7.0.3",
-		"js-yaml": "^4.1.0"
+		"js-yaml": "^4.1.0",
+		"readline-sync": "^1.4.10"
 	}
 }

package/src/UnitTester.coffee

@@ -8,9 +8,7 @@ import {
 	} from '@jdeighan/coffee-utils'
 import {blockToArray} from '@jdeighan/coffee-utils/block'
 import {log, currentLogger, setLogger} from '@jdeighan/coffee-utils/log'
-import {
-	debug, debugging, setDebugging,
-	} from '@jdeighan/coffee-utils/debug'
+import {debug, debugging, setDebugging} from '@jdeighan/coffee-utils/debug'
 
 # ---------------------------------------------------------------------------
 
@@ -175,6 +173,9 @@ export class UnitTester
 
 	test: (lineNum, input, expected) ->
 
+		assert isInteger(lineNum),
+			"UnitTester.test(): arg 1 must be an integer"
+
 		@initialize()
 		@lineNum = lineNum    # set an object property
 
@@ -187,9 +188,6 @@ export class UnitTester
 		if lineNum < -100000
 			setDebugging true
 
-		assert isInteger(lineNum),
-			"UnitTester.test(): arg 1 must be an integer"
-
 		lineNum = @getLineNum(lineNum)   # corrects for duplicates
 		errMsg = undef
 		try
@@ -200,6 +198,7 @@ export class UnitTester
 			errMsg = err.message || 'UNKNOWN ERROR'
 			log "got ERROR: #{errMsg}"
 
+		expected = @transformExpected(expected)
 		if isString(expected)
 			expected = @normalize(expected)
 
@@ -236,6 +235,11 @@ export class UnitTester
 
 	# ........................................................................
 
+	transformExpected: (input) ->
+		return input
+
+	# ........................................................................
+
 	getLineNum: (lineNum) ->
 
 		if @fulltest && (lineNum < 0)

package/src/UnitTester.js

@@ -185,6 +185,7 @@ export var UnitTester = class UnitTester {
   // ........................................................................
   test(lineNum, input, expected) {
     var err, errMsg, got, whichTest;
+    assert(isInteger(lineNum), "UnitTester.test(): arg 1 must be an integer");
     this.initialize();
     this.lineNum = lineNum; // set an object property
     if ((lineNum < 0) && process.env.FINALTEST) {
@@ -196,7 +197,6 @@ export var UnitTester = class UnitTester {
     if (lineNum < -100000) {
       setDebugging(true);
     }
-    assert(isInteger(lineNum), "UnitTester.test(): arg 1 must be an integer");
     lineNum = this.getLineNum(lineNum); // corrects for duplicates
     errMsg = undef;
     try {
@@ -209,6 +209,7 @@ export var UnitTester = class UnitTester {
       errMsg = err.message || 'UNKNOWN ERROR';
       log(`got ERROR: ${errMsg}`);
     }
+    expected = this.transformExpected(expected);
     if (isString(expected)) {
       expected = this.normalize(expected);
     }
@@ -248,6 +249,11 @@ export var UnitTester = class UnitTester {
     return input;
   }
 
+  // ........................................................................
+  transformExpected(input) {
+    return input;
+  }
+
   // ........................................................................
   getLineNum(lineNum) {
     if (this.fulltest && (lineNum < 0)) {

package/src/coffee_utils.coffee

@@ -1,5 +1,6 @@
 # coffee_utils.coffee
 
+import getline from 'readline-sync'
 import {log} from '@jdeighan/coffee-utils/log'
 
 export sep_dash = '-'.repeat(42)
@@ -212,9 +213,9 @@ export warn = (message) ->
 #   say - print to the console (for now)
 #         later, on a web page, call alert(str)
 
-export say = (str, obj=undef) ->
+export say = (str) ->
 
-	log str, obj
+	console.log str
 	return
 
 # ---------------------------------------------------------------------------
@@ -223,7 +224,8 @@ export say = (str, obj=undef) ->
 
 export ask = (prompt) ->
 
-	return 'yes'
+	answer = getline.question("{prompt}? ")
+	return answer
 
 # ---------------------------------------------------------------------------
 

package/src/coffee_utils.js

@@ -2,6 +2,8 @@
 // coffee_utils.coffee
 var commentRegExp;
 
+import getline from 'readline-sync';
+
 import {
   log
 } from '@jdeighan/coffee-utils/log';
@@ -217,15 +219,17 @@ export var warn = function(message) {
 // ---------------------------------------------------------------------------
 //   say - print to the console (for now)
 //         later, on a web page, call alert(str)
-export var say = function(str, obj = undef) {
-  log(str, obj);
+export var say = function(str) {
+  console.log(str);
 };
 
 // ---------------------------------------------------------------------------
 //   ask - ask a question
 //         later, on a web page, prompt the user for answer to question
 export var ask = function(prompt) {
-  return 'yes';
+  var answer;
+  answer = getline.question("{prompt}? ");
+  return answer;
 };
 
 // ---------------------------------------------------------------------------

package/src/debug_utils.coffee

@@ -5,7 +5,7 @@ import {
 	oneline, escapeStr, isNumber, isArray,
 	} from '@jdeighan/coffee-utils'
 import {blockToArray} from '@jdeighan/coffee-utils/block'
-import {log} from '@jdeighan/coffee-utils/log'
+import {log, setLogger} from '@jdeighan/coffee-utils/log'
 import {slurp} from '@jdeighan/coffee-utils/fs'
 
 vbar = '│'       # unicode 2502
@@ -23,7 +23,28 @@ lDebugStack = []
 # --- These are saved/restored in lDebugStack
 export debugging = false
 ifMatches = undef
-lDebugFuncs = undef
+lDebugFuncs = undef   # --- names of functions to debug
+
+stdLogger = false
+
+# ---------------------------------------------------------------------------
+
+export useStdLogger = (flag=true) ->
+
+	stdLogger = flag
+	return
+
+# ---------------------------------------------------------------------------
+
+logger = (lArgs...) ->
+
+	if stdLogger
+		log lArgs...
+	else
+		orgLogger = setLogger(console.log)
+		log lArgs...
+		setLogger(orgLogger)
+	return
 
 # ---------------------------------------------------------------------------
 
@@ -158,9 +179,9 @@ export debug = (lArgs...) ->
 			prefix = indent.repeat(debugLevel)
 
 		if (nArgs==1)
-			log str, item, {prefix}
+			logger str, item, {prefix}
 		else
-			log str, item, {
+			logger str, item, {
 				prefix,
 				logItem: true,
 				itemPrefix: stripArrow(prefix),
@@ -222,15 +243,15 @@ export checkTrace = (block) ->
 			funcName = lMatches[1]
 			len = lStack.length
 			if (len == 0)
-				log "return from #{funcName} with empty stack"
+				logger "return from #{funcName} with empty stack"
 			else if (lStack[len-1] == funcName)
 				lStack.pop()
 			else if (lStack[len-2] == funcName)
-				log "missing return from #{lStack[len-2]}"
+				logger "missing return from #{lStack[len-2]}"
 				lStack.pop()
 				lStack.pop()
 			else
-				log "return from #{funcName} - not found on stack"
+				logger "return from #{funcName} - not found on stack"
 	return
 
 # ---------------------------------------------------------------------------

package/src/debug_utils.js

@@ -1,6 +1,6 @@
 // Generated by CoffeeScript 2.6.1
 // debug_utils.coffee
-var arrow, arrowhead, corner, debugLevel, getPrefix, hbar, ifMatches, indent, lDebugFuncs, lDebugStack, reMethod, restoreDebugEnv, saveDebugEnv, stripArrow, vbar;
+var arrow, arrowhead, corner, debugLevel, getPrefix, hbar, ifMatches, indent, lDebugFuncs, lDebugStack, logger, reMethod, restoreDebugEnv, saveDebugEnv, stdLogger, stripArrow, vbar;
 
 import {
   assert,
@@ -22,7 +22,8 @@ import {
 } from '@jdeighan/coffee-utils/block';
 
 import {
-  log
+  log,
+  setLogger
 } from '@jdeighan/coffee-utils/log';
 
 import {
@@ -50,7 +51,26 @@ export var debugging = false;
 
 ifMatches = undef;
 
-lDebugFuncs = undef;
+lDebugFuncs = undef; // --- names of functions to debug
+
+stdLogger = false;
+
+// ---------------------------------------------------------------------------
+export var useStdLogger = function(flag = true) {
+  stdLogger = flag;
+};
+
+// ---------------------------------------------------------------------------
+logger = function(...lArgs) {
+  var orgLogger;
+  if (stdLogger) {
+    log(...lArgs);
+  } else {
+    orgLogger = setLogger(console.log);
+    log(...lArgs);
+    setLogger(orgLogger);
+  }
+};
 
 // ---------------------------------------------------------------------------
 stripArrow = function(prefix) {
@@ -157,9 +177,9 @@ export var debug = function(...lArgs) {
       prefix = indent.repeat(debugLevel);
     }
     if (nArgs === 1) {
-      log(str, item, {prefix});
+      logger(str, item, {prefix});
     } else {
-      log(str, item, {
+      logger(str, item, {
         prefix,
         logItem: true,
         itemPrefix: stripArrow(prefix)
@@ -208,15 +228,15 @@ export var checkTrace = function(block) {
       funcName = lMatches[1];
       len = lStack.length;
       if (len === 0) {
-        log(`return from ${funcName} with empty stack`);
+        logger(`return from ${funcName} with empty stack`);
       } else if (lStack[len - 1] === funcName) {
         lStack.pop();
       } else if (lStack[len - 2] === funcName) {
-        log(`missing return from ${lStack[len - 2]}`);
+        logger(`missing return from ${lStack[len - 2]}`);
         lStack.pop();
         lStack.pop();
       } else {
-        log(`return from ${funcName} - not found on stack`);
+        logger(`return from ${funcName} - not found on stack`);
       }
     }
   }