@jdeighan/coffee-utils 6.0.7 → 7.0.0

package/src/log_utils.coffee

@@ -4,17 +4,15 @@ import yaml from 'js-yaml'
 
 import {
 	assert, undef, isNumber, isInteger, isString, isHash, isFunction,
-	escapeStr, sep_eq, sep_dash
+	escapeStr, sep_eq, sep_dash, pass
 	} from '@jdeighan/coffee-utils'
 import {blockToArray} from '@jdeighan/coffee-utils/block'
 import {tabify, untabify, indentation} from '@jdeighan/coffee-utils/indent'
-import {arrow, hasArrow, removeArrow} from '@jdeighan/coffee-utils/arrow'
 
 # --- This logger only ever gets passed a single string argument
 putstr = undef
 
 export stringify = undef
-objSep = '-'.repeat(42)
 
 # ---------------------------------------------------------------------------
 # This is useful for debugging and easy to remove after debugging
@@ -23,13 +21,13 @@ export LOG = (lArgs...) ->
 
 	[label, item] = lArgs
 	if lArgs.length > 1
-		console.log objSep
+		console.log sep_dash
 		if item?
 			console.log "#{label}:"
 			console.log untabify(orderedStringify(item))
 		else
 			console.log "[#{label}]: UNDEFINED"
-		console.log objSep
+		console.log sep_dash
 	else
 		console.log label
 	return
@@ -107,61 +105,77 @@ maxOneLine = 32
 
 # ---------------------------------------------------------------------------
 
-export log = (item, hOptions={}) ->
+fixStr = (str) ->
+
+	if !str
+		return ''
+
+	# --- If putstr is console.log, we'll convert TAB char to 3 spaces
+	if putstr == console.log
+		return untabify(str)
+	else
+		return str
+
+# ---------------------------------------------------------------------------
+
+export log = (str, hOptions={}) ->
 	# --- valid options:
-	#   label
 	#   prefix
-	#   itemPrefix
-	#   escape
 
 	assert isFunction(putstr), "putstr not properly set"
-	if isString(hOptions)
-		label = hOptions
-		prefix = itemPrefix = ''
-	else
-		assert isHash(hOptions), "log(): 2nd arg must be a string or hash"
-		label = hOptions.label || ''
-		prefix = hOptions.prefix ||  ''
-		itemPrefix = hOptions.itemPrefix || prefix || ''
+	assert isString(str),      "log(): not a string"
+	assert isHash(hOptions),   "log(): arg 2 not a hash"
 
-	# --- If putstr is console.log, we'll convert TAB char to 3 spaces
-	if putstr == console.log
-		label = untabify(label)
-		prefix = untabify(prefix)
-		itemPrefix = untabify(itemPrefix)
+	prefix = fixStr(hOptions.prefix)
+	putstr "#{prefix}#{str}"
+	return
 
-	if isString(item) && (label == '')
-		if hOptions.escape
-			putstr "#{prefix}#{escapeStr(item)}"
-		else
-			putstr "#{prefix}#{item}"
-		return
+# ---------------------------------------------------------------------------
 
-	if (label == '')
-		label = 'ITEM'
+export logItem = (label, item, hOptions={}) ->
+	# --- valid options:
+	#   prefix
+	#   itemPrefix
+
+	assert isFunction(putstr), "putstr not properly set"
+	assert !label || isString(label), "label a non-string"
+	assert isHash(hOptions), "arg 3 not a hash"
+
+	label = fixStr(label)
+	prefix = fixStr(hOptions.prefix)
+	itemPrefix = fixStr(hOptions.itemPrefix || prefix)
+
+	labelStr = if label then "#{label} = " else ""
 
 	if (item == undef)
-		putstr "#{prefix}#{label} = undef"
+		putstr "#{prefix}#{labelStr}undef"
 	else if isString(item)
 		if (item.length <= maxOneLine)
-			putstr "#{prefix}#{label} = '#{escapeStr(item)}'"
+			putstr "#{prefix}#{labelStr}'#{escapeStr(item)}'"
 		else
-			putstr "#{prefix}#{label}:"
-			putstr "#{itemPrefix}#{sep_eq}"
-			for line in blockToArray(item)
-				putstr "#{itemPrefix}#{escapeStr(line)}"
-			putstr "#{itemPrefix}#{sep_eq}"
+			if label
+				putstr "#{prefix}#{label}:"
+			putBlock item, itemPrefix
 	else if isNumber(item)
