react 0.6.2 → 0.8.0

package/doc/simple.dot

@@ -1,25 +0,0 @@
-digraph loadRender {
-  loadRender_input [ shape = box, style = filled, fillcolor = aquamarine ];
-  fooPath [ style = filled, fillcolor = gainsboro ];
-  barPath [ style = filled, fillcolor = gainsboro ];
-  barP2 [ style = filled, fillcolor = gainsboro ];
-  loadFoo [ shape = box, color = blue, fillcolor = beige, style = filled ];
-  foo [ style = filled, fillcolor = gainsboro ];
-  loadBar [ shape = box, color = blue, fillcolor = beige, style = filled ];
-  bar [ style = filled, fillcolor = gainsboro ];
-  render [ shape = box, color = blue, fillcolor = beige, style = filled ];
-  renderedOut [ style = filled, fillcolor = gainsboro ];
-  loadRender_output [ shape = box, style = filled, fillcolor = aquamarine ];
-  loadRender_input -> fooPath;
-  loadRender_input -> barPath;
-  loadRender_input -> barP2;
-  fooPath -> loadFoo;
-  loadFoo -> foo;
-  barPath -> loadBar;
-  barP2 -> loadBar;
-  loadBar -> bar;
-  foo -> render;
-  bar -> render;
-  render -> renderedOut;
-  renderedOut -> loadRender_output;
-}

package/examples/longer-example.js

@@ -1,41 +0,0 @@
-'use strict';
-/*jshint white: false */
-
-var react = require('../'); // require('react');
-
-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);
-    console.error(err.stack);
-    return;
-  }
-  console.log('final result: %s, user: %s, written:%s', html, user, bytesWritten);
-}
-
-// define fn, glue together with react, it will parallelize
-// starts with name and in/out params, then the tasks
-var loadAndSave = react('loadAndSave', 'filename, uid, outDir, cb -> err, html, user, bytes',  
-  loadUser,         'uid, cb          -> err, user',     // calling async loadUser with uid, cb called with err and user
-  loadFile,         'filename, cb     -> err, filedata',
-  markdown,         'filedata         -> html',    // using a sync function
-  prepareDirectory, 'outDir, cb   -> err, dircreated',
-  writeOutput,      'html, user, cb   -> err, bytes', { after: prepareDirectory },  // only after prepareDirectory done
-  loadEmailTemplate, 'cb              -> err, emailmd',
-  markdown,         'emailmd          -> emailHtml',   // using a sync function
-  customizeEmail,   'user, emailHtml  -> custEmailHtml',  // sync function
-  deliverEmail,     'custEmailHtml, cb    -> err, deliveredEmail', { after: writeOutput }  // only after writeOutput is done
-);
-
-//in another module you can use this as any other exported fn
-loadAndSave('file.md', 100, '/tmp/foo', useHtml);  // executing the flow
-
-

package/examples/simple.js

@@ -1,45 +0,0 @@
-'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/using-ast-directly.js

@@ -1,30 +0,0 @@
-'use strict';
-
-/**
-   Advanced example using the AST directly which most users will not do.
-   For general use, see other examples like simple.js
-  */
-var react = require('../'); // require('react');
-
-function load(res, cb) { setTimeout(cb, 100, null, res + '-loaded'); }
-function prefix(prefstr, str, cb) { setTimeout(cb, 100, null, prefstr + str); }
-function postfix(str, poststr, cb) { setTimeout(cb, 100, null, str + poststr); }
-function upper(str) { return str.toUpperCase(); }
-
-var fn = react();
-var errors = fn.setAndValidateAST({
-  inParams: ['res', 'prefstr', 'poststr'],
-  tasks: [
-    { f: load,    a: ['res'],              out: ['lres'] },
-    { f: upper,   a: ['lres'],             out: ['ulres'], type: 'ret'  },
-    { f: prefix,  a: ['prefstr', 'ulres'], out: ['plres'] },
-    { f: postfix, a: ['plres', 'poststr'], out: ['plresp'] }
-  ],
-  outTask: { a: ['plresp'] }
-});
-console.error('errors:', errors); // []
-
-fn('foo', 'pre-', '-post', function cb(err, lres) {
-  console.error('err:', err);  // null
-  console.error('lres:', lres); // pre-FOO-LOADED-post
-});

package/examples/using-events1.js

