-
Notifications
You must be signed in to change notification settings - Fork 19
/
model.js
445 lines (382 loc) · 11.8 KB
/
model.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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
if (global.GENTLY) {
require = global.GENTLY.hijack(require);
}
var _ = require('underscore');
module.exports = function (db, collection_name) {
if (!db) {
throw (Error('You must specify a db'));
}
if (!collection_name) {
throw (Error('You must specify a collection name'));
}
var MODEL = {
db: db
, collection_proxy: require('./helpers/collection_proxy')
};
/**
* Gets the mongo collection
*
* @param {Function} callback
* @returns itself
*/
MODEL.getCollection = function (callback) {
db.collection(collection_name, callback);
return MODEL;
};
/**
* Proxies `collection` calls and then:
*
* + Namespacing: Filters sent and received documents according to namespaces.
* + Mapping: Applies functions to sent and received document attributes.
* + Hooks: Calls some before* and after* hooks
*
* This functionalities are enabled by default, but you can disable them by providing
* options as the first param.
*
* Adds custom `findArray`, `mapReduceCursor` and `mapReduceArray`.
*
* @param {String|Object} options
* @param {Mixed} args
* @param {Function} callback
* @returns itself
*/
MODEL.mongo = function (args) {
var parsed_method, options, callback;
args = [].slice.call(arguments, 0);
options = args.shift();
if (typeof options === 'string') {
parsed_method = options.match(/([a-zA-Z]*)(?::([a-zA-Z]*))?/); // extract the namespace
options = {
method: parsed_method[1]
, namespace: parsed_method[2]
};
}
if (!options.method) {
throw (Error('`method` is mandatory!'));
}
options = _.extend({
hooks: true
, namespacing: true
, mapping: true
}, options);
if (typeof args[args.length - 1] === 'function') {
callback = args[args.length - 1];
} else {
callback = function () {}; // noop
args.push(callback);
}
MODEL.collection_proxy.proxy(MODEL, options, args, callback);
return MODEL;
};
/**
* Validates a mongo document
*
* @param {Object} document
* @param {Object} update
* @param {Function} callback
*/
MODEL.validate = function (document, update, callback) {
var validator = require('./validator')(document, update);
callback(null, validator);
};
/**
* Validates a mongo document and inserts it
*
* @param {Object} document
* @param {Object} options
* @param {Function} callback
* @returns itself
*/
MODEL.validateAndInsert = function (document, options, callback) {
// options are optional
if (typeof options === 'function') {
callback = options;
options = {};
} else {
options = options || {};
}
var fn = {method: 'insert', namespacing: false, mapping: false}
, args = [document];
if (options.namespace) {
fn.namespace = options.namespace;
}
if (MODEL.namespaces && MODEL.namespaces[options.namespace]) {
// has side effects, alters args
MODEL.collection_proxy.namespacer.filter(MODEL.namespaces, options.namespace, 'insert', args);
}
if (MODEL.maps) {
// has side effects, alters args
MODEL.collection_proxy.mapper.map(MODEL.maps, 'insert', args);
}
MODEL.validate({}, document, function (error, validator) {
if (error) return callback(error);
if (validator.hasErrors()) return callback(null, validator);
args.push(function cb(error, documents) {
if (error) {
return callback(error);
} else {
if (documents) {
validator.updated_document = documents[0];
}
callback(error, validator);
}
});
args.unshift(fn);
MODEL.mongo.apply(MODEL, args);
});
return MODEL;
};
/**
* Hook triggered before inserting a document
*
* @param {Array} documents
* @param {Function} callback
*/
MODEL.beforeInsert = function (documents, callback) {
documents.forEach(function (document) {
if (!document.created_at) {
document.created_at = new Date();
}
});
callback(null, documents);
};
/**
* Hook triggered after inserting a document
*
* @param {Array} documents
* @param {Function} callback
*/
MODEL.afterInsert = function (documents, callback) {
callback(null, documents);
};
/**
* Hook triggered before updating a document
*
* @param {Object} query
* @param {Object} update
* @param {Function} callback
*/
MODEL.beforeUpdate = function (query, update, callback) {
update.$set = update.$set || {};
update.$set.updated_at = new Date();
callback(null, query, update);
};
/**
* Hook triggered after updating a document
*
* @param {Object} query
* @param {Object} update
* @param {Function} callback
*/
MODEL.afterUpdate = function (query, update, callback) {
callback(null, query, update);
};
/**
* Hook triggered before removing a document
*
* @param {Object} query
* @param {Function} callback
*/
MODEL.beforeRemove = function (query, callback) {
callback(null, query);
};
/**
* Hook triggered after removing a document
*
* @param {Object} query
* @param {Function} callback
*/
MODEL.afterRemove = function (query, callback) {
callback(null, query);
};
/**
* Validates a mongo document and updates it
*
* @param {Object} query - Document query
* @param {Object} update - Update object
* @param {Object} options - Update options. Defaults to {upsert: false, multi: false}
* @param {Function} callback - The callback returns a validator
*
* @returns itself
*/
MODEL.validateAndUpdate = function (query, update, options, callback) {
// options are optional
if (typeof options === 'function') {
callback = options;
options = {};
} else {
options = options || {};
}
options = _.defaults(options, {upsert: false, multi: false});
var fn = {method: 'update', namespacing: false, mapping: false}
, args = [query, update, options];
if (options.namespace) {
fn.namespace = options.namespace;
}
delete options.namespace;
if (MODEL.namespaces && MODEL.namespaces[options.namespace]) {
// has side effects, alters args
MODEL.collection_proxy.namespacer.filter(MODEL.namespaces, options.namespace, 'update', args);
}
if (MODEL.maps) {
// has side effects, alters args
MODEL.collection_proxy.mapper.map(MODEL.maps, 'update', args);
}
MODEL.mongo('findOne', query, function (error, document) {
if (error) return callback(error);
MODEL.validate(document, update, function (error, validator) {
if (error) return callback(error);
if (validator.hasErrors()) {
return callback(null, validator);
} else {
args.push(function cb(error, _) {
callback(error, validator);
});
args.unshift(fn);
args[1] = {_id: document._id};
MODEL.mongo.apply(MODEL, args);
}
});
});
return MODEL;
};
/**
* Get the document ready to embed to this model according to the skeleton
* TODO: Refactor this method! Or take it away as a helper
*
* @param {String} name
* @param {Object} document
* @param {String} scope - Optional field to scope the resulting document
* @param {Boolean} dot_notation - Return the nested object or using dot_notation ready for mongo
*
* @returns document with applied skeleton
*/
MODEL.getEmbeddedDocument = function (name, document, scope, dot_notation) {
var filtered = _.clone(document)
, result = {}
, pointer = result;
function parseAttr(scope, attr) {
return dot_notation ? ((scope ? scope + '.' : '') + attr) : attr;
}
/* 0: not visible
* 1: partial visible, needs more inspection
* 2: fully visible
*/
function isVisible(attr, level) {
var ret = 0;
if (MODEL.skeletons && MODEL.skeletons[name]) {
_.some(MODEL.skeletons[name], function (el) {
var match;
if (attr.indexOf('.') !== -1) {
match = attr.match(new RegExp(el + "(\..*)?"));
if (match) {
ret = 2;
}
} else {
el = el.split('.');
match = el[level] === attr;
if (match) {
ret = el.length === level + 1 ? 2 : 1;
}
}
return match;
});
} else {
return 2; // if no skeleton available, everything is visible!
}
return ret;
}
function filter(el, level, accumulated_scope) {
var attr, is_visible;
for (attr in el) {
if (el.hasOwnProperty(attr)) {
is_visible = isVisible(attr, level);
if (is_visible === 0) {
delete el[attr];
} else {
if (is_visible === 1 && typeof el[attr] === 'object') {
filter(el[attr], level + 1, accumulated_scope ? accumulated_scope + '.' + attr : attr);
if (dot_notation) {
delete el[attr];
}
} else {
if (dot_notation && parseAttr(attr) !== attr) {
if (accumulated_scope) {
filtered[parseAttr(parseAttr(scope, accumulated_scope), attr)] = el[attr];
} else {
el[parseAttr(scope, attr)] = el[attr];
}
delete el[attr];
}
}
}
}
}
}
filter(filtered, 0);
if (scope && !dot_notation) {
scope.split('.').forEach(function (level, i, array) {
pointer = pointer[level] = (i === array.length - 1) ? filtered : {};
});
return result;
} else {
return filtered;
}
};
/**
* Update all the embedded objects
*
* @param {ObjectID} id - Id of the embedded document to be updated
* @param {String} document_name - Name for the embedded document
* @param {Object} document - Document to be embedded
* @param {Object} options - Update options. Defaults to {upsert: false, multi: true}
* @param {Function} callback
*
* @returns itself
*/
MODEL.updateEmbeddedDocument = function (query, document_name, document, options, callback) {
var update = {},
scoped_query = {};
document = document.$set || document;
update = MODEL.getEmbeddedDocument(document_name, document, document_name, true);
// options are optional
if (typeof options === "function") {
callback = options;
options = {};
} else {
options = options || {};
}
options = _.extend({upsert: false, multi: true}, options);
Object.keys(query).forEach(function (attr) {
scoped_query[document_name + '.' + attr] = query[attr];
});
MODEL.mongo({method: 'update', hooks: false}, scoped_query, {'$set': update}, options, callback);
return MODEL;
};
/**
* Push an embedded document.
*
* @param {Object} query - Query to match the objects to push the embedded doc
* @param {String} document_name - Name for the embedded document array
* @param {Object} document - Document to be push
* @param {Object} options - Update options. Defaults to {upsert: false, multi: true}
* @param {Function} callback
*
* @returns itself
*/
MODEL.pushEmbeddedDocument = function (query, document_name, document, options, callback) {
var update = {};
update[document_name] = MODEL.getEmbeddedDocument(document_name, document);
// options are optional
if (typeof options === "function") {
callback = options;
options = {};
} else {
options = options || {};
}
options = _.extend({upsert: false, multi: true}, options);
MODEL.mongo({method: 'update', hooks: false}, query, {'$push': update}, options, callback);
return MODEL;
};
return MODEL;
};