-		putstr "#{prefix}#{label} = #{item}"
+		putstr "#{prefix}#{labelStr}#{item}"
 	else
-		putstr "#{removeArrow(prefix, true)}#{objSep}"
-		putstr "#{prefix}#{label}:"
-		for str in blockToArray(stringify(item, true))
-			if putstr == console.log
-				putstr "#{itemPrefix}   #{untabify(str)}"
-			else
-				putstr "#{itemPrefix}#{indentation(1)}#{str}"
-		putstr "#{removeArrow(prefix, false)}#{objSep}"
+		putstr "#{itemPrefix}#{sep_dash}"
+		if label
+			putstr "#{prefix}#{label}:"
+		for str in blockToArray(stringify(item, true))  # escape special chars
+			putstr "#{itemPrefix}#{indentation(1)}#{fixStr(str)}"
+		putstr "#{itemPrefix}#{sep_dash}"
+
+	return
+
+# ---------------------------------------------------------------------------
+
+putBlock = (item, prefix='') ->
+
+	putstr "#{prefix}#{sep_eq}"
+	for line in blockToArray(item)
+		putstr "#{prefix}#{escapeStr(line)}"
+	putstr "#{prefix}#{sep_eq}"
 	return
 
 # ---------------------------------------------------------------------------

package/src/log_utils.js

@@ -1,6 +1,6 @@
 // Generated by CoffeeScript 2.6.1
 // log_utils.coffee
-var escReplacer, loaded, maxOneLine, objSep, putstr;
+var escReplacer, fixStr, loaded, maxOneLine, putBlock, putstr;
 
 import yaml from 'js-yaml';
 
