@jdeighan/coffee-utils 11.0.48 → 12.0.0

package/package.json

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

package/src/block.coffee

@@ -138,91 +138,3 @@ export joinBlocks = (lBlocks...) ->
 		if nonEmpty(block)
 			lNonEmptyBlocks.push block
 	return lNonEmptyBlocks.join('\n')
-
-# ---------------------------------------------------------------------------
-
-```
-export async function forEachLine(filepath, func) {
-
-const fileStream = fs.createReadStream(filepath);
-const rl = readline.createInterface({
-	input: fileStream,
-	crlfDelay: Infinity
-	});
-
-// Note: we use the crlfDelay option to recognize all instances of CR LF
-// ('\r\n') in input.txt as a single line break.
-
-var lineNum = 0
-for await (const line of rl) {
-	lineNum += 1
-	// Each line will be successively available here as 'line'
-	if (func(line, lineNum)) {
-		rl.close();      // close if true return value
-		return;
-		}
-	}
-} // forEachLine()
-```
-# ---------------------------------------------------------------------------
-
-export forEachBlock = (filepath, func, regexp = /^-{16,}$/) ->
-
-	lLines = []
-	firstLineNum = 1
-	earlyExit = false
-
-	callback = (line, lineNum) ->
-		if (line.match(regexp))
-			if result = func(lLines.join('\n'), firstLineNum, line)
-				if (result == true)
-					earlyExit = true
-					return true
-				else if result?
-					croak "forEachBlock() - callback returned '#{result}'"
-			lLines = []
-			firstLineNum = lineNum+1
-		else
-			lLines.push line
-		return
-
-	await forEachLine filepath, callback
-	if ! earlyExit
-		func(lLines.join('\n'), firstLineNum)
-	return
-
-# ---------------------------------------------------------------------------
-
-export forEachSetOfBlocks = (filepath, func,
-		block_regexp = /^-{16,}$/,
-		set_regexp   = /^={16,}$/) ->
-
-	lBlocks = []
-	lLines = []
-	firstLineNum = 1
-	earlyExit = false
-
-	callback = (line, lineNum) ->
-		if (line.match(set_regexp))
-			lBlocks.push(lLines.join('\n'))
-			lLines = []
-			if result = func(lBlocks, firstLineNum, line)
-				if (result == true)
-					earlyExit = true
-					return true
-				else if result?
-					croak "forEachSetOfBlocks() - callback returned '#{result}'"
-			lBlocks = []
-			firstLineNum = lineNum+1
-		else if (line.match(block_regexp))
-			lBlocks.push(lLines.join('\n'))
-			lLines = []
-		else
-			lLines.push line
-		return
-
-	await forEachLine filepath, callback
-	if ! earlyExit
-		lBlocks.push(lLines.join('\n'))
-		func(lBlocks, firstLineNum)
-	return

package/src/block.js

@@ -185,93 +185,3 @@ export var joinBlocks = function(...lBlocks) {
   }
   return lNonEmptyBlocks.join('\n');
 };
-
-
-export async function forEachLine(filepath, func) {
-
-const fileStream = fs.createReadStream(filepath);
-const rl = readline.createInterface({
-	input: fileStream,
-	crlfDelay: Infinity
-	});
-
-// Note: we use the crlfDelay option to recognize all instances of CR LF
-// ('\r\n') in input.txt as a single line break.
-
-var lineNum = 0
-for await (const line of rl) {
-	lineNum += 1
-	// Each line will be successively available here as 'line'
-	if (func(line, lineNum)) {
-		rl.close();      // close if true return value
-		return;
-		}
-	}
-} // forEachLine()
-// ---------------------------------------------------------------------------
-;
-
-// ---------------------------------------------------------------------------
-export var forEachBlock = async function(filepath, func, regexp = /^-{16,}$/) {
-  var callback, earlyExit, firstLineNum, lLines;
-  lLines = [];
-  firstLineNum = 1;
-  earlyExit = false;
-  callback = function(line, lineNum) {
-    var result;
-    if (line.match(regexp)) {
-      if (result = func(lLines.join('\n'), firstLineNum, line)) {
-        if (result === true) {
-          earlyExit = true;
-          return true;
-        } else if (result != null) {
-          croak(`forEachBlock() - callback returned '${result}'`);
-        }
-      }
-      lLines = [];
-      firstLineNum = lineNum + 1;
-    } else {
-      lLines.push(line);
-    }
-  };
-  await forEachLine(filepath, callback);
-  if (!earlyExit) {
-    func(lLines.join('\n'), firstLineNum);
-  }
-};
-
-// ---------------------------------------------------------------------------
-export var forEachSetOfBlocks = async function(filepath, func, block_regexp = /^-{16,}$/, set_regexp = /^={16,}$/) {
-  var callback, earlyExit, firstLineNum, lBlocks, lLines;
-  lBlocks = [];
-  lLines = [];
-  firstLineNum = 1;
-  earlyExit = false;
-  callback = function(line, lineNum) {
-    var result;
-    if (line.match(set_regexp)) {
-      lBlocks.push(lLines.join('\n'));
-      lLines = [];
-      if (result = func(lBlocks, firstLineNum, line)) {
-        if (result === true) {
-          earlyExit = true;
-          return true;
-        } else if (result != null) {
-          croak(`forEachSetOfBlocks() - callback returned '${result}'`);
-        }
-      }
-      lBlocks = [];
-      firstLineNum = lineNum + 1;
-    } else if (line.match(block_regexp)) {
-      lBlocks.push(lLines.join('\n'));
-      lLines = [];
-    } else {
-      lLines.push(line);
-    }
-  };
-  await forEachLine(filepath, callback);
-  if (!earlyExit) {
-    lBlocks.push(lLines.join('\n'));
-    func(lBlocks, firstLineNum);
-  }
-};

