react 0.3.4 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/.npmignore +2 -1
  2. package/README.md +68 -172
  3. package/doc/advanced.md +166 -0
  4. package/doc/color-def.graffle +938 -0
  5. package/doc/color-def.png +0 -0
  6. package/doc/simple.dot +25 -0
  7. package/doc/simple.png +0 -0
  8. package/examples/{default1.js → longer-example.js} +0 -0
  9. package/examples/simple.js +45 -0
  10. package/examples/{ast1.js → using-ast-directly.js} +4 -0
  11. package/examples/{default-events1.js → using-events1.js} +0 -0
  12. package/examples/{default-log-events.js → using-log-events.js} +1 -1
  13. package/lib/core.js +13 -1
  14. package/lib/event-collector.js +68 -0
  15. package/lib/event-manager.js +4 -0
  16. package/lib/id.js +1 -0
  17. package/lib/log-events.js +30 -15
  18. package/{promise-resolve.js → lib/promise-resolve.js} +1 -1
  19. package/lib/task.js +8 -3
  20. package/lib/track-tasks.js +5 -62
  21. package/lib/vcon.js +1 -1
  22. package/package.json +2 -2
  23. package/react.js +33 -1
  24. package/test/ast.test.js +50 -1
  25. package/test/core.test.js +27 -2
  26. package/test/dsl.test.js +2 -2
  27. package/test/module-use.test.js +5 -2
  28. package/test/promise-auto-resolve.test.js +2 -1
  29. package/Jakefile.js +0 -8
  30. package/doc/alternate-dsls.md +0 -103
  31. package/dsl/chain.js +0 -150
  32. package/dsl/fstr.js +0 -121
  33. package/dsl/pcode.js +0 -175
  34. package/examples/chain-events1.js +0 -55
  35. package/examples/chain1.js +0 -19
  36. package/examples/fstr-events1.js +0 -38
  37. package/examples/fstr1.js +0 -37
  38. package/examples/pcode1.js +0 -22
  39. package/jake-tasks/jake-test.js +0 -64
  40. package/test/dsl/chain.test.js +0 -324
  41. package/test/dsl/fstr.test.js +0 -300
  42. package/test/dsl/pcode.test.js +0 -448
