Skip to content

Commit 0ec9d97

Browse files
committed
Renamed some methods and parameters.
Added some missing semicolon.
1 parent 99cf986 commit 0ec9d97

14 files changed

Lines changed: 127 additions & 133 deletions

lib/lcformvalidation.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ export class FormValidationResult {
1111
formGlobalErrors: Array<FieldValidationResult>;
1212
}
1313

14-
export interface ValidationFilters {
14+
export interface ValidationEventsFilter {
1515
[key: string]: boolean;
1616
}
1717

1818
interface FormValidation {
19-
validateField(vm: any, key: string, value: any, filter?: ValidationFilters): Promise<FieldValidationResult>;
19+
validateField(vm: any, key: string, value: any, eventsFilter?: ValidationEventsFilter): Promise<FieldValidationResult>;
2020
validateForm(vm: any): Promise<FormValidationResult>;
2121
isValidationInProgress(): boolean;
2222
isFormDirty(): boolean;
@@ -33,13 +33,13 @@ export interface FieldValidationFunction {
3333
(value: any, vm: any, customParams: any): ValidationResult;
3434
}
3535

36-
export interface FieldValidationConstraint extends Object {
36+
export interface FieldValidationConstraint{
3737
validator: FieldValidationFunction;
38-
eventFilters?: ValidationFilters,
39-
customParams?: Object
38+
eventFilters?: ValidationEventsFilter;
39+
customParams?: any;
4040
}
4141

42-
export interface ValidationConstraints extends Object {
42+
export interface ValidationConstraints{
4343
global?: FormValidationFunction[];
4444
fields?: { [key: string]: FieldValidationConstraint[] }
4545
}

lib/src/baseFormValidation.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ import {
66
FieldValidationResult,
77
FormValidationResult,
88
FieldValidationConstraint,
9-
ValidationFilters,
9+
ValidationEventsFilter,
1010
} from './entities';
1111
import { consts } from './consts';
1212

1313
interface FormValidation {
14-
validateField(vm: any, key: string, value: any, filter?: any): Promise<FieldValidationResult>;
14+
validateField(vm: any, key: string, value: any, eventsFilter?: any): Promise<FieldValidationResult>;
1515
validateForm(vm: any): Promise<FormValidationResult>;
1616
isValidationInProgress(): boolean;
1717
isFormDirty(): boolean;
@@ -66,14 +66,14 @@ export class BaseFormValidation implements FormValidation {
6666
this.validationEngine.addFieldValidation(
6767
constraint,
6868
validationConstraint.validator,
69-
validationConstraint.eventFilters,
69+
validationConstraint.eventsFilter,
7070
validationConstraint.customParams
7171
);
7272
return this;
7373
}
7474

75-
validateField(vm: any, key: string, value: any, filter?: ValidationFilters): Promise<FieldValidationResult> {
76-
return this.validationEngine.triggerFieldValidation(vm, key, value, filter);
75+
validateField(vm: any, key: string, value: any, eventsFilter?: ValidationEventsFilter): Promise<FieldValidationResult> {
76+
return this.validationEngine.triggerFieldValidation(vm, key, value, eventsFilter);
7777
}
7878

7979
validateForm(vm: any): Promise<FormValidationResult> {

lib/src/entities.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
export interface ValidationFilters {
1+
export interface ValidationEventsFilter {
22
[key: string]: boolean;
33
}
44

55
export class FieldValidation {
66
validationFn: (value, vm, customParams) => Promise<FieldValidationResult>;
7-
filters: ValidationFilters;
7+
eventsFilter: ValidationEventsFilter;
88
customParams: any;
99
}
1010

@@ -51,7 +51,7 @@ export type FieldValidationFunction = SyncValidationFunction | AsyncFieldValidat
5151

5252
export interface FieldValidationConstraint {
5353
validator: FieldValidationFunction;
54-
eventFilters?: ValidationFilters;
54+
eventsFilter?: ValidationEventsFilter;
5555
customParams?: any;
5656
}
5757

lib/src/fieldValidationEventFilter.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
import { FieldValidation, ValidationFilters } from './entities';
1+
import { FieldValidation, ValidationEventsFilter } from './entities';
22

33
class FieldValidationEventFilter {
44

5-
public filter(fieldValidations: FieldValidation[], filters: ValidationFilters): FieldValidation[] {
5+
public filter(fieldValidations: FieldValidation[], eventsFilter: ValidationEventsFilter): FieldValidation[] {
66
let result: FieldValidation[] = [];
77

8-
if (filters) {
8+
if (eventsFilter) {
99
result = fieldValidations.filter((fieldValidation) =>
10-
this.matchsAnyFilter(fieldValidation, filters)
10+
this.hasAnyFilter(fieldValidation, eventsFilter)
1111
);
1212
} else {
1313
result = fieldValidations;
@@ -16,9 +16,9 @@ class FieldValidationEventFilter {
1616
return result;
1717
}
1818

19-
private matchsAnyFilter(fieldValidation: FieldValidation, filters: ValidationFilters) {
20-
return Object.keys(filters).some(filter =>
21-
filters[filter] === fieldValidation.filters[filter]
19+
private hasAnyFilter(fieldValidation: FieldValidation, eventsFilter: ValidationEventsFilter) {
20+
return Object.keys(eventsFilter).some(filter =>
21+
eventsFilter[filter] === fieldValidation.eventsFilter[filter]
2222
);
2323
}
2424
}

lib/src/spec/baseFormValidation.spec.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ describe('formValidation tests', () => {
4242
const viewModel = {};
4343
const key = 'fullname';
4444
const value = '';
45-
const filter = undefined;
45+
const eventsFilter = undefined;
4646

4747
// Act
4848
const formValidation = new BaseFormValidation(validationConstraints);
49-
formValidation.validateField(viewModel, key, value, filter);
49+
formValidation.validateField(viewModel, key, value, eventsFilter);
5050

5151
// Assert
5252
expect(validateSingleField.calledOnce).to.be.true;
@@ -299,7 +299,7 @@ describe('formValidation tests', () => {
299299
const addFieldValidation = sinon.stub(ValidationEngine.prototype, 'addFieldValidation', () => { });
300300
const validation1 = () => new FieldValidationResult();
301301
const validation2 = () => new FieldValidationResult();
302-
const filters = undefined;
302+
const eventsFilter = undefined;
303303
const customParams = undefined;
304304
const validationConstraints: ValidationConstraints = {
305305
fields: {
@@ -317,8 +317,8 @@ describe('formValidation tests', () => {
317317

318318
// Assert
319319
expect(addFieldValidation.calledTwice).to.be.true;
320-
expect(addFieldValidation.calledWithExactly('property1', validation1, filters, customParams)).to.be.true;
321-
expect(addFieldValidation.calledWithExactly('property2', validation2, filters, customParams)).to.be.true;
320+
expect(addFieldValidation.calledWithExactly('property1', validation1, eventsFilter, customParams)).to.be.true;
321+
expect(addFieldValidation.calledWithExactly('property2', validation2, eventsFilter, customParams)).to.be.true;
322322
}));
323323

324324
it('should add multiple validations given a property haveing multiple FieldValidationConstraints', sinon.test(function () {
@@ -327,7 +327,7 @@ describe('formValidation tests', () => {
327327
const addFieldValidation = sinon.stub(ValidationEngine.prototype, 'addFieldValidation', () => { });
328328
const validation1 = () => new FieldValidationResult();
329329
const validation2 = () => new FieldValidationResult();
330-
const filters = undefined;
330+
const eventsFilter = undefined;
331331
const customParams = undefined;
332332
const validationConstraints: ValidationConstraints = {
333333
fields: {
@@ -343,8 +343,8 @@ describe('formValidation tests', () => {
343343

344344
// Assert
345345
expect(addFieldValidation.calledTwice).to.be.true;
346-
expect(addFieldValidation.calledWithExactly('property1', validation1, filters, customParams)).to.be.true;
347-
expect(addFieldValidation.calledWithExactly('property1', validation2, filters, customParams)).to.be.true;
346+
expect(addFieldValidation.calledWithExactly('property1', validation1, eventsFilter, customParams)).to.be.true;
347+
expect(addFieldValidation.calledWithExactly('property1', validation2, eventsFilter, customParams)).to.be.true;
348348
}));
349349

350350
it('should pass FieldValidationConstraints to ValidationEngine', sinon.test(function () {
@@ -353,13 +353,13 @@ describe('formValidation tests', () => {
353353
const addFieldValidation = sinon.stub(ValidationEngine.prototype, 'addFieldValidation', () => { });
354354
const validation1 = () => new FieldValidationResult();
355355
const customParams = { foo: 'bar' };
356-
const eventFilters = { OnBlur: true };
356+
const eventsFilter = { OnBlur: true };
357357
const validationConstraints: ValidationConstraints = {
358358
fields: {
359359
property1: [
360360
{
361361
validator: validation1,
362-
eventFilters,
362+
eventsFilter,
363363
customParams,
364364
},
365365
]
@@ -370,7 +370,7 @@ describe('formValidation tests', () => {
370370
const formValidation = createFormValidation(validationConstraints);
371371

372372
// Assert
373-
expect(addFieldValidation.calledWithExactly('property1', validation1, eventFilters, customParams)).to.be.true;
373+
expect(addFieldValidation.calledWithExactly('property1', validation1, eventsFilter, customParams)).to.be.true;
374374
}));
375375

376376
});

0 commit comments

Comments
 (0)