react 0.0.1 → 0.0.2

package/README.md

@@ -12,6 +12,8 @@ It takes inspiration from several projects including:
  - Tim Caswell and Elijah Insua's [conductor](https://github.com/creationix/conductor) - [Article](http://howtonode.org/step-of-conductor)
  - Caolan McMahon's [async](https://github.com/caolan/async)
 
+React gets its name from similarities with how "chain reactions" work in the physical world. You start the reaction and then it cascades and continues until complete.
+
 ## Goals
 
  - Improved error and exception handling
@@ -40,6 +42,14 @@ To reduce the boilerplate code needed and improve error handling, React automati
  - Validate the flow AST - determine if dependencies can all be met as defined such that flow will complete (TODO)
  - Execute the flow AST
 
+## Installing
+
+    npm install react
+
+OR 
+   
+Pull from github - http://github.com/jeffbski/react
+
 ## Examples
 
  1. [Direct AST](#directAST)

package/lib/react.js

@@ -163,10 +163,15 @@ function react(inputDef){
     });
     tasksByName = nameTasks(tasks); //remap names to exec task copies instead of taskDefs
 
+    function getVar(name) { //get the name from the variable context, name might be simple or obj.prop
+      var nameAndProps = name.split('.');
+      return nameAndProps.reduce(function(accObj, prop){ return accObj[prop]; }, vCon); // vCon['foo']['bar']
+    }
+      
 
     function execTask(t){
       t.status = STATUS.RUNNING;
-      var args = t.a.map(function(k){ return vCon[k]; }); //get args from vCon
+      var args = t.a.map(function(k){ return getVar(k); }); //get args from vCon
       if (t.cbFun) args.push(t.cbFun); //push custom callback to back if fn uses cb
       if (reactOptions.debugOutput) console.log('starting task: %s', fName(t.f), args);
       try {
@@ -192,6 +197,17 @@ function react(inputDef){
         }                     
       } catch (e) { handleTaskError(t, e); }    //catch and handle the task error, calling final cb
     }      
+
+    function stripProp(objectWithOptionalPropertyName) { //return only object if object.property
+      return ( /\w+/ ).exec(objectWithOptionalPropertyName)[0];
+    }
+    
+    function isTaskReady(t, idx, arr){
+      return !t.status &&                                                   // filter for not started AND
+             t.a.every(function(k){ return (vCon[stripProp(k)] !== undefined); }) &&   // all dep vars defined AND
+             (!t.after ||                                                   // (no dep tasks OR 
+               t.after.every( function(n){ return tasksByName[n].status === STATUS.COMPLETE; })); //alldone
+    }
     
     contExec = function contExec(){
       if (firstError) { return; } //stop execution, we already hit an error
@@ -202,12 +218,7 @@ function react(inputDef){
         cbFinal.apply(null, finalArgs);
         return;
       }
-      var tasksReady = tasks.filter(function(t, idx, arr){ //if we are here then we stil have tasks to run
-        return !t.status &&                                                   // filter for not started AND
-               t.a.every(function(k){ return (vCon[k] !== undefined); }) &&   // all dep vars defined AND
-               (!t.after ||                                                   // (no dep tasks OR 
-                t.after.every( function(n){ return tasksByName[n].status === STATUS.COMPLETE; })); //alldone
-      });
+      var tasksReady = tasks.filter(isTaskReady);     //if we are here then we stil have tasks to run
       tasksReady.forEach(function(t){ t.status = STATUS.READY; }); //set ready before call, no double exec
       tasksReady.forEach(function(t){ execTask(t); });
     };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react",
   "description": "React is a javascript module to make it easier to work with asynchronous code, by reducing boilerplate code and improving error and exception handling while allowing variable and task dependencies when defining flow.",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "Jeff Barczewski <jeff.barczewski@gmail.com>",
   "repository": { "type": "git", "url": "http://github.com/jeffbski/react.git" }, 
   "bugs" : { "url": "http://github.com/jeffbski/react/issues" }, 

package/test/example6-ast.js

@@ -4,8 +4,8 @@
    Example setting the AST directly without using define
  */
 
-var react = require('../react.js').react;
-var reactOptions = require('react').reactOptions;
+var react = require(__dirname+'/../lib/react.js').react;
+var reactOptions = require(__dirname+'/../lib/react.js').reactOptions;
 reactOptions.debugOutput = true;
 
 function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }

package/test/example6-dsl.js

@@ -4,8 +4,8 @@
    Example using functions with the simple DSL
  */
 
-var react = require('../react.js').react;
-var reactOptions = require('react').reactOptions;
+var react = require(__dirname+'/../lib/react.js').react;
+var reactOptions = require(__dirname+'/../lib/react.js').reactOptions;
 reactOptions.debugOutput = true;
 reactOptions.stackTraceLimitMin = 20;
 

package/test/example8-ast.js

