-
Notifications
You must be signed in to change notification settings - Fork 240
/
index.js
518 lines (447 loc) · 15.3 KB
/
index.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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
/*
* Geddy JavaScript Web development framework
* Copyright 2112 Matthew Eernisse (mde@fleegix.org)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
/*
Example model file, would be app/models/user.js:
var User = function () {
this.property('login', 'string', {required: true});
this.property('password', 'string', {required: true});
this.property('lastName', 'string');
this.property('firstName', 'string');
this.validatesPresent('login');
this.validatesFormat('login', /[a-z]+/, {message: 'Subdivisions!'});
this.validatesLength('login', {min: 3});
this.validatesConfirmed('password', 'confirmPassword');
this.validatesWithFunction('password',
function (s) { return s.length > 0; // Could be anything
});
};
User.prototype.someMethod = function () {
// Do some stuff on a User instance
};
User = geddy.model.register('User', User);
*/
var model = {}
, utils = require('utilities')
, i18n = require('../i18n');
model.datatypes = require('./datatypes.js');
model.validators = require('./validators.js');
model.formatters = require('./formatters.js');
utils.mixin(model, new (function () {
this.adapter = null;
this.descriptionRegistry = {};
this.useTimestamps = false;
this.forceCamel = true;
var _createModelItemConstructor = function (def) {
// Base constructor function for all model items
var ModelItemConstructor = function (params) {
var self = this;
this.type = def.name;
// Items fetched from an API should have this flag set to true
this.saved = params.saved || false;
// If fetched and instantiated from an API-call, give the
// instance the appropriate ID -- newly created objects won't
// have one until saved
if (params.saved) {
this.id = params.id;
}
this.isValid = function () {
return !this.errors;
};
/**
@name ModelBase#save
@public
@function
@description Saves an instance of a Geddy ModelBase
@param {Object} [opts]
@param {String} [opts.locale=null] Optional locale for
localizing error messages from validations
@param {Function} [callback] Callback function that receives
the result of the save action -- should be in the format of
function (err, result) {}
*/
this.save = function () {
var args = Array.prototype.slice.call(arguments)
, arg
, opts
, callback;
while ((arg = args.shift())) {
if (typeof arg == 'function') {
callback = arg;
}
else {
opts = arg;
}
}
if (this.errors) {
callback(this.errors, null);
}
else {
if (model.useTimestamps && this.saved) {
this.updatedAt = new Date();
}
model.adapter[this.type].save(this, opts, callback);
}
};
/**
@name ModelBase#updateAttributes
@public
@function
@description Updates the attributes an instance of a Geddy
ModelBase, and validate the changes
@param {Object} params Object-literal with updated values for
the instance
the result of the save action -- should be in the format of
function (err, result) {}
@param {Object} [opts]
@param {String} [opts.locale=null] Optional locale for
localizing error messages from validations
*/
this.updateAttributes = function (params, opts) {
geddy.model.updateItem(this, params, opts || {});
};
/**
@name ModelBase#toObj
@public
@function
@description Returns an object with just the properties
and values of the model instance
*/
this.toObj = function () {
var obj = {};
for (var p in this) {
// TODO: Make this so it hides functions and the
// - props 'type' 'saved' and 'adapter'
if ((typeof this[p] !== 'function') &&
p !== 'adapter' && p !== 'type') {
obj[p] = this[p];
}
}
return obj;
}
this.toString = function () {
var obj = {}
, props = this.properties
, formatter;
obj.id = this.id;
obj.type = this.type;
for (var p in props) {
formatter = model.formatters[props[p].datatype];
obj[p] = typeof formatter == 'function' ? formatter(this[p]) : this[p];
}
return JSON.stringify(obj);
};
this.toJson = this.toString;
if (geddy.model.descriptionRegistry[this.type].relations.hasMany) {
var hasMany = geddy.model.descriptionRegistry[this.type].relations.hasMany;
this[geddy.string.decapitalize(hasMany)] = function (query, opts, callback) {
query = query || {};
opts = opts || {};
callback = callback || function () {};
query[this.type.toLowerCase() + 'id'] = this.id;
geddy.model.adapter[geddy.inflection.singularize(hasMany)].all(query, opts, callback);
}
}
if (geddy.model.descriptionRegistry[this.type].relations.hasOne) {
var hasOne = geddy.model.descriptionRegistry[this.type].relations.hasOne;
this[geddy.string.decapitalize(hasOne)] = function (callback) {
var query = {};
query[this.type.toLowerCase() + 'id'] = this.id;
geddy.model.adapter[hasOne].load(query, {}, callback);
}
}
if (geddy.model.descriptionRegistry[this.type].relations.belongsTo) {
var belongsTo = geddy.model.descriptionRegistry[this.type].relations.belongsTo;
this[geddy.string.decapitalize(belongsTo)] = function (callback) {
geddy.model.adapter[belongsTo].load(this[geddy.string.decapitalize(belongsTo)
+ 'id'], {}, callback);
}
}
};
return ModelItemConstructor;
};
var _createStaticMethodsMixin = function (name) {
var obj = {}
, createAPIMethod = function (method) {
return function () {
var adapt;
if (!model.adapter) {
throw new Error('geddy.model.adapter is not defined.');
}
adapt = model.adapter[name];
return adapt[method].apply(adapt, arguments);
};
};
/**
@name ModelBase.create
@public
@static
@function
@description Creates an instance of a Geddy ModelBase, validating
the input parameters
@param {Object} params Object-literal with updated values for
the instance
the result of the save action -- should be in the format of
function (err, result) {}
@param {Object} [opts]
@param {String} [opts.locale=null] Optional locale for
localizing error messages from validations
*/
obj.create = function () {
var args = Array.prototype.slice.call(arguments);
args.unshift(name);
return model.createItem.apply(model, args);
};
// Create statics that invoke the same model-name/method
// combination on the model.adapter, e.g.:
// FooBar.load => geddy.model.adapter.FooBar.load
['load', 'update', 'remove', 'save'].forEach(function (method) {
obj[method] = createAPIMethod(method);
});
return obj;
};
this.register = function (name, ModelDefinition) {
var origProto = ModelDefinition.prototype
, defined
, ModelCtor;
// Create the place to store the metadata about the model structure
// to use to do validations, etc. when constructing
model.descriptionRegistry[name] = new model.ModelDescription(name);
// Execute all the definition methods to create that metadata
ModelDefinition.prototype = new model.ModelDefinitionBase(name);
defined = new ModelDefinition();
// Create the constructor function to use when calling static
// ModelCtor.create. Gives them the proper instanceof value,
// and .valid, etc. instance-methods.
ModelCtor = _createModelItemConstructor(defined);
// Mix in the static methods like .create and .load
utils.mixin(ModelCtor, _createStaticMethodsMixin(name));
// Same with statics
utils.mixin(ModelCtor, defined);
// Mix any functions defined directly in the model-item definition
// 'constructor' into the original prototype, and set it as the prototype of the
// actual constructor
utils.mixin(origProto, defined);
ModelCtor.prototype = origProto;
model[name] = ModelCtor;
return ModelCtor;
};
this.createItem = function (name, params, opts) {
var item = new model[name](params);
item = this.validateAndUpdateFromParams(item, params, opts);
if (this.useTimestamps && !item.createdAt) {
item.createdAt = new Date();
}
// After-create hook
if (typeof item.afterCreate === 'function') {
item.afterCreate();
}
return item;
};
this.updateItem = function (item, params) {
item = this.validateAndUpdateFromParams(item, params);
// After-update hook
if (typeof item.afterUpdate === 'function') {
item.afterUpdate();
}
return item;
};
this.validateAndUpdateFromParams = function (item, passedParams, opts) {
var params
, type = model.descriptionRegistry[item.type]
, properties = type.properties
, validated = null
, errs = null
, camelizedKey
, val;
// May be revalidating, clear errors
delete item.errors;
// Convert snake_case names in params to camelCase
if (this.forceCamel) {
params = {};
for (var p in passedParams) {
// Allow leading underscores in the keys for pseudo-privates
camelizedKey = geddy.string.camelize(p, {leadingUnderscore: true});
params[camelizedKey] = passedParams[p];
}
}
else {
params = passedParams;
}
// User-input should never contain these -- but we still want
// to validate them to make sure the format didn't get fucked up
if (typeof item.createdAt != 'undefined') {
params.createdAt = item.createdAt;
}
if (typeof item.updatedAt != 'undefined') {
params.updatedAt = item.updatedAt;
}
for (var p in properties) {
validated = this.validateProperty(properties[p], params);
// If there are any failed validations, the errs param
// contains an Object literal keyed by field name, and the
// error message for the first failed validation for that
// property
if (validated.err) {
errs = errs || {};
errs[p] = validated.err;
}
// Otherwise add this property to the return item
else {
item[p] = validated.val;
}
}
// Should never have been incuded in user input, so safe to
// rm these from the params
delete params.createdAt;
delete params.updatedAt;
if (errs) {
item.errors = errs;
}
return item;
};
this.validateProperty = function (prop, params, opts) {
var options = opts || {}
, name = prop.name
, val = params[name]
, result
, locale = options.locale || geddy.config.i18n.defaultLocale;
// Validate for the base datatype only if there actually is a value --
// e.g., undefined will fail the validation for Number, even if the
// field is optional
if (val) {
// 'Any' datatype
if (prop.datatype == '*') {
result = {
val: val
};
}
// Specific datatype -- perform validation/type-coercion
else {
result = model.datatypes[
prop.datatype.toLowerCase()](prop.name, val, locale);
if (result.err) {
return {
err: result.err,
val: null
};
}
}
// Value may have been modified in the datatype check -- e.g.,
// 'false' changed to false, '8.0' changed to 8, '2112' changed to
// 2112, etc.
val = result.val;
}
// Now go through all the base validations for this property
var validations = prop.validations;
var validator;
var err;
for (var p in validations) {
validator = model.validators[p]
if (typeof validator != 'function') {
throw new Error(p + ' is not a valid validator');
}
err = validator(name, val, params, validations[p], locale);
// If there's an error for a validation, don't bother
// trying to continue with more validations -- just return
// this first error message
if (err) {
return {
err: err,
val: null
};
}
}
// If there weren't any errors, return the value for this property
// and no error
return {
err: null,
val: val
};
};
})());
model.ModelDefinitionBase = function (name) {
var self = this
, _getValidator = function (p) {
return function () {
var args = Array.prototype.slice.call(arguments);
args.unshift(p);
return self.validates.apply(self, args);
};
};
this.name = name;
this.property = function (name, datatype, o) {
model.descriptionRegistry[this.name].properties[name] =
new model.PropertyDescription(name, datatype, o);
};
this.defineProperties = function (obj) {
for (var property in obj) {
this.property(property, obj[property].type, obj);
}
}
this.validates = function (condition, name, qualifier, opts) {
var rule = utils.mixin({}, opts, true);
rule.qualifier = qualifier;
model.descriptionRegistry[this.name].properties[name]
.validations[condition] = rule;
};
// For each of the validators, create a validatesFooBar from
// validates('fooBar' ...
for (var p in model.validators) {
this['validates' + utils.string.capitalize(p)] = _getValidator(p);
}
// Add the base model properties -- these should not be handled by user input
if (model.useTimestamps) {
this.property('createdAt', 'datetime');
this.property('updatedAt', 'datetime');
}
this.hasMany = function (pluralCtorName) {
geddy.model.descriptionRegistry[this.name].relations.hasMany = pluralCtorName;
};
this.belongsTo = function (ctorName) {
geddy.model.descriptionRegistry[this.name].relations.belongsTo = ctorName;
this.property(ctorName.toLowerCase()+'id', 'string');
}
this.hasOne = function (ctorName) {
geddy.model.descriptionRegistry[this.name].relations.hasOne = ctorName;
}
};
model.ModelDescription = function (name) {
this.name = name;
this.properties = {};
this.relations = {};
};
model.PropertyDescription = function (name, datatype, o) {
var opts = o || {};
this.name = name;
this.datatype = datatype;
this.options = opts;
var validations = {};
for (var p in opts) {
if (opts.required || opts.length) {
validations.present = true;
}
if (opts.length) {
validations.length = opts.length;
}
if (opts.format) {
validations.format = opts.format;
}
}
this.validations = validations;
};
module.exports = model;