react 0.2.5 → 0.3.5

package/doc/default-simple.dot

@@ -0,0 +1,19 @@
+digraph simple {
+  inputs [shape=box];
+  loadFoo [shape=box];
+  loadBar [shape=box];
+  render [shape=box];
+  outputs[shape=box];
+  inputs -> fooPath;
+  inputs -> barPath;
+  inputs -> barP2;
+  fooPath -> loadFoo;
+  loadFoo -> foo;
+  barPath -> loadBar;
+  loadBar -> bar;
+  barP2 -> loadBar;
+  foo -> render;
+  bar -> render;
+  render -> renderedOut;
+  renderedOut -> outputs;
+}

package/{lib → dsl}/chain.js

@@ -1,8 +1,8 @@
 'use strict';
 
 var sprintf = require('sprintf').sprintf;
-var core = require('./core.js');
-var tutil = require('./task.js');
+var core = require('../lib/core.js');
+var tutil = require('../lib/task.js');
 
 // err for task type cb is implied and thus optional, but allow for clarity. 
 var ERROR_NAMES_RE = /^err$/i;  // first out param matching this is skipped as being the err object
@@ -145,4 +145,6 @@ FlowBuilder.prototype.end = function end() {
   return reactFn;
 };
 
-module.exports = chainDefine;
+module.exports = chainDefine;
+module.exports.options = core.options;
+module.exports.events = core.events;

package/{lib → dsl}/fstr.js

@@ -1,23 +1,32 @@
 'use strict';
+/*jshint regexp: false */
 
 var sprintf = require('sprintf').sprintf;
-var core = require('./core.js');
-var parse = require('./parse.js');
-var tutil = require('./task.js');
+var core = require('../lib/core.js');
+var parse = require('../lib/parse.js');
+var tutil = require('../lib/task.js');
 
 var INPARAMS_NO_MATCH = 'input params in wrong format, wanted "foo, bar" -  found: %s';
 var OUTPARAMS_NO_MATCH = 'output params in wrong format, wanted "foo, bar" - found: %s';
 var INOUT_PARAMS_NO_MATCH = 'task params in wrong format, wanted "foo, bar -> err, baz" - found: %s';
 var EXTRA_TASKARG = 'extra unmatched task arg: %s';
 
+var ERR_NAMES_RE = /^err$/i; // err, ERR, Err, ...
+
+function filterOutLeadingErrParam(args) { // if leading err param, filter it out
+  if (args.length && args[0].match(ERR_NAMES_RE)) args.shift();
+  return args;
+}
+
+
 var inOutDefParse = {
-  regex: /^([^-]*)(->)?\s*(er{0,2}\s*,|returns?\s+)?(.*)$/i,
+  regex: /^([^\-]*)(->)?\s*(returns?\s+)?(.*)$/i,  //TODO this will not work if literal has dash
   fn: function (m) {
     var reMatchReturns = /returns?/i;
     return {
       type: (m[3] && m[3].match(reMatchReturns)) ? 'ret' : 'cb',
       inDef: parse.splitTrimFilterArgs(m[1]),
-      outDef: parse.splitTrimFilterArgs(m[4])
+      outDef: filterOutLeadingErrParam(parse.splitTrimFilterArgs(m[4]))
     };
   }
 };
@@ -107,4 +116,6 @@ function selectFirst(inParamStr, taskDefArr, outParamStr, options) {
 }
 
 module.exports = fstrDefine;
-module.exports.selectFirst = selectFirst;
+module.exports.selectFirst = selectFirst;
+module.exports.options = core.options;
+module.exports.events = core.events;

package/{lib → dsl}/pcode.js

@@ -1,15 +1,24 @@
 'use strict';
+/*jshint regexp: false */
 
 var sprintf = require('sprintf').sprintf;
