@jdeighan/coffee-utils 10.0.7 → 10.0.10

package/package.json

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

package/src/block_utils.coffee

@@ -5,11 +5,12 @@ import readline from 'readline'
 
 import {assert, error, croak} from '@jdeighan/unit-tester/utils'
 import {
-	undef, defined, isEmpty, isString, isArray, nonEmpty, rtrim,
+	undef, pass, defined, isEmpty, isString, isArray, nonEmpty, rtrim,
 	} from '@jdeighan/coffee-utils'
 
 # ---------------------------------------------------------------------------
 #   blockToArray - split a block into lines
+#   DEPRECATED - use toArray()
 
 export blockToArray = (block) ->
 
@@ -28,22 +29,48 @@ export blockToArray = (block) ->
 # ---------------------------------------------------------------------------
 #   toArray - split a block or array into lines w/o newlines
 
-export toArray = (item) ->
+export toArray = (item, option=undef) ->
+	# --- Valid options:
+	#     'noEmptyLines'
+	#     'noLeadingEmptyLines'
 
 	if isString(item)
-		return item.split(/\r?\n/)
+		lLines = item.split(/\r?\n/)
 	else if isArray(item)
-		# --- We still need to ensure that no strings contain newlines
-		lLines = []
-		for str in item
-			for substr in toArray(str)
-				lLines.push substr
-		return lLines
+		lLines = item
 	else
 		croak "Not a string or array"
 
+	# --- We need to ensure that no strings contain newlines
+	#     and possibly remove empty lines
+	lNewLines = []
+	nonEmptyFound = false
+	for line in lLines
+		if isEmpty(line)
+			if (option == 'noEmptyLines') \
+					|| ((option == 'noLeadingEmptyLines') && ! nonEmptyFound)
+				pass
+			else
+				lNewLines.push ''
+		else if (line.indexOf("\n") > -1)
+			for substr in toArray(line)
+				if isEmpty(substr)
+					if (option == 'noEmptyLines') \
+							|| ((option == 'noLeadingEmptyLines') && ! nonEmptyFound)
+						pass
+					else
+						lNewLines.push ''
+				else
+					nonEmptyFound = true
+					lNewLines.push substr
+		else
+			nonEmptyFound = true
+			lNewLines.push line
+	return lNewLines
+
 # ---------------------------------------------------------------------------
-#   arrayToBlock - block will have no trailing whitespace
+#   arrayToBlock - block and lines in block will have no trailing whitespace
+#   DEPRECATED - use toBlock()
 
 export arrayToBlock = (lLines) ->
 
@@ -65,11 +92,11 @@ export toBlock = (lLines) ->
 	if (lLines == undef)
 		return undef
 	assert isArray(lLines), "lLines is not an array"
-	lLines = lLines.filter((line) => defined(line));
-	if lLines.length == 0
-		return undef
-	else
-		return lLines.join('\n')
+	lNewLines = []
+	for line in lLines
+		if defined(line)
+			lNewLines.push rtrim(line)
+	return lNewLines.join("\n")
 
 # ---------------------------------------------------------------------------
 

package/src/block_utils.js

