forked from Automattic/mongoose
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schematype.js
421 lines (351 loc) · 8.36 KB
/
schematype.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
/**
* Module dependencies.
*/
var MongooseError = require('./error');
var utils = require('./utils');
/**
* SchemaType constructor
*
* @param {String} path
* @api public
*/
function SchemaType (path, options, instance) {
this.path = path;
this.instance = instance;
this.validators = [];
this.setters = [];
this.getters = [];
this.options = options;
this._index = null;
this.selected;
for (var i in options) if (this[i] && 'function' == typeof this[i]) {
var opts = Array.isArray(options[i])
? options[i]
: [options[i]];
this[i].apply(this, opts);
}
};
/**
* Sets a default
*
* @param {Object} default value
* @api public
*/
SchemaType.prototype.default = function (val) {
if (1 === arguments.length) {
this.defaultValue = typeof val === 'function'
? val
: this.cast(val);
return this;
} else if (arguments.length > 1) {
this.defaultValue = utils.args(arguments);
}
return this.defaultValue;
};
/**
* Sets index. It can be a boolean or a hash of options
* Example:
* Schema.path('my.path').index(true);
* Schema.path('my.path').index({ unique: true });
*
* "Direction doesn't matter for single key indexes"
* http://www.mongodb.org/display/DOCS/Indexes#Indexes-CompoundKeysIndexes
*
* @param {Object} true/
* @api public
*/
SchemaType.prototype.index = function (index) {
this._index = index;
return this;
};
/**
* Adds an unique index
*
* @param {Boolean}
* @api private
*/
SchemaType.prototype.unique = function (bool) {
if (!this._index || 'Object' !== this._index.constructor.name) {
this._index = {};
}
this._index.unique = bool;
return this;
};
/**
* Adds an unique index
*
* @param {Boolean}
* @api private
*/
SchemaType.prototype.sparse = function (bool) {
if (!this._index || 'Object' !== this._index.constructor.name) {
this._index = {};
}
this._index.sparse = bool;
return this;
};
/**
* Adds a setter
*
* @param {Function} setter
* @api public
*/
SchemaType.prototype.set = function (fn) {
if ('function' != typeof fn)
throw new Error('A setter must be a function.');
this.setters.push(fn);
return this;
};
/**
* Adds a getter
*
* @param {Function} getter
* @api public
*/
SchemaType.prototype.get = function (fn) {
if ('function' != typeof fn)
throw new Error('A getter must be a function.');
this.getters.push(fn);
return this;
};
/**
* ##validate
*
* Adds validators.
*
* Examples:
*
* function validator () { ... }
*
* var single = [validator, 'failed']
* new Schema({ name: { type: String, validate: single }});
*
* var many = [
* { validator: validator, msg: 'uh oh' }
* , { validator: fn, msg: 'failed' }
* ]
* new Schema({ name: { type: String, validate: many }});
*
* @param {Object} validator
* @param {String} optional error message
* @api public
*/
SchemaType.prototype.validate = function (obj, error) {
if ('function' == typeof obj || obj && 'RegExp' === obj.constructor.name) {
this.validators.push([obj, error]);
return this;
}
var i = arguments.length
, arg
while (i--) {
arg = arguments[i];
this.validators.push([arg.validator, arg.msg]);
}
return this;
};
/**
* Adds a required validator
*
* @param {Boolean} enable/disable the validator
* @api public
*/
SchemaType.prototype.required = function (required) {
var self = this;
function __checkRequired (v) {
// in here, `this` refers to the validating document.
// no validation when this path wasn't selected in the query.
if ('isSelected' in this &&
!this.isSelected(self.path) &&
!this.isModified(self.path)) return true;
return self.checkRequired(v);
}
if (false === required) {
this.isRequired = false;
this.validators = this.validators.filter(function (v) {
return v[0].name !== '__checkRequired';
});
} else {
this.isRequired = true;
this.validators.push([__checkRequired, 'required']);
}
return this;
};
/**
* Gets the default value
*
* @param {Object} scope for callback defaults
* @api private
*/
SchemaType.prototype.getDefault = function (scope, init) {
var ret = 'function' === typeof this.defaultValue
? this.defaultValue.call(scope)
: this.defaultValue;
if (null !== ret && undefined !== ret) {
return this.cast(ret, scope, init);
} else {
return ret;
}
};
/**
* Applies setters
*
* @param {Object} value
* @param {Object} scope
* @api private
*/
SchemaType.prototype.applySetters = function (value, scope, init) {
if (SchemaType._isRef(this, value, init)) return value;
var v = value
, setters = this.setters
, len = setters.length
if (!len) {
if (null === v || undefined === v) return v;
return init
? v // if we just initialized we dont recast
: this.cast(v, scope, init)
}
while (len--) {
v = setters[len].call(scope, v, this);
}
if (null === v || undefined === v) return v;
// do not cast until all setters are applied #665
v = this.cast(v, scope);
return v;
};
/**
* Applies getters to a value
*
* @param {Object} value
* @param {Object} scope
* @api private
*/
SchemaType.prototype.applyGetters = function (value, scope) {
if (SchemaType._isRef(this, value, true)) return value;
var v = value
, getters = this.getters
, len = getters.length;
if (!len) {
return v;
}
while (len--) {
v = getters[len].call(scope, v, this);
}
return v;
};
/**
* ## select
*
* Set default select() behavior for this path. True if
* this path should always be included in the results,
* false if it should be excluded by default. This setting
* can be overridden at the query level.
*
* T = db.model('T', new Schema({ x: { type: String, select: true }}));
* T.find(..); // x will always be selected ..
* // .. unless overridden;
* T.find().select({ x: 0 }).exec();
*
* @api public
*/
SchemaType.prototype.select = function select (val) {
this.selected = !! val;
}
/**
* Performs a validation
*
* @param {Function} callback
* @param {Object} scope
* @api private
*/
SchemaType.prototype.doValidate = function (value, fn, scope) {
var err = false
, path = this.path
, count = this.validators.length;
if (!count) return fn(null);
function validate (val, msg) {
if (err) return;
if (val === undefined || val) {
--count || fn(null);
} else {
fn(err = new ValidatorError(path, msg));
}
}
this.validators.forEach(function (v) {
var validator = v[0]
, message = v[1];
if (validator instanceof RegExp) {
validate(validator.test(value), message);
} else if ('function' === typeof validator) {
if (2 === validator.length) {
validator.call(scope, value, function (val) {
validate(val, message);
});
} else {
validate(validator.call(scope, value), message);
}
}
});
};
/**
* Determines if value is a valid Reference.
*
* @param {SchemaType} self
* @param {object} value
* @param {Boolean} init
* @param {MongooseType} instance
* @return Boolean
* @private
*/
SchemaType._isRef = function (self, value, init) {
if (init && self.options && self.options.ref) {
if (null == value) return true;
if (value._id && value._id.constructor.name === self.instance) return true;
}
return false;
}
/**
* Schema validator error
*
* @param {String} path
* @param {String} msg
* @api private
*/
function ValidatorError (path, type) {
var msg = type
? '"' + type + '" '
: '';
MongooseError.call(this, 'Validator ' + msg + 'failed for path ' + path);
Error.captureStackTrace(this, arguments.callee);
this.name = 'ValidatorError';
this.path = path;
this.type = type;
};
ValidatorError.prototype.toString = function () {
return this.message;
}
/**
* Inherits from MongooseError
*/
ValidatorError.prototype.__proto__ = MongooseError.prototype;
/**
* Cast error
*
* @api private
*/
function CastError (type, value) {
MongooseError.call(this, 'Cast to ' + type + ' failed for value "' + value + '"');
Error.captureStackTrace(this, arguments.callee);
this.name = 'CastError';
this.type = type;
this.value = value;
};
/**
* Inherits from MongooseError.
*/
CastError.prototype.__proto__ = MongooseError.prototype;
/**
* Module exports.
*/
module.exports = exports = SchemaType;
exports.CastError = CastError;
exports.ValidatorError = ValidatorError;