@@ -14,7 +14,8 @@ import {
   isFunction,
   escapeStr,
   sep_eq,
-  sep_dash
+  sep_dash,
+  pass
 } from '@jdeighan/coffee-utils';
 
 import {
@@ -27,33 +28,25 @@ import {
   indentation
 } from '@jdeighan/coffee-utils/indent';
 
-import {
-  arrow,
-  hasArrow,
-  removeArrow
-} from '@jdeighan/coffee-utils/arrow';
-
 // --- This logger only ever gets passed a single string argument
 putstr = undef;
 
 export var stringify = undef;
 
-objSep = '-'.repeat(42);
-
 // ---------------------------------------------------------------------------
 // This is useful for debugging and easy to remove after debugging
 export var LOG = function(...lArgs) {
   var item, label;
   [label, item] = lArgs;
   if (lArgs.length > 1) {
-    console.log(objSep);
+    console.log(sep_dash);
     if (item != null) {
       console.log(`${label}:`);
       console.log(untabify(orderedStringify(item)));
     } else {
       console.log(`[${label}]: UNDEFINED`);
     }
-    console.log(objSep);
+    console.log(sep_dash);
   } else {
     console.log(label);
   }
@@ -132,71 +125,81 @@ export var orderedStringify = function(obj, escape = false) {
 maxOneLine = 32;
 
 // ---------------------------------------------------------------------------
-export var log = function(item, hOptions = {}) {
-  var i, itemPrefix, j, label, len, len1, line, prefix, ref, ref1, str;
-  // --- valid options:
-  //   label
-  //   prefix
-  //   itemPrefix
-  //   escape
-  assert(isFunction(putstr), "putstr not properly set");
-  if (isString(hOptions)) {
-    label = hOptions;
-    prefix = itemPrefix = '';
-  } else {
-    assert(isHash(hOptions), "log(): 2nd arg must be a string or hash");
-    label = hOptions.label || '';
-    prefix = hOptions.prefix || '';
-    itemPrefix = hOptions.itemPrefix || prefix || '';
+fixStr = function(str) {
+  if (!str) {
+    return '';
   }
   // --- If putstr is console.log, we'll convert TAB char to 3 spaces
   if (putstr === console.log) {
-    label = untabify(label);
-    prefix = untabify(prefix);
-    itemPrefix = untabify(itemPrefix);
-  }
-  if (isString(item) && (label === '')) {
-    if (hOptions.escape) {
-      putstr(`${prefix}${escapeStr(item)}`);
-    } else {
-      putstr(`${prefix}${item}`);
-    }
-    return;
-  }
-  if (label === '') {
-    label = 'ITEM';
+    return untabify(str);
+  } else {
+    return str;
   }
+};
+
+// ---------------------------------------------------------------------------
+export var log = function(str, hOptions = {}) {
+  var prefix;
+  // --- valid options:
+  //   prefix
+  assert(isFunction(putstr), "putstr not properly set");
+  assert(isString(str), "log(): not a string");
+  assert(isHash(hOptions), "log(): arg 2 not a hash");
+  prefix = fixStr(hOptions.prefix);
+  putstr(`${prefix}${str}`);
+};
+
+// ---------------------------------------------------------------------------
+export var logItem = function(label, item, hOptions = {}) {
+  var i, itemPrefix, labelStr, len, prefix, ref, str;
+  // --- valid options:
+  //   prefix
+  //   itemPrefix
+  assert(isFunction(putstr), "putstr not properly set");
+  assert(!label || isString(label), "label a non-string");
+  assert(isHash(hOptions), "arg 3 not a hash");
+  label = fixStr(label);
+  prefix = fixStr(hOptions.prefix);
+  itemPrefix = fixStr(hOptions.itemPrefix || prefix);
+  labelStr = label ? `${label} = ` : "";
   if (item === undef) {
-    putstr(`${prefix}${label} = undef`);
+    putstr(`${prefix}${labelStr}undef`);
   } else if (isString(item)) {
     if (item.length <= maxOneLine) {
-      putstr(`${prefix}${label} = '${escapeStr(item)}'`);
+      putstr(`${prefix}${labelStr}'${escapeStr(item)}'`);
     } else {
-      putstr(`${prefix}${label}:`);
-      putstr(`${itemPrefix}${sep_eq}`);
-      ref = blockToArray(item);
-      for (i = 0, len = ref.length; i < len; i++) {
-        line = ref[i];
-        putstr(`${itemPrefix}${escapeStr(line)}`);
+      if (label) {
+        putstr(`${prefix}${label}:`);
       }
-      putstr(`${itemPrefix}${sep_eq}`);
+      putBlock(item, itemPrefix);
     }
   } else if (isNumber(item)) {
-    putstr(`${prefix}${label} = ${item}`);
+    putstr(`${prefix}${labelStr}${item}`);
   } else {
-    putstr(`${removeArrow(prefix, true)}${objSep}`);
-    putstr(`${prefix}${label}:`);
-    ref1 = blockToArray(stringify(item, true));
-    for (j = 0, len1 = ref1.length; j < len1; j++) {
-      str = ref1[j];
-      if (putstr === console.log) {
-        putstr(`${itemPrefix}   ${untabify(str)}`);
-      } else {
-        putstr(`${itemPrefix}${indentation(1)}${str}`);
-      }
+    putstr(`${itemPrefix}${sep_dash}`);
+    if (label) {
+      putstr(`${prefix}${label}:`);
+    }
+    ref = blockToArray(stringify(item, true));
+    // escape special chars
+    for (i = 0, len = ref.length; i < len; i++) {
+      str = ref[i];
+      putstr(`${itemPrefix}${indentation(1)}${fixStr(str)}`);
     }
-    putstr(`${removeArrow(prefix, false)}${objSep}`);
+    putstr(`${itemPrefix}${sep_dash}`);
+  }
+};
+
+// ---------------------------------------------------------------------------
+putBlock = function(item, prefix = '') {
+  var i, len, line, ref;
+  putstr(`${prefix}${sep_eq}`);
+  ref = blockToArray(item);
+  for (i = 0, len = ref.length; i < len; i++) {
+    line = ref[i];
+    putstr(`${prefix}${escapeStr(line)}`);
   }
+  putstr(`${prefix}${sep_eq}`);
 };
 
 if (!loaded) {

package/src/taml.coffee

@@ -5,11 +5,12 @@ import yaml from 'js-yaml'
 import {
 	assert, undef, oneline, isString,
 	} from '@jdeighan/coffee-utils'
-import {untabify, tabify} from '@jdeighan/coffee-utils/indent'
-import {log, tamlStringify} from '@jdeighan/coffee-utils/log'
+import {untabify, tabify, splitLine} from '@jdeighan/coffee-utils/indent'
 import {slurp} from '@jdeighan/coffee-utils/fs'
 import {debug} from '@jdeighan/coffee-utils/debug'
-import {firstLine} from '@jdeighan/coffee-utils/block'
+import {
+	firstLine, blockToArray, arrayToBlock,
+	} from '@jdeighan/coffee-utils/block'
 
 # ---------------------------------------------------------------------------
 #   isTAML - is the string valid TAML?
@@ -18,6 +19,12 @@ export isTAML = (text) ->
 
 	return isString(text) && (firstLine(text).indexOf('---') == 0)
 
+# ---------------------------------------------------------------------------
+
+squote = (text) ->
+
+	return "'" + text.replace(/'/g, "''") + "'"
+
 # ---------------------------------------------------------------------------
 #   taml - convert valid TAML string to a JavaScript value
 
@@ -28,8 +35,27 @@ export taml = (text) ->
 		debug "return undef from taml() - text is not defined"
 		return undef
 	assert isTAML(text), "taml(): string #{oneline(text)} isn't TAML"
+
+	lLines = for line in blockToArray(text)
+		[level, str] = splitLine(line)
+		prefix = ' '.repeat(level)
+		if lMatches = line.match(///^
+				([A-Za-z_][A-Za-z0-9_]*)    # the key
+				\s*
+				:
+				\s*
+				(.*)
+				$///)
+			[_, key, text] = lMatches
+			if isEmpty(text) || text.match(/\d+(?:\.\d*)$/)
+				prefix + str
+			else
+				prefix + key + ':' + ' ' + squote(text)
+		else
+			prefix + str
+
 	debug "return from taml()"
-	return yaml.load(untabify(text, 1), {skipInvalid: true})
+	return yaml.load(arrayToBlock(lLines), {skipInvalid: true})
 
 # ---------------------------------------------------------------------------
 #   slurpTAML - read TAML from a file

package/src/taml.js

@@ -1,5 +1,7 @@
 // Generated by CoffeeScript 2.6.1
 // taml.coffee
+var squote;
+
 import yaml from 'js-yaml';
 
 import {
@@ -11,14 +13,10 @@ import {
 
 import {
   untabify,
-  tabify
+  tabify,
+  splitLine
 } from '@jdeighan/coffee-utils/indent';
 
-import {
-  log,
-  tamlStringify
-} from '@jdeighan/coffee-utils/log';
-
 import {
   slurp
 } from '@jdeighan/coffee-utils/fs';
@@ -28,7 +26,9 @@ import {
 } from '@jdeighan/coffee-utils/debug';
 
 import {
-  firstLine
+  firstLine,
+  blockToArray,
+  arrayToBlock
 } from '@jdeighan/coffee-utils/block';
 
 // ---------------------------------------------------------------------------
@@ -37,17 +37,44 @@ export var isTAML = function(text) {
   return isString(text) && (firstLine(text).indexOf('---') === 0);
 };
 
+// ---------------------------------------------------------------------------
+squote = function(text) {
+  return "'" + text.replace(/'/g, "''") + "'";
+};
+
 // ---------------------------------------------------------------------------
 //   taml - convert valid TAML string to a JavaScript value
 export var taml = function(text) {
+  var _, key, lLines, lMatches, level, line, prefix, str;
   debug(`enter taml(${oneline(text)})`);
   if (text == null) {
     debug("return undef from taml() - text is not defined");
     return undef;
   }
   assert(isTAML(text), `taml(): string ${oneline(text)} isn't TAML`);
+  lLines = (function() {
+    var i, len, ref, results;
+    ref = blockToArray(text);
+    results = [];
+    for (i = 0, len = ref.length; i < len; i++) {
+      line = ref[i];
+      [level, str] = splitLine(line);
+      prefix = ' '.repeat(level);
+      if (lMatches = line.match(/^([A-Za-z_][A-Za-z0-9_]*)\s*:\s*(.*)$/)) { // the key
+        [_, key, text] = lMatches;
+        if (isEmpty(text) || text.match(/\d+(?:\.\d*)$/)) {
+          results.push(prefix + str);
+        } else {
+          results.push(prefix + key + ':' + ' ' + squote(text));
+        }
+      } else {
+        results.push(prefix + str);
+      }
+    }
+    return results;
+  })();
   debug("return from taml()");
-  return yaml.load(untabify(text, 1), {
+  return yaml.load(arrayToBlock(lLines), {
     skipInvalid: true
   });
 };