react 0.2.0 → 0.2.1

package/examples/default-events1.js

@@ -0,0 +1,52 @@
+'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);
+  }
+});
+                
+
+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 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, cb -> err, custEmailHtml',
+  deliverEmail,     'custEmailHtml, cb -> err, deliveredEmail', { after: writeOutput }  // only after writeOutput is done
+); 
+
+loadAndSave('file.md', 100, '/tmp/foo', useHtml);  // executing the flow
+
+

package/examples/default1.js

@@ -23,16 +23,16 @@ function useHtml(err, 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', 'fName, uid, outDir, cb -> err, html, user, bytes',  
-  loadUser,         'uid              -> err, user',     // calling async loadUser with uid, cb called with err and user
-  loadFile,         'filename         -> err, filedata',
-  markdown,         'filedata         -> returns html',    // using a sync function
-  prepareDirectory, 'outDirname       -> err, dircreated',
-  writeOutput,      'html, user       -> err, bytesWritten', { after: prepareDirectory },  // only after prepareDirectory done
-  loadEmailTemplate, '                -> err, emailmd',
-  markdown,         'emailmd          -> returns emailHtml',   // using a sync function
-  customizeEmail,   'user, emailHtml  -> returns custEmailHtml',
-  deliverEmail,     'custEmailHtml    -> err, deliveredEmail', { after: writeOutput }  // only after writeOutput is done
-);   // callback output params
+  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, '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, cb  -> custEmailHtml',
+  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/lib/dsl.js

@@ -63,12 +63,12 @@ function parseTasks(arr) {
 }
 
 /**
-   Parse the variable arguments into in/out params, tasks, options
+   Parse the variable arguments into in/out params, options, tasks
   */
 function parseVargs(vargs) {
   var inOutParamStr = vargs.shift() || '';
-  // if last arg is object, pop it off as options
-  var options = (vargs.length && typeof(vargs[vargs.length - 1]) === 'object') ? vargs.pop() : { };
+  // if next arg is object, shift it off as options
+  var options = (vargs.length && typeof(vargs[0]) === 'object') ? vargs.shift() : { };
   var taskDefArr = vargs; // rest are for the tasks
   var defObj = {  
     inOutParamStr: inOutParamStr,

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.2.0",
+  "version": "0.2.1",
   "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/dsl.test.js

@@ -129,9 +129,9 @@ test('two inputs, two tasks, two out params', function (t) {
 
 test('two inputs, two tasks, two out params, options', function (t) {
   var r = react('myName', 'a, b, cb -> err, c, d',
+    { otherOptFoo: 'foo'},  // main flow options
     falpha, 'a, b, cb -> err, c',
-    fbeta,  'a, b, cb -> err, d, e',
-    { name: 'myflow', otherOptFoo: 'foo'}
+    fbeta,  'a, b, cb -> err, d, e'
   );
   t.deepEqual(r.ast.inParams, ['a', 'b']);
   t.deepEqual(r.ast.tasks, [
@@ -139,7 +139,7 @@ test('two inputs, two tasks, two out params, options', function (t) {
     { f: fbeta,  a: ['a', 'b'], out: ['d', 'e'], type: 'cb', name: 'fbeta'}
   ]);
   t.deepEqual(r.ast.outTask, { a: ['c', 'd'], type: 'finalcb' });
-  t.equal(r.ast.name, 'myflow', 'name should match if supplied');
+  t.equal(r.ast.name, 'myName', 'name should match');
   t.equal(r.ast.otherOptFoo, 'foo', 'other options should pass through');
   t.end();  
 });
@@ -220,9 +220,9 @@ test('not enough args throws error', function (t) {
 
 test('selectFirst', function (t) {
   var r = react.selectFirst('myName', 'a, b, cb -> c',
+    { otherOptFoo: 'foo'},  // main options                            
     falpha, 'a, b, cb -> err, c',
-    fbeta,  'a, b -> c',
-    { otherOptFoo: 'foo'}
+    fbeta,  'a, b -> c'
   );
   t.equal(r.ast.name, 'myName');
   t.deepEqual(r.ast.inParams, ['a', 'b']);