@@ -1,79 +0,0 @@
-'use strict';
-/*jshint white: false */
-
-/**
-   Default DSL, showing use of events
-  */
-
-var react = require('../'); // require('react');
-react.trackTasks();  // turn on flow and task tracking events
-
-//output events as tasks start and complete
-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'); });
-  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 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/using-log-events.js

@@ -1,43 +0,0 @@
-'use strict';
-/*jshint white: false */
-
-/**
-   Default DSL, showing use of events
-  */
-
-var react = require('../'); // require('react');
-react.logEvents(); // turn on logging of all flow and task events for all react functions
-
-
-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/lib/base-task.js

@@ -1,123 +0,0 @@
-'use strict';
-/*global define:true */
-
-if (typeof define !== 'function') {
-  var define = require('amdefine')(module);
-}
-
-define(['ensure-array', './status', './event-manager'],
-       function (array, STATUS, EventManager) {
-  
-  function BaseTask() {
-  }
-
-  /**
-     Getter Fn to retrieveAn array of the output param names for this task.
-  */
-  BaseTask.prototype.getOutParams = function () {
-    return array(this.out); // ensure array
-  };
-
-  BaseTask.prototype.isComplete = function () {
-    return (this.status === STATUS.COMPLETE);
-  };
-
-  BaseTask.prototype.start = function (args) { // mark task as started with args and note time
-    /*jshint validthis: true */
-    this.args = args;
-    this.env.currentTask = this;
-    this.env.flowEmitter.emit(EventManager.TYPES.EXEC_TASK_START, this);
-  };
-
-  BaseTask.prototype.complete = function (args) { //args that were used are available
-    /*jshint validthis: true */
-    this.status = STATUS.COMPLETE;
-    this.results = args;
-    this.env.currentTask = this;
-    this.env.flowEmitter.emit(EventManager.TYPES.EXEC_TASK_COMPLETE, this);
-  };
-
-  BaseTask.prototype.functionExists = function (vCon) {
-    var fn = this.f;
-    if (!fn) return false;
-    if (fn instanceof Function) return true;
-    if (typeof(fn) === 'string') {
-      var f = vCon.getVar(fn);  // fn/method by string
-      if (f && f instanceof Function) return true;
-    }
-    return false;
-  };
-
-  BaseTask.prototype.areAllDepArgsDefined = function (vCon) {
-    return this.a.every(function (k) { return (vCon.getVar(k) !== undefined); });
-  };
-
-  BaseTask.prototype.depTasksAreDone = function (tasksByName) {
-    return (!this.after || !this.after.length || // no dep tasks OR
-            this.after.every(function (n) { return tasksByName[n].isComplete(); }));  //all done
-  };
-
-  function isObjProperty(str) { return (str.indexOf('.') !== -1); }
-
-  /**
-     check that obj parent is def and not null so writing to obj.prop
-     will not fail. ex: 'b.c' checks that b is def and not null.
-     Also returns true if not obj.prop but simple var ex: 'b'.
-     Tasks will implement outParentsExist() passing each out str
-     to this if they want to do this check.
-  */
-  BaseTask.prototype.parentExists = function (objPropStr, vCon) {
-      if (!isObjProperty(objPropStr)) return true; // NOT obj prop, just simple arg, ret true
-    var nameAndProps = objPropStr.split('.');
-    nameAndProps.pop(); // pop off final prop
-    var parent = nameAndProps.reduce(function (accObj, prop) {
-      if (accObj === undefined || accObj === null) return undefined; // prevent exception
-      return accObj[prop];
-    }, vCon.values);   // vCon['foo']['bar']
-    return (parent !== undefined && parent !== null);
-  };
-
-  /**
-     If params are obj property writes make sure the dst objects
-     are defined and not null. cb: ['b.c'] -> b is def and not null.
-     If null is specified then param is valid and will be ignored.
-       @returns true if all obj prop parents are def and non null
-  */
-  BaseTask.prototype.outParentsExist = function (vCon) {
-    var self = this;
-    return this.getOutParams().every(function (x) {
-      if (x === null) return true;
-      return self.parentExists(x, vCon);
-    });
-  };
-
-  BaseTask.prototype.isReady = function (vCon, tasksByName) {
-    return !this.status &&                  // not started AND
-    this.functionExists(vCon) &&            // function/method exists AND
-    this.areAllDepArgsDefined(vCon) &&      // all dep vars defined AND
-    this.depTasksAreDone(tasksByName) &&    // all dep tasks are done AND
-    (!this.outParentsExist ||               // (task does not implement outParentsExist method OR
-     this.outParentsExist(vCon));          //  output parents exists (for obj property writes)
-  };
-
-  BaseTask.prototype.isMethodCall = function () {
-    /*jshint regexp: false */
-    return (typeof(this.f) === 'string' && /^.*\..*$/.test(this.f));  //str contains .
-    };
-
-    BaseTask.prototype.getMethodObj =  function (vCon) { //obj.prop.prop2, returns obj.prop or undefined
-      var name = this.f;
-      if (!name) return undefined;
-      var nameAndProps = name.split('.');
-      nameAndProps.pop(); // pop off last one
-      if (!nameAndProps.length) return undefined;
-      var result = nameAndProps.reduce(function (accObj, prop) {
-        if (accObj === undefined || accObj === null) return undefined; // prevent exception
-        return accObj[prop];
-      }, vCon.values); // vCon['foo']['bar']
-      return result;
-    };
-
-  return BaseTask;
-  
-});