@@ -4,8 +4,8 @@
   AST directly without define, using object methods in addition to functions 
  */
 
-var react = require('../react.js').react;
-var reactOptions = require('react').reactOptions;
+var react = require(__dirname+'/../lib/react.js').react;
+var reactOptions = require(__dirname+'/../lib/react.js').reactOptions;
 reactOptions.debugOutput = true;
 
 

package/test/example8-dsl.js

@@ -4,8 +4,8 @@
   Using object methods in addition to functions with simple DSL
  */
 
-var react = require('../react.js').react;
-var reactOptions = require('react').reactOptions;
+var react = require(__dirname+'/../lib/react.js').react;
+var reactOptions = require(__dirname+'/../lib/react.js').reactOptions;
 reactOptions.debugOutput = true;
 reactOptions.stackTraceLimitMin = 20;
 

package/test/example9-ast.js

@@ -0,0 +1,57 @@
+'use strict';
+
+/**
+  AST directly without define, using object methods in addition to functions
+  also passing in an options object and referring to the properties.
+  The dependency is on the object existing, if it exists, it expects the values
+  to be there.
+ */
+
+var react = require(__dirname+'/../lib/react.js').react;
+var reactOptions = require(__dirname+'/../lib/react.js').reactOptions;
+reactOptions.debugOutput = true;
+
+
+var UserMgr = function(){ };
+UserMgr.prototype = {};
+UserMgr.prototype.constructor = UserMgr;
+UserMgr.prototype.loadUser = 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, cb) { 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 r = react();
+r.ast.inputNames = ['options', 'uid', 'anObj', 'cb'];
+r.ast.taskDefs = [
+  { f:'anObj.loadUser',      a:['uid'],               cb:['user'] },
+  { f:loadFile,              a:['options.filename'],  cb:['filedata'] },
+  { f:markdown,              a:['filedata'],          ret:['html'] },
+  { f:prepareDirectory,      a:['options.outDirname'],cb:['dircreated'] },
+  { f:writeOutput,           a:['html', 'user'],      cb:['bytesWritten'],   after:['prepareDirectory'] },
+  { f:loadEmailTemplate,     a:[],                    cb:['emailmd'] },
+  { f:markdown,              a:['emailmd'],           ret:['emailHtml'] },
+  { f:customizeEmail,        a:['user', 'emailHtml'], ret:['custEmailHtml'] },
+  { f:deliverEmail,          a:['custEmailHtml'],     cb:['deliveredEmail'], after:['writeOutput'] }
+];
+r.ast.finalOutputNames = ['html', 'user', 'bytesWritten'];
+
+var myObj = new UserMgr();
+r.exec({ filename: "hello.txt", outDirname: 'outHello' }, 100, myObj, useHtml);
+r.exec({ filename: "small.txt", outDirname: 'outSmall' }, 200, myObj, useHtml);
+r.exec({ filename: "world.txt", outDirname: 'outWorld' }, 300, myObj, useHtml);
+
+
+

package/test/example9-dsl.js

@@ -0,0 +1,56 @@
+'use strict';
+
+/**
+  Using object methods in addition to functions with simple DSL
+  also passing in an options object and referring to the properties.
+  The dependency is on the object existing, if it exists, it expects the values
+  to be there.
+ */
+
+var react = require(__dirname+'/../lib/react.js').react;
+var reactOptions = require(__dirname+'/../lib/react.js').reactOptions;
+reactOptions.debugOutput = true;
+reactOptions.stackTraceLimitMin = 20;
+
+var UserMgr = function(){ };
+UserMgr.prototype = {};
+UserMgr.prototype.constructor = UserMgr;
+UserMgr.prototype.loadUser = 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, cb) { 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 r = react('options, uid, anObj, cb').define(
+    'anObj.loadUser', 'uid                -> err, user',
+    loadFile,         'options.filename   -> err, filedata',
+    markdown,         'filedata           -> returns html',
+    prepareDirectory, 'options.outDirname -> err, dircreated', 
+    writeOutput,      'html, user         -> err, bytesWritten', { after:prepareDirectory },
+    loadEmailTemplate,'                   -> err, emailmd',
+    markdown,         'emailmd            -> returns emailHtml',
+    customizeEmail,   'user, emailHtml    -> returns custEmailHtml',
+    deliverEmail,     'custEmailHtml      -> err, deliveredEmail', { after: writeOutput }
+).callbackDef('err, html, user, bytesWritten');
+
+
+//console.log(r.ast);
+
+var myObj = new UserMgr();
+r.exec({ filename: "hello.txt", outDirname: 'outHello' }, 100, myObj, useHtml);
+r.exec({ filename: "small.txt", outDirname: 'outSmall' }, 200, myObj, useHtml);
+r.exec({ filename: "world.txt", outDirname: 'outWorld' }, 300, myObj, useHtml);
+
+