Merge branch 'feature/84-Improve-get-formValidationResult.fieldErrors'

Lemoncode · Sep 4, 2018 · 1f44dff · 1f44dff
2 parents a8ed619 + bd68022
commit 1f44dff
Show file tree

Hide file tree

Showing 21 changed files with 305 additions and 203 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,4 +10,4 @@ lib/coverage/
 yarn.lock
 .vscode/
 npm-debug.log
-lib/package-lock\.json
+package-lock\.json
diff --git a/README.md b/README.md
@@ -43,10 +43,10 @@ customerFormValidation
     console.log(validationResult.success); // true
     console.log(validationResult.formGlobalErrors); // []
     console.log(validationResult.fieldErrors);
-    /*[
-        { succeeded: true, type: "REQUIRED", key: "firstName", errorMessage: "" },
-        { succeeded: true, type: "REQUIRED", key: "lastName", errorMessage: "" }
-      ]*/
+    /*{
+        firstName: { succeeded: true, type: "REQUIRED", key: "firstName", errorMessage: "" },
+        lastName: { succeeded: true, type: "REQUIRED", key: "lastName", errorMessage: "" }
+      }*/
   })
   .catch((error) => {
     // handle unexpected errors
@@ -240,7 +240,7 @@ testFormValidation
   .then((validationResult) => {
     console.log(validationResult.succeeded); // true
     console.log(validationResult.formGlobalErrors) // []
-    console.log(validationResult.fieldErrors); //  []
+    console.log(validationResult.fieldErrors); //  {}
   })
   .catch((error) => {
     // handle unexpected errors

diff --git a/lib/lc-form-validation.d.ts b/lib/lc-form-validation.d.ts
@@ -7,7 +7,7 @@ export class FieldValidationResult {
 
 export class FormValidationResult {
   succeeded: boolean;
-  fieldErrors: Array<FieldValidationResult>;
+  fieldErrors: { [key: string]: FieldValidationResult };
   formGlobalErrors: Array<FieldValidationResult>;
 }
 

diff --git a/lib/package.json b/lib/package.json
@@ -1,6 +1,6 @@
 {
   "name": "lc-form-validation",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "lcFormValidation is an async form validation library heavily based on JavaScript (no HTML attributes or annotations). lcFormValidation is third party / framework agnostic so it can be easily integrated with frameworks like React.",
   "main": "dist/lc-form-validation.js",
   "scripts": {
@@ -84,6 +84,7 @@
   ],
   "dependencies": {
     "es6-promise": "4.1.0",
-    "lodash.get": "^4.4.2"
+    "lodash.get": "^4.4.2",
+    "lodash.set": "^4.3.2"
   }
 }
diff --git a/lib/src/entities.ts b/lib/src/entities.ts
@@ -24,12 +24,12 @@ export class FieldValidationResult {
 
 export class FormValidationResult {
   succeeded: boolean;
-  fieldErrors: FieldValidationResult[];
+  fieldErrors: { [key: string]: FieldValidationResult };
   formGlobalErrors: FieldValidationResult[];
 
   constructor() {
     this.succeeded = false;
-    this.fieldErrors = [];
+    this.fieldErrors = {};
   }
 }
 

diff --git a/lib/src/spec/validationEngineValidateForm.spec.ts b/lib/src/spec/validationEngineValidateForm.spec.ts
diff --git a/lib/src/spec/validationsResultBuilder.spec.ts b/lib/src/spec/validationsResultBuilder.spec.ts
@@ -104,7 +104,7 @@ describe('ValidationsResultBuilder ', () => {
         expect(result.succeeded).to.be.true;
       });
 
-    it('Spec #8 => should returns new FormValidationResult equals { fieldErrors: [] } ' +
+    it('Spec #8 => should returns new FormValidationResult equals { fieldErrors: {} } ' +
       'when passing fieldValidationResults equals undefined', () => {
         //Arrange
         let fieldValidationResults = undefined;
@@ -113,10 +113,10 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.be.empty;
+        expect(result.fieldErrors).to.deep.equals({});
       });
 
-    it('Spec #9 => should returns new FormValidationResult equals { fieldErrors: [] } ' +
+    it('Spec #9 => should returns new FormValidationResult equals { fieldErrors: {} } ' +
       'when passing fieldValidationResults equals null', () => {
         //Arrange
         let fieldValidationResults = null;
@@ -125,10 +125,10 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.be.empty;
+        expect(result.fieldErrors).to.deep.equals({});
       });
 
-    it('Spec #10 => should returns new FormValidationResult equals { fieldErrors: [] } ' +
+    it('Spec #10 => should returns new FormValidationResult equals { fieldErrors: {} } ' +
       'when passing fieldValidationResults equals empty', () => {
         //Arrange
         let fieldValidationResults = [];
@@ -137,11 +137,11 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.be.empty;
+        expect(result.fieldErrors).to.deep.equals({});
       });
 
     it('Spec #11 => should returns new FormValidationResult equals ' +
-      '{ fieldErrors: [{ key: "test" }] } with length equals 1 ' +
+      '{ fieldErrors: { test: { key: "test", succeeded: false, errorMessage: "", type: "" } } }' +
       'when passing fieldValidationResults with one item equals { key: "test" }', () => {
         //Arrange
         let fieldValidationResult = new FieldValidationResult();
@@ -152,12 +152,18 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.have.length(1);
-        expect(result.fieldErrors[0].key).to.be.equal('test');
+        expect(result.fieldErrors).to.deep.equal({
+          test: {
+            key: 'test',
+            succeeded: false,
+            errorMessage: '',
+            type: '',
+          } as FieldValidationResult,
+        });
       });
 
     it('Spec #12 => should returns new FormValidationResult equals ' +
-      '{ fieldErrors: [] } with length equals 0 ' +
+      '{ fieldErrors: {} } without properties ' +
       'when passing fieldValidationResults with one item equals { key: null }', () => {
         //Arrange
         let fieldValidationResult = new FieldValidationResult();
@@ -168,11 +174,11 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.have.length(0);
+        expect(result.fieldErrors).to.deep.equals({});
       });
 
     it('Spec #13 => should returns new FormValidationResult equals ' +
-      '{ fieldErrors: [] } with length equals 0 ' +
+      '{ fieldErrors: {} } without properties ' +
       'when passing fieldValidationResults with one item equals { key: undefined }', () => {
         //Arrange
         let fieldValidationResult = new FieldValidationResult();
@@ -183,11 +189,11 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.have.length(0);
+        expect(result.fieldErrors).to.deep.equals({});
       });
 
     it('Spec #14 => should returns new FormValidationResult equals ' +
-      '{ fieldErrors: [] } with length equals 0 ' +
+      '{ fieldErrors: {} } without properties ' +
       'when passing fieldValidationResults with one item equals { key: "" }', () => {
         //Arrange
         let fieldValidationResult = new FieldValidationResult();
@@ -198,11 +204,11 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.have.length(0);
+        expect(result.fieldErrors).to.deep.equals({});
       });
 
     it('Spec #15 => should returns new FormValidationResult equals ' +
-      '{ fieldErrors: [] } with length equals 0 ' +
+      '{ fieldErrors: {} } without properties ' +
       'when passing fieldValidationResults with one item equals { key: "_GLOBAL_FORM_" }', () => {
         //Arrange
         let fieldValidationResult = new FieldValidationResult();
@@ -213,7 +219,7 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.have.length(0);
+        expect(result.fieldErrors).to.deep.equals({});
       });
 
     it('Spec #16 => should returns new FormValidationResult equals ' +
@@ -296,7 +302,7 @@ describe('ValidationsResultBuilder ', () => {
       });
 
     it('Spec #21 => should returns new FormValidationResult equals ' +
-      '{ fieldErrors: [{ key: "test" }] } with length equals 1 ' +
+      '{ fieldErrors: { test: { key: "test" } } } ' +
       'when passing fieldValidationResults with two item first equals { key: "test" }' +
       'and second equals null', () => {
         //Arrange
@@ -311,12 +317,18 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.have.length(1);
-        expect(result.fieldErrors[0].key).to.be.equal('test');
+        expect(result.fieldErrors).to.deep.equal({
+          test: {
+            key: 'test',
+            succeeded: false,
+            errorMessage: '',
+            type: '',
+          } as FieldValidationResult,
+        });
       });
 
     it('Spec #22 => should returns new FormValidationResult equals ' +
-      '{ fieldErrors: [{ key: "test" }] } with length equals 1 ' +
+      '{ fieldErrors: { test: { key: "test" } } } ' +
       'when passing fieldValidationResults with two item first equals { key: "test" }' +
       'and second equals undefined', () => {
         //Arrange
@@ -331,11 +343,50 @@ describe('ValidationsResultBuilder ', () => {
         let result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
 
         //Assert
-        expect(result.fieldErrors).to.have.length(1);
-        expect(result.fieldErrors[0].key).to.be.equal('test');
+        expect(result.fieldErrors).to.deep.equal({
+          test: {
+            key: 'test',
+            succeeded: false,
+            errorMessage: '',
+            type: '',
+          } as FieldValidationResult,
+        });
       });
 
     it('Spec #23 => should returns new FormValidationResult equals ' +
+      '{ fieldErrors: { test1: { key: "test1" }, test2: { key: "test2" } } } ' +
+      'when passing fieldValidationResults with two item first equals { key: "test1" }' +
+      'and second equals { key: "test2" }', () => {
+        //Arrange
+        const fieldValidationResult1 = new FieldValidationResult();
+        fieldValidationResult1.key = 'test1';
+
+        const fieldValidationResult2 = new FieldValidationResult();
+        fieldValidationResult2.key = 'test2';
+
+        const fieldValidationResults = [fieldValidationResult1, fieldValidationResult2];
+
+        //Act
+        const result = validationsResultBuilder.buildFormValidationsResult(fieldValidationResults);
+
+        //Assert
+        expect(result.fieldErrors).to.deep.equal({
+          test1: {
+            key: 'test1',
+            succeeded: false,
+            errorMessage: '',
+            type: '',
+          } as FieldValidationResult,
+          test2: {
+            key: 'test2',
+            succeeded: false,
+            errorMessage: '',
+            type: '',
+          } as FieldValidationResult,
+        });
+      });
+
+    it('Spec #24 => should returns new FormValidationResult equals ' +
       '{ formGlobalErrors: [{ key: "_GLOBAL_FORM_" }] } with length equals 1 ' +
       'when passing fieldValidationResults with two item first equals { key: "_GLOBAL_FORM_" }' +
       'and second equals null', () => {
@@ -355,7 +406,7 @@ describe('ValidationsResultBuilder ', () => {
         expect(result.formGlobalErrors[0].key).to.be.equal('_GLOBAL_FORM_');
       });
 
-    it('Spec #24 => should returns new FormValidationResult equals ' +
+    it('Spec #25 => should returns new FormValidationResult equals ' +
       '{ formGlobalErrors: [{ key: "_GLOBAL_FORM_" }] } with length equals 1 ' +
       'when passing fieldValidationResults with two item first equals { key: "_GLOBAL_FORM_" }' +
       'and second equals undefined', () => {

diff --git a/lib/src/validationsResultBuilder.ts b/lib/src/validationsResultBuilder.ts
@@ -1,5 +1,6 @@
 import { FieldValidationResult, FormValidationResult } from './entities';
 import { consts } from './consts';
+import set from 'lodash.set';
 
 export class ValidationsResultBuilder {
   buildFormValidationsResult(fieldValidationResults: Array<FieldValidationResult>): FormValidationResult {
@@ -10,7 +11,8 @@ export class ValidationsResultBuilder {
       this.setGlobalKeyToEmptyKeys(filteredFieldValidationResults);
 
       formValidationResult.succeeded = filteredFieldValidationResults.every(fvr => fvr.succeeded);
-      formValidationResult.fieldErrors = filteredFieldValidationResults.filter(fvr => fvr.key !== consts.globalFormValidationId);
+      const fieldValidationResultList = filteredFieldValidationResults.filter(fvr => fvr.key !== consts.globalFormValidationId);
+      formValidationResult.fieldErrors = this.mapFieldValidationResultListToFieldErrorsObject(fieldValidationResultList);
       formValidationResult.formGlobalErrors = filteredFieldValidationResults.filter(fvr => fvr.key === consts.globalFormValidationId);
     }
 
@@ -31,6 +33,10 @@ export class ValidationsResultBuilder {
       }
     });
   }
+
+  private mapFieldValidationResultListToFieldErrorsObject = (fieldValidationResultList: FieldValidationResult[]): { [key: string]: FieldValidationResult } => (
+    fieldValidationResultList.reduce((errors, result) => set(errors, result.key, result), {})
+  )
 }
 
 let validationsResultBuilder = new ValidationsResultBuilder();

diff --git a/samples/jquery/00 ShoppingForm/src/modules/app/app.js b/samples/jquery/00 ShoppingForm/src/modules/app/app.js
@@ -2,7 +2,6 @@ import $ from 'jquery';
 import { productsService } from '../../services/productsService';
 import { productsFormValidation } from './validation/formProductValidationService';
 
-let storedProducts = [];
 let $selBrands, $selProducts, $formProducts, $txtNif, $txtDiscount;
 
 class App {
@@ -94,7 +93,9 @@ class App {
     productsFormValidation
       .validateForm(vm)
       .then(validationResult => {
-        validationResult.fieldErrors.forEach(this.handleFieldValidationResult($form));
+        Object.keys(validationResult.fieldErrors).forEach((key) => {
+          this.handleFieldValidationResult($form)(validationResult.fieldErrors[key]);
+        });
         if (validationResult.succeeded) {
           console.log('Form is sent');
         }

diff --git a/samples/react/es6/00 SimpleForm/src/reducers/customer.js b/samples/react/es6/00 SimpleForm/src/reducers/customer.js
@@ -43,14 +43,11 @@ function customerProcessUIInputCompleted(state, action) {
 }
 
 function customerSaveCompleted(state, action) {
-  const newCustomerErrors = { ...state.customerErrors };
-
-  action.formValidationResult.fieldErrors.forEach(fieldValidationResult => {
-    newCustomerErrors[fieldValidationResult.key] = fieldValidationResult;
-  });
-
   return {
     ...state,
-    customerErrors: newCustomerErrors
+    customerErrors: {
+      ...state.customerErrors,
+      ...action.formValidationResult.fieldErrors,
+    },
   };
 }
diff --git a/samples/react/es6/01 SignupForm/src/reducers/signup.js b/samples/react/es6/01 SignupForm/src/reducers/signup.js
@@ -43,14 +43,11 @@ function signupProcessCompleted(state, action) {
 }
 
 function performSignupCompleted(state, action) {
-  const newSignupErrors = { ...state.signupErrors };
-
-  action.formValidationResult.fieldErrors.forEach(fieldValidationResult => {
-    newSignupErrors[fieldValidationResult.key] = fieldValidationResult;
-  });
-
   return {
     ...state,
-    signupErrors: newSignupErrors
+    signupErrors: {
+      ...state.signupErrors,
+      ...action.formValidationResult.fieldErrors,
+    },
   };
 }
diff --git a/samples/react/typescript/00 SimpleForm/src/reducers/customer.ts b/samples/react/typescript/00 SimpleForm/src/reducers/customer.ts
@@ -48,14 +48,11 @@ function customerProcessUIInputCompleted(state: CustomerState, action: ICustomer
 }
 
 function customerSaveCompleted(state: CustomerState, action: ICustomerSaveCompletedAction): CustomerState {
-  const newCustomerErrors: CustomerErrors = Object.assign({}, state.customerErrors);
-
-  action.formValidationResult.fieldErrors.forEach(fieldValidationResult => {
-    newCustomerErrors[fieldValidationResult.key] = fieldValidationResult;
-  });
-
   return {
     ...state,
-    customerErrors: newCustomerErrors
+    customerErrors: {
+      ...state.customerErrors,
+      ...action.formValidationResult.fieldErrors,
+    }
   };
 }
diff --git a/samples/react/typescript/00 SimpleForm/tsconfig.json b/samples/react/typescript/00 SimpleForm/tsconfig.json
@@ -10,7 +10,8 @@
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "preserveConstEnums": true,
-    "suppressImplicitAnyIndexErrors": true
+    "suppressImplicitAnyIndexErrors": true,
+    "skipLibCheck": true
   },
   "compileOnSave": false,
   "exclude": [