package/lib/cb-task.js

@@ -1,84 +0,0 @@
-'use strict';
-/*global define:true */
-
-if (typeof define !== 'function') {
-  var define = require('amdefine')(module);
-}
-
-define(['util', './sprintf', './base-task'], function (util, sprintf, BaseTask) {
-
-  function format_error(errmsg, obj) {
-    return sprintf('%s - %s', errmsg, util.inspect(obj));
-  }
-
-  var REQ = 'cbTask requires f, a, out';
-  var FN_REQ = 'cbTask requires f to be a function or string';
-  var A_REQ = 'cbTask requires a to be an array of string param names';
-  var CB_REQ = 'cbTask requires out to be an array of string param names';
-
-  function CbTask(taskDef) {
-    var self = this;
-    Object.keys(taskDef).forEach(function (k) { self[k] = taskDef[k]; });
-  }
-
-  CbTask.prototype = new BaseTask();
-  CbTask.prototype.constructor = CbTask;
-
-  CbTask.validate = function (taskDef) {
-    var errors = [];
-    if (!taskDef.f || !taskDef.a || !taskDef.out) {
-      errors.push(format_error(REQ, taskDef));
-    } else {
-      var ftype = typeof(taskDef.f);
-      if (! ((taskDef.f instanceof Function) || (ftype === 'string'))) {
-        errors.push(format_error(FN_REQ, taskDef));
-      }
-      if (! (Array.isArray(taskDef.a) &&
-             taskDef.a.every(function (x) { return (typeof(x) === 'string'); }))) {
-        errors.push(format_error(A_REQ, taskDef));
-      }
-      if (! (Array.isArray(taskDef.out) &&
-             taskDef.out.every(function (x) { return (typeof(x) === 'string'); }))) {
-        errors.push(format_error(CB_REQ, taskDef));
-      }
-    }
-    return errors;
-  };
-
-  CbTask.prototype.prepare = function prepare(handleTaskError, vCon, contExec) {
-    var self = this;
-    this.cbFun = function (err, arg0, arg1, argn) {
-      var args = Array.prototype.slice.call(arguments, 1);
-      if (err) { handleTaskError(self, err); return; } //handle error and return, we are done
-
-      //no error, save callback args to vCon context, then continue execution
-      vCon.saveResults(self.out, args);
-      self.complete(args);
-      contExec();
-    };    
-  };
-
-  CbTask.prototype.exec = function exec(vCon, handleError, contExec) {
-    try {
-      var args = this.a.map(function (k) { return vCon.getVar(k); }); //get args from vCon
-      //console.error('CbTask.exec.args=', args);
-      //console.error('CbTask.exec.vCon=', vCon);
-      this.start(args); //note the start time, args
-      args.push(this.cbFun);   // push callback fn on end
-      var func = this.f;
-      var bindObj = vCon.getVar('this'); //global space or the original this
-      if (this.isMethodCall()) { //if method call then reset func and bindObj
-        func = vCon.getVar(this.f);
-        bindObj = this.getMethodObj(vCon);
-      } else if (typeof(func) === 'string') {
-        func = vCon.getVar(func); // we want the actual fn from this string
-      }
-      func.apply(bindObj, args); 
-    } catch (err) { //catch and handle the task error, calling final cb
-      handleError(this, err);
-    }    
-  };
-
-  return CbTask;
-
-});