-var core = require('./core.js');
-var parse = require('./parse.js');
-var tutil = require('./task.js');
+var core = require('../lib/core.js');
+var parse = require('../lib/parse.js');
+var tutil = require('../lib/task.js');
 
 var INPARAMS_NO_MATCH = 'input params in wrong format, wanted "foo, bar, cb" -  found: %s';
 var OUTPARAMS_NO_MATCH = 'output params in wrong format, wanted "cb(err, foo)" - found: %s';
 var INOUT_PARAMS_NO_MATCH = 'task params in wrong format, wanted "foo, bar := func(baz, cat, cb) " - found: %s';
 var EXTRA_TASKARG = 'extra unmatched task arg: %s';
 
+var ERR_NAMES_RE = /^err$/i; // err, ERR, Err, ...
+
+function filterOutLeadingErrParam(args) { // if leading err param, filter it out
+  if (args.length && args[0].match(ERR_NAMES_RE)) args.shift();
+  return args;
+}
+
+
 /**
   Examples:
   var react = require('react');
@@ -54,7 +63,7 @@ var inParse = {
 };
 
 var cbParse = {
-  regex: /^\s*(var\s+)?([^:]*)\s*:=\s*([a-zA-Z0-9_\.-]+)\s*\(\s*([^)]*)\)\s*(when\s+([^;]+))?;?\s*$/,
+  regex: /^\s*(var\s+)?([^:]*)\s*:=\s*([a-zA-Z0-9_\.\-]+)\s*\(\s*([^)]*)\)\s*(when\s+([^;]+))?;?\s*$/,
   fn: function (m) {
     var taskDef = {
       type: 'cb',
@@ -68,7 +77,7 @@ var cbParse = {
 };
 
 var retParse = {
-  regex: /^\s*(var\s+)?([^:]*)\s*=\s*([a-zA-Z0-9_\.-]+)\s*\(\s*([^)]*)\)\s*(when\s+([^;]+))?;?\s*$/,
+  regex: /^\s*(var\s+)?([^:]*)\s*=\s*([a-zA-Z0-9_\.\-]+)\s*\(\s*([^)]*)\)\s*(when\s+([^;]+))?;?\s*$/,
   fn: function (m) {
     var taskDef = {
       type: 'ret',
@@ -82,10 +91,10 @@ var retParse = {
 };
 
 var finalCbParse = {
-  regex: /^\s*(cb|callback)\s*\((er{0,2}\s*,\s*)?([^)]*)\)\s*;?$/i,
+  regex: /^\s*(cb|callback)\s*\(([^)]*)\)\s*;?$/i,
   fn: function (m) {
     return {
-      outDef: (m[3]) ? parse.splitTrimFilterArgs(m[3]) : []
+      outDef: (m[2]) ? filterOutLeadingErrParam(parse.splitTrimFilterArgs(m[2])) : []
     };
   }
 };
@@ -161,4 +170,6 @@ function selectFirst(inParamStr, taskStrArr, locals, options) {
 }
 
 module.exports = pcodeDefine;
-module.exports.selectFirst = selectFirst;
+module.exports.selectFirst = selectFirst;
+module.exports.options = core.options;
+module.exports.events = core.events;

package/examples/chain-events1.js

@@ -1,26 +1,47 @@
 'use strict';
 
-var react = require('../'); // require('react');
+var chainDefine = require('../dsl/chain'); // require('react/dsl/chain');
+require('../lib/track-tasks');  // require('react/lib/track-tasks'); // turn on tracking
 
 //output events as tasks start and complete
-react.events.on('*', function (obj) {
+chainDefine.events.on('flow.*', function (obj) {
+  /*jshint validthis: true */
   var time = new Date();
   time.setTime(obj.time);
-  var eventTimeStr = time.toISOString();
   var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
