-
Notifications
You must be signed in to change notification settings - Fork 3
/
Promises.js
397 lines (359 loc) · 11.6 KB
/
Promises.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
/*
Promises version 0.5
An implementation of promises for MooTools:
http://en.wikipedia.org/wiki/Futures_and_promises
*/
function $get(first, prop) {
var args = $A(arguments), rest = args.rest(2), next;
if(rest.length == 0) return first[prop];
if(['object', 'array'].contains($type(first))) next = first[prop];
if($type(next) == 'function') next = first[prop]();
return (next == null) ? null : $get.apply(null, [next].concat(rest));
};
// We need a backreference to wrapper to support usage from within classes - David
Class.extend({
wrap: function(self, key, method) {
if (method._origin) method = method._origin;
var wrapper = function() {
if (method._protected && this._current == null) throw new Error('The method "' + key + '" cannot be called.');
var caller = this.caller, current = this._current;
this.caller = current; this._current = arguments.callee;
var result = method.apply(this, arguments);
this._current = current; this.caller = caller;
return result;
}.extend({_owner: self, _origin: method, _name: key});
method._wrapper = wrapper;
return wrapper;
}
});
Array.implement({
rest: function(n) { return this.slice(n || 1, this.length); }
});
Function.implement({
decorate: function() {
var decorators = $A(arguments), resultFn = this, decorator;
while(decorator = decorators.pop()) resultFn = decorator(resultFn);
return resultFn;
},
comp: function() {
var fns = $A(arguments), self = this;
return function() {
var temp = $A(fns);
var args = $A(arguments), result = (self && $type(self) == 'function') ? self.apply(this, args) : null, fn;
while(fn = temp.shift()) result = fn.apply(null, (result && [result]) || args);
return result;
}
}
});
var $comp = Function.comp;
Function.implement({
asPromise: function() { return this.decorate(promise); }
});
function $msg(methodName) {
var rest = $A(arguments).rest();
return function(obj) {
return obj[methodName].apply(obj, rest);
};
}
/*
Class: Promise
You can create empty Promise instances, Promises from unsent Request instances
or from an array of values containing promises.
new Promise();
new Promise(new Request({url:'bar.html'}));
new Promise(["foo", new Promise(new Request({url:'bar.html'})), "baz"]);
Please note that you should not initialize Promise with a Request which has already
been sent.
*/
var Promise = new Class({
Implements: [Events, Options],
name: "Promise",
defaults: {
lazy: true,
reduce: null,
bare: false,
meta: null
},
initialize: function(value, options) {
this.setOptions(this.defaults, options);
this.__realized = false;
this.__ops = [];
if(this.options.meta) this.setMeta(this.options.meta);
if(value && value.xhr) {
this.initReq(value);
} else if(value && $type(value) == "array") {
Promise.watch(value, function(promises) {
var values = promises.map(Promise.getValue);
var result = (this.options.reduce && this.options.reduce.apply(null, values)) || values;
this.setValue(result);
}.bind(this));
} else if(value && !Promise.isPromise(value) && $type(value) == "object") {
Promise.watch($H(value).getValues(), function(promises) {
this.setValue($H(value).map(Promise.getValue).getClean());
}.bind(this));
} else if(Promise.isPromise(value)) {
value.addEvent('realized', function() {
this.setValue(value.value());
}.bind(this))
} else if(value) {
this.__plain = true;
this.setValue(value, false);
}
return this;
},
setMeta: function(meta) { this.__meta = meta; },
meta: function() { return this.__meta; },
initReq: function(req) {
this.__req = req;
req.addEvent('onSuccess', function(responseText) {
var json = (!req.options.bare) ? JSON.decode(responseText) : responseText;
var v = json.data || json;
this.setValue(this.applyOps(v));
}.bind(this));
req.addEvent('onFailure', function(responseText) {
this.setValue(undefined);
this.fireEvent('error', this);
}.bind(this));
if(!this.options.lazy) {
if(Promise.debug) req.options.async = false;
req.send();
}
},
realize: function() {
if(this.__req && !this.__realizing) {
this.__realizing = true;
if(Promise.debug) this.__req.options.async = false;
this.__req.send();
} else if(this.__plain) {
this.setValue(this.value());
}
return this;
},
applyOps: function(value) {
var aop = this.__ops.shift();
while(aop) {
value = aop(value);
aop = this.__ops.shift();
}
return value;
},
/*
Method: op
You can modify the value of unrealized Promise with op. If the Promise
is unrealized, the return value will be the Promise itself. If already
realized, the return value will be value of the Promise after the operation
has been applied.
*/
op: function(fn) {
if(!this.__realized) {
this.__ops.push(fn);
} else {
this.setValue(fn(this.__value));
}
if(!this.__realized) return this;
return this.value();
},
hasOps: function() { return this.__ops.length > 0; },
setValue: function(value, notify) {
if(value && value.xhr) {
this.initReq(value);
} else {
this.__value = value
if(!this.__realized && notify !== false) {
this.__realized = true;
this.fireEvent('realized', this.__value);
}
}
},
value: function() {
if(this.hasOps()) this.__value = this.applyOps(this.__value);
return this.__value;
},
isRealized: function() {
return this.__realized;
},
isNotRealized: function() {
return !this.__realized;
},
get: function() {
var args = $A(arguments);
if(!this.isRealized()) return (new Promise(this.realize())).op(function(v) { return $get.apply(null, [v].extend(args)); });
return $get.apply(null, [this.value()].extend(args));
}
});
Promise.debug = false;
Promise.isPromise = function(obj) {
return (obj && obj.name == "Promise");
}
Promise.getValue = function(v) {
while (Promise.isPromise(v) && v.isRealized()) v = v.value();
return v;
}
/*
Function: Promise.toValues
Map an array of values to only non-Promise values or
unrealized Promise values.
*/
Promise.toValues = function(ary) {
while(ary.some(Promise.isPromise)) ary = ary.map(Promise.getValue);
return ary;
}
/*
Function: Promise.promiseOrValue
If v is a Request object returns a promise, otherwise
if v is Promise which has been realized returns the promises
value. If it is not a promise, the value is simply returned.
*/
Promise.promiseOrValue = function(v) {
if(v && v.xhr) return new Promise(v);
if(Promise.isPromise(v) && v.isRealized()) return v.value();
return v;
}
/*
Function: Promise.watch
Watch an array of values containing unrealized promises.
This will not call the callback until there no unrealized
promises left. This means if the value of a Promise is
another Promise which is not realized, Promise.watch will simply
Promise.watch the values again.
Parametes:
args - an array of values, can contain Promise instances realized or unrealized.
cb - a function callback.
errCb - a error callback.
*/
Promise.watch = function(args, cb, errCb) {
var promises = args.filter(Promise.isPromise);
var unrealized = promises.filter($msg("isNotRealized"));
if(unrealized.length > 0) {
var watching = new Group(unrealized);
watching.addEvent('realized', function() {
args = args.map(Promise.getValue);
if(!Promise.allRealized(args)) {
Promise.watch(args, cb, errCb);
} else {
cb(Promise.toValues(args));
}
});
if(errCb) {
unrealized.each(function(aPromise) {
aPromise.addEvent('error', errCb.bind(null, [aPromise]));
});
}
unrealized.each($msg('realize'));
} else {
cb(Promise.toValues(args))
}
}
Promise.allRealized = function(vs) { return vs.filter(Promise.isPromise).every($msg("isRealized")); }
/*
Decorator: promise
The promise decorator. Takes a function and returns a new function that
can handle Promises as arguments. If this new function recieves any Promises
it will continue to block until it can convert all of it's arguments to
non-Promise values.
*/
function promise(fn) {
return function decorator() {
var args = $A(arguments);
var promises = args.filter(Promise.isPromise);
var unrealized = promises.filter($msg('isNotRealized'));
if(unrealized.length > 0) {
if(!Promise.debug) {
var p = new Promise();
Promise.watch(
args,
function(values) {
// hack so that this.parent(...) is meaningful even after an async call
var temp = this._current;
this._current = decorator._wrapper;
p.setValue(fn.apply(this, values));
this._current = temp;
}.bind(this),
function(errPromise) {
var err = new Error("Failed to realize promise from " + errPromise.__req.options.url);
err.promise = errPromise;
err.source = fn.toString();
err.sourceArgs = args;
throw err;
}.bind(this));
return p;
} else {
var temp = this._current;
unrealized.each($msg('realize'));
var values = args.map(Promise.getValue);
this._current = decorator._wrapper;
result = fn.apply(this, values);
this._current = temp;
return result;
}
} else {
var porv = Promise.promiseOrValue(fn.apply(this, args.map(Promise.getValue)));
return porv;
}
}
}
/*
Decorator: memoize
Because lazy-loading of resources is so common, I've included
memoize. This will memoize the return values of a function depending
on the arguments passed in. Note that if you call a function frequently
with many different kinds of arguments you will consume memory very
quickly. This decorator works best with arguments not containing any
object values. This is becuase the args array is JSON encoded into a
string for comparison. So arguments composed of strings, integers, and
arrays work best. Normally this would be a problem but for acecssing remote
resources this limitation is fine.
*/
function memoize(fn) {
var table = {};
return function memoized() {
var args = $A(arguments);
var enc = JSON.encode(args);
if(!table[enc]) {
var result = fn.apply(this, args);
table[enc] = result;
return result;
} else {
return table[enc];
}
};
}
/*
Decorator: pre
*/
function pre(conditions, error) {
error = error || false;
return function preDecorator(fn) {
return function() {
var args = $A(arguments);
var i = 0;
var passed = conditions.map(function(afn) {
var result = afn(args[i]);
i++;
return result;
});
if(passed.indexOf(false) == -1) {
return fn.apply(this, args);
} else {
if($type(error) == 'boolean' && error) {
var err = new Error("Arguments did not match pre conditions.");
err.args = args;
err.conditions = conditions;
err.source = fn.toString();
throw err;
} else if($type(error) == 'function') {
error(passed);
}
}
}
}
}
var $if = function(test, trueExpr, falseExpr) {
if(test) {
if($type(trueExpr) == "function") return trueExpr();
return trueExpr;
} else if(falseExpr) {
if($type(falseExpr) == "function") return falseExpr();
return falseExpr;
}
}.asPromise();