@jdeighan/coffee-utils 4.1.30 → 4.1.34

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@jdeighan/coffee-utils",
 	"type": "module",
-	"version": "4.1.30",
+	"version": "4.1.34",
 	"description": "A set of utility functions for CoffeeScript",
 	"main": "coffee_utils.js",
 	"exports": {
@@ -16,6 +16,8 @@
 		"./debug": "./src/debug_utils.js",
 		"./svelte": "./src/svelte_utils.js",
 		"./test": "./src/UnitTester.js",
+		"./store": "./src/DataStores.js",
+		"./taml": "./src/taml.js",
 		"./package.json": "./package.json"
 	},
 	"engines": {

package/src/DataStores.coffee

@@ -0,0 +1,165 @@
+# DataStores.coffee
+
+import pathlib from 'path'
+import yaml from 'js-yaml'
+import {writable, readable, get} from 'svelte/store'
+
+import {
+	assert, undef, pass, error, localStore, isEmpty,
+	} from '@jdeighan/coffee-utils'
+import {log} from '@jdeighan/coffee-utils/log'
+import {
+	withExt, slurp, barf, newerDestFileExists,
+	} from '@jdeighan/coffee-utils/fs'
+
+# ---------------------------------------------------------------------------
+
+export class WritableDataStore
+
+	constructor: (value=undef) ->
+		@store = writable value
+
+	subscribe: (callback) ->
+		return @store.subscribe(callback)
+
+	set: (value) ->
+		@store.set(value)
+
+	update: (func) ->
+		@store.update(func)
+
+# ---------------------------------------------------------------------------
+
+export class LocalStorageDataStore extends WritableDataStore
+
+	constructor: (@masterKey, defValue=undef) ->
+
+		# --- CoffeeScript forces us to call super first
+		#     so we can't get the localStorage value first
+		super defValue
+		value = localStore(@masterKey)
+		if value?
+			@set value
+
+	# --- I'm assuming that when update() is called,
+	#     set() will also be called
+
+	set: (value) ->
+		if ! value?
+			error "LocalStorageStore.set(): cannont set to undef"
+		super value
+		localStore @masterKey, value
+
+	update: (func) ->
+		super func
+		localStore @masterKey, get(@store)
+
+# ---------------------------------------------------------------------------
+
+export class PropsDataStore extends LocalStorageDataStore
+
+	constructor: (masterKey) ->
+		super masterKey, {}
+
+	setProp: (name, value) ->
+		if ! name?
+			error "PropStore.setProp(): empty key"
+		@update (hPrefs) ->
+			hPrefs[name] = value
+			return hPrefs
+
+# ---------------------------------------------------------------------------
+
+export class ReadableDataStore
+
+	constructor: () ->
+		@store = readable null, (set) ->
+			@setter = set        # store the setter function
+			@start()             # call your start() method
+			return () => @stop() # return function capable of stopping
+
+	subscribe: (callback) ->
+		return @store.subscribe(callback)
+
+	start: () ->
+		pass
+
+	stop: () ->
+		pass
+
+# ---------------------------------------------------------------------------
+
+export class DateTimeDataStore extends ReadableDataStore
+
+	start: () ->
+		# --- We need to store this interval for use in stop() later
+		@interval = setInterval(() ->
+			@setter new Date()
+			, 1000)
+
+	stop: () ->
+		clearInterval @interval
+
+# ---------------------------------------------------------------------------
+
+export class MousePosDataStore extends ReadableDataStore
+
+	start: () ->
+		# --- We need to store this handler for use in stop() later
+		@mouseMoveHandler = (e) ->
+			@setter {
+				x: e.clientX,
+				y: e.clientY,
+				}
+		document.body.addEventListener('mousemove', @mouseMoveHandler)
+
+	stop: () ->
+		document.body.removeEventListener('mousemove', @mouseMoveHandler)
+
+# ---------------------------------------------------------------------------
+
+export class TAMLDataStore extends WritableDataStore
+
+	constructor: (str) ->
+
+		super taml(str)
+
+# ---------------------------------------------------------------------------
+#         UTILITIES
+# ---------------------------------------------------------------------------
+
+export taml = (text) ->
+
+	if ! text?
+		return undef
+	return yaml.load(untabify(text, 1), {skipInvalid: true})
+
+# ---------------------------------------------------------------------------
+
+export brewTamlStr = (code, stub) ->
+
+	return """
+			import {TAMLDataStore} from '@jdeighan/starbucks/stores';
+
+			export let #{stub} = new TAMLDataStore(`#{code}`);
+			"""
+
+# ---------------------------------------------------------------------------
+
+export brewTamlFile = (srcPath, destPath=undef, hOptions={}) ->
+	# --- taml => js
+	#     Valid Options:
+	#        force
+
+	if ! destPath?
+		destPath = withExt(srcPath, '.js', {removeLeadingUnderScore:true})
+	if hOptions.force || ! newerDestFileExists(srcPath, destPath)
+		hInfo = pathlib.parse(destPath)
+		stub = hInfo.name
+
+		tamlCode = slurp(srcPath)
+		jsCode = brewTamlStr(tamlCode, stub)
+		barf destPath, jsCode
+	return
+
+# ---------------------------------------------------------------------------

package/src/DataStores.js

@@ -0,0 +1,204 @@
+// Generated by CoffeeScript 2.6.1
+// DataStores.coffee
+import pathlib from 'path';
+
+import yaml from 'js-yaml';
+
+import {
+  writable,
+  readable,
+  get
+} from 'svelte/store';
+
+import {
+  assert,
+  undef,
+  pass,
+  error,
+  localStore,
+  isEmpty
+} from '@jdeighan/coffee-utils';
+
+import {
+  log
+} from '@jdeighan/coffee-utils/log';
+
+import {
+  withExt,
+  slurp,
+  barf,
+  newerDestFileExists
+} from '@jdeighan/coffee-utils/fs';
+
+// ---------------------------------------------------------------------------
+export var WritableDataStore = class WritableDataStore {
+  constructor(value = undef) {
+    this.store = writable(value);
+  }
+
+  subscribe(callback) {
+    return this.store.subscribe(callback);
+  }
+
+  set(value) {
+    return this.store.set(value);
+  }
+
+  update(func) {
+    return this.store.update(func);
+  }
+
+};
+
+// ---------------------------------------------------------------------------
+export var LocalStorageDataStore = class LocalStorageDataStore extends WritableDataStore {
+  constructor(masterKey1, defValue = undef) {
+    var value;
+    super(defValue);
+    this.masterKey = masterKey1;
+    value = localStore(this.masterKey);
+    if (value != null) {
+      this.set(value);
+    }
+  }
+
+  // --- I'm assuming that when update() is called,
+  //     set() will also be called
+  set(value) {
+    if (value == null) {
+      error("LocalStorageStore.set(): cannont set to undef");
+    }
+    super.set(value);
+    return localStore(this.masterKey, value);
+  }
+
+  update(func) {
+    super.update(func);
+    return localStore(this.masterKey, get(this.store));
+  }
+
+};
+
+// ---------------------------------------------------------------------------
+export var PropsDataStore = class PropsDataStore extends LocalStorageDataStore {
+  constructor(masterKey) {
+    super(masterKey, {});
+  }
+
+  setProp(name, value) {
+    if (name == null) {
+      error("PropStore.setProp(): empty key");
+    }
+    return this.update(function(hPrefs) {
+      hPrefs[name] = value;
+      return hPrefs;
+    });
+  }
+
+};
+
+// ---------------------------------------------------------------------------
+export var ReadableDataStore = class ReadableDataStore {
+  constructor() {
+    this.store = readable(null, function(set) {
+      this.setter = set; // store the setter function
+      this.start(); // call your start() method
+      return () => {
+        return this.stop(); // return function capable of stopping
+      };
+    });
+  }
+
+  subscribe(callback) {
+    return this.store.subscribe(callback);
+  }
+
+  start() {
+    return pass;
+  }
+
+  stop() {
+    return pass;
+  }
+
+};
+
+// ---------------------------------------------------------------------------
+export var DateTimeDataStore = class DateTimeDataStore extends ReadableDataStore {
+  start() {
+    // --- We need to store this interval for use in stop() later
+    return this.interval = setInterval(function() {
+      return this.setter(new Date(), 1000);
+    });
+  }
+
+  stop() {
+    return clearInterval(this.interval);
+  }
+
+};
+
+// ---------------------------------------------------------------------------
+export var MousePosDataStore = class MousePosDataStore extends ReadableDataStore {
+  start() {
+    // --- We need to store this handler for use in stop() later
+    this.mouseMoveHandler = function(e) {
+      return this.setter({
+        x: e.clientX,
+        y: e.clientY
+      });
+    };
+    return document.body.addEventListener('mousemove', this.mouseMoveHandler);
+  }
+
+  stop() {
+    return document.body.removeEventListener('mousemove', this.mouseMoveHandler);
+  }
+
+};
+
+// ---------------------------------------------------------------------------
+export var TAMLDataStore = class TAMLDataStore extends WritableDataStore {
+  constructor(str) {
+    super(taml(str));
+  }
+
+};
+
+// ---------------------------------------------------------------------------
+//         UTILITIES
+// ---------------------------------------------------------------------------
+export var taml = function(text) {
+  if (text == null) {
+    return undef;
+  }
+  return yaml.load(untabify(text, 1), {
+    skipInvalid: true
+  });
+};
+
+// ---------------------------------------------------------------------------
+export var brewTamlStr = function(code, stub) {
+  return `import {TAMLDataStore} from '@jdeighan/starbucks/stores';
+
+export let ${stub} = new TAMLDataStore(\`${code}\`);`;
+};
+
+// ---------------------------------------------------------------------------
+export var brewTamlFile = function(srcPath, destPath = undef, hOptions = {}) {
+  var hInfo, jsCode, stub, tamlCode;
+  if (destPath == null) {
+    destPath = withExt(srcPath, '.js', {
+      removeLeadingUnderScore: true
+    });
+  }
+  if (hOptions.force || !newerDestFileExists(srcPath, destPath)) {
+    hInfo = pathlib.parse(destPath);
+    stub = hInfo.name;
+    tamlCode = slurp(srcPath);
+    jsCode = brewTamlStr(tamlCode, stub);
+    barf(destPath, jsCode);
+  }
+};
+
+// ---------------------------------------------------------------------------

package/src/taml.coffee

@@ -0,0 +1,40 @@
+# taml.coffee
+
+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 {slurp} from '@jdeighan/coffee-utils/fs'
+import {debug} from '@jdeighan/coffee-utils/debug'
+import {firstLine} from '@jdeighan/coffee-utils/block'
+
+# ---------------------------------------------------------------------------
+#   isTAML - is the string valid TAML?
+
+export isTAML = (text) ->
+
+	return isString(text) && (firstLine(text).indexOf('---') == 0)
+
+# ---------------------------------------------------------------------------
+#   taml - convert valid TAML string to a JavaScript value
+
+export taml = (text) ->
+
+	debug "enter taml(#{oneline(text)})"
+	if ! text?
+		debug "return undef from taml() - text is not defined"
+		return undef
+	assert isTAML(text), "taml(): string #{oneline(text)} isn't TAML"
+	debug "return from taml()"
+	return yaml.load(untabify(text, 1), {skipInvalid: true})
+
+# ---------------------------------------------------------------------------
+#   slurpTAML - read TAML from a file
+
+export slurpTAML = (filepath) ->
+
+	contents = slurp(filepath)
+	return taml(contents)

package/src/taml.js

@@ -0,0 +1,61 @@
+// Generated by CoffeeScript 2.6.1
+// taml.coffee
+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 {
+  slurp
+} from '@jdeighan/coffee-utils/fs';
+
+import {
+  debug
+} from '@jdeighan/coffee-utils/debug';
+
+import {
+  firstLine
+} from '@jdeighan/coffee-utils/block';
+
+// ---------------------------------------------------------------------------
+//   isTAML - is the string valid TAML?
+export var isTAML = function(text) {
+  return isString(text) && (firstLine(text).indexOf('---') === 0);
+};
+
+// ---------------------------------------------------------------------------
+//   taml - convert valid TAML string to a JavaScript value
+export var taml = function(text) {
+  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`);
+  debug("return from taml()");
+  return yaml.load(untabify(text, 1), {
+    skipInvalid: true
+  });
+};
+
+// ---------------------------------------------------------------------------
+//   slurpTAML - read TAML from a file
+export var slurpTAML = function(filepath) {
+  var contents;
+  contents = slurp(filepath);
+  return taml(contents);
+};