-  if (obj.event === 'task.complete') {
+  var eventTimeStr = time.toISOString();
+  if (this.event === 'flow.complete') {
+    var env = obj; 
     console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
-                  obj.event, obj.name, obj.elapsedTime, argsNoCb, obj.results);
+                  this.event, env.name, env.elapsedTime, argsNoCb, env.results);   
   } else {
-    console.error('%s: %s \n\targs:(%s)\n', obj.event, obj.name, argsNoCb);
+    var name = obj.name;
+    var args = obj.args;
+    console.error('%s: %s \n\targs:(%s)\n', this.event, name, argsNoCb);
   }
 });
 
+chainDefine.events.on('task.*', function (obj) {
+  /*jshint validthis: true */
+  var time = new Date();
+  time.setTime(obj.time);
+  var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
+  var eventTimeStr = time.toISOString();
+  if (this.event === 'task.complete') {
+    var task = obj;
+    console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
+                  this.event, task.name, task.elapsedTime, argsNoCb, task.results);
+  } else {
+    var name = obj.name;
+    var args = obj.args;
+    console.error('%s: %s \n\targs:(%s)\n', this.event, name, argsNoCb);
+  }
+});
 
 function multiply(a, b, cb) { cb(null, a * b); }
 function add(a, b) { return a + b; }
 
-var fn = react.chainDefine()
+var fn = chainDefine()
   .in('a', 'b', 'cb')                                   // input params
   .out('err', 'm', 's')                                 // final callback output params
   .async(multiply).in('a', 'b', 'cb').out('err', 'm')   // task def - async fn, in params, callback out params

package/examples/chain1.js

@@ -1,11 +1,11 @@
 'use strict';
 
-var react = require('../'); // require('react');
+var chainDefine = require('../dsl/chain'); // require('react/dsl/chain');
 
 function multiply(a, b, cb) { cb(null, a * b); }
 function add(a, b) { return a + b; }
 
-var fn = react.chainDefine()
+var fn = chainDefine()
   .in('a', 'b', 'cb')                                   // input params
   .out('err', 'm', 's')                                 // final callback output params
   .async(multiply).in('a', 'b', 'cb').out('err', 'm')   // task def - async fn, in params, callback out params

package/examples/default-events1.js

@@ -1,22 +1,49 @@
 'use strict';
 /*jshint white: false */
 
+/**
+   Default DSL, showing use of events
+  */
+
 var react = require('../'); // require('react');
+require('../lib/track-tasks');  // require('react/lib/track-tasks'); // turn on tracking
 
 //output events as tasks start and complete
-react.events.on('*', function (obj) {
+react.events.on('flow.*', function (obj) {
+  /*jshint validthis: true */
   var time = new Date();
   time.setTime(obj.time);
+  var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
   var eventTimeStr = time.toISOString();
+  if (this.event === 'flow.complete') {
+    var env = obj; 
+    console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
+                  this.event, env.name, env.elapsedTime, argsNoCb, env.results);   
+  } else {
+    var name = obj.name;
+    var args = obj.args;
+    console.error('%s: %s \n\targs:(%s)\n', this.event, name, argsNoCb);
+  }
+});
+
+react.events.on('task.*', function (obj) {
+  /*jshint validthis: true */
+  var time = new Date();
+  time.setTime(obj.time);
   var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
-  if (obj.event === 'task.complete') {
+  var eventTimeStr = time.toISOString();
+  if (this.event === 'task.complete') {
+    var task = obj;
     console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
-                  obj.event, obj.name, obj.elapsedTime, argsNoCb, obj.results);
+                  this.event, task.name, task.elapsedTime, argsNoCb, task.results);
   } else {
-    console.error('%s: %s \n\targs:(%s)\n', obj.event, obj.name, argsNoCb);
+    var name = obj.name;
+    var args = obj.args;
+    console.error('%s: %s \n\targs:(%s)\n', this.event, name, argsNoCb);
   }
 });
-                
+
+
 
 function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }
 function loadFile(filename, cb){ setTimeout(cb, 100, null, 'Filedata'+filename); }
