solarite 0.1.1 → 0.2.0

package/src/solarite/hash.js

@@ -3,32 +3,14 @@ let objectIds = new WeakMap();
 
 /**
  * @param obj {Object|string|Node}
- * @param prefix
  * @returns {string} */
-export function getObjectId(obj, prefix=null) {
-	
-	
-	
-	//#IFDEV
-	// Slower but useful for debugging:
-	if (!prefix) {
-		if (Array.isArray(obj))
-			prefix = 'Array';
-		else if (typeof obj === 'function')
-			prefix = 'Func';
-		else if (typeof obj === 'object')
-			prefix = 'Obj'
-	}
-	//#ENDIF
-	
-	prefix = prefix || '~\f';
-	
+export function getObjectId(obj) {
 	// if (typeof obj === 'function')
-	// 	return obj.toString();
+	// 	return obj.toString(); // This fails to detect when a function's bound variables changes.
 	
 	let result = objectIds.get(obj);
 	if (!result) { // convert to string, store in result, then add 1 to lastObjectId.
-		result = prefix+(lastObjectId++); // We use a unique prefix to ensure it doesn't collide w/ strings not from getObjectId()
+		result = (lastObjectId++); // We use a unique prefix to ensure it doesn't collide w/ strings not from getObjectId()
 		objectIds.set(obj, result)
 	}
 	return result;
@@ -41,12 +23,20 @@ export function getObjectId(obj, prefix=null) {
  * Adding a toJSON method globally on these object prototypes doesn't incur that performance penalty. */
 let isHashing = true;
 function toJSON() {
-	//return (isHashing && !Array.isArray(this)) ? getObjectId(this) : this
 	return isHashing ? getObjectId(this) : this
 }
+
+
 // Node.prototype.toJSON = toJSON;
 // Function.prototype.toJSON = toJSON;
-
+// Sometimes these get unassigned by Chrome and Brave 119, as well as Firefox, seemingly randomly!
+// The same tests sometimes pass, sometimes fail, even after browser and OS restarts.
+// So we check the assignments on every run of getObjectHash()
+if (Node.prototype.toJSON !== toJSON) {
+	Node.prototype.toJSON = toJSON;
+	if (Function.prototype.toJSON !== toJSON) // Will it only unmap one but not the other?
+		Function.prototype.toJSON = toJSON;
+}
 
 /**
  * Get a string that uniquely maps to the values of the given object.
@@ -55,25 +45,18 @@ function toJSON() {
  *
  * Relies on the Node and Function prototypes being overridden above.
  *
+ * Note that passing an integer may collide with the number we get from hashing an object.
+ * But we don't handle that case because we need max performance and Solarite never passes integers to this function.
+ *
  * @param obj {*}
  * @returns {string} */
 export function getObjectHash(obj) {
-	
-	// Sometimes these get unassigned by Chrome and Brave 119, as well as Firefox, seemingly randomly!
-	// The same tests sometimes pass, sometimes fail, even after browser and OS restarts.
-	// So we check the assignments on every run of getObjectHash()
-	if (Node.prototype.toJSON !== toJSON) {
-		Node.prototype.toJSON = toJSON;
-		if (Function.prototype.toJSON !== toJSON) // Will it only unmap one but not the other?
-			Function.prototype.toJSON = toJSON;
-	}
-	
 	let result;
 	isHashing = true;
 	try {
 		result = JSON.stringify(obj);
 	}
-	catch(e){
+	catch(e) {
 		result = getObjectHashCircular(obj);
 	}
 	isHashing = false;
@@ -81,7 +64,7 @@ export function getObjectHash(obj) {
 }
 
 /**
- * Having this separate might help the optimzer for getObjectHash() ?
+ * Slower hashing method that supports.
  * @param obj
  * @returns {string} */
 function getObjectHashCircular(obj) {

package/src/solarite/r.js

@@ -1,5 +1,6 @@
 import Template from "./Template.js";
-import NodeGroupManager from "./NodeGroupManager.js";
+import Util from "./Util.js";
+import Globals from "./Globals.js";
 
 /**
  * Convert strings to HTMLNodes.
@@ -14,140 +15,139 @@ import NodeGroupManager from "./NodeGroupManager.js";
  * 5. TODO:  list more
  *
  * Currently supported:
- * 1. r`<b>Hello${'World'}!`           // Create Template that can later be used to create nodes.
+ * 1. r(el, options)`<b>${'Hi'}</b>`   // Create template and render its nodes to el.
+ * 2. r(el, template, ?options)        // Render the Template created by #1 to element.
  *
- * 2. r(el, template, ?options)        // Render the template created by #1 to element.
- * 3. r(el, options)`<b>${'Hi'}</b>`   // Create template and render its nodes to el.
+ * 3. r`<b>Hello</b> ${'World'}!`      // Create Template that can later be used to create nodes.
  *
  * 4. r('Hello');                      // Create single text node.
  * 5. r('<b>Hello</b>');               // Create single HTMLElement
  * 6. r('<b>Hello</b><u>Goodbye</u>'); // Create document fragment because there's more than one node.
- * 7. r()`Hello<b>${'World'}!</b>`     // Same as 4-6, but evaluates the string as a Solarite template, which includes properly handling nested components and r`` sub-expressions.
+ * 7. r()`Hello<b>${'World'}!</b>`     // Same as 4-6, but evaluates the string as a Solarite template, which
+ *                                     // includes properly handling nested components and r`` sub-expressions.
  * 8. r(template)                      // Render Template created by #1.
- * 9. r(() => r`<b>Hello</b>`, {...}); // Create dynamic element that has a render() function.
  *
- * @param htmlStrings {?HTMLElement|string|string[]|function():Template}
+ * 9. r({render(){...}})              // Pass an object with a render method, and optionally other props/methods.
+ *
+ * @param htmlStrings {?HTMLElement|string|string[]|function():Template|{render:function()}}
  * @param exprs {*[]|string|Template|Object}
  * @return {Node|HTMLElement|Template} */
 export default function r(htmlStrings=undefined, ...exprs) {
 
-    // 1. Path if used as a template tag.
-    if (Array.isArray(htmlStrings)) {
-        return new Template(htmlStrings, exprs);
-    }
-
-    else if (htmlStrings instanceof Node) {
-        let parent = htmlStrings, template = exprs[0];
-
-        // 2. Render template created by #4 to element.
-        if (exprs[0] instanceof Template) {
-            let options = exprs[1];
-            template.render(parent, options);
-
-            // Append on the first go.
-            if (!parent.childNodes.length && this) {
-                // TODO: Is htis ever executed?
-                debugger;
-                parent.append(this.rootNg.getParentNode());
-            }
-        }
-
-        // 3
-        else if (!exprs.length || exprs[0]) {
-            if (parent.shadowRoot)
-                parent.innerHTML = ''; // Remove shadowroot.  TODO: This could mess up paths?
-
-            let options = exprs[0];
-            return (htmlStrings, ...exprs) => {
-                rendered.add(parent)
-                let template = r(htmlStrings, ...exprs);
-                return template.render(parent, options);
-            }
-        }
-
-        // null for expr[0], remove whole element.
-           // This path never happens?
-        else {
-            throw new Error('unsupported');
-            //let ngm = NodeGroupManager.get(parent);
-            //ngm.render(null, exprs[1])
-        }
-    }
-
-    else if (typeof htmlStrings === 'string' || htmlStrings instanceof String) {
-        // If it starts with a string, trim both ends.
-        // TODO: Also trim if it ends with whitespace?
-        if (htmlStrings.match(/^\s^</))
-            htmlStrings = htmlStrings.trim();
-
-        // We create a new one each time because otherwise
-        // the returned fragment will have its content replaced by a subsequent call.
-        let templateEl = document.createElement('template');
-        templateEl.innerHTML = htmlStrings;
-
-        // 4+5. Return Node if there's one child.
-        if (templateEl.content.childNodes.length === 1)
-            return templateEl.content.firstChild;
-
-        // 6. Otherwise return DocumentFragment.
-        return templateEl.content;
-    }
-
-    // 7. Create a static element
-    else if (htmlStrings === undefined) {
-        return (htmlStrings, ...exprs) => {
-            //rendered.add(parent)
-            let template = r(htmlStrings, ...exprs);
-            return template.render();
-        }
-    }
-
-    // 8.
-    else if (htmlStrings instanceof Template) {
-        return htmlStrings.render();
-    }
-
-
-    // 9. Create dynamic element with render() function.
-    else if (typeof htmlStrings === 'function') {
-        let getTemplate = htmlStrings;
-        let template = getTemplate();
-
-        if (typeof template === 'string')
-            throw new Error(`Please add the "r" prefix before the string "${template}"`)
-
-        template.replaceMode = true;
-        let el = template.render();
-
-        // Create the render() function from the function we were given.
-        el.render = (function() {
-            template = getTemplate();
-            template.render(el);
-        }).bind(el);
-
-
-        // The second argument was an object of additional properties to add.
-        let props = exprs[0];
-        for (let name in props)
-            if (typeof props[name] === 'function')
-                el[name] = props[name].bind(el);
-            else
-                el[name] = props[name];
-
-        return el;
-    }
-
-    else
-        throw new Error('Unsupported arguments.')
-}
-
-
-
-
-
-
-/**
- * Elements that have been rendered to by r() at least once.
- * @type {WeakSet<HTMLElement>} */
-let rendered = new WeakSet();
-export {rendered}
+	// TODO: Make this a more flat if/else and call other functions for the logic.
+	if (htmlStrings instanceof Node) {
+		let parent = htmlStrings, template = exprs[0];
+
+		// 1
+		if (!(exprs[0] instanceof Template)) {
+			if (parent.shadowRoot)
+				parent.innerHTML = ''; // Remove shadowroot.  TODO: This could mess up paths?
+
+			let options = exprs[0];
+
+			// Return a tagged template function that applies the tagged themplate to parent.
+			let taggedTemplate = (htmlStrings, ...exprs) => {
+				Globals.rendered.add(parent)
+				let template = new Template(htmlStrings, exprs);
+				return template.render(parent, options);
+			}
+			return taggedTemplate;
+		}
+
+		// 2. Render template created by #4 to element.
+		else if (exprs[0] instanceof Template) {
+			let options = exprs[1];
+			template.render(parent, options);
+
+			// Append on the first go.
+			if (!parent.childNodes.length && this) {
+				// TODO: Is this ever executed?
+				debugger;
+				parent.append(this.rootNg.getParentNode());
+			}
+		}
+
+
+
+		// null for expr[0], remove whole element.
+		   // This path never happens?
+		else {
+			throw new Error('unsupported');
+			//let ngm = NodeGroupManager.get(parent);
+			//ngm.render(null, exprs[1])
+		}
+	}
+
+	// 3. Path if used as a template tag.
+	else if (Array.isArray(htmlStrings)) {
+		return new Template(htmlStrings, exprs);
+	}
+
+	else if (typeof htmlStrings === 'string' || htmlStrings instanceof String) {
+		// If it starts with a string, trim both ends.
+		// TODO: Also trim if it ends with whitespace?
+		if (htmlStrings.match(/^\s^</))
+			htmlStrings = htmlStrings.trim();
+
+		// We create a new one each time because otherwise
+		// the returned fragment will have its content replaced by a subsequent call.
+		let templateEl = document.createElement('template');
+		templateEl.innerHTML = htmlStrings;
+
+		// 4+5. Return Node if there's one child.
+		let relevantNodes = Util.trimEmptyNodes(templateEl.content.childNodes);
+		if (relevantNodes.length === 1)
+			return relevantNodes[0];
+
+		// 6. Otherwise return DocumentFragment.
+		return templateEl.content;
+	}
+
+	// 7. Create a static element
+	else if (htmlStrings === undefined) {
+		return (htmlStrings, ...exprs) => {
+			//Globals.rendered.add(parent)
+			let template = r(htmlStrings, ...exprs);
+			return template.render();
+		}
+	}
+
+	// 8.
+	else if (htmlStrings instanceof Template) {
+		return htmlStrings.render();
+	}
+
+
+	// 9. Create dynamic element with render() function.
+	else if (typeof htmlStrings === 'object') {
+		let obj = htmlStrings;
+
+		// Special rebound render path, called by normal path.
+		if (Globals.objToEl.has(obj)) {
+			return function(...args) {
+			   let template = r(...args);
+			   let el = template.render();
+				Globals.objToEl.set(obj, el);
+			}.bind(obj);
+		}
+
+		// Normal path
+		else {
+			Globals.objToEl.set(obj, null);
+			obj.render(); // Calls the Special rebound render path above, when the render function calls r(this)
+			let el = Globals.objToEl.get(obj);
+			Globals.objToEl.delete(obj);
+
+			for (let name in obj)
+				if (typeof obj[name] === 'function')
+					el[name] = obj[name].bind(el);
+				else
+					el[name] = obj[name];
+
+			return el;
+		}
+	}
+
+	else
+		throw new Error('Unsupported arguments.')
+}

package/src/solarite/watch3.js

@@ -47,10 +47,17 @@ a.items.push({name: 'Fred'});
 
 
 import Globals from "./Globals.js";
-import NodeGroupManager from "./NodeGroupManager.js";
+import delve from "../util/delve.js";
+//import NodeGroupManager from "./NodeGroupManager.js";
 
+let unusedArg = Symbol('unusedArg');
 
-export default function watch3(root, path) {
+/**
+ *
+ * @param root {Object}
+ * @param path {string}
+ * @param value {string|Symbol} */
+export default function watch3(root, path, value=unusedArg) {
 
 	/** @type {ExprPath} The ExprPath that's using this variable.*/
 	let exprPath;
@@ -58,10 +65,12 @@ export default function watch3(root, path) {
 	/** @type {function} Function evaluated by the ExprPath. */
 	let exprFunction;
 
-	// Store internal value used by get/set.
-	let value = root[path];
+	if (value !== unusedArg)
+		root[path] = value;
 
-	let ngm = NodeGroupManager.get(root);
+	// Store internal value used by get/set.
+	else
+		value = root[path];
 
 	Object.defineProperty(root, path, {
 		get() {
@@ -76,14 +85,12 @@ export default function watch3(root, path) {
 			value = val;
 
 			if (exprFunction) {
-				let ng = exprPath.parentNg;
-
-				ng.applyExprs([exprFunction], [exprPath]);  // TODO: Will fail for attribute w/ a value having multiple ExprPaths.
 
-				// TODO: This doesn't cascade upward.
-				//ng.exactKey = getObjectHash(ng.template);
+				// TODO: Will fail for attribute w/ a value having multiple ExprPaths.
+				// TODO: This won't update a component's expressions.
+				exprPath.apply(exprFunction);
 
-				ngm.reset(); // TODO: This could be skipped if applyExprs() never marked them as in-use.
+				exprPath.freeNodeGroups(); // TODO: This could be skipped if applyExprs() never marked them as in-use.
 
 			}
 		}