@jdeighan/coffee-utils 8.0.1 → 8.0.4

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "8.0.1",
+	"version": "8.0.4",
 	"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": {
@@ -53,6 +55,6 @@
 		"svelte": "^3.48.0"
 	},
 	"devDependencies": {
-		"@jdeighan/unit-tester": "^2.0.8"
+		"@jdeighan/unit-tester": "^2.0.9"
 	}
 }

package/src/Section.coffee

@@ -0,0 +1,69 @@
+# 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: () ->
+
+		@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: () ->
+
+		return arrayToBlock(@lLines)

package/src/Section.js

@@ -0,0 +1,84 @@
+// 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() {
+    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() {
+    return arrayToBlock(this.lLines);
+  }
+
+};

package/src/SectionMap.coffee

@@ -0,0 +1,221 @@
+# SectionMap.coffee
+
+import {
+	assert, pass, undef, defined, croak, OL, isEmpty, nonEmpty,
+	isString, isHash, isArray, isUniqueTree, isNonEmptyString,
+	} from '@jdeighan/coffee-utils'
+import {arrayToBlock} from '@jdeighan/coffee-utils/block'
+import {debug} from '@jdeighan/coffee-utils/debug'
+import {Section} from '@jdeighan/coffee-utils/section'
+
+# ---------------------------------------------------------------------------
+
+isSectionName = (name) ->
+
+	assert isString(name), "not a string"
+	return name.match(/^[a-z][a-z0-9]*/)
+
+# ---------------------------------------------------------------------------
+
+isSetName = (name) ->
+
+	assert isString(name), "not a string"
+	return name.match(/^[A-Z][a-z0-9]*/)
+
+# ---------------------------------------------------------------------------
+
+export class SectionMap
+
+	constructor: (lSections) ->
+		# --- lSections is a tree of section names
+
+		debug "enter SectionMap()", lSections
+		@lSections = lSections   # a tree of section names
+		@hSets = {}
+		@hSections = {}
+		@addSections lSections
+		debug "return from SectionMap()", @hSections
+
+	# ..........................................................
+
+	# --- TODO: Allow array to start with a set name ---
+
+	addSections: (desc) ->
+
+		if isString(desc)
+			assert nonEmpty(desc), "empty section name"
+			assert desc.match(/^[a-z][a-z0-9]*$/), "bad section name #{OL(desc)}"
+			assert (@hSections[desc] == undef), "duplicate section #{OL(desc)}"
+			@hSections[desc] = new Section()
+		else
+			assert isArray(desc), "not an array or string #{OL(desc)}"
+			for item in desc
+				@addSections item
+		return
+
+	# ..........................................................
+	# --- a generator - yield order is not guaranteed
+
+	allSections: (desc) ->
+
+		debug "enter allSections()"
+		if (desc == undef)
+			# --- We want to return all sections
+			debug "yield all sections"
+			for _,sect of @hSections
+				yield sect
+		else if isString(desc)
+			if isSectionName(desc)
+				debug "yield section #{OL(desc)}"
+				yield @section(desc)
+			else if isSetName(desc)
+				debug "expand set #{OL(desc)}"
+				debug 'hSets', @hSets
+				lNames = @hSets[desc]
+				assert defined(lNames), "no set named #{OL(desc)}"
+				debug "set #{desc}", lNames
+				for name in lNames
+					debug "yield section #{OL(desc)}"
+					yield @section(name)
+			else
+				croak "bad name #{OL(desc)}"
+		else
+			assert isArray(desc), "not an array"
+			for name in desc
+				debug "yield section #{OL(name)}"
+				assert isString(name), "not a string #{OL(name)}"
+				if isSectionName(name)
+					yield @section(name)
+				else if isSetName(name)
+					for _,sect of @hSets[name]
+						yield sect
+				else
+					croak "bad name #{OL(name)}"
+		debug "return from allSections()"
+		return
+
+	# ..........................................................
+
+	addSet: (name, lSections) ->
+
+		debug "enter addSet()", name, lSections
+
+		# --- check the name
+		assert isSetName(name), "not a valid set name #{OL(name)}"
+
+		# --- check lSections
+		assert isArray(lSections), "arg 2 not an array"
+		for secName in lSections
+			assert isNonEmptyString(secName),
+					"not a non-empty string #{OL(secName)}"
+			assert defined(@hSections[secName]),
+					"not a section name #{OL(secName)}"
+
+		@hSets[name] = lSections
+		debug 'hSets', @hSets
+		debug "return from addSet()"
+		return
+
+	# ..........................................................
+
+	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)}"
+		lSections = @hSets[name]
+		assert defined(lSections), "no such set #{OL(name)}"
+		assert nonEmpty(lSections), "empty section #{OL(name)}"
+		return @section(lSections[0])
+
+	# ..........................................................
+
+	lastSection: (name) ->
+
+		assert isSetName(name), "bad set name #{OL(name)}"
+		lSections = @hSets[name]
+		assert defined(lSections), "no such set #{OL(name)}"
+		assert nonEmpty(lSections), "empty section #{OL(name)}"
+		return @section(lSections[lSections.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)
+
+	# ..........................................................
+
+	indent: (desc=undef, level=1) ->
+
+		for sect from @allSections(desc)
+			sect.indent(level)
+		return
+
+	# ..........................................................
+
+	enclose: (name, pre, post) ->
+
+		if isSectionName(name)
+			sect = @section(name)
+			if sect.nonEmpty()
+				sect.indent()
+				sect.prepend(pre)
+				sect.add(post)
+		else if isSetName(name)
+			if @nonEmpty(name)
+				@indent(name)
+				@firstSection(name).prepend(pre)
+				@lastSection(name).add(post)
+		else
+			croak "Bad name param #{OL(name)}"
+		return
+
+	# ..........................................................
+
+	getBlock: () ->
+
+		debug "enter getBlock()"
+		@lAllBlocks = []
+		debug 'lSections', @lSections
+		@accumBlock @lSections
+		debug 'lAllBlocks', @lAllBlocks
+		result = arrayToBlock(@lAllBlocks)
+		debug "return from getBlock()", result
+		return result
+
+	# ..........................................................
+
+	accumBlock: (tree) ->
+
+		if isString(tree)
+			debug "accumBlock #{OL(tree)}"
+			block = @section(tree).getBlock()
+			if nonEmpty(block)
+				@lAllBlocks.push block
+		else
+			assert isArray(tree), "not an array"
+			for subtree in tree
+				@accumBlock subtree
+		return

package/src/SectionMap.js

@@ -0,0 +1,257 @@
+// 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
+} from '@jdeighan/coffee-utils';
+
+import {
+  arrayToBlock
+} from '@jdeighan/coffee-utils/block';
+
+import {
+  debug
+} from '@jdeighan/coffee-utils/debug';
+
+import {
+  Section
+} from '@jdeighan/coffee-utils/section';
+
+// ---------------------------------------------------------------------------
+isSectionName = function(name) {
+  assert(isString(name), "not a string");
+  return name.match(/^[a-z][a-z0-9]*/);
+};
+
+// ---------------------------------------------------------------------------
+isSetName = function(name) {
+  assert(isString(name), "not a string");
+  return name.match(/^[A-Z][a-z0-9]*/);
+};
+
+// ---------------------------------------------------------------------------
+export var SectionMap = class SectionMap {
+  constructor(lSections) {
+    // --- lSections is a tree of section names
+    debug("enter SectionMap()", lSections);
+    this.lSections = lSections; // a tree of section names
+    this.hSets = {};
+    this.hSections = {};
+    this.addSections(lSections);
+    debug("return from SectionMap()", this.hSections);
+  }
+
+  // ..........................................................
+
+    // --- TODO: Allow array to start with a set name ---
+  addSections(desc) {
+    var i, item, len;
+    if (isString(desc)) {
+      assert(nonEmpty(desc), "empty section name");
+      assert(desc.match(/^[a-z][a-z0-9]*$/), `bad section name ${OL(desc)}`);
+      assert(this.hSections[desc] === undef, `duplicate section ${OL(desc)}`);
+      this.hSections[desc] = new Section();
+    } else {
+      assert(isArray(desc), `not an array or string ${OL(desc)}`);
+      for (i = 0, len = desc.length; i < len; i++) {
+        item = desc[i];
+        this.addSections(item);
+      }
+    }
+  }
+
+  // ..........................................................
+  // --- a generator - yield order is not guaranteed
+  * allSections(desc) {
+    var _, i, j, lNames, len, len1, name, ref, ref1, sect;
+    debug("enter allSections()");
+    if (desc === undef) {
+      // --- We want to return all sections
+      debug("yield all sections");
+      ref = this.hSections;
+      for (_ in ref) {
+        sect = ref[_];
+        yield sect;
+      }
+    } else if (isString(desc)) {
+      if (isSectionName(desc)) {
+        debug(`yield section ${OL(desc)}`);
+        yield this.section(desc);
+      } else if (isSetName(desc)) {
+        debug(`expand set ${OL(desc)}`);
+        debug('hSets', this.hSets);
+        lNames = this.hSets[desc];
+        assert(defined(lNames), `no set named ${OL(desc)}`);
+        debug(`set ${desc}`, lNames);
+        for (i = 0, len = lNames.length; i < len; i++) {
+          name = lNames[i];
+          debug(`yield section ${OL(desc)}`);
+          yield this.section(name);
+        }
+      } else {
+        croak(`bad name ${OL(desc)}`);
+      }
+    } else {
+      assert(isArray(desc), "not an array");
+      for (j = 0, len1 = desc.length; j < len1; j++) {
+        name = desc[j];
+        debug(`yield section ${OL(name)}`);
+        assert(isString(name), `not a string ${OL(name)}`);
+        if (isSectionName(name)) {
+          yield this.section(name);
+        } else if (isSetName(name)) {
+          ref1 = this.hSets[name];
+          for (_ in ref1) {
+            sect = ref1[_];
+            yield sect;
+          }
+        } else {
+          croak(`bad name ${OL(name)}`);
+        }
+      }
+    }
+    debug("return from allSections()");
+  }
+
+  // ..........................................................
+  addSet(name, lSections) {
+    var i, len, secName;
+    debug("enter addSet()", name, lSections);
+    // --- check the name
+    assert(isSetName(name), `not a valid set name ${OL(name)}`);
+    // --- check lSections
+    assert(isArray(lSections), "arg 2 not an array");
+    for (i = 0, len = lSections.length; i < len; i++) {
+      secName = lSections[i];
+      assert(isNonEmptyString(secName), `not a non-empty string ${OL(secName)}`);
+      assert(defined(this.hSections[secName]), `not a section name ${OL(secName)}`);
+    }
+    this.hSets[name] = lSections;
+    debug('hSets', this.hSets);
+    debug("return from addSet()");
+  }
+
+  // ..........................................................
+  section(name) {
+    var sect;
+    sect = this.hSections[name];
+    assert(defined(sect), `No section named ${OL(name)}`);
+    return sect;
+  }
+
+  // ..........................................................
+  firstSection(name) {
+    var lSections;
+    assert(isSetName(name), `bad set name ${OL(name)}`);
+    lSections = this.hSets[name];
+    assert(defined(lSections), `no such set ${OL(name)}`);
+    assert(nonEmpty(lSections), `empty section ${OL(name)}`);
+    return this.section(lSections[0]);
+  }
+
+  // ..........................................................
+  lastSection(name) {
+    var lSections;
+    assert(isSetName(name), `bad set name ${OL(name)}`);
+    lSections = this.hSets[name];
+    assert(defined(lSections), `no such set ${OL(name)}`);
+    assert(nonEmpty(lSections), `empty section ${OL(name)}`);
+    return this.section(lSections[lSections.length - 1]);
+  }
+
+  // ..........................................................
+  length(desc = undef) {
+    var ref, result, sect;
+    result = 0;
+    ref = this.allSections(desc);
+    for (sect of ref) {
+      result += sect.length();
+    }
+    return result;
+  }
+
+  // ..........................................................
+  isEmpty(desc = undef) {
+    return this.length(desc) === 0;
+  }
+
+  // ..........................................................
+  nonEmpty(desc = undef) {
+    return this.length(desc) > 0;
+  }
+
+  // ..........................................................
+  indent(desc = undef, level = 1) {
+    var ref, sect;
+    ref = this.allSections(desc);
+    for (sect of ref) {
+      sect.indent(level);
+    }
+  }
+
+  // ..........................................................
+  enclose(name, pre, post) {
+    var sect;
+    if (isSectionName(name)) {
+      sect = this.section(name);
+      if (sect.nonEmpty()) {
+        sect.indent();
+        sect.prepend(pre);
+        sect.add(post);
+      }
+    } else if (isSetName(name)) {
+      if (this.nonEmpty(name)) {
+        this.indent(name);
+        this.firstSection(name).prepend(pre);
+        this.lastSection(name).add(post);
+      }
+    } else {
+      croak(`Bad name param ${OL(name)}`);
+    }
+  }
+
+  // ..........................................................
+  getBlock() {
+    var result;
+    debug("enter getBlock()");
+    this.lAllBlocks = [];
+    debug('lSections', this.lSections);
+    this.accumBlock(this.lSections);
+    debug('lAllBlocks', this.lAllBlocks);
+    result = arrayToBlock(this.lAllBlocks);
+    debug("return from getBlock()", result);
+    return result;
+  }
+
+  // ..........................................................
+  accumBlock(tree) {
+    var block, i, len, subtree;
+    if (isString(tree)) {
+      debug(`accumBlock ${OL(tree)}`);
+      block = this.section(tree).getBlock();
+      if (nonEmpty(block)) {
+        this.lAllBlocks.push(block);
+      }
+    } else {
+      assert(isArray(tree), "not an array");
+      for (i = 0, len = tree.length; i < len; i++) {
+        subtree = tree[i];
+        this.accumBlock(subtree);
+      }
+    }
+  }
+
+};