@@ -43,7 +70,7 @@ var loadAndSave = react('loadAndSave', 'filename, uid, outDirname, cb -> err, ht
   writeOutput,      'html, user, cb   -> err, bytesWritten', { after: prepareDirectory },  // only after prepareDirectory done
   loadEmailTemplate, 'cb              -> err, emailmd',
   markdown,         'emailmd          -> emailHtml',   // using a sync function
-  customizeEmail,   'user, emailHtml  -> err, custEmailHtml', // sync fn
+  customizeEmail,   'user, emailHtml  -> custEmailHtml', // sync fn
   deliverEmail,     'custEmailHtml, cb -> err, deliveredEmail', { after: writeOutput }  // only after writeOutput is done
 );
 

package/examples/default-log-events.js

@@ -0,0 +1,43 @@
+'use strict';
+/*jshint white: false */
+
+/**
+   Default DSL, showing use of events
+  */
+
+var react = require('../'); // require('react');
+require('../lib/log-events').logEvents(react);  // require('react/lib/log-events').logEvents(react); // turn on logging
+
+
+function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }
+function loadFile(filename, cb){ setTimeout(cb, 100, null, 'Filedata'+filename); }
+function markdown(filedata) { return 'html'+filedata; }
+function prepareDirectory(outDirname, cb){ setTimeout(cb, 200, null, 'dircreated-'+outDirname); }
+function writeOutput(html, user, cb){  setTimeout(cb, 300, null, html+'_bytesWritten'); }
+function loadEmailTemplate(cb) { setTimeout(cb, 50, null, 'emailmd'); }
+function customizeEmail(user, emailHtml) { return 'cust-'+user+emailHtml; }
+function deliverEmail(custEmailHtml, cb) { setTimeout(cb, 100, null, 'delivered-'+custEmailHtml); }
+
+function useHtml(err, html, user, bytesWritten) {
+  if (err) {
+    console.log('***Error: %s', err);
+    return;
+  }
+  console.log('final result: %s, user: %s, written:%s', html, user, bytesWritten);
+}
+
+var loadAndSave = react('loadAndSave', 'filename, uid, outDirname, cb -> err, html, user, bytesWritten',  // name, in/out params
+  loadUser,         'uid, cb          -> err, user',     // calling async fn loadUser with uid, callback is called with err and user
+  loadFile,         'filename, cb     -> err, filedata',
+  markdown,         'filedata         -> html',    // using a sync function
+  prepareDirectory, 'outDirname, cb   -> err, dircreated',
+  writeOutput,      'html, user, cb   -> err, bytesWritten', { after: prepareDirectory },  // only after prepareDirectory done
+  loadEmailTemplate, 'cb              -> err, emailmd',
+  markdown,         'emailmd          -> emailHtml',   // using a sync function
+  customizeEmail,   'user, emailHtml  -> custEmailHtml', // sync fn
+  deliverEmail,     'custEmailHtml, cb -> err, deliveredEmail', { after: writeOutput }  // only after writeOutput is done
+);
+
+loadAndSave('file.md', 100, '/tmp/foo', useHtml);  // executing the flow
+
+

package/examples/default-simple.js

@@ -0,0 +1,45 @@
+'use strict';
+
+/**
+   Simple example showing flow definition of two async functions feeding a
+   synchronous function.
+
+   First two async functions inputs are satisfied by the flow inputs, so
+   they will both run immediately in parallel.
+
+   The last function waits for the outputs of the previous ones, then
+   executes synchronously.
+
+   Finally the flow calls the callback with the output values once all
+   the tasks have completed.
+  */
+
+var react = require('../'); // require('react');
+
+function loadFoo(fooPath, cb) {
+  setTimeout(function () {
+    cb(null, [fooPath, 'data'].join(':'));
+  }, 10);
+}
+
+function loadBar(barPath, barP2, cb) {
+  setTimeout(function () {
+    cb(null, [barPath, barP2, 'data'].join(':'));
+  }, 10);
+}
+
+function render(foo, bar) {
+  return ['<html>', foo, '/', bar, '</html>'].join('');
+}
+
+
+var fn = react('loadRender', 'fooPath, barPath, barP2, cb -> err, renderedOut',
+  loadFoo, 'fooPath, cb -> err, foo',
+  loadBar, 'barPath, barP2, cb -> err, bar',
+  render, 'foo, bar -> renderedOut'
+);
+
+
+fn('foo.txt', 'bar.txt', 'BBB', function (err, renderedOut) {
+  console.error('results:', renderedOut);
+});

