@jdeighan/coffee-utils 8.0.3 → 8.0.6

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "8.0.3",
+	"version": "8.0.6",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {
@@ -19,6 +19,8 @@
 		"./store": "./src/DataStores.js",
 		"./taml": "./src/taml.js",
 		"./placeholders": "./src/placeholders.js",
+		"./section": "./src/Section.js",
+		"./sectionmap": "./src/SectionMap.js",
 		"./package.json": "./package.json"
 	},
 	"engines": {

package/src/Section.coffee

@@ -0,0 +1,72 @@
+# Section.coffee
+
+import {
+	assert, pass, undef, defined, croak, isArray,
+	} from '@jdeighan/coffee-utils'
+import {arrayToBlock} from '@jdeighan/coffee-utils/block'
+import {indented} from '@jdeighan/coffee-utils/indent'
+
+# ---------------------------------------------------------------------------
+
+export class Section
+
+	constructor: (@name) ->
+
+		@lLines = []
+
+	# ..........................................................
+
+	length: () ->
+
+		return @lLines.length
+
+	# ..........................................................
+
+	indent: (level=1) ->
+
+		lNewLines = for line in @lLines
+			indented(line, level)
+		@lLines = lNewLines
+		return
+
+	# ..........................................................
+
+	isEmpty: () ->
+
+		return (@lLines.length == 0)
+
+	# ..........................................................
+
+	nonEmpty: () ->
+
+		return (@lLines.length > 0)
+
+	# ..........................................................
+
+	add: (data) ->
+
+		if isArray(data)
+			for line in data
+				@lLines.push line
+		else
+			@lLines.push data
+		return
+
+	# ..........................................................
+
+	prepend: (data) ->
+
+		if isArray(data)
+			@lLines = [data..., @lLines...]
+		else
+			@lLines = [data, @lLines...]
+		return
+
+	# ..........................................................
+
+	getBlock: () ->
+
+		if (@lLines.length == 0)
+			return undef
+		else
+			return arrayToBlock(@lLines)

package/src/Section.js

@@ -0,0 +1,89 @@
+// Generated by CoffeeScript 2.7.0
+  // Section.coffee
+import {
+  assert,
+  pass,
+  undef,
+  defined,
+  croak,
+  isArray
+} from '@jdeighan/coffee-utils';
+
+import {
+  arrayToBlock
+} from '@jdeighan/coffee-utils/block';
+
+import {
+  indented
+} from '@jdeighan/coffee-utils/indent';
+
+// ---------------------------------------------------------------------------
+export var Section = class Section {
+  constructor(name) {
+    this.name = name;
+    this.lLines = [];
+  }
+
+  // ..........................................................
+  length() {
+    return this.lLines.length;
+  }
+
+  // ..........................................................
+  indent(level = 1) {
+    var lNewLines, line;
+    lNewLines = (function() {
+      var i, len, ref, results;
+      ref = this.lLines;
+      results = [];
+      for (i = 0, len = ref.length; i < len; i++) {
+        line = ref[i];
+        results.push(indented(line, level));
+      }
+      return results;
+    }).call(this);
+    this.lLines = lNewLines;
+  }
+
+  // ..........................................................
+  isEmpty() {
+    return this.lLines.length === 0;
+  }
+
+  // ..........................................................
+  nonEmpty() {
+    return this.lLines.length > 0;
+  }
+
+  // ..........................................................
+  add(data) {
+    var i, len, line;
+    if (isArray(data)) {
+      for (i = 0, len = data.length; i < len; i++) {
+        line = data[i];
+        this.lLines.push(line);
+      }
+    } else {
+      this.lLines.push(data);
+    }
+  }
+
+  // ..........................................................
+  prepend(data) {
+    if (isArray(data)) {
+      this.lLines = [...data, ...this.lLines];
+    } else {
+      this.lLines = [data, ...this.lLines];
+    }
+  }
+
+  // ..........................................................
+  getBlock() {
+    if (this.lLines.length === 0) {
+      return undef;
+    } else {
+      return arrayToBlock(this.lLines);
+    }
+  }
+
+};

package/src/SectionMap.coffee

@@ -0,0 +1,217 @@
+# SectionMap.coffee
+
+import {
+	assert, pass, undef, defined, croak, OL, isEmpty, nonEmpty,
+	isString, isHash, isArray, isUniqueTree, isNonEmptyString,
+	isNonEmptyArray,
+	} from '@jdeighan/coffee-utils'
+import {arrayToBlock} from '@jdeighan/coffee-utils/block'
+import {indented} from '@jdeighan/coffee-utils/indent'
+import {debug} from '@jdeighan/coffee-utils/debug'
+import {Section} from '@jdeighan/coffee-utils/section'
+
+# ---------------------------------------------------------------------------
+
+isSectionName = (name) ->
+
+	return isString(name) && name.match(/^[a-z][a-z0-9]*/)
+
+# ---------------------------------------------------------------------------
+
+isSetName = (name) ->
+
+	return isString(name) && name.match(/^[A-Z][a-z0-9]*/)
+
+# ---------------------------------------------------------------------------
+
+export class SectionMap
+
+	constructor: (lSectionTree) ->
+		# --- lSectionTree is a tree of section names
+
+		debug "enter SectionMap()", lSectionTree
+		@lSectionTree = lSectionTree   # a tree of section names
+		@hSets = {}
+		@hSections = {}
+		@addSections lSectionTree
+		debug "return from SectionMap()", @hSections
+
+	# ..........................................................
+
+	addSections: (desc) ->
+		# --- returns a flat array of sections that were added
+
+		if isString(desc)
+			assert nonEmpty(desc), "empty section name"
+			assert isSectionName(desc), "bad section name #{OL(desc)}"
+			assert (@hSections[desc] == undef), "duplicate section #{OL(desc)}"
+			@hSections[desc] = new Section(desc)
+			return [desc]
+		else
+			assert isArray(desc), "not an array or string #{OL(desc)}"
+			name = undef
+			lParts = []
+			for item,i in desc
+				if (i==0) && isSetName(item)
+					name = item
+				else
+					lAdded = @addSections item
+					for item in lAdded
+						lParts.push item
+			if defined(name)
+				@addSet name, lParts
+			return lParts
+		return
+
+	# ..........................................................
+
+	addSet: (name, lSectionTree) ->
+
+		debug "enter addSet()", name, lSectionTree
+
+		# --- check the name
+		assert isSetName(name), "not a valid set name #{OL(name)}"
+
+		# --- check lSectionTree
+		assert isArray(lSectionTree), "arg 2 not an array"
+		for secName in lSectionTree
+			assert isNonEmptyString(secName),
+					"not a non-empty string #{OL(secName)}"
+			assert defined(@hSections[secName]),
+					"not a section name #{OL(secName)}"
+
+		@hSets[name] = lSectionTree
+		debug 'hSets', @hSets
+		debug "return from addSet()"
+		return
+
+	# ..........................................................
+	# --- sections returned in depth-first order from section tree
+	#     Set names are simply skipped
+	#     yields: [<level>, <section>]
+
+	allSections: (desc=undef, level=0) ->
+
+		debug "enter allSections()", desc, level
+		if (desc == undef)
+			desc = @lSectionTree
+		if isArray(desc)
+			for item in desc
+				if isSectionName(item)
+					result = [level, @section(item)]
+					debug 'yield', result
+					yield result
+				else if isSetName(item)
+					pass
+				else
+					assert isArray(item), "not an array #{OL(item)}"
+					yield from @allSections(item, level+1)
+		else if isSectionName(desc)
+			result = [level, @section(desc)]
+			debug 'yield', result
+			yield result
+		else if isSetName(desc)
+			lTree = @hSets[desc]
+			assert defined(lTree), "Not a Set: #{OL(desc)}"
+			yield from @allSections(lTree, level)
+		else
+			croak "Bad item: #{OL(desc)}"
+		debug "return from allSections()"
+		return
+
+	# ..........................................................
+	# --- procFunc should be (name, text) -> return processedText
+
+	getBlock: (procFunc=undef, lTree=undef) ->
+
+		debug "enter getBlock()"
+		if (lTree == undef)
+			lTree = @lSectionTree
+		else
+			assert isArray(lTree), "not an array #{OL(lTree)}"
+
+		lParts = []
+		for part in lTree
+			if isString(part)
+				text = @section(part).getBlock()
+				if nonEmpty(text) && defined(procFunc)
+					text = procFunc(part, text)
+			else if isNonEmptyArray(part)
+				if isSectionName(part[0])
+					text = @getBlock(procFunc, part)
+				else if isSetName(part[0])
+					text = @getBlock(procFunc, part.slice(1))
+					if nonEmpty(text) && defined(procFunc)
+						text = procFunc(part[0], text)
+				else
+					croak "Bad part: #{OL(part)}"
+			else
+				croak "Bad part: #{OL(part)}"
+			if defined(text)
+				lParts.push text
+
+		debug 'lParts', lParts
+		result = arrayToBlock(lParts)
+		debug "return from getBlock()", result
+		return result
+
+	# ..........................................................
+
+	section: (name) ->
+
+		sect = @hSections[name]
+		assert defined(sect), "No section named #{OL(name)}"
+		return sect
+
+	# ..........................................................
+
+	firstSection: (name) ->
+
+		assert isSetName(name), "bad set name #{OL(name)}"
+		lSectionTree = @hSets[name]
+		assert defined(lSectionTree), "no such set #{OL(name)}"
+		assert nonEmpty(lSectionTree), "empty section #{OL(name)}"
+		return @section(lSectionTree[0])
+
+	# ..........................................................
+
+	lastSection: (name) ->
+
+		assert isSetName(name), "bad set name #{OL(name)}"
+		lSectionTree = @hSets[name]
+		assert defined(lSectionTree), "no such set #{OL(name)}"
+		assert nonEmpty(lSectionTree), "empty section #{OL(name)}"
+		return @section(lSectionTree[lSectionTree.length - 1])
+
+	# ..........................................................
+
+	length: (desc=undef) ->
+
+		result = 0
+		for [_, sect] from @allSections(desc)
+			result += sect.length()
+		return result
+
+	# ..........................................................
+
+	isEmpty: (desc=undef) ->
+
+		return (@length(desc) == 0)
+
+	# ..........................................................
+
+	nonEmpty: (desc=undef) ->
+
+		return (@length(desc) > 0)
+
+	# ..........................................................
+
+	getShape: () ->
+
+		debug "enter getShape()"
+		lParts = []
+		for [level, sect] from @allSections()
+			lParts.push indented(sect.name, level)
+		result = arrayToBlock(lParts)
+		debug "return from getShape()", result
+		return result

package/src/SectionMap.js

@@ -0,0 +1,256 @@
+// Generated by CoffeeScript 2.7.0
+// SectionMap.coffee
+var isSectionName, isSetName;
+
+import {
+  assert,
+  pass,
+  undef,
+  defined,
+  croak,
+  OL,
+  isEmpty,
+  nonEmpty,
+  isString,
+  isHash,
+  isArray,
+  isUniqueTree,
+  isNonEmptyString,
+  isNonEmptyArray
+} from '@jdeighan/coffee-utils';
+
+import {
+  arrayToBlock
+} from '@jdeighan/coffee-utils/block';
+
+import {
+  indented
+} from '@jdeighan/coffee-utils/indent';
+
+import {
+  debug
+} from '@jdeighan/coffee-utils/debug';
+
+import {
+  Section
+} from '@jdeighan/coffee-utils/section';
+
+// ---------------------------------------------------------------------------
+isSectionName = function(name) {
+  return isString(name) && name.match(/^[a-z][a-z0-9]*/);
+};
+
+// ---------------------------------------------------------------------------
+isSetName = function(name) {
+  return isString(name) && name.match(/^[A-Z][a-z0-9]*/);
+};
+
+// ---------------------------------------------------------------------------
+export var SectionMap = class SectionMap {
+  constructor(lSectionTree) {
+    // --- lSectionTree is a tree of section names
+    debug("enter SectionMap()", lSectionTree);
+    this.lSectionTree = lSectionTree; // a tree of section names
+    this.hSets = {};
+    this.hSections = {};
+    this.addSections(lSectionTree);
+    debug("return from SectionMap()", this.hSections);
+  }
+
+  // ..........................................................
+  addSections(desc) {
+    var i, item, j, k, lAdded, lParts, len, len1, name;
+    // --- returns a flat array of sections that were added
+    if (isString(desc)) {
+      assert(nonEmpty(desc), "empty section name");
+      assert(isSectionName(desc), `bad section name ${OL(desc)}`);
+      assert(this.hSections[desc] === undef, `duplicate section ${OL(desc)}`);
+      this.hSections[desc] = new Section(desc);
+      return [desc];
+    } else {
+      assert(isArray(desc), `not an array or string ${OL(desc)}`);
+      name = undef;
+      lParts = [];
+      for (i = j = 0, len = desc.length; j < len; i = ++j) {
+        item = desc[i];
+        if ((i === 0) && isSetName(item)) {
+          name = item;
+        } else {
+          lAdded = this.addSections(item);
+          for (k = 0, len1 = lAdded.length; k < len1; k++) {
+            item = lAdded[k];
+            lParts.push(item);
+          }
+        }
+      }
+      if (defined(name)) {
+        this.addSet(name, lParts);
+      }
+      return lParts;
+    }
+  }
+
+  // ..........................................................
+  addSet(name, lSectionTree) {
+    var j, len, secName;
+    debug("enter addSet()", name, lSectionTree);
+    // --- check the name
+    assert(isSetName(name), `not a valid set name ${OL(name)}`);
+    // --- check lSectionTree
+    assert(isArray(lSectionTree), "arg 2 not an array");
+    for (j = 0, len = lSectionTree.length; j < len; j++) {
+      secName = lSectionTree[j];
+      assert(isNonEmptyString(secName), `not a non-empty string ${OL(secName)}`);
+      assert(defined(this.hSections[secName]), `not a section name ${OL(secName)}`);
+    }
+    this.hSets[name] = lSectionTree;
+    debug('hSets', this.hSets);
+    debug("return from addSet()");
+  }
+
+  // ..........................................................
+  // --- sections returned in depth-first order from section tree
+  //     Set names are simply skipped
+  //     yields: [<level>, <section>]
+  * allSections(desc = undef, level = 0) {
+    var item, j, lTree, len, result;
+    debug("enter allSections()", desc, level);
+    if (desc === undef) {
+      desc = this.lSectionTree;
+    }
+    if (isArray(desc)) {
+      for (j = 0, len = desc.length; j < len; j++) {
+        item = desc[j];
+        if (isSectionName(item)) {
+          result = [level, this.section(item)];
+          debug('yield', result);
+          yield result;
+        } else if (isSetName(item)) {
+          pass;
+        } else {
+          assert(isArray(item), `not an array ${OL(item)}`);
+          yield* this.allSections(item, level + 1);
+        }
+      }
+    } else if (isSectionName(desc)) {
+      result = [level, this.section(desc)];
+      debug('yield', result);
+      yield result;
+    } else if (isSetName(desc)) {
+      lTree = this.hSets[desc];
+      assert(defined(lTree), `Not a Set: ${OL(desc)}`);
+      yield* this.allSections(lTree, level);
+    } else {
+      croak(`Bad item: ${OL(desc)}`);
+    }
+    debug("return from allSections()");
+  }
+
+  // ..........................................................
+  // --- procFunc should be (name, text) -> return processedText
+  getBlock(procFunc = undef, lTree = undef) {
+    var j, lParts, len, part, result, text;
+    debug("enter getBlock()");
+    if (lTree === undef) {
+      lTree = this.lSectionTree;
+    } else {
+      assert(isArray(lTree), `not an array ${OL(lTree)}`);
+    }
+    lParts = [];
+    for (j = 0, len = lTree.length; j < len; j++) {
+      part = lTree[j];
+      if (isString(part)) {
+        text = this.section(part).getBlock();
+        if (nonEmpty(text) && defined(procFunc)) {
+          text = procFunc(part, text);
+        }
+      } else if (isNonEmptyArray(part)) {
+        if (isSectionName(part[0])) {
+          text = this.getBlock(procFunc, part);
+        } else if (isSetName(part[0])) {
+          text = this.getBlock(procFunc, part.slice(1));
+          if (nonEmpty(text) && defined(procFunc)) {
+            text = procFunc(part[0], text);
+          }
+        } else {
+          croak(`Bad part: ${OL(part)}`);
+        }
+      } else {
+        croak(`Bad part: ${OL(part)}`);
+      }
+      if (defined(text)) {
+        lParts.push(text);
+      }
+    }
+    debug('lParts', lParts);
+    result = arrayToBlock(lParts);
+    debug("return from getBlock()", result);
+    return result;
+  }
+
+  // ..........................................................
+  section(name) {
+    var sect;
+    sect = this.hSections[name];
+    assert(defined(sect), `No section named ${OL(name)}`);
+    return sect;
+  }
+
+  // ..........................................................
+  firstSection(name) {
+    var lSectionTree;
+    assert(isSetName(name), `bad set name ${OL(name)}`);
+    lSectionTree = this.hSets[name];
+    assert(defined(lSectionTree), `no such set ${OL(name)}`);
+    assert(nonEmpty(lSectionTree), `empty section ${OL(name)}`);
+    return this.section(lSectionTree[0]);
+  }
+
+  // ..........................................................
+  lastSection(name) {
+    var lSectionTree;
+    assert(isSetName(name), `bad set name ${OL(name)}`);
+    lSectionTree = this.hSets[name];
+    assert(defined(lSectionTree), `no such set ${OL(name)}`);
+    assert(nonEmpty(lSectionTree), `empty section ${OL(name)}`);
+    return this.section(lSectionTree[lSectionTree.length - 1]);
+  }
+
+  // ..........................................................
+  length(desc = undef) {
+    var _, ref, result, sect, x;
+    result = 0;
+    ref = this.allSections(desc);
+    for (x of ref) {
+      [_, sect] = x;
+      result += sect.length();
+    }
+    return result;
+  }
+
+  // ..........................................................
+  isEmpty(desc = undef) {
+    return this.length(desc) === 0;
+  }
+
+  // ..........................................................
+  nonEmpty(desc = undef) {
+    return this.length(desc) > 0;
+  }
+
+  // ..........................................................
+  getShape() {
+    var lParts, level, ref, result, sect, x;
+    debug("enter getShape()");
+    lParts = [];
+    ref = this.allSections();
+    for (x of ref) {
+      [level, sect] = x;
+      lParts.push(indented(sect.name, level));
+    }
+    result = arrayToBlock(lParts);
+    debug("return from getShape()", result);
+    return result;
+  }
+
+};

package/src/block_utils.coffee

@@ -30,19 +30,31 @@ export blockToArray = (block) ->
 export arrayToBlock = (lLines) ->
 
 	if (lLines == undef)
-		return ''
+		return undef
 	assert isArray(lLines), "lLines is not an array"
 	lLines = lLines.filter((line) => defined(line));
 	if lLines.length == 0
-		return ''
+		return undef
 	else
 		return rtrim(lLines.join('\n'))
 
 # ---------------------------------------------------------------------------
 
+export splitBlock = (block) ->
+
+	assert isString(block), "not a string"
+	pos = block.indexOf('\n')
+	if (pos == -1)
+		return [block, undef]
+	else
+		return [block.substring(0, pos), block.substring(pos+1)]
+
+
+# ---------------------------------------------------------------------------
+
 export firstLine = (block) ->
 
-	assert isString(block), "firstLine(): string expected"
+	assert isString(block), "not a string"
 	pos = block.indexOf('\n')
 	if (pos == -1)
 		return block
@@ -53,10 +65,10 @@ export firstLine = (block) ->
 
 export remainingLines = (block) ->
 
-	assert isString(block), "remainingLines(): string expected"
+	assert isString(block), "not a string"
 	pos = block.indexOf('\n')
 	if (pos == -1)
-		return ''
+		return undef
 	else
 		return block.substring(pos+1)
 

package/src/block_utils.js

@@ -38,23 +38,35 @@ export var blockToArray = function(block) {
 //   arrayToBlock - block will have no trailing whitespace
 export var arrayToBlock = function(lLines) {
   if (lLines === undef) {
-    return '';
+    return undef;
   }
   assert(isArray(lLines), "lLines is not an array");
   lLines = lLines.filter((line) => {
     return defined(line);
   });
   if (lLines.length === 0) {
-    return '';
+    return undef;
   } else {
     return rtrim(lLines.join('\n'));
   }
 };
 
+// ---------------------------------------------------------------------------
+export var splitBlock = function(block) {
+  var pos;
+  assert(isString(block), "not a string");
+  pos = block.indexOf('\n');
+  if (pos === -1) {
+    return [block, undef];
+  } else {
+    return [block.substring(0, pos), block.substring(pos + 1)];
+  }
+};
+
 // ---------------------------------------------------------------------------
 export var firstLine = function(block) {
   var pos;
-  assert(isString(block), "firstLine(): string expected");
+  assert(isString(block), "not a string");
   pos = block.indexOf('\n');
   if (pos === -1) {
     return block;
@@ -66,10 +78,10 @@ export var firstLine = function(block) {
 // ---------------------------------------------------------------------------
 export var remainingLines = function(block) {
   var pos;
-  assert(isString(block), "remainingLines(): string expected");
+  assert(isString(block), "not a string");
   pos = block.indexOf('\n');
   if (pos === -1) {
-    return '';
+    return undef;
   } else {
     return block.substring(pos + 1);
   }

package/src/coffee_utils.coffee

@@ -173,6 +173,12 @@ export isArray = (x) ->
 
 # ---------------------------------------------------------------------------
 
+export isNonEmptyArray = (x) ->
+
+	return isArray(x) && (x.length > 0)
+
+# ---------------------------------------------------------------------------
+
 export isHash = (x, lKeys) ->
 
 	if ! x || (getClassName(x) != 'Object')
@@ -186,6 +192,12 @@ export isHash = (x, lKeys) ->
 
 # ---------------------------------------------------------------------------
 
+export isNonEmptyHash = (x) ->
+
+	return isHash(x) && (Object.keys(x).length > 0)
+
+# ---------------------------------------------------------------------------
+
 export hashHasKey = (x, key) ->
 
 	assert isHash(x), "hashHasKey(): not a hash"

package/src/coffee_utils.js

@@ -159,6 +159,11 @@ export var isArray = function(x) {
   return Array.isArray(x);
 };
 
+// ---------------------------------------------------------------------------
+export var isNonEmptyArray = function(x) {
+  return isArray(x) && (x.length > 0);
+};
+
 // ---------------------------------------------------------------------------
 export var isHash = function(x, lKeys) {
   var i, key, len;
@@ -177,6 +182,11 @@ export var isHash = function(x, lKeys) {
   return true;
 };
 
+// ---------------------------------------------------------------------------
+export var isNonEmptyHash = function(x) {
+  return isHash(x) && (Object.keys(x).length > 0);
+};
+
 // ---------------------------------------------------------------------------
 export var hashHasKey = function(x, key) {
   assert(isHash(x), "hashHasKey(): not a hash");

package/src/indent_utils.coffee

@@ -146,3 +146,10 @@ export tabify = (str, numSpaces=undef) ->
 export untabify = (str, numSpaces=3) ->
 
 	return str.replace(/\t/g, ' '.repeat(numSpaces))
+
+# ---------------------------------------------------------------------------
+#    enclose - indent text, surround with pre and post
+
+export enclose = (text, pre, post) ->
+
+	return pre + "\n" + indented(text) + "\n" + post

package/src/indent_utils.js

@@ -175,3 +175,9 @@ export var tabify = function(str, numSpaces = undef) {
 export var untabify = function(str, numSpaces = 3) {
   return str.replace(/\t/g, ' '.repeat(numSpaces));
 };
+
+// ---------------------------------------------------------------------------
+//    enclose - indent text, surround with pre and post
+export var enclose = function(text, pre, post) {
+  return pre + "\n" + indented(text) + "\n" + post;
+};