package/src/fs.coffee

@@ -3,6 +3,7 @@
 import pathlib from 'path'
 import urllib from 'url'
 import fs from 'fs'
+import readline from 'readline'
 import NReadLines from 'n-readlines'
 
 import {assert, croak, LOG, fromTAML} from '@jdeighan/base-utils'
@@ -128,30 +129,94 @@ export getFullPath = (filepath) ->
 
 # ---------------------------------------------------------------------------
 
-export forEachLineInFile = (filepath, func) ->
+export forEachLine = (filepath, func) ->
 
 	reader = new NReadLines(filepath)
 	nLines = 0
 
 	while (buffer = reader.next())
 		nLines += 1
-		# --- text is split on \n chars, we also need to remove \r chars
+		# --- text is split on \n chars,
+		#     we also need to remove \r chars
 		line = buffer.toString().replace(/\r/g, '')
-		if func(line, nLines) == 'EOF'
+		if func(line, nLines)
 			reader.close()   # allow premature termination
 	return
 
+# ---------------------------------------------------------------------------
+
+export forEachBlock = (filepath, func, regexp = /^-{16,}$/) ->
+
+	lLines = []
+	firstLineNum = 1
+	earlyExit = false
+
+	callback = (line, lineNum) ->
+		if (line.match(regexp))
+			if result = func(lLines.join('\n'), firstLineNum, line)
+				if (result == true)
+					earlyExit = true
+					return true
+				else if defined(result)
+					croak "forEachBlock() - callback returned '#{result}'"
+			lLines = []
+			firstLineNum = lineNum+1
+		else
+			lLines.push line
+		return
+
+	forEachLine filepath, callback
+	if ! earlyExit
+		func(lLines.join('\n'), firstLineNum)
+	return
+
+# ---------------------------------------------------------------------------
+
+export forEachSetOfBlocks = (filepath, func,
+		block_regexp = /^-{16,}$/,
+		set_regexp   = /^={16,}$/) ->
+
+	lBlocks = []
+	lLines = []
+	firstLineNum = 1
+	earlyExit = false
+
+	callback = (line, lineNum) ->
+		if (line.match(set_regexp))
+			lBlocks.push(lLines.join('\n'))
+			lLines = []
+			if result = func(lBlocks, firstLineNum, line)
+				if (result == true)
+					earlyExit = true
+					return true
+				else if result?
+					croak "forEachSetOfBlocks() - callback returned '#{result}'"
+			lBlocks = []
+			firstLineNum = lineNum+1
+		else if (line.match(block_regexp))
+			lBlocks.push(lLines.join('\n'))
+			lLines = []
+		else
+			lLines.push line
+		return
+
+	forEachLine filepath, callback
+	if ! earlyExit
+		lBlocks.push(lLines.join('\n'))
+		func(lBlocks, firstLineNum)
+	return
+
 # ---------------------------------------------------------------------------
 #   slurp - read an entire file into a string
 
 export slurp = (filepath, maxLines=undef) ->
 
-	if maxLines?
+	if defined(maxLines)
 		lLines = []
-		forEachLineInFile filepath, (line, nLines) ->
+		forEachLine filepath, (line, nLines) ->
 			lLines.push line