package/examples/fstr-events1.js

@@ -1,21 +1,8 @@
 'use strict';
+/*jshint white: false */
 
-var react = require('../'); // require('react');
-
-//output events as tasks start and complete
-react.events.on('*', function (obj) {
-  var time = new Date();
-  time.setTime(obj.time);
-  var eventTimeStr = time.toISOString();
-  var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
-  if (obj.event === 'task.complete') {
-    console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
-                  obj.event, obj.name, obj.elapsedTime, argsNoCb, obj.results);
-  } else {
-    console.error('%s: %s \n\targs:(%s)\n', obj.event, obj.name, argsNoCb);
-  }
-});
-                
+var fstr = require('../dsl/fstr'); // require('react/dsl/fstr');
+require('../lib/log-events').logEvents(fstr); // require('react/lib/log-events').logEvents(react);
 
 function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }
 function loadFile(filename, cb){ setTimeout(cb, 100, null, 'Filedata'+filename); }
@@ -34,7 +21,7 @@ function useHtml(err, html, user, bytesWritten) {
   console.log('final result: %s, user: %s, written:%s', html, user, bytesWritten);
 }
 
-var loadAndSave = react.fstrDefine('filename, uid, outDirname, cb', [  // input params
+var loadAndSave = fstr('filename, uid, outDirname, cb', [  // input params
   loadUser,         'uid              -> err, user',     // calling async fn loadUser with uid, callback is called with err and user
   loadFile,         'filename         -> err, filedata',
   markdown,         'filedata         -> returns html',    // using a sync function

package/examples/fstr1.js

@@ -1,6 +1,7 @@
 'use strict';
+/*jshint white: false */
 
-var react = require('../'); // require('react');
+var fstr = require('../dsl/fstr'); // require('react/dsl/fstr');
 
 function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }
 function loadFile(filename, cb){ setTimeout(cb, 100, null, 'Filedata'+filename); }
@@ -19,7 +20,7 @@ function useHtml(err, html, user, bytesWritten) {
   console.log('final result: %s, user: %s, written:%s', html, user, bytesWritten);
 }
 
-var loadAndSave = react.fstrDefine('filename, uid, outDirname, cb', [  // input params
+var loadAndSave = fstr('filename, uid, outDirname, cb', [  // input params
   loadUser,         'uid              -> err, user',     // calling async fn loadUser with uid, callback is called with err and user
   loadFile,         'filename         -> err, filedata',
   markdown,         'filedata         -> returns html',    // using a sync function

package/examples/pcode1.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var react = require('../'); // require('react');
+var pcodeDefine = require('../dsl/pcode'); // require('react/dsl/pcode');
 
 function multiply(a, b, cb) { cb(null, a * b); }
 function add(a, b) { return a + b; }
@@ -9,7 +9,7 @@ var locals = {   // since pcodeDefine uses strings, need references to functions
   add: add
 };
 
-var fn = react.pcodeDefine('a, b, cb', [  // input params
+var fn = pcodeDefine('a, b, cb', [  // input params
   'm := multiply(a, b)',   // using a callback function, use :=
   's = add(m, a)',        // using a sync function, use =
   'cb(err, m, s)'     // output params for final callback