-
-
Notifications
You must be signed in to change notification settings - Fork 173
/
factory.js
919 lines (803 loc) · 25.7 KB
/
factory.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
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
import Mixin from '@ember/object/mixin';
import { Promise } from 'rsvp';
import EmberObject, { getWithDefault, computed, set, get } from '@ember/object';
import { A as emberArray, makeArray, isArray } from '@ember/array';
import { readOnly } from '@ember/object/computed';
import { assign } from '@ember/polyfills';
import { run } from '@ember/runloop';
import { guidFor } from '@ember/object/internals';
import { isEmpty, isNone } from '@ember/utils';
import { getOwner } from '@ember/application';
import deepSet from '../utils/deep-set';
import ValidationResult from '../-private/result';
import ResultCollection from './result-collection';
import BaseValidator from '../validators/base';
import cycleBreaker from '../utils/cycle-breaker';
import shouldCallSuper from '../utils/should-call-super';
import lookupValidator from '../utils/lookup-validator';
import { flatten } from '../utils/array';
import {
getDependentKeys,
isDescriptor,
isDsModel,
isValidatable,
isPromise,
mergeOptions
} from '../utils/utils';
import {
VALIDATIONS_CLASS,
IS_VALIDATIONS_CLASS,
ATTRS_MODEL,
ATTRS_PATH,
ATTRS_RESULT_COLLECTION
} from '../-private/symbols';
const VALIDATION_COUNT_MAP = new WeakMap();
/**
* ## Running Manual Validations
*
* Although validations are lazily computed, there are times where we might want to force all or
* specific validations to happen. For this reason we have exposed three methods:
*
* - {{#crossLink "Factory/validate:method"}}{{/crossLink}}: Will always return a promise and should be used if asynchronous validations are present
* - {{#crossLink "Factory/validateSync:method"}}{{/crossLink}}: Should only be used if all validations are synchronous. It will throw an error if any of the validations are asynchronous
* - {{#crossLink "Factory/validateAttribute:method"}}{{/crossLink}}: A functional approach to validating an attribute without changing its state
*
* @module Validations
* @main Validations
*/
/**
* All validations can be accessed via the `validations` object created on your model/object.
* Each attribute also has its own validation which has the same properties.
* An attribute validation can be accessed via `validations.attrs.<ATTRIBUTE>` which will return a {{#crossLink "ResultCollection"}}{{/crossLink}}.
*
* ### Global Validations
*
* Global validations exist on the `validations` object that resides on the object that is being validated.
* To see all possible properties, please checkout the docs for {{#crossLink "ResultCollection"}}{{/crossLink}}.
*
* ```js
* model.get('validations.isValid');
* model.get('validations.errors');
* model.get('validations.messages');
* // etc...
* ```
*
* ### Attribute Validations
*
* The `validations` object also contains an `attrs` object which holds a {{#crossLink "ResultCollection"}}{{/crossLink}}
* for each attribute specified in your validation rules.
*
* ```js
* model.get('validations.attrs.username.isValid');
* model.get('validations.attrs.password.errors');
* model.get('validations.attrs.email.messages');
* // etc...
* ```
* @module Validations
* @submodule Accessing Validations
*/
/**
* @module Validations
* @class Factory
*/
/**
* Top level method that will ultimately return a mixin with all CP validations
*
* @method buildValidations
* @param {Object} validations Validation rules
* @return {Ember.Mixin}
*/
export default function buildValidations(validations = {}, globalOptions = {}) {
normalizeOptions(validations, globalOptions);
let Validations, validationMixinCount;
return Mixin.create({
init() {
this._super(...arguments);
// Count number of mixins to bypass super check if there is more than 1
validationMixinCount = (VALIDATION_COUNT_MAP.get(this) || 0) + 1;
VALIDATION_COUNT_MAP.set(this, validationMixinCount);
},
[VALIDATIONS_CLASS]: computed(function() {
if (!Validations) {
let inheritedClass;
if (
shouldCallSuper(this, VALIDATIONS_CLASS) ||
validationMixinCount > 1
) {
inheritedClass = this._super();
}
Validations = createValidationsClass(inheritedClass, validations, this);
}
return Validations;
}).readOnly(),
validations: computed(function() {
return this.get(VALIDATIONS_CLASS).create({ model: this });
}).readOnly(),
validate() {
return get(this, 'validations').validate(...arguments);
},
validateSync() {
return get(this, 'validations').validateSync(...arguments);
},
validateAttribute() {
return get(this, 'validations').validateAttribute(...arguments);
},
destroy() {
this._super(...arguments);
get(this, 'validations').destroy();
}
});
}
/**
* Validation rules can be created with default and global options
* {
* description: 'Username',
* validators: [...]
* }
*
* This method generate the default options pojo, applies it to each validation rule, and flattens the object
*
* @method normalizeOptions
* @private
* @param {Object} validations
* @return
*/
function normalizeOptions(validations = {}, globalOptions = {}) {
let validatableAttrs = Object.keys(validations);
validatableAttrs.forEach(attribute => {
let rules = validations[attribute];
if (rules && typeof rules === 'object' && isArray(rules.validators)) {
let options = Object.keys(rules).reduce((o, k) => {
if (k !== 'validators') {
o[k] = rules[k];
}
return o;
}, {});
let { validators } = rules;
validators.forEach(v => {
v.defaultOptions = options;
});
validations[attribute] = validators;
}
validations[attribute] = makeArray(validations[attribute]);
validations[attribute].forEach(v => {
v.globalOptions = globalOptions;
});
});
}
/**
* Creates the validations class that will become `model.validations`.
* - Setup parent validation inheritance
* - Normalize nested keys (i.e. 'details.dob') into objects (i.e { details: { dob: validator() }})
* - Merge normalized validations with parent
* - Create global CPs (i.e. 'isValid', 'messages', etc...)
*
* @method createValidationsClass
* @private
* @param {Object} inheritedValidationsClass
* @param {Object} validations
* @param {Object} model
* @return {Ember.Object}
*/
function createValidationsClass(inheritedValidationsClass, validations, model) {
let validationRules = {};
let validatableAttributes = Object.keys(validations);
// Setup validation inheritance
if (
inheritedValidationsClass &&
inheritedValidationsClass[IS_VALIDATIONS_CLASS]
) {
let inheritedValidations = inheritedValidationsClass.create();
validationRules = assign(
validationRules,
inheritedValidations.get('_validationRules')
);
validatableAttributes = emberArray(
inheritedValidations
.get('validatableAttributes')
.concat(validatableAttributes)
).uniq();
}
// Normalize nested keys into actual objects and merge them with parent object
Object.keys(validations).reduce((obj, key) => {
deepSet(obj, key, validations[key]);
return obj;
}, validationRules);
// Create the mixin that holds all the top level validation props (isValid, messages, etc)
let TopLevelProps = createTopLevelPropsMixin(validatableAttributes);
// Create the `attrs` class which will add the current model reference once instantiated
let AttrsClass = createAttrsClass(
validatableAttributes,
validationRules,
model
);
// Create `validations` class
let ValidationsClass = EmberObject.extend(TopLevelProps, {
model: null,
attrs: null,
isValidations: true,
// Caches
_validators: null,
_debouncedValidations: null,
// Private
_validationRules: validationRules,
validate,
validateSync,
validateAttribute,
validatableAttributes,
init() {
this._super(...arguments);
this.setProperties({
attrs: AttrsClass.create({
[ATTRS_MODEL]: this.get('model')
}),
_validators: {},
_debouncedValidations: {}
});
},
destroy() {
this._super(...arguments);
let validatableAttrs = get(this, 'validatableAttributes');
let debouncedValidations = get(this, '_debouncedValidations');
// Initiate attrs destroy to cleanup any remaining model references
this.get('attrs').destroy();
// Cancel all debounced timers
validatableAttrs.forEach(attr => {
let attrCache = get(debouncedValidations, attr);
if (!isNone(attrCache)) {
// Itterate over each attribute and cancel all of its debounced validations
Object.keys(attrCache).forEach(v => run.cancel(attrCache[v]));
}
});
}
});
ValidationsClass.reopenClass({
[IS_VALIDATIONS_CLASS]: true
});
return ValidationsClass;
}
/**
* Creates the `attrs` class which holds all the CP logic
*
* ```javascript
* model.get('validations.attrs.username');
* model.get('validations.attrs.nested.object.attribute');
* ```
*
* @method createAttrsClass
* @private
* @param {Object} validatableAttributes
* @param {Object} validationRules
* @param {Object} model
* @return {Ember.Object}
*/
function createAttrsClass(validatableAttributes, validationRules, model) {
let nestedClasses = {};
let rootPath = 'root';
let AttrsClass = EmberObject.extend({
[ATTRS_PATH]: rootPath,
init() {
this._super(...arguments);
let model = this.get(ATTRS_MODEL);
let path = this.get(ATTRS_PATH);
/*
Instantiate the nested attrs classes for the current path
*/
Object.keys(nestedClasses[path] || []).forEach(key => {
set(
this,
key,
nestedClasses[path][key].create({ [ATTRS_MODEL]: model })
);
});
},
willDestroy() {
this._super(...arguments);
let path = this.get(ATTRS_PATH);
/*
Remove the model reference
*/
set(this, ATTRS_MODEL, null);
/*
Destroy all nested classes
*/
Object.keys(nestedClasses[path] || []).forEach(key => {
get(this, key).destroy();
});
}
});
/*
Insert CPs + Create nested classes
*/
validatableAttributes.forEach(attribute => {
let path = attribute.split('.');
let attr = path.pop();
let currPath = [rootPath];
let currClass = AttrsClass;
// Iterate over the path and create the necessary nested classes along the way
for (let i = 0; i < path.length; i++) {
let key = path[i];
let currPathStr = currPath.join('.');
let _nestedClasses;
nestedClasses[currPathStr] = nestedClasses[currPathStr] || {};
_nestedClasses = nestedClasses[currPathStr];
currPath.push(key);
if (!_nestedClasses[key]) {
_nestedClasses[key] = AttrsClass.extend({
[ATTRS_PATH]: currPath.join('.')
});
}
currClass = _nestedClasses[key];
}
// Add the final attr's CP to the class
currClass.reopen({
[attr]: createCPValidationFor(
attribute,
model,
get(validationRules, attribute)
)
});
});
return AttrsClass;
}
/**
* CP generator for the given attribute
*
* @method createCPValidationFor
* @private
* @param {String} attribute
* @param {Object} model Since the CPs are created once per class on the first initialization,
* this is the first model that was instantiated
* @param {Array} validations
* @return {Ember.ComputedProperty} A computed property which is a ResultCollection
*/
function createCPValidationFor(attribute, model, validations) {
let isVolatile = hasOption(validations, 'volatile', true);
let dependentKeys = isVolatile
? []
: getCPDependentKeysFor(attribute, model, validations);
let cp = computed(
...dependentKeys,
cycleBreaker(function() {
let model = get(this, ATTRS_MODEL);
let validators = !isNone(model) ? getValidatorsFor(attribute, model) : [];
let validationResults = generateValidationResultsFor(
attribute,
model,
validators,
(validator, options) => {
return validator.validate(
validator.getValue(),
options,
model,
attribute
);
}
);
return ResultCollection.create({
attribute,
content: validationResults
});
})
).readOnly();
if (isVolatile) {
cp = cp.volatile();
}
return cp;
}
/**
* Check if a collection of validations have an option
* equal to the given value
*
* @method hasOption
* @private
* @param {Array} validations
* @param {String} option
* @param {Boolean} [value=true]
* @returns {Boolean}
*/
function hasOption(validations, option, value = true) {
for (let i = 0; i < validations.length; i++) {
let { options, defaultOptions = {}, globalOptions = {} } = validations[i];
let mergedOptions = mergeOptions(options, defaultOptions, globalOptions);
if (mergedOptions[option] === value) {
return true;
}
}
return false;
}
/**
* Generates the validation results for a given attribute and validators. If a
* given validator should be validated, it calls upon the validate callback to retrieve
* the result.
*
* @method generateValidationResultsFor
* @private
* @param {String} attribute
* @param {Object} model
* @param {Array} validators
* @param {Function} validate
* @param {Object} opts
* - disableDebounceCache {Boolean}
* @return {Array}
*/
function generateValidationResultsFor(
attribute,
model,
validators,
validate,
opts = {}
) {
let isModelValidatable = isValidatable(model);
let isInvalid = false;
let value, result;
return validators.map(validator => {
let options = get(validator, 'options').toObject();
let isWarning = getWithDefault(options, 'isWarning', false);
let disabled = getWithDefault(options, 'disabled', false);
let debounce = getWithDefault(options, 'debounce', 0);
let lazy = getWithDefault(options, 'lazy', true);
if (disabled || (lazy && isInvalid) || !isModelValidatable) {
value = true;
} else if (debounce > 0) {
let cache = getDebouncedValidationsCacheFor(attribute, model);
// Return a promise and pass the resolve method to the debounce handler
value = new Promise(resolve => {
let t = run.debounce(validator, resolveDebounce, resolve, debounce);
if (!opts.disableDebounceCache) {
cache[guidFor(validator)] = t;
}
}).then(() => {
return validate(validator, get(validator, 'options').toObject());
});
} else {
value = validate(validator, options);
}
result = validationReturnValueHandler(attribute, value, model, validator);
/*
If the current result is invalid, the rest of the validations do not need to be
triggered (if lazy) since the attribute is already in an invalid state.
*/
if (!isInvalid && !isWarning && get(result, 'isInvalid')) {
isInvalid = true;
}
return result;
});
}
/**
* Create a mixin that will have all the top level CPs under the validations object.
* These are computed collections on different properties of each attribute validations CP
*
* @method createTopLevelPropsMixin
* @private
* @param {Object} validations
*/
function createTopLevelPropsMixin(validatableAttrs) {
// Expose the following properties as public APIs via readOnly aliases
let aliases = [
'isValid',
'isValidating',
'isAsync',
'isNotValidating',
'isInvalid',
'isTruelyValid',
'isTruelyInvalid',
'hasWarnings',
'messages',
'message',
'warningMessages',
'warningMessage',
'warnings',
'warning',
'errors',
'error',
'_promise'
];
let topLevelProps = aliases.reduce((props, alias) => {
props[alias] = readOnly(`${ATTRS_RESULT_COLLECTION}.${alias}`);
return props;
}, {});
return Mixin.create(topLevelProps, {
/*
Dedupe logic by creating a top level ResultCollection for all attr's ResultCollections
*/
[ATTRS_RESULT_COLLECTION]: computed(
...validatableAttrs.map(attr => `attrs.${attr}`),
function() {
return ResultCollection.create({
attribute: `Model:${this}`,
content: validatableAttrs.map(attr => get(this, `attrs.${attr}`))
});
}
).readOnly()
});
}
/**
* CP dependency generator for a give attribute depending on its relationships
*
* @method getCPDependentKeysFor
* @private
* @param {String} attribute
* @param {Object} model Since the CPs are created once per class on the first initialization,
* this is the first model that was instantiated
* @param {Array} validations
* @return {Array} Unique list of dependencies
*/
function getCPDependentKeysFor(attribute, model, validations) {
let owner = getOwner(model);
let dependentKeys = validations.map(validation => {
let { options } = validation;
let type = validation._type;
let Validator =
type === 'function' ? BaseValidator : lookupValidator(owner, type).class;
let baseDependents =
BaseValidator.getDependentsFor(attribute, options) || [];
let dependents = Validator.getDependentsFor(attribute, options) || [];
return [
...baseDependents,
...dependents,
// Get all explicitly defined dependents
...getWithDefault(options, 'dependentKeys', []),
...getWithDefault(validation, 'defaultOptions.dependentKeys', []),
...getWithDefault(validation, 'globalOptions.dependentKeys', []),
// Extract implicit dependents from CPs
...extractOptionsDependentKeys(options),
...extractOptionsDependentKeys(get(validation, 'defaultOptions')),
...extractOptionsDependentKeys(get(validation, 'globalOptions'))
];
});
dependentKeys = flatten(dependentKeys);
dependentKeys.push(`model.${attribute}`);
if (isDsModel(model)) {
dependentKeys.push('model.isDeleted');
}
dependentKeys = dependentKeys.map(d => {
return d.replace(/^model\./, `${ATTRS_MODEL}.`);
});
return emberArray(dependentKeys).uniq();
}
/**
* Extract all dependentKeys from any property that is a CP
*
* @method extractOptionsDependentKeys
* @private
* @param {Object} options
* @return {Array} dependentKeys
*/
function extractOptionsDependentKeys(options) {
if (options && typeof options === 'object') {
return Object.keys(options).reduce((arr, key) => {
let option = options[key];
if (isDescriptor(option)) {
return arr.concat(getDependentKeys(option) || []);
}
return arr;
}, []);
}
return [];
}
/**
* A handler used to create ValidationResult object from values returned from a validator
*
* @method validationReturnValueHandler
* @private
* @param {String} attribute
* @param {Mixed} value
* @param {Object} model
* @return {ValidationResult}
*/
function validationReturnValueHandler(attribute, value, model, validator) {
let result;
let commonProps = {
model,
attribute,
_validator: validator
};
if (isPromise(value)) {
result = ValidationResult.create(commonProps, {
_promise: Promise.resolve(value)
});
} else {
result = ValidationResult.create(commonProps);
result.update(value);
}
return result;
}
/**
* Get validators for the give attribute. If they are not in the cache, then create them.
*
* @method getValidatorsFor
* @private
* @param {String} attribute
* @param {Object} model
* @return {Array}
*/
function getValidatorsFor(attribute, model) {
let validators = get(model, `validations._validators.${attribute}`);
return isNone(validators)
? createValidatorsFor(attribute, model)
: validators;
}
/**
* Get debounced validation cache for the given attribute. If it doesn't exist, create a new one.
*
* @method getValidatorCacheFor
* @private
* @param {String} attribute
* @param {Object} model
* @return {Map}
*/
function getDebouncedValidationsCacheFor(attribute, model) {
let debouncedValidations = get(model, 'validations._debouncedValidations');
if (isNone(get(debouncedValidations, attribute))) {
deepSet(debouncedValidations, attribute, {});
}
return get(debouncedValidations, attribute);
}
/**
* Create validators for the give attribute and store them in a cache
*
* @method createValidatorsFor
* @private
* @param {String} attribute
* @param {Object} model
* @return {Array}
*/
function createValidatorsFor(attribute, model) {
let validations = get(model, 'validations');
let validationRules = makeArray(
get(validations, `_validationRules.${attribute}`)
);
let validatorCache = get(validations, '_validators');
let owner = getOwner(model);
let validators = [];
// We must have an owner to be able to lookup our validators
if (isNone(owner)) {
throw new TypeError(
`[ember-cp-validations] ${model.toString()} is missing a container or owner.`
);
}
validationRules.forEach(v => {
v.attribute = attribute;
v.model = model;
validators.push(lookupValidator(owner, v._type).create(v));
});
// Add validators to model instance cache
deepSet(validatorCache, attribute, validators);
return validators;
}
/**
* Call the passed resolve method. This is needed as run.debounce expects a
* static method to work properly.
*
* @method resolveDebounce
* @private
* @param {Function} resolve
*/
function resolveDebounce(resolve) {
resolve();
}
/**
* ```javascript
* model.validate({ on: ['username', 'email'] }).then(({ m, validations }) => {
* validations.get('isValid'); // true or false
* validations.get('isValidating'); // false
*
* let usernameValidations = m.get('validations.attrs.username');
* usernameValidations.get('isValid') // true or false
* });
* ```
*
* @method validate
* @param {Object} options
* @param {Array} options.on Only validate the given attributes. If empty, will validate over all validatable attribute
* @param {Array} options.excludes Exclude validation on the given attributes
* @param {Boolean} isAsync If `false`, will get all validations and will error if an async validations is found.
* If `true`, will get all validations and wrap them in a promise hash
* @return {Promise or Object} Promise if isAsync is true, object if isAsync is false
*/
function validate(options = {}, isAsync = true) {
let model = get(this, 'model');
let whiteList = makeArray(options.on);
let blackList = makeArray(options.excludes);
let validationResults = get(this, 'validatableAttributes').reduce(
(v, name) => {
if (!isEmpty(blackList) && blackList.indexOf(name) !== -1) {
return v;
}
if (isEmpty(whiteList) || whiteList.indexOf(name) !== -1) {
let validationResult = get(this, `attrs.${name}`);
// If an async validation is found, throw an error
if (!isAsync && get(validationResult, 'isAsync')) {
throw new Error(
`[ember-cp-validations] Synchronous validation failed due to ${name} being an async validation.`
);
}
v.push(validationResult);
}
return v;
},
[]
);
let validations = ResultCollection.create({
attribute: `Validate:${model}`,
content: validationResults
});
let resultObject = { model, validations };
if (isAsync) {
return Promise.resolve(get(validations, '_promise')).then(() => {
/*
NOTE: When dealing with belongsTo and hasMany relationships, there are cases
where we have to resolve the actual models and only then resolve all the underlying
validation promises. This is the reason that `validate` must be called recursively.
*/
return get(validations, 'isValidating')
? this.validate(options, isAsync)
: resultObject;
});
}
return resultObject;
}
/**
* A functional approach to check if a given attribute on a model is valid independently of the
* model attribute's validations. This method will always return a promise which will then resolve
* to a {{#crossLink "ResultCollection"}}{{/crossLink}}.
*
* ```javascript
* model.validateAttribute('username', 'offirgolan').then(({ m, validations }) => {
* validations.get('isValid'); // true or false
* validations.get('isValidating'); // false
* });
* ```
*
* @method validateAttribute
* @param {String} attribute
* @param {Mixed} value
* @return {Promise}
* @async
*/
function validateAttribute(attribute, value) {
let model = get(this, 'model');
let validators = !isNone(model) ? getValidatorsFor(attribute, model) : [];
let validationResults = generateValidationResultsFor(
attribute,
model,
validators,
(validator, options) => {
return validator.validate(value, options, model, attribute);
},
{
disableDebounceCache: true
}
);
let validations = ResultCollection.create({
attribute,
content: flatten(validationResults)
});
let result = { model, validations };
return Promise.resolve(get(validations, '_promise')).then(() => {
/*
NOTE: When dealing with belongsTo and hasMany relationships, there are cases
where we have to resolve the actual models and only then resolve all the underlying
validation promises. This is the reason that `validateAttribute` must be called recursively.
*/
return get(validations, 'isValidating')
? this.validateAttribute(attribute, value)
: result;
});
}
/**
* ```javascript
* let { m, validations } = model.validateSync();
* validations.get('isValid') // true or false
* ```
*
* @method validateSync
* @param {Object} options
* @param {Array} options.on Only validate the given attributes. If empty, will validate over all validatable attribute
* @param {Array} options.excludes Exclude validation on the given attributes
* @return {Object}
*/
function validateSync(options) {
return this.validate(options, false);
}