package/dsl/fstr.js DELETED
@@ -1,121 +0,0 @@
1
- 'use strict';
2
- /*jshint regexp: false */
3
-
4
- var sprintf = require('sprintf').sprintf;
5
- var core = require('../lib/core.js');
6
- var parse = require('../lib/parse.js');
7
- var tutil = require('../lib/task.js');
8
-
9
- var INPARAMS_NO_MATCH = 'input params in wrong format, wanted "foo, bar" - found: %s';
10
- var OUTPARAMS_NO_MATCH = 'output params in wrong format, wanted "foo, bar" - found: %s';
11
- var INOUT_PARAMS_NO_MATCH = 'task params in wrong format, wanted "foo, bar -> err, baz" - found: %s';
12
- var EXTRA_TASKARG = 'extra unmatched task arg: %s';
13
-
14
- var ERR_NAMES_RE = /^err$/i; // err, ERR, Err, ...
15
-
16
- function filterOutLeadingErrParam(args) { // if leading err param, filter it out
17
- if (args.length && args[0].match(ERR_NAMES_RE)) args.shift();
18
- return args;
19
- }
20
-
21
-
22
- var inOutDefParse = {
23
- regex: /^([^\-]*)(->)?\s*(returns?\s+)?(.*)$/i, //TODO this will not work if literal has dash
24
- fn: function (m) {
25
- var reMatchReturns = /returns?/i;
26
- return {
27
- type: (m[3] && m[3].match(reMatchReturns)) ? 'ret' : 'cb',
28
- inDef: parse.splitTrimFilterArgs(m[1]),
29
- outDef: filterOutLeadingErrParam(parse.splitTrimFilterArgs(m[4]))
30
- };
31
- }
32
- };
33
-
34
- function filterOutTrailingCbParam(args) { // if has trailing cb | callback param, filter it out
35
- var cbNamesRe = /^cb|callback$/i; //cb, Cb, CB, callback, Callback
36
- if (args.length && args[args.length - 1].match(cbNamesRe)) args.pop();
37
- return args;
38
- }
39
-
40
- function parseInParams(str) {
41
- var objDef = parse.parseStr(str, [inOutDefParse], INPARAMS_NO_MATCH);
42
- objDef.inDef = filterOutTrailingCbParam(objDef.inDef);
43
- return objDef;
44
- }
45
-
46
- function parseInOutParams(str) {
47
- var objDef = parse.parseStr(str, [inOutDefParse], INOUT_PARAMS_NO_MATCH);
48
- objDef.inDef = filterOutTrailingCbParam(objDef.inDef);
49
- return objDef;
50
- }
51
-
52
- function parseOutParams(str) {
53
- if (str.indexOf('->') === -1) str = '-> ' + str; // prefix so does out err process
54
- return parse.parseStr(str, [inOutDefParse], OUTPARAMS_NO_MATCH);
55
- }
56
-
57
- function parseTasks(arr) {
58
- var tasks = [];
59
- var fn, obj, result;
60
- while (arr.length >= 2) {
61
- obj = {};
62
- fn = arr.shift();
63
- result = parseInOutParams(arr.shift());
64
- if (typeof(arr[0]) === 'object') obj = arr.shift(); // has options, use as obj
65
- obj.f = fn;
66
- obj.a = result.inDef;
67
- var type = result.type;
68
- obj.out = result.outDef;
69
- obj.type = type;
70
- tasks.push(obj);
71
- }
72
- if (arr.length) throw new Error(sprintf(EXTRA_TASKARG, arr[0]));
73
- return tasks;
74
- }
75
-
76
-
77
- function fstrDefine(inParamStr, taskDefArr, outParamStr, options) {
78
- if (!inParamStr) inParamStr = '';
79
- if (!taskDefArr) taskDefArr = [];
80
- if (!outParamStr) outParamStr = '';
81
-
82
- var reactFn = core();
83
- var ast = {
84
- inParams: parseInParams(inParamStr).inDef,
85
- tasks: parseTasks(taskDefArr),
86
- outTask: { a: parseOutParams(outParamStr).outDef }
87
- };
88
- if (options) Object.keys(options).forEach(function (k) { ast[k] = options[k]; });
89
- var errors = reactFn.setAndValidateAST(ast);
90
- if (errors.length) {
91
- var errorStr = errors.join('\n');
92
- throw new Error(errorStr);
93
- }
94
- return reactFn;
95
- }
96
-
97
- function selectFirst(inParamStr, taskDefArr, outParamStr, options) {
98
- if (!inParamStr) inParamStr = '';
99
- if (!taskDefArr) taskDefArr = [];
100
- if (!outParamStr) outParamStr = '';
101
- var tasks = tutil.serializeTasks(parseTasks(taskDefArr));
102
-
103
- var reactFn = core();
104
- var ast = {
105
- inParams: parseInParams(inParamStr).inDef,
106
- tasks: tasks,
107
- outTask: { type: 'finalcbFirst', a: parseOutParams(outParamStr).outDef },
108
- };
109
- if (options) Object.keys(options).forEach(function (k) { ast[k] = options[k]; });
110
- var errors = reactFn.setAndValidateAST(ast);
111
- if (errors.length) {
112
- var errorStr = errors.join('\n');
113
- throw new Error(errorStr);
114
- }
115
- return reactFn;
116
- }
117
-
118
- module.exports = fstrDefine;
119
- module.exports.selectFirst = selectFirst;
120
- module.exports.options = core.options;
121
- module.exports.events = core.events;
package/dsl/pcode.js DELETED
@@ -1,175 +0,0 @@
1
- 'use strict';
2
- /*jshint regexp: false */
3
-
4
- var sprintf = require('sprintf').sprintf;
5
- var core = require('../lib/core.js');
6
- var parse = require('../lib/parse.js');
7
- var tutil = require('../lib/task.js');
8
-
9
- var INPARAMS_NO_MATCH = 'input params in wrong format, wanted "foo, bar, cb" - found: %s';
10
- var OUTPARAMS_NO_MATCH = 'output params in wrong format, wanted "cb(err, foo)" - found: %s';
11
- var INOUT_PARAMS_NO_MATCH = 'task params in wrong format, wanted "foo, bar := func(baz, cat, cb) " - found: %s';
12
- var EXTRA_TASKARG = 'extra unmatched task arg: %s';
13
-
14
- var ERR_NAMES_RE = /^err$/i; // err, ERR, Err, ...
15
-
16
- function filterOutLeadingErrParam(args) { // if leading err param, filter it out
17
- if (args.length && args[0].match(ERR_NAMES_RE)) args.shift();
18
- return args;
19
- }
20
-
21
-
22
- /**
23
- Examples:
24
- var react = require('react');
25
-
26
- var locals = { falpha: falpha, fbeta: fbeta, fcharlie: fcharlie };
27
- var fn = react.pcodeDefine('a, b', [
28
- 'd := fbeta(a, b)',
29
- 'e = fcharlie(a, b)',
30
- 'c := falpha(a, b) when fbeta:done and fcharlie:done',
31
- 'cb(err, c, d, e);'
32
- ], locals);
33
-
34
- function cb(err, d, e) { }
35
- fn(10, 20, cb);
36
- */
37
-
38
- function splitAndFilterArgs(commaSepArgs) { // split, trim, filter out empty and (cb or callback)
39
- var args = parse.splitTrimFilterArgs(commaSepArgs);
40
- var cbNamesRe = /^cb|callback$/i; //cb, Cb, CB, callback, Callback
41
- if (args.length && args[args.length - 1].match(cbNamesRe)) args.pop();
42
- return args;
43
- }
44
-
45
- function extractNamesFromWhenClause(str) { //given 'foo:done and bar.baz:done' return ['foo', 'bar.baz']
46
- var reSplit = /\s+and\s+/i;
47
- var reDone = /^([^:]+):done$/i;
48
- var names = str.split(reSplit).map(function (x) {
49
- x = x.trim();
50
- var m = x.match(reDone); // if foo:done, we'll use foo
51
- return (m) ? m[1] : x;
52
- });
53
- return names;
54
- }
55
-
56
- var inParse = {
57
- regex: /^(.*)$/,
58
- fn: function (m) {
59
- return {
60
- inDef: splitAndFilterArgs(m[1]),
61
- };
62
- }
63
- };
64
-
65
- var cbParse = {
66
- regex: /^\s*(var\s+)?([^:]*)\s*:=\s*([a-zA-Z0-9_\.\-]+)\s*\(\s*([^)]*)\)\s*(when\s+([^;]+))?;?\s*$/,
67
- fn: function (m) {
68
- var taskDef = {
69
- type: 'cb',
70
- f: m[3],
71
- inDef: (m[4]) ? splitAndFilterArgs(m[4]) : [],
72
- outDef: (m[2]) ? parse.splitTrimFilterArgs(m[2]) : []
73
- };
74
- if (m[6]) taskDef.after = extractNamesFromWhenClause(m[6]);
75
- return taskDef;
76
- }
77
- };
78
-
79
- var retParse = {
80
- regex: /^\s*(var\s+)?([^:]*)\s*=\s*([a-zA-Z0-9_\.\-]+)\s*\(\s*([^)]*)\)\s*(when\s+([^;]+))?;?\s*$/,
81
- fn: function (m) {
82
- var taskDef = {
83
- type: 'ret',
84
- f: m[3],
85
- inDef: (m[4]) ? splitAndFilterArgs(m[4]) : [],
86
- outDef: (m[2]) ? parse.splitTrimFilterArgs(m[2]) : []
87
- };
88
- if (m[6]) taskDef.after = extractNamesFromWhenClause(m[6]);
89
- return taskDef;
90
- }
91
- };
92
-
93
- var finalCbParse = {
94
- regex: /^\s*(cb|callback)\s*\(([^)]*)\)\s*;?$/i,
95
- fn: function (m) {
96
- return {
97
- outDef: (m[2]) ? filterOutLeadingErrParam(parse.splitTrimFilterArgs(m[2])) : []
98
- };
99
- }
100
- };
101
-
102
- function parseInParams(str) {
103
- return parse.parseStr(str, [inParse], INPARAMS_NO_MATCH);
104
- }
105
-
106
- function parseTask(str) {
107
- var result = parse.parseStr(str, [cbParse, retParse], INOUT_PARAMS_NO_MATCH);
108
- var type = result.type;
109
- var task = {
110
- f: result.f,
111
- a: result.inDef
112
- };
113
- task.out = result.outDef;
114
- task.type = type;
115
- if (result.after) task.after = result.after;
116
- return task;
117
- }
118
-
119
- function parseOutParams(str) {
120
- if (!str.trim().length) return { outDef: [] };
121
- return parse.parseStr(str, [finalCbParse], OUTPARAMS_NO_MATCH);
122
- }
123
-
124
- function parseTasks(arr) { return arr.map(parseTask); }
125
-
126
-
127
- function pcodeDefine(inParamStr, taskStrArr, locals, options) {
128
- if (!inParamStr) inParamStr = '';
129
- if (!taskStrArr) taskStrArr = [];
130
- var outTaskStr = (taskStrArr.length) ? taskStrArr.pop() : '';
131
- if (!locals) locals = { };
132
-
133
- var reactFn = core();
134
- var ast = {
135
- inParams: parseInParams(inParamStr).inDef,
136
- tasks: parseTasks(taskStrArr),
137
- outTask: { a: parseOutParams(outTaskStr).outDef },
138
- locals: locals
139
- };
140
- if (options) Object.keys(options).forEach(function (k) { ast[k] = options[k]; });
141
- var errors = reactFn.setAndValidateAST(ast);
142
- if (errors.length) {
143
- var errorStr = errors.join('\n');
144
- throw new Error(errorStr);
145
- }
146
- return reactFn;
147
- }
148
-
149
- function selectFirst(inParamStr, taskStrArr, locals, options) {
150
- if (!inParamStr) inParamStr = '';
151
- if (!taskStrArr) taskStrArr = [];
152
- var outTaskStr = (taskStrArr.length) ? taskStrArr.pop() : '';
153
- if (!locals) locals = { };
154
- var tasks = tutil.serializeTasks(parseTasks(taskStrArr));
155
-
156
- var reactFn = core();
157
- var ast = {
158
- inParams: parseInParams(inParamStr).inDef,
159
- tasks: tasks,
160
- outTask: { type: 'finalcbFirst', a: parseOutParams(outTaskStr).outDef },
161
- locals: locals
162
- };
163
- if (options) Object.keys(options).forEach(function (k) { ast[k] = options[k]; });
164
- var errors = reactFn.setAndValidateAST(ast);
165
- if (errors.length) {
166
- var errorStr = errors.join('\n');
167
- throw new Error(errorStr);
168
- }
169
- return reactFn;
170
- }
171
-
172
- module.exports = pcodeDefine;
173
- module.exports.selectFirst = selectFirst;
174
- module.exports.options = core.options;
175
- module.exports.events = core.events;
@@ -1,55 +0,0 @@
1
- 'use strict';
2
-
3
- var chainDefine = require('../dsl/chain'); // require('react/dsl/chain');
4
- require('../lib/track-tasks'); // require('react/lib/track-tasks'); // turn on tracking
5
-
6
- //output events as tasks start and complete
7
- chainDefine.events.on('flow.*', function (obj) {
8
- /*jshint validthis: true */
9
- var time = new Date();
10
- time.setTime(obj.time);
11
- var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
12
- var eventTimeStr = time.toISOString();
13
- if (this.event === 'flow.complete') {
14
- var env = obj;
15
- console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
16
- this.event, env.name, env.elapsedTime, argsNoCb, env.results);
17
- } else {
18
- var name = obj.name;
19
- var args = obj.args;
20
- console.error('%s: %s \n\targs:(%s)\n', this.event, name, argsNoCb);
21
- }
22
- });
23
-
24
- chainDefine.events.on('task.*', function (obj) {
25
- /*jshint validthis: true */
26
- var time = new Date();
27
- time.setTime(obj.time);
28
- var argsNoCb = obj.args.filter(function (a) { return (typeof(a) !== 'function'); });
29
- var eventTimeStr = time.toISOString();
30
- if (this.event === 'task.complete') {
31
- var task = obj;
32
- console.error('%s: %s \tmsecs:(%s) \n\targs:(%s) \n\tresults:(%s)\n',
33
- this.event, task.name, task.elapsedTime, argsNoCb, task.results);
34
- } else {
35
- var name = obj.name;
36
- var args = obj.args;
37
- console.error('%s: %s \n\targs:(%s)\n', this.event, name, argsNoCb);
38
- }
39
- });
40
-
41
- function multiply(a, b, cb) { cb(null, a * b); }
42
- function add(a, b) { return a + b; }
43
-
44
- var fn = chainDefine()
45
- .in('a', 'b', 'cb') // input params
46
- .out('err', 'm', 's') // final callback output params
47
- .async(multiply).in('a', 'b', 'cb').out('err', 'm') // task def - async fn, in params, callback out params
48
- .sync(add).in('m', 'a').out('s') // task def - sync fn, in params, return value
49
- .end();
50
-
51
- fn(2, 3, function (err, m, s) {
52
- console.error('err:', err); // null
53
- console.error('m:', m); // 2 * 3 = 6
54
- console.error('s:', s); // 6 + 2 = 8
55
- });
@@ -1,19 +0,0 @@
1
- 'use strict';
2
-
3
- var chainDefine = require('../dsl/chain'); // require('react/dsl/chain');
4
-
5
- function multiply(a, b, cb) { cb(null, a * b); }
6
- function add(a, b) { return a + b; }
7
-
8
- var fn = chainDefine()
9
- .in('a', 'b', 'cb') // input params
10
- .out('err', 'm', 's') // final callback output params
11
- .async(multiply).in('a', 'b', 'cb').out('err', 'm') // task def - async fn, in params, callback out params
12
- .sync(add).in('m', 'a').out('s') // task def - sync fn, in params, return value
13
- .end();
14
-
15
- fn(2, 3, function (err, m, s) {
16
- console.error('err:', err); // null
17
- console.error('m:', m); // 2 * 3 = 6
18
- console.error('s:', s); // 6 + 2 = 8
19
- });
@@ -1,38 +0,0 @@
1
- 'use strict';
2
- /*jshint white: false */
3
-
4
- var fstr = require('../dsl/fstr'); // require('react/dsl/fstr');
5
- require('../lib/log-events').logEvents(fstr); // require('react/lib/log-events').logEvents(react);
6
-
7
- function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }
8
- function loadFile(filename, cb){ setTimeout(cb, 100, null, 'Filedata'+filename); }
9
- function markdown(filedata) { return 'html'+filedata; }
10
- function prepareDirectory(outDirname, cb){ setTimeout(cb, 200, null, 'dircreated-'+outDirname); }
11
- function writeOutput(html, user, cb){ setTimeout(cb, 300, null, html+'_bytesWritten'); }
12
- function loadEmailTemplate(cb) { setTimeout(cb, 50, null, 'emailmd'); }
13
- function customizeEmail(user, emailHtml, cb) { return 'cust-'+user+emailHtml; }
14
- function deliverEmail(custEmailHtml, cb) { setTimeout(cb, 100, null, 'delivered-'+custEmailHtml); }
15
-
16
- function useHtml(err, html, user, bytesWritten) {
17
- if(err) {
18
- console.log('***Error: %s', err);
19
- return;
20
- }
21
- console.log('final result: %s, user: %s, written:%s', html, user, bytesWritten);
22
- }
23
-
24
- var loadAndSave = fstr('filename, uid, outDirname, cb', [ // input params
25
- loadUser, 'uid -> err, user', // calling async fn loadUser with uid, callback is called with err and user
26
- loadFile, 'filename -> err, filedata',
27
- markdown, 'filedata -> returns html', // using a sync function
28
- prepareDirectory, 'outDirname -> err, dircreated',
29
- writeOutput, 'html, user -> err, bytesWritten', { after: prepareDirectory }, // only after prepareDirectory done
30
- loadEmailTemplate, ' -> err, emailmd',
31
- markdown, 'emailmd -> returns emailHtml', // using a sync function
32
- customizeEmail, 'user, emailHtml -> returns custEmailHtml',
33
- deliverEmail, 'custEmailHtml -> err, deliveredEmail', { after: writeOutput } // only after writeOutput is done
34
- ], 'err, html, user, bytesWritten'); // callback output params
35
-
36
- loadAndSave('file.md', 100, '/tmp/foo', useHtml); // executing the flow
37
-
38
-
package/examples/fstr1.js DELETED
@@ -1,37 +0,0 @@
1
- 'use strict';
2
- /*jshint white: false */
3
-
4
- var fstr = require('../dsl/fstr'); // require('react/dsl/fstr');
5
-
6
- function loadUser(uid, cb){ setTimeout(cb, 100, null, "User"+uid); }
7
- function loadFile(filename, cb){ setTimeout(cb, 100, null, 'Filedata'+filename); }
8
- function markdown(filedata) { return 'html'+filedata; }
9
- function prepareDirectory(outDirname, cb){ setTimeout(cb, 200, null, 'dircreated-'+outDirname); }
10
- function writeOutput(html, user, cb){ setTimeout(cb, 300, null, html+'_bytesWritten'); }
11
- function loadEmailTemplate(cb) { setTimeout(cb, 50, null, 'emailmd'); }
12
- function customizeEmail(user, emailHtml, cb) { return 'cust-'+user+emailHtml; }
13
- function deliverEmail(custEmailHtml, cb) { setTimeout(cb, 100, null, 'delivered-'+custEmailHtml); }
14
-
15
- function useHtml(err, html, user, bytesWritten) {
16
- if(err) {
17
- console.log('***Error: %s', err);
18
- return;
19
- }
20
- console.log('final result: %s, user: %s, written:%s', html, user, bytesWritten);
21
- }
22
-
23
- var loadAndSave = fstr('filename, uid, outDirname, cb', [ // input params
24
- loadUser, 'uid -> err, user', // calling async fn loadUser with uid, callback is called with err and user
25
- loadFile, 'filename -> err, filedata',
26
- markdown, 'filedata -> returns html', // using a sync function
27
- prepareDirectory, 'outDirname -> err, dircreated',
28
- writeOutput, 'html, user -> err, bytesWritten', { after: prepareDirectory }, // only after prepareDirectory done
29
- loadEmailTemplate, ' -> err, emailmd',
30
- markdown, 'emailmd -> returns emailHtml', // using a sync function
31
- customizeEmail, 'user, emailHtml -> returns custEmailHtml',
32
- deliverEmail, 'custEmailHtml -> err, deliveredEmail', { after: writeOutput } // only after writeOutput is done
33
- ], 'err, html, user, bytesWritten'); // callback output params
34
-
35
- loadAndSave('file.md', 100, '/tmp/foo', useHtml); // executing the flow
36
-
37
-