package/src/coffee_utils.coffee

@@ -296,6 +296,26 @@ export isUniqueList = (lItems, func=undef) ->
 
 # ---------------------------------------------------------------------------
 
+export isUniqueTree = (lItems, func=undef, hFound={}) ->
+
+	if isEmpty(lItems)
+		return true     # empty list is unique
+	if defined(func)
+		assert isFunction(func), "Not a function: #{OL(func)}"
+	for item in lItems
+		if isArray(item)
+			if ! isUniqueTree(item, func, hFound)
+				return false
+		else
+			if defined(func) && !func(item)
+				return false
+			if defined(hFound[item])
+				return false
+			hFound[item] = 1
+	return true
+
+# ---------------------------------------------------------------------------
+
 export uniq = (lItems) ->
 
 	return [...new Set(lItems)]

package/src/coffee_utils.js

@@ -303,6 +303,34 @@ export var isUniqueList = function(lItems, func = undef) {
   return true;
 };
 
+// ---------------------------------------------------------------------------
+export var isUniqueTree = function(lItems, func = undef, hFound = {}) {
+  var i, item, len;
+  if (isEmpty(lItems)) {
+    return true; // empty list is unique
+  }
+  if (defined(func)) {
+    assert(isFunction(func), `Not a function: ${OL(func)}`);
+  }
+  for (i = 0, len = lItems.length; i < len; i++) {
+    item = lItems[i];
+    if (isArray(item)) {
+      if (!isUniqueTree(item, func, hFound)) {
+        return false;
+      }
+    } else {
+      if (defined(func) && !func(item)) {
+        return false;
+      }
+      if (defined(hFound[item])) {
+        return false;
+      }
+      hFound[item] = 1;
+    }
+  }
+  return true;
+};
+
 // ---------------------------------------------------------------------------
 export var uniq = function(lItems) {
   return [...new Set(lItems)];