react 0.3.0 → 0.5.1

package/test/dsl.test.js

@@ -16,7 +16,7 @@ test('module exports is a fn with properties', function (t) {
 
 test('no arguments -> empty name, inParams, tasks, outTask', function (t) {
   var r = react();
-  t.equal(r.ast.name, undefined);
+  t.equal(r.ast.name.slice(0, 'flow_'.length), 'flow_', 'generated flow name should start with flow_');
   t.deepEqual(r.ast.inParams, []);
   t.deepEqual(r.ast.tasks, []);
   t.deepEqual(r.ast.outTask, { a: [], type: 'finalcb' });
@@ -26,7 +26,7 @@ test('no arguments -> empty name, inParams, tasks, outTask', function (t) {
 
 test('empty first string -> empty name, inParams, tasks, outTask', function (t) {
   var r = react('');
-  t.equal(r.ast.name, '');
+  t.equal(r.ast.name.slice(0, 'flow_'.length), 'flow_', 'generated flow name should start with flow_');
   t.deepEqual(r.ast.inParams, []);
   t.deepEqual(r.ast.tasks, []);
   t.deepEqual(r.ast.outTask, { a: [], type: 'finalcb' });

package/test/module-use.test.js

@@ -4,6 +4,9 @@ var test = require('tap').test;
 var BaseTask = require('../lib/base-task.js');
 
 var react = require('../'); // require('react');
+// turn on tracking, obtain EventCollector
+var EventCollector = require('../lib/event-collector');  // require('react/lib/event-collector'); 
+
 
 /**
   @example
@@ -36,6 +39,9 @@ test('module exports an function object with properties', function (t) {
   t.type(react, 'function', 'is a core constructor and default dsl function');
   t.type(react.options, 'object', 'has property for global react options');
   t.type(react.events, 'object', 'has global react event manager');
+  t.type(react.logEvents, 'function', 'has function to enable event logging');
+  t.type(react.trackTasks, 'function', 'has function to enable task and flow tracking');
+  t.type(react.resolvePromises, 'function', 'has fn to enable promise detection & resolution');
   t.end();
 });
 
@@ -79,6 +85,7 @@ test('use react() default DSL from module', function (t) {
     multiply, 'a, b, cb -> err, m',
     add, 'm, a, cb -> err, s'
   );
+
   
   fn(2, 3, function (err, m, s) {
     t.deepEqual(err, null, 'should not be any error');
@@ -96,10 +103,6 @@ test('use react.selectFirst() default DSL with events', function (t) {
   function noSuccessNull(a, b, cb) { cb(null, null); } // returns null result
   function add(a, b, cb) { cb(null, a + b); }
 
-  var events = [];
-  function accumEvents(task) {
-    events.push(task);
-  }
   
   var fn = react.selectFirst('mySelectFirst', 'a, b, cb -> err, c',
     noSuccess, 'a, b, cb -> err, c',
@@ -108,16 +111,18 @@ test('use react.selectFirst() default DSL with events', function (t) {
     noSuccess, 'a, b, cb -> err, c'                             
   );
 
-  fn.events.on('task.complete', accumEvents);
+  var collector = new EventCollector();
+  collector.capture(fn, 'task.complete');
   
   fn(2, 3, function (err, c) {
     t.deepEqual(err, null, 'should not be any error');
     t.equal(c, 5);
+    var events = collector.list();
     t.equal(events.length, 3, 'should have seen two task compl events');
-    t.equal(events[0].name, 'noSuccess', 'name matches');
-    t.equal(events[1].name, 'noSuccessNull', 'name matches');
-    t.equal(events[2].name, 'add', 'name matches');
-    t.deepEqual(events[2].results, [5], 'results match');
+    t.equal(events[0].task.name, 'noSuccess', 'name matches');
+    t.equal(events[1].task.name, 'noSuccessNull', 'name matches');
+    t.equal(events[2].task.name, 'add', 'name matches');
+    t.deepEqual(events[2].task.results, [5], 'results match');
     t.end();
   });
 });

package/test/promise-auto-resolve.test.js

@@ -8,7 +8,8 @@
 var test = require('tap').test;
 var Deferred = require('promised-io/promise').Deferred;
 
-var react = require('../promise-resolve');  // require('react/promise-resolve');
+var react = require('../');  // require('react');
+react.resolvePromises(); // enable promise resolving
 
 function multiply(x, y, cb) { cb(null, x * y); }
 function add(x, y, cb) { cb(null, x + y); }

package/Jakefile.js

@@ -1,8 +0,0 @@
-
-
-require('./jake-tasks/jake-test.js');
-
-desc('Default - run watch');
-task('default', ['test:watch']);
-
-

package/dsl/chain.js

@@ -1,150 +0,0 @@
-'use strict';
-
-var sprintf = require('sprintf').sprintf;
-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
-
-// callback is implied for task type cb is implied and thus optional, but allow for clarity. 
-var CALLBACK_NAMES_RE = /^cb$|^callback$/i;  // last in param matching this is skipped as being the cb
-
-var FlowBuilder;
-
-/**
-   jQuery-like chain interface for defining flow
-
-   @example
-    // normal flow
-    var react = require('react');
-    var fn = react.chainDefine()
-      .in('filename', 'uid', 'outDirname', 'cb')
-      .out('err', 'html', 'user', 'bytesWritten')  
-      .async(loadUser)          .in('uid')               .out('err', 'user')
-      .async(loadFile)          .in('filename')          .out('err', 'filedata')
-      .sync(markdown)           .in('filedata')          .out('html')
-      .async(prepareDirectory)  .in('outDirname')        .out('err', 'dircreated') 
-      .async(writeOutput)       .in('html', 'user')      .out('err', 'bytesWritten')   .after('prepareDirectory')
-      .async(loadEmailTemplate) .in()                    .out('err', 'emailmd')
-      .sync(markdown)           .in('emailmd')           .out('emailHtml')
-      .sync(customizeEmail)     .in('user', 'emailHtml') .out('custEmailHtml')
-      .async(deliverEmail)      .in('custEmailHtml')     .out('err', 'deliveredEmail') .after('writeOutput')
-      .end();
-
-   @example
-    // selectFirst flow
-    var fn = chainDefine()
-      .selectFirst()
-      .in('a', 'b', 'cb')
-      .out('err', 'c')
-      .async(falpha).in('a', 'b', 'cb').out('err', 'c')
-      .sync(fbeta).in('a', 'b').out('c')
-      .end();    
-*/
-function chainDefine() {
-  return FlowBuilder.create();
-}
-
-function FlowBuilder() {
-  this.main = {
-    name: null,
-    options: {}
-  };
-  this.tasks = [];
-  this.focus = this.main;
-}
-
-FlowBuilder.create = function () { return new FlowBuilder(); };
-
-FlowBuilder.prototype.selectFirst = function () {
-  this.main.outTaskType = 'finalcbFirst';
-  return this;
-};
-
-FlowBuilder.prototype.name = function (name) {
-  this.focus.name = name;
-  return this;
-};
-
-FlowBuilder.prototype.in = function (param1, param2, paramN) { 
-  var args = Array.prototype.slice.call(arguments);
-  if (args.length && this.focus.type !== 'ret') {  // has args and cb or main
-    if (args[args.length - 1].match(CALLBACK_NAMES_RE)) args.pop(); // pop off the cb name if specified
-  }
-  if (this.focus === this.main) this.focus.in = args;
-  else this.focus.a = args;   // for tasks
-  return this;
-};
-
-FlowBuilder.prototype.out = function (param1, param2, paramN) {
-  var args = Array.prototype.slice.call(arguments);
-  if (args.length && this.focus.type !== 'ret') {  // has args and cb or main
-    if (args[0].match(ERROR_NAMES_RE)) args.shift(); // shift off err if specified
-  }
-  this.focus.out = args;
-  return this;
-};
-
-FlowBuilder.prototype.options = function (options) {
-  var self = this;
-  if (this.focus === this.main) {
-    Object.keys(options).forEach(function (k) { self.focus.options[k] = options[k]; });
-  } else { // task so set options right on task
-    Object.keys(options).forEach(function (k) { self.focus[k] = options[k]; });
-  }
-  return this;
-};
-
-FlowBuilder.prototype.async = function (funcOrStrMethod) {
-  var task = { f: funcOrStrMethod, type: 'cb' };
-  this.tasks.push(task);
-  this.focus = task;
-  return this;
-};
-
-FlowBuilder.prototype.sync = function (funcOrStrMethod) {
-  var task = { f: funcOrStrMethod, type: 'ret' };
-  this.tasks.push(task);
-  this.focus = task;
-  return this;
-};
-
-FlowBuilder.prototype.after = function (name1, name2, nameN) {
-  this.focus.after = Array.prototype.slice.call(arguments);
-  return this;
-};
-
-/**
-   Complete the building of a flow and perform validation
-   which throws error if flow is not valid.
-  */
-FlowBuilder.prototype.end = function end() {
-  var reactFn = core();
-
-  if (this.main.outTaskType === 'finalcbFirst') {
-    this.tasks = tutil.serializeTasks(this.tasks);
-  }
-
-  var ast = {
-    inParams: this.main.in || [],
-    tasks: this.tasks,
-    outTask: {
-      a: this.main.out || [],
-      type: this.main.outTaskType || 'finalcb'
-    }
-  };
-  if (this.main.name) ast.name = this.main.name;
-  var self = this;
-  Object.keys(this.main.options).forEach(function (k) { ast[k] = self.main.options[k]; });
-  var errors = reactFn.setAndValidateAST(ast);
-  if (errors.length) {
-    var errorStr = errors.join('\n');
-    throw new Error(errorStr);
-  }
-  return reactFn;
-};
-
-module.exports = chainDefine;
-module.exports.options = core.options;
-module.exports.events = core.events;

package/dsl/fstr.js

@@ -1,121 +0,0 @@
-'use strict';
-/*jshint regexp: false */
-
-var sprintf = require('sprintf').sprintf;
-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*(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: filterOutLeadingErrParam(parse.splitTrimFilterArgs(m[4]))
-    };
-  }
-};
-
-function filterOutTrailingCbParam(args) { // if has trailing cb | callback param, filter it out
-  var cbNamesRe = /^cb|callback$/i;  //cb, Cb, CB, callback, Callback
-  if (args.length && args[args.length - 1].match(cbNamesRe)) args.pop();
-  return args;
-}
-
-function parseInParams(str) {
-  var objDef = parse.parseStr(str, [inOutDefParse], INPARAMS_NO_MATCH);
-  objDef.inDef = filterOutTrailingCbParam(objDef.inDef);
-  return objDef;
-}
-
-function parseInOutParams(str) {
-  var objDef = parse.parseStr(str, [inOutDefParse], INOUT_PARAMS_NO_MATCH);
-  objDef.inDef = filterOutTrailingCbParam(objDef.inDef);
-  return objDef;
-}
-
-function parseOutParams(str) {
-  if (str.indexOf('->') === -1) str = '-> ' + str; // prefix so does out err process
-  return parse.parseStr(str, [inOutDefParse], OUTPARAMS_NO_MATCH);
-} 
-
-function parseTasks(arr) {
-  var tasks = [];
-  var fn, obj, result;
-  while (arr.length >= 2) {
-    obj = {};
-    fn = arr.shift();
-    result = parseInOutParams(arr.shift());
-    if (typeof(arr[0]) === 'object') obj = arr.shift(); // has options, use as obj
-    obj.f = fn;
-    obj.a = result.inDef;
-    var type = result.type;
-    obj.out = result.outDef;
-    obj.type = type;
-    tasks.push(obj);
-  }
-  if (arr.length) throw new Error(sprintf(EXTRA_TASKARG, arr[0]));
-  return tasks;
-}
-
-
-function fstrDefine(inParamStr, taskDefArr, outParamStr, options) {
-  if (!inParamStr) inParamStr = '';
-  if (!taskDefArr) taskDefArr = [];
-  if (!outParamStr) outParamStr = '';
-
-  var reactFn = core();
-  var ast = {
-    inParams: parseInParams(inParamStr).inDef,
-    tasks: parseTasks(taskDefArr),
-    outTask: { a: parseOutParams(outParamStr).outDef }
-  };
-  if (options) Object.keys(options).forEach(function (k) { ast[k] = options[k]; });
-  var errors = reactFn.setAndValidateAST(ast);
-  if (errors.length) {
-    var errorStr = errors.join('\n');
-    throw new Error(errorStr);
-  }
-  return reactFn;
-}
-
-function selectFirst(inParamStr, taskDefArr, outParamStr, options) {
-  if (!inParamStr) inParamStr = '';
-  if (!taskDefArr) taskDefArr = [];
-  if (!outParamStr) outParamStr = '';
-  var tasks = tutil.serializeTasks(parseTasks(taskDefArr));
-
-  var reactFn = core();
-  var ast = {
-    inParams: parseInParams(inParamStr).inDef,
-    tasks: tasks,
-    outTask: { type: 'finalcbFirst', a: parseOutParams(outParamStr).outDef },
-  };
-  if (options) Object.keys(options).forEach(function (k) { ast[k] = options[k]; });  
-  var errors = reactFn.setAndValidateAST(ast);
-  if (errors.length) {
-    var errorStr = errors.join('\n');
-    throw new Error(errorStr);
-  }
-  return reactFn;
-}
-
-module.exports = fstrDefine;
-module.exports.selectFirst = selectFirst;
-module.exports.options = core.options;
-module.exports.events = core.events;

package/dsl/pcode.js

@@ -1,175 +0,0 @@
-'use strict';
-/*jshint regexp: false */
-
-var sprintf = require('sprintf').sprintf;
-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');
-  
-  var locals = { falpha: falpha, fbeta: fbeta, fcharlie: fcharlie };
-  var fn = react.pcodeDefine('a, b', [
-    'd := fbeta(a, b)',
-    'e = fcharlie(a, b)',
-    'c := falpha(a, b) when fbeta:done and fcharlie:done',
-    'cb(err, c, d, e);'
-  ], locals);
-
-  function cb(err, d, e) { }
-  fn(10, 20, cb);
- */
-
-function splitAndFilterArgs(commaSepArgs) { // split, trim, filter out empty and (cb or callback)
-  var args = parse.splitTrimFilterArgs(commaSepArgs);
-  var cbNamesRe = /^cb|callback$/i;  //cb, Cb, CB, callback, Callback
-  if (args.length && args[args.length - 1].match(cbNamesRe)) args.pop();
-  return args;
-}
-
-function extractNamesFromWhenClause(str) { //given 'foo:done and bar.baz:done' return ['foo', 'bar.baz']
-  var reSplit = /\s+and\s+/i;
-  var reDone = /^([^:]+):done$/i;
-  var names = str.split(reSplit).map(function (x) {
-    x = x.trim();
-    var m = x.match(reDone); // if foo:done, we'll use foo
-    return (m) ? m[1] : x; 
-  });
-  return names;
-}
-
-var inParse = {
-  regex: /^(.*)$/, 
-  fn: function (m) {
-    return {
-      inDef: splitAndFilterArgs(m[1]),
-    };
-  }
-};
-
-var cbParse = {
-  regex: /^\s*(var\s+)?([^:]*)\s*:=\s*([a-zA-Z0-9_\.\-]+)\s*\(\s*([^)]*)\)\s*(when\s+([^;]+))?;?\s*$/,
-  fn: function (m) {
-    var taskDef = {
-      type: 'cb',
-      f: m[3],
-      inDef: (m[4]) ? splitAndFilterArgs(m[4]) : [],
-      outDef: (m[2]) ? parse.splitTrimFilterArgs(m[2]) : []
-    };
-    if (m[6]) taskDef.after = extractNamesFromWhenClause(m[6]);
-    return taskDef;
-  }
-};
-
-var retParse = {
-  regex: /^\s*(var\s+)?([^:]*)\s*=\s*([a-zA-Z0-9_\.\-]+)\s*\(\s*([^)]*)\)\s*(when\s+([^;]+))?;?\s*$/,
-  fn: function (m) {
-    var taskDef = {
-      type: 'ret',
-      f: m[3],
-      inDef: (m[4]) ? splitAndFilterArgs(m[4]) : [],
-      outDef: (m[2]) ? parse.splitTrimFilterArgs(m[2]) : []
-    };
-    if (m[6]) taskDef.after = extractNamesFromWhenClause(m[6]);
-    return taskDef;
-  }
-};
-
-var finalCbParse = {
-  regex: /^\s*(cb|callback)\s*\(([^)]*)\)\s*;?$/i,
-  fn: function (m) {
-    return {
-      outDef: (m[2]) ? filterOutLeadingErrParam(parse.splitTrimFilterArgs(m[2])) : []
-    };
-  }
-};
-
-function parseInParams(str) {
-  return parse.parseStr(str, [inParse], INPARAMS_NO_MATCH);
-}
-
-function parseTask(str) {
-  var result = parse.parseStr(str, [cbParse, retParse], INOUT_PARAMS_NO_MATCH);
-  var type = result.type;
-  var task = {
-    f: result.f,
-    a: result.inDef
-  };
-  task.out = result.outDef;
-  task.type = type;
-  if (result.after) task.after = result.after;
-  return task;
-}
-
-function parseOutParams(str) {
-  if (!str.trim().length) return { outDef: [] };
-  return parse.parseStr(str, [finalCbParse], OUTPARAMS_NO_MATCH);
-} 
-
-function parseTasks(arr) { return arr.map(parseTask); }
-
-
-function pcodeDefine(inParamStr, taskStrArr, locals, options) {
-  if (!inParamStr) inParamStr = '';
-  if (!taskStrArr) taskStrArr = [];
-  var outTaskStr = (taskStrArr.length) ? taskStrArr.pop() : '';
-  if (!locals) locals = { };
-
-  var reactFn = core();
-  var ast = {
-    inParams: parseInParams(inParamStr).inDef,
-    tasks: parseTasks(taskStrArr),
-    outTask: { a: parseOutParams(outTaskStr).outDef },
-    locals: locals
-  };
-  if (options) Object.keys(options).forEach(function (k) { ast[k] = options[k]; });  
-  var errors = reactFn.setAndValidateAST(ast);
-  if (errors.length) {
-    var errorStr = errors.join('\n');
-    throw new Error(errorStr);
-  }
-  return reactFn;
-}
-
-function selectFirst(inParamStr, taskStrArr, locals, options) {
-  if (!inParamStr) inParamStr = '';
-  if (!taskStrArr) taskStrArr = [];
-  var outTaskStr = (taskStrArr.length) ? taskStrArr.pop() : '';
-  if (!locals) locals = { };
-  var tasks = tutil.serializeTasks(parseTasks(taskStrArr));
-  
-  var reactFn = core();
-  var ast = {
-    inParams: parseInParams(inParamStr).inDef,
-    tasks: tasks,
-    outTask: { type: 'finalcbFirst', a: parseOutParams(outTaskStr).outDef },
-    locals: locals
-  };
-  if (options) Object.keys(options).forEach(function (k) { ast[k] = options[k]; });  
-  var errors = reactFn.setAndValidateAST(ast);
-  if (errors.length) {
-    var errorStr = errors.join('\n');
-    throw new Error(errorStr);
-  }
-  return reactFn;
-}
-
-module.exports = pcodeDefine;
-module.exports.selectFirst = selectFirst;
-module.exports.options = core.options;
-module.exports.events = core.events;