-			return if nLines >= maxLines then 'EOF' else undef
-		contents = lLines.join("\n")
+			return (nLines >= maxLines)
+		contents = arrayToBlock(lLines)
 	else
 		filepath = filepath.replace(/\//g, "\\")
 		contents = fs.readFileSync(filepath, 'utf8').toString()
@@ -418,26 +483,6 @@ export parseSource = (source) ->
 	dbgReturn "parseSource", hSourceInfo
 	return hSourceInfo
 
-# ---------------------------------------------------------------------------
-#   backup - back up a file
-
-# --- If report is true, missing source files are not an error
-#     but both missing source files and successful copies
-#     are reported via LOG
-
-export backup = (file, from, to, report=false) ->
-	src = mkpath(from, file)
-	dest = mkpath(to, file)
-
-	if report
-		if fs.existsSync(src)
-			LOG "OK #{file}"
-			fs.copyFileSync(src, dest)
-		else
-			LOG "MISSING #{src}"
-	else
-		fs.copyFileSync(src, dest)
-
 # ---------------------------------------------------------------------------
 #   slurpTAML - read TAML from a file
 

package/src/fs.js

@@ -8,6 +8,8 @@ import urllib from 'url';
 
 import fs from 'fs';
 
+import readline from 'readline';
+
 import NReadLines from 'n-readlines';
 
 import {
@@ -160,35 +162,97 @@ export var getFullPath = function(filepath) {
 };
 
 // ---------------------------------------------------------------------------
-export var forEachLineInFile = function(filepath, func) {
+export var forEachLine = function(filepath, func) {
   var buffer, line, nLines, reader;
   reader = new NReadLines(filepath);
   nLines = 0;
   while ((buffer = reader.next())) {
     nLines += 1;
-    // --- text is split on \n chars, we also need to remove \r chars
+    // --- text is split on \n chars,
+    //     we also need to remove \r chars
     line = buffer.toString().replace(/\r/g, '');
-    if (func(line, nLines) === 'EOF') {
+    if (func(line, nLines)) {
       reader.close(); // allow premature termination
     }
   }
 };
 
+// ---------------------------------------------------------------------------
+export var forEachBlock = function(filepath, func, regexp = /^-{16,}$/) {
+  var callback, earlyExit, firstLineNum, lLines;
+  lLines = [];
+  firstLineNum = 1;
+  earlyExit = false;
+  callback = function(line, lineNum) {
+    var result;
+    if (line.match(regexp)) {
+      if (result = func(lLines.join('\n'), firstLineNum, line)) {
+        if (result === true) {
+          earlyExit = true;
+          return true;
+        } else if (defined(result)) {
+          croak(`forEachBlock() - callback returned '${result}'`);
+        }
+      }
+      lLines = [];
+      firstLineNum = lineNum + 1;
+    } else {
+      lLines.push(line);
+    }
+  };
+  forEachLine(filepath, callback);
+  if (!earlyExit) {
+    func(lLines.join('\n'), firstLineNum);
+  }
+};
+
+// ---------------------------------------------------------------------------
+export var forEachSetOfBlocks = function(filepath, func, block_regexp = /^-{16,}$/, set_regexp = /^={16,}$/) {
+  var callback, earlyExit, firstLineNum, lBlocks, lLines;
+  lBlocks = [];
+  lLines = [];
+  firstLineNum = 1;
+  earlyExit = false;
+  callback = function(line, lineNum) {
+    var result;
+    if (line.match(set_regexp)) {
+      lBlocks.push(lLines.join('\n'));
+      lLines = [];
+      if (result = func(lBlocks, firstLineNum, line)) {
+        if (result === true) {
+          earlyExit = true;
+          return true;
+        } else if (result != null) {
+          croak(`forEachSetOfBlocks() - callback returned '${result}'`);
+        }
+      }
+      lBlocks = [];
+      firstLineNum = lineNum + 1;
+    } else if (line.match(block_regexp)) {
+      lBlocks.push(lLines.join('\n'));
+      lLines = [];
+    } else {
+      lLines.push(line);
+    }
+  };
+  forEachLine(filepath, callback);
+  if (!earlyExit) {
+    lBlocks.push(lLines.join('\n'));
+    func(lBlocks, firstLineNum);
+  }
+};
+
 // ---------------------------------------------------------------------------
 //   slurp - read an entire file into a string
 export var slurp = function(filepath, maxLines = undef) {
   var contents, lLines;
-  if (maxLines != null) {
+  if (defined(maxLines)) {
     lLines = [];
-    forEachLineInFile(filepath, function(line, nLines) {
+    forEachLine(filepath, function(line, nLines) {
       lLines.push(line);
-      if (nLines >= maxLines) {
-        return 'EOF';
-      } else {
-        return undef;
-      }
+      return nLines >= maxLines;
     });
-    contents = lLines.join("\n");
+    contents = arrayToBlock(lLines);
   } else {
     filepath = filepath.replace(/\//g, "\\");
     contents = fs.readFileSync(filepath, 'utf8').toString();
@@ -492,28 +556,6 @@ export var parseSource = function(source) {
   return hSourceInfo;
 };
 
-// ---------------------------------------------------------------------------
-//   backup - back up a file
-
-// --- If report is true, missing source files are not an error
-//     but both missing source files and successful copies
-//     are reported via LOG
-export var backup = function(file, from, to, report = false) {
-  var dest, src;
-  src = mkpath(from, file);
-  dest = mkpath(to, file);
-  if (report) {
-    if (fs.existsSync(src)) {
-      LOG(`OK ${file}`);
-      return fs.copyFileSync(src, dest);
-    } else {
-      return LOG(`MISSING ${src}`);
-    }
-  } else {
-    return fs.copyFileSync(src, dest);
-  }
-};
-
 // ---------------------------------------------------------------------------
 //   slurpTAML - read TAML from a file
 export var slurpTAML = function(filepath) {

package/temp.txt

@@ -0,0 +1 @@
+this is text