bitwrench 1.2.15 → 2.0.7

package/dev/bitwrench-todo.md

@@ -1,215 +0,0 @@
-# bitwrench.js todo list  
-(c) 2012-2019 manu chatterjee 
- 			  deftio (at) deftio (dot) com
-
-This list is used for internal ideas, housekeeping, checklists and notes
-
-## features
-	[x] typeOf
-	[x] getURLParam fails test case where URL param contains # character
-	[x] bw.html formelry buildHTMLObjecStr (note rename)
-		add pretty print option (prettyPrint : true) --> adds tabbed || space beginning, \n in output for readability.
-	[x] makeHTMLTable (also add sort, style examples)
-		[ ] support adding column headers to makeHTMLTable as option ==> {header_content: [,,,]}
-	[x] makeHTMLTabs()
-	[x] makeHTMLList()  ==> bulleted or numerical list
- 	[x] table HTML sort support (needs alpha num fix)
-	[x] get/save cookie
-	[x] save/store file 
-		make params for JSON, CSV, function(provide parser), raw 
-	[x] typeOf
-	[ ] prettyPrintJSON with stylizble CSS
-		settable tab widths (use padding:<width><units>)
-		allow prettyPrint of functions and member-functions
-		allow functions to print correctly
-	[o] find/set css class name on supplied element (bw.markElement)  clean this up
-	[ ] encode/decode var info in to a CSS classname (see spannit.js)
-	[ ] find classes by encoded var name (returns array of hits)
-		note bw.markElement does some of this
-	[x] xformScaleSig   #sigmoidal scale, linear, constrain (mapScale can do this)
-	[0] xformScalePow   #power scale ==> remove
-	[ ] interp [NN,Lin, Cos] for arrays (e.g. simple resample, any # of dims)
- 	[x] clip 
-	[x] setIntervalX // rename repeatN() ?
-	[*] repeatUntil   --> needs usability clean up
-	[x] randomNum in (x,y, float_or_int)
-	[x] pseudoRandom gen (prandom())
-	[ ] sha256 (can be used of psuedoRandom gen)
-	[x] multidim array quick generator
-	[x] loremIpsum quick generator
- 	[x] bwSimpleStyles
- 	[x] bwSimpleThemes -- note it should work on the examples / docs page w/o problems
- 		use args (a.g. bwargs-loadSimpleTheme:themeIndex;
- 	[x] docString()
- 		support jsdoc style comments, export as JSON or prettyHTML
- 		allow man style export e.g. doc string params ==> array of vars [] ==> nice text output 
- 	[x] simple logging control to a stream (e.g. bw.log(...) with settable function)
- 	[x] isHexStr 
- 	[ ] graphMatrixAsImage (use canvas, also allow export as png)
- 	[ ] save canvas as data:url (show example with save as button)
- 	[x] color conversions, interpolate colors (used in themes, graphMatrix)
- 	[x] command line processing via <script bwargs="arg1:val1;arg2:val2">  # also works from URL param, can be disabled here as well 
- 	[ ] simple boolean search of text object.  (TBD: jado and frabjousmix support this)
- 	[x] pad strings (used in logExport({exportFormat:"text"}))
- 	[ ] bitwrench-server.js / bitwrench-server.php / bitwrench-server.py - simple server for receiving JSON encoded data
- 	[x] in options (bw.html) allow non-closed tags e.g. bw.html(["meta",{keywords:"foo, bar"},null,{tagClose:false}]) // default is tagClose:true
- 	[x] in options (bw.html) allow attribs with no value e.g. bw.html(["special tag", {type:"javascript", specialTag:null},null])
- 	[x] in options (bw.html) null for content means no content e.g.g <tag></tag>
- 	[ ] in makeCSS (pretty:false) remove "\n"
- 	[ ] makeCSS, makeCSSRule ==> CSS CSSRuleEmit
-
-## packaging and todo
-	[x] build script # currently using gnu make --> migrated to just using NPM
-	[ ] build script should fail building new package if either lint or tests fail (e.g. make script exit conditional)
-	[x] README.md
-	[o] index.html should be auto-gen'd from README.md (but include bitwrench.js)
-	[x] npm register
-	[x] npm install 
-	[x] minify (yes, using uglifyjs)
-	[ ] tests, coverage -- make sure all functions get tested
-	[x] linting - JSHint or ESLint
-	[x] "use strict";
-	[ ] api ref docs
-	[ ] examples 
-	[ ] pure JSON page generation
-	[ ] example of using YAML instead of JSON (use yamljs in example but not in bw)
-	[x] dir structure
-	[x] license
-	[x] github
-	[x] deftio.com/bitwrench pages  ==> move to deftio/opensource/bitwrench ?
-	[x] build notes
-	[x] rename to bitwrench
-	[x] npm release (already an npm package)
-	[ ] support inline logo for example favicons: <img src="data:image/png;base64,base64encoded images" /> 
-	[x] full UMD support (cjs / require / AMD / import / browser)
-
-## Issues and clean up
- 	* bw.bwSimpleThemes has cosmetic issues
-	* repeatUntil usabilitiy issues
-	* make internal function for commonly used:
-		a = bw.typeOf(a) == "type" ? true_value : false_value
-		==>
-		_toa(a,typeString | [typeString1, typeString2]) ==> {if true ... false}
-	* in buildHTMLObjectString() add paramter{"pretty" : false}  // if set to true inserts "\n" and "\t" at appropriate points in output for readability
-	* fix attribute values to escape "".  e.g. {style: "background-image: url('/path/to/image') "} <<-- shown single quotes, needs to support double quotes.  
-	* converge all makeHTML functions to have simple names (see list below).  could drop "make" so HTML, HTMLList, HTMLCard, HTMLTable, HTMLPage
-		** makeHTML   /// currently called buildHTMLObjectStr()
-		** makeHTMLTabs
-		** makeHTMLList(data_array1d, options)
-			* ordered vs unordered
-		** makeHTMLCard (see w3 schools)
-		** makeHTMLAccordian
-		** makeHTMLTable
-		** makeHTMLPage
-		** makeHTMLFooter
-		** makeHTMLHeader
-	* converge file operations
-		** fileLoadJSON also csv 
-		** fileSaveJSON also csv 
-		** fileLoad
-		** fileSave
-	* converge function registration operations
-		** funcGetID
-		** funcRegister
-		** funcUnRegister
-		** funcGetDispatchStr
-	* converge numeric operations
-		** mapScale 	==> numInterp
-		** random   	==> random
-		** clip     	==> numClip
-		** fixNum   	==> numFix
-		** multiArray	==> numMultiArray
-		** numHash32
-	* converge color operations
-		** colorInterp
-		** colorParse ==> bwformat [c0,c1,c2,alpha,model] // model can be "rgb" | "hsl" 
-		** colorToRGBHex
-		** colorRBGToHSL
-	* add disolving bw.logd on all catch (e) {}
-	* add attribute "text/css" to <style></style> export functions
-	* arrows on sortTable
-		* bw-table-sort-upa  bw-table-sort-dna bw-table-sort-xxa  // arrows mark-element is in cycle xx--> upa --> dna --> xx
-		* bw-table-sort-up  bw-table-sort-dn bw-table-sort-xx     // no arrows or display just sorts.  mark-elment is in cycle xx-->up-->dn-->xx 
-			* need to add this as option to sortable in sortTable 
-	* tree accordian (eg  explorer)
-		indented divs with show / hide
-	* makeThemes directory (?)
-	* add bw.logd(values)  // bw.debug log (adds to regular bw.log) but
-		TODO: transpose .logd and .log names --> more readable e.g. bw.log acts like console.log
-		* is dissolving via bw.logdControl
-			bw.logd joins all args like console.log
-			bw.logd can be turned on
-				bw.logdControl("on") // on
-				bw.logdControl("off") // don't log
-				bw.logd()  // return current on/off status
-				all messages are writtend with "bw.logd" as message type.  use bw.log() for custom messages
-		* takes same style params as console.log (e.g. ...)
-		*
-	* polyfils needed  ==> consider jado pull in
-		array.indexOf
-		array.map
-		array.filter
-		array.reduce
-		array.forEach
-		atob / btoa (base64)
-		string.trim  ==> bw.trim() 
-
-
-
-## future
-	consider merging spannit.js in to bitwrench
-
-```javascript
-//useful for table code, other stuff	
-element.className.replace("name", "new-name");
-//e.g. el.className.replace("bw-active", "bw-none");
-el.className.replace("bw-col", "bw-none");
-
-```
-
-## doc notes:
-document how to "mannually" set up tabs
-make sure bw doesn't try to "append to head" any code if in nodejs
-
-
-## Themes
-```javascript
-
-makeBasicTheme(colors{}) {
-color.light.primary
-color.light.background
-
-color.dark.primary
-color.dark.background
-
-color.border
-color.
-
-color.hover.primary
-color.hover.background
-color.hover.border
-
-
-var bthem = 
-`
-.w3-theme-light   {color:#000 !important; background-color:#f2f9fe !important}
-.bw-theme-dark    {color:#fff !important; background-color:#074b83 !important}
-.bw-theme-action  {color:#fff !important; background-color:#074b83 !important}
-
-.bw-theme         {color:#fff !important; background-color:#2196f3 !important}
-.bw-text-theme    {color:#2196f3 !important}
-.bw-border-theme  {border-color:#2196f3 !important}
-
-.bw-hover-theme:hover {color:#fff !important; background-color:#2196f3 !important}
-.bw-hover-text-theme:hover {color:#2196f3 !important}
-.bw-hover-border-theme:hover {border-color:#2196f3 !important}
-`	
-}
-
-```
-
-
-================================
-testing
-log
-logd

package/dev/css-arrows.md

@@ -1,23 +0,0 @@
-//=============================================
-//arrows for table sort (needs js to be fixed)
-``` css
-.bw-table-sort-upa::after {
-     content: "\2191"; 
-}
-
-.bw-table-sort-dna::after {
-     content: "\2193"; 
-}
-
-.bw-table-sort-xxa::after {
-     content: "\00a0"; 
-}
-.bw-table-sort-up::after {
-}
-
-.bw-table-sort-dn::after {
-}
-
-.bw-table-sort-xx::after {
-}
-```

package/dev/docStringDev.js

@@ -1,124 +0,0 @@
-#!/bin/sh
-':' //; exec "$(command -v nodejs || command -v node)" "$0" "$@"
-
-//The above shenbang allows running on systems whether nodejs exec is called 'node'
-//or called 'nodejs' which is common on many debian systems such as Ubuntu.
-
-//more traditional shebang would be:
-//#!/usr/bin/env node
-
-//begin actual javascript below
-
-var fs = require('fs');
-var bw = require('../bitwrench.js')["bw"];
-
-var tests = [
-function() {
-/** 
-	s1
-	abc
-	def
-	ghi
-	@wejo
-*/
-	var x;
-/* s1  not a docstring
- */
-
- /**  s1 another docsting 
- */
-	return true;
-},
-
-function() {
-
-/*
- @description 
- not a docstring
- */
- 	var y=1; // var y=1, not a valid docstring
-/**
- 	s2
-	abc
-	def
-	ghi
-	@wejo
-*/
-	var x =2;
-	x = (3>4) ? x : 2;
-
- /**  s2 another docsting  */
-	return x+y;
-},
-"/** this is a simple string */",
-"/* not a valid doc string*/",
-"not a valid doc string",
-"// not a valid docstring"
-
-];
-
-
-var outs = function(x,o) {
-		var y = typeof(x) != "string" ? x.toString() : x;
-		return "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"+bw.docString(y,o).join("\n..................\n")+"\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n";
-}
-                      
-console.log("started ... ")                        
-tests.forEach(function(x){console.log(outs(x))})
-
-tests.forEach(function(x){console.log(outs(x,{}))})
-//======
-//test docStringParse()
-console.log("\n|||||||||||||||||||||||||||||||||||||\n")
-
-//http://usejsdoc.org/tags-param.html
-//Test cases
-//Name only
-function sayHello1(somebody) {
-/**
- * @param somebody
- */
-    alert('Hello ' + somebody);
-}
-
-//Name and type
-function sayHello2(somebody) {
-/**
- * @param {string} somebody
- */
-    alert('Hello ' + somebody);
-}
-
-//Name, type, and description
-function sayHello3(somebody) {
-/**
- * @param {string} somebody Somebody's name.
- */
-    alert('Hello ' + somebody);
-}
-
-//You can add a hyphen before the description to make it more readable. Be sure to include a space before and after the hyphen.
-//Name, type, and description, with a hyphen before the description
-function sayHello4(somebody) {
-/**
- * @param {string} somebody - Somebody's name.
- */
-    alert('Hello ' + somebody);
-}
-
-var testCasesParse = [
-	sayHello1.toString(),
-	sayHello2.toString(),
-	sayHello3.toString(),
-	sayHello4.toString()
-]
-
-var outp = function(x,o) {
-	var y = typeof(x) != "string" ? x.toString() : x;
-		return "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"+(bw.docString(y,o).forEach(function(z){return bw.parseJsDocString(z)}).join ("|")).join("\n..................\n")+"\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n";
-}
-//console.log(outp(bw.parseJsDocString))
-
-//any issues here..
-console.log("\n"+bw.logExport({"format":"text"}));
-

package/dev/docStringParseDev.js

@@ -1,171 +0,0 @@
-#!/bin/sh
-':' //; exec "$(command -v nodejs || command -v node)" "$0" "$@"
-
-//The above shenbang allows running on systems whether nodejs exec is called 'node'
-//or called 'nodejs' which is common on many debian systems such as Ubuntu.
-
-//more traditional shebang would be:
-//#!/usr/bin/env node
-
-//begin actual javascript below
-
-"use strict";
-var fs = require('fs');
-var bw = require('../bitwrench.js')["bw"];
-
-/*
-
- this is a comment with no @ 
- * this is a comment with no @  (note begins with *)
-
-	@param foo
- * 	@param foo
-
- 	@param {type,type2} description starts here
- 	@param {type,type2} name - description starts here
-
-*/
-                      
-console.log("started ... ")                        
-//======
-//test docStringParse()
-console.log("\n|||||||||||||||||||||||||||||||||||||\n")
-
-//http://usejsdoc.org/tags-param.html
-//Test cases
-//Name only
-function sayHello1(somebody) {
-/**
- * @param somebody
- */
-    alert('Hello ' + somebody);
-}
-
-//Name and type
-function sayHello2(somebody) {
-/**
- * @param {string} somebody
- */
-    alert('Hello ' + somebody);
-}
-
-//Name, type, and description
-function sayHello3(somebody) {
-/**
- * @param {string} somebody Somebody's name.
- */
-    alert('Hello ' + somebody);
-}
-
-//You can add a hyphen before the description to make it more readable. Be sure to include a space before and after the hyphen.
-//Name, type, and description, with a hyphen before the description
-function sayHello4(somebody) {
-/**
- * @param {string} somebody - Somebody's name.
- */
-    alert('Hello ' + somebody);
-}
-
-function sayHello5(somebody) {
-/**
-   This is a simple description which shoud be hanlded by the parser eventhough it doesn;t have an @param type d
-   declaration in it.
-*/
-}
-var testCasesParse = [
-	sayHello1.toString(),
-	sayHello2.toString(),
-	sayHello3.toString(),
-	sayHello4.toString(),
-]
-
-var outp = function(z,opts) {
-	var i,s = "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n";
-	for (i=0; i<z.length; i++) { // for each test case
-		z.forEach(function(x){return bw.docStringParse(x,opts)}).join ("|");
-	}
-	s+= "\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n";
-}
-//console.log(outp(bw.parseJsDocString))
-var testCaseParse2 = [
- " @param",                                 // {field: "@param", "types" :"", "fieldName" :"", "description" :""}
- " @field d1 d2 d3 d4",    		//
- " @param {type1 } d1 d2 d3 d4",		//
- " @param2 {type1, type2} d1 d2 d3",	// 
- " @param {type} name - d1 d2 d3",	// 
- " this is just a desctription line"  //
-]
-
-var fn = function(s) {
-	var r={"source":s,  "field" : "", "types":"", "name" :"", "description" : ""};  
-	var a = s.replace(/^\s*(\/\*\*?)?|(\*\/)?\s*$/ig,"") // remove the comment markers if still there "/** my comment */"" ==> "my comment"
-	a = a.replace(/^\s*\**\s*/,"");  					 // remove any cruft at beginning of line " * @myParam {}....." ==> "@myParam {}....."
-	if (a.charAt(0) == "@") { // if we have hit a @fieldname parameter we start parsing.
-		//  ([str, regex, fieldStr, result{}]) ==> ([str, regex, fieldStr, result{}])  ::> ([str,result{},fieldStr,regex])
-		var _tok = function(x){
-			var m = x[0].match(x[1]);
-			if (m != null) {x[4][3]=m[1];}
-			x[0] = x[0].replace(x[1],"");
-			return x;
-		}
-		//r = [[e,f],[e,f],[e,f],[e,f]].reduce(,_tok);
-
-		var e,x;
-		var t = bw.trim;
-		e =/^@([A-Za-z0-9_<>[\]]*)/i;
-		x = a.match(e);
-		if (x != null) {r["field"] = t(x[1])} else return r; // didn't match... opt out here
-		a = a.replace(e,"");
-		
-		e = /^\s*\{([A-Za-z0-9_|\s,.\-+!@#$%^&*()=[\]]*)\}/i;
-		x = a.match(e);
-		if (x != null) 	{r["types"]=t(x[1]);} // types is optional..
-		a = a.replace(e,""); 
-
-		e  = /^\s*([\S]*)/i;
-		x = a.match(e);
-		if (x != null) 	{r["description"]=t(x[1]);} //
-		a = a.replace(e,""); 
-
-		e = /^\s*([\S]*)/i;
-		x = a.match(e);
-		if (x != null) 	{r["name"]=t(x[1]);} //
-		a = a.replace(e,""); 
-		
-		// descrpition                  ==> name: ""     	description : "description"
-		// description  we  we          ==> name: ""  		description : "description we we "
-		// name - description  we we    ==> name: "name"	descrpition : "description we we"
-		// - description we we 			==> name: ""        description : "description we we"
-		if (r["name"].match(/^\s*-+\s*/) != null) {
-			r["name"] = r["description"];
-			r["description"] = t(a);
-		} else {
-			r["description"] = r["description"]+" "+r["name"]+" "+t(a);
-			r["name"] ="";
-		}
-	}
-	return r;
-}
-
-var testFn = function(t) {
-	var i;
-	for (i in t) {
-		console.log("\n     +++++++++++++++++++++++++\n");
-		var x = fn(t[i]);
-		console.log(x);
-		console.log("\n     -------------------------\n");
-	}
-}
-testFn(testCaseParse2);
-//outp(testCaseParse2);//any issues here..
-bw.log("end-time");
-console.log("\n"+bw.logExport({"format":"text"}));
-
-/*
-
-s = getline()
-trim()
-trim leading * ==> "\*?\s+"
-
-
-*/

package/dev/figures.html

@@ -1,37 +0,0 @@
-<!DOCTYPE html>
-<html>
-<script src="https://unpkg.com/bitwrench/bitwrench.js"></script>
-<body class="bw-def-page-setup">
-
-<h1>The figure and figcaption element</h1>
-This demo shows use of html figure elements...<br>
-<div style="display:inline-block">
-<figure style="width:500px; ">
-  <img src="../images/bitwrench-512x512.png" alt="Image Alt Text" style="width:100%">
-  <figcaption id="x1">Fig.1 - Sample Image weij we owjroiew jroiew joiwewjrwe</figcaption>
-</figure>
-<figure style="width:200px">
-  <img src="../images/bitwrench-512x512.png" alt="Image Alt Text" style="width:100%">
-  <figcaption>Fig.1 - Sample Image</figcaption>
-</figure>
-<figure style="width:200px; ">
-  <figcaption>Fig.1 - Sample Image</figcaption>
-  <img src="../images/bitwrench-512x512.png" alt="Image Alt Text" style="width:100%">
-  
-</figure>
-<figure style="width:200px">
-  <img src="../images/bitwrench-512x512.png" alt="Image Alt Text" style="width:100%">
-  <figcaption>Fig.1 - Sample Image</figcaption>
-</figure>
-</div>
-End of the figures..
-
-<script>
-bw.DOM("#x1",bw.htmlTabs([["tab1","content1"],["tab2",`<figure style="width:200px; ">
-  <figcaption>Fig.1 - Sample Image</figcaption>
-  <img src="../images/bitwrench-512x512.png" alt="Image Alt Text" style="width:100%">
-  
-</figure>`],["tab3","content3"]]));
-</script>
-</body>
-</html>