@@ -12,6 +12,7 @@ import {
 
 import {
   undef,
+  pass,
   defined,
   isEmpty,
   isString,
@@ -22,6 +23,7 @@ import {
 
 // ---------------------------------------------------------------------------
 //   blockToArray - split a block into lines
+//   DEPRECATED - use toArray()
 export var blockToArray = function(block) {
   var lLines, len;
   if (isEmpty(block)) {
@@ -40,29 +42,56 @@ export var blockToArray = function(block) {
 
 // ---------------------------------------------------------------------------
 //   toArray - split a block or array into lines w/o newlines
-export var toArray = function(item) {
-  var i, j, lLines, len1, len2, ref, str, substr;
+export var toArray = function(item, option = undef) {
+  var i, j, lLines, lNewLines, len1, len2, line, nonEmptyFound, ref, substr;
+  // --- Valid options:
+  //     'noEmptyLines'
+  //     'noLeadingEmptyLines'
   if (isString(item)) {
-    return item.split(/\r?\n/);
+    lLines = item.split(/\r?\n/);
   } else if (isArray(item)) {
-    // --- We still need to ensure that no strings contain newlines
-    lLines = [];
-    for (i = 0, len1 = item.length; i < len1; i++) {
-      str = item[i];
-      ref = toArray(str);
+    lLines = item;
+  } else {
+    croak("Not a string or array");
+  }
+  // --- We need to ensure that no strings contain newlines
+  //     and possibly remove empty lines
+  lNewLines = [];
+  nonEmptyFound = false;
+  for (i = 0, len1 = lLines.length; i < len1; i++) {
+    line = lLines[i];
+    if (isEmpty(line)) {
+      if ((option === 'noEmptyLines') || ((option === 'noLeadingEmptyLines') && !nonEmptyFound)) {
+        pass;
+      } else {
+        lNewLines.push('');
+      }
+    } else if (line.indexOf("\n") > -1) {
+      ref = toArray(line);
       for (j = 0, len2 = ref.length; j < len2; j++) {
         substr = ref[j];
-        lLines.push(substr);
+        if (isEmpty(substr)) {
+          if ((option === 'noEmptyLines') || ((option === 'noLeadingEmptyLines') && !nonEmptyFound)) {
+            pass;
+          } else {
+            lNewLines.push('');
+          }
+        } else {
+          nonEmptyFound = true;
+          lNewLines.push(substr);
+        }
       }
+    } else {
+      nonEmptyFound = true;
+      lNewLines.push(line);
     }
-    return lLines;
-  } else {
-    return croak("Not a string or array");
   }
+  return lNewLines;
 };
 
 // ---------------------------------------------------------------------------
-//   arrayToBlock - block will have no trailing whitespace
+//   arrayToBlock - block and lines in block will have no trailing whitespace
+//   DEPRECATED - use toBlock()
 export var arrayToBlock = function(lLines) {
   if (lLines === undef) {
     return undef;
@@ -82,18 +111,19 @@ export var arrayToBlock = function(lLines) {
 //   toBlock - block may have trailing whitespace
 //             but undef items are ignored
 export var toBlock = function(lLines) {
+  var i, lNewLines, len1, line;
   if (lLines === undef) {
     return undef;
   }
   assert(isArray(lLines), "lLines is not an array");
-  lLines = lLines.filter((line) => {
-    return defined(line);
-  });
-  if (lLines.length === 0) {
-    return undef;
-  } else {
-    return lLines.join('\n');
+  lNewLines = [];
+  for (i = 0, len1 = lLines.length; i < len1; i++) {
+    line = lLines[i];
+    if (defined(line)) {
+      lNewLines.push(rtrim(line));
+    }
   }
+  return lNewLines.join("\n");
 };
 
 // ---------------------------------------------------------------------------

package/src/coffee_utils.coffee

@@ -223,6 +223,22 @@ export nonEmpty = (x) ->
 
 # ---------------------------------------------------------------------------
 
+export notInArray = (lItems, item) ->
+
+	return (lItems.indexOf(item) == -1)
+
+# ---------------------------------------------------------------------------
+
+export pushCond = (lItems, item, doPush=notInArray) ->
+
+	if doPush(lItems, item)
+		lItems.push item
+		return true
+	else
+		return false
+
+# ---------------------------------------------------------------------------
+
 export words = (str) ->
 
 	return str.trim().split(/\s+/)

package/src/coffee_utils.js

@@ -236,6 +236,21 @@ export var nonEmpty = function(x) {
   }
 };
 
+// ---------------------------------------------------------------------------
+export var notInArray = function(lItems, item) {
+  return lItems.indexOf(item) === -1;
+};
+
+// ---------------------------------------------------------------------------
+export var pushCond = function(lItems, item, doPush = notInArray) {
+  if (doPush(lItems, item)) {
+    lItems.push(item);
+    return true;
+  } else {
+    return false;
+  }
+};
+
 // ---------------------------------------------------------------------------
 export var words = function(str) {
   return str.trim().split(/\s+/);

package/src/indent_utils.coffee

@@ -88,6 +88,7 @@ export indented = (input, level=1, oneIndent="\t") ->
 
 # ---------------------------------------------------------------------------
 #   undented - string with 1st line indentation removed for each line
+#            - ignore leading empty lines
 #            - unless level is set, in which case exactly that
 #              indentation is removed
 #            - returns same type as text, i.e. either string or array
@@ -97,7 +98,7 @@ export undented = (input, level=undef, oneIndent="\t") ->
 	if defined(level) && (level==0)
 		return input
 
-	lLines = toArray(input)
+	lLines = toArray(input, 'noLeadingEmptyLines')
 	if (lLines.length == 0)
 		if isString(input)
 			return ''

package/src/indent_utils.js

@@ -108,6 +108,7 @@ export var indented = function(input, level = 1, oneIndent = "\t") {
 
 // ---------------------------------------------------------------------------
 //   undented - string with 1st line indentation removed for each line
+//            - ignore leading empty lines
 //            - unless level is set, in which case exactly that
 //              indentation is removed
 //            - returns same type as text, i.e. either string or array
@@ -116,7 +117,7 @@ export var undented = function(input, level = undef, oneIndent = "\t") {
   if (defined(level) && (level === 0)) {
     return input;
   }
-  lLines = toArray(input);
+  lLines = toArray(input, 'noLeadingEmptyLines');
   if (lLines.length === 0) {
     if (isString(input)) {
       return '';