Package update and IConvertOption (#17)

codeBelt · web-flow · commit e2ca5e723ade · 2019-06-23T22:15:12.000-05:00
* update packages

* IConvertOption now happens before data is assigned to properties. Now if you use ConversionTypeEnum.JSON and have a default model it will create that new model instead of having a plain object.
diff --git a/README.md b/README.md
@@ -318,6 +318,8 @@ export default class CarModel extends BaseModel {
 
 ## Release History
 
+-   2019-06-23 v1.9.0 IConvertOption now happens before data is assigned to properties. Now if you use ConversionTypeEnum.JSON and have a default model it will create that new model instead of having a plain object.
+
 -   2019-01-28 v1.8.2 ConversionTypeEnum.String now coverts objects with JSON.stringify.
 
 -   2019-01-28 v1.8.1 Returns the original data for ConversionTypeEnum.JSON if parse fails.
diff --git a/__tests__/BaseModel.test.ts b/__tests__/BaseModel.test.ts
@@ -6,6 +6,7 @@ import {UserResponseModel} from './data/models/UserResponseModel';
 import {ConversionInfoModel} from './data/models/ConversionInfoModel';
 import {NonExistentKeyConversionModel} from './data/models/NonExistentKeyConversionModel';
 import {NameModel} from './data/models/NameModel';
+import {AdminModel} from './data/models/AdminModel';
 
 describe('BaseModel', () => {
     let json: any = null;
@@ -26,7 +27,24 @@ describe('BaseModel', () => {
     test('should populate InfoModel', () => {
         const model = new InfoModel(json.info);
 
-        expect(model.toJSON()).toEqual(json.info);
+        expect(model.toJSON()).toEqual({
+            ...json.info,
+            stringified: JSON.parse(json.info.stringified),
+        });
+        expect(model.stringified).toBeInstanceOf(AdminModel);
+    });
+
+    test('should have default of InfoModel', () => {
+        const model = new InfoModel();
+
+        expect(model.toJSON()).toEqual({
+            page: null,
+            results: null,
+            seed: '',
+            stringified: null,
+            version: '',
+        });
+        expect(model.stringified).toEqual(null);
     });
 
     test('should have default of UserResponseModel', () => {
@@ -86,19 +104,26 @@ describe('BaseModel', () => {
             results: json.results.map((resultItem: any) =>
                 Util.deletePropertyFromObject(resultItem, ['location', 'login', 'dob', 'registered', 'phone', 'cell', 'id'])
             ),
+            info: {
+                ...json.info,
+                stringified: JSON.parse(json.info.stringified),
+            },
         };
 
         expect(model.toJSON()).toEqual(expectedData);
     });
 
     test('should call update with empty object and have no changes', () => {
         const model = new UserResponseModel(json);
-
         const expectedData = {
             ...json,
             results: json.results.map((resultItem: any) =>
                 Util.deletePropertyFromObject(resultItem, ['location', 'login', 'dob', 'registered', 'phone', 'cell', 'id'])
             ),
+            info: {
+                ...json.info,
+                stringified: JSON.parse(json.info.stringified),
+            },
         };
 
         model.update({});
@@ -108,13 +133,18 @@ describe('BaseModel', () => {
 
     test('should have populate UserResponseModel from same UserResponseModel', () => {
         let model = new UserResponseModel(json);
+
         model = new UserResponseModel(model);
 
         const expectedData = {
             ...json,
             results: json.results.map((resultItem: any) =>
                 Util.deletePropertyFromObject(resultItem, ['location', 'login', 'dob', 'registered', 'phone', 'cell', 'id'])
             ),
+            info: {
+                ...json.info,
+                stringified: JSON.parse(json.info.stringified),
+            },
         };
 
         expect(model.toJSON()).toEqual(expectedData);
@@ -153,6 +183,10 @@ describe('BaseModel', () => {
                     },
                 },
             ],
+            info: {
+                ...json.info,
+                stringified: JSON.parse(json.info.stringified),
+            },
         });
     });
 
@@ -193,6 +227,12 @@ describe('BaseModel', () => {
                 results: null,
                 page: null,
                 version: '',
+                stringified: {
+                    description: '',
+                    id: '',
+                    name: '',
+                    userCount: 0,
+                },
             },
             results: [],
             resultsAny: [],
diff --git a/__tests__/Util.test.ts b/__tests__/Util.test.ts
@@ -105,39 +105,7 @@ describe('Util', () => {
         expect(Util.convertDataToConversionType(json, ConversionTypeEnum.JSON)).toEqual(json); // should return same
     });
 
-    describe('Util.convertDataUsingConversionOptions()', () => {
-        test('Should convert data types', () => {
-            const data: object = {
-                stringToFloat: '23.345',
-                stringToNumber: '23.345',
-                stringToFalse: '0',
-                stringToTrue: '1',
-                noChange: '8',
-                numberToString: 8,
-                stringToJson: '{"complete":"Complete","new":"New","open":"Open"}',
-            };
-            const conversionOptions: IConversionOption = {
-                stringToFloat: ConversionTypeEnum.Float,
-                stringToNumber: ConversionTypeEnum.Number,
-                stringToFalse: ConversionTypeEnum.Boolean,
-                stringToTrue: ConversionTypeEnum.Boolean,
-                numberToString: ConversionTypeEnum.String,
-                stringToJson: ConversionTypeEnum.JSON,
-            };
-
-            Util.convertDataUsingConversionOptions(data, conversionOptions);
-
-            expect(data).toEqual({
-                stringToFloat: 23.345,
-                stringToNumber: 23,
-                stringToFalse: false,
-                stringToTrue: true,
-                noChange: '8',
-                numberToString: '8',
-                stringToJson: {complete: 'Complete', new: 'New', open: 'Open'},
-            });
-        });
-
+    describe('Util.validConversionOptionNames()', () => {
         test('should throw error on non existent key', () => {
             const data: any = {
                 something: '',
@@ -147,7 +115,7 @@ describe('Util', () => {
             };
 
             expect(() => {
-                Util.convertDataUsingConversionOptions(data, conversionOptions);
+                Util.validConversionOptionNames(data, conversionOptions);
             }).toThrow(SyntaxError);
         });
     });
diff --git a/__tests__/data/models/AdminModel.ts b/__tests__/data/models/AdminModel.ts
@@ -0,0 +1,19 @@
+import {IBaseModelOptions} from '../../../src/IBaseModelOptions';
+import {BaseModel} from '../../../src';
+
+export class AdminModel extends BaseModel {
+    public id: string = '';
+    public name: string = '';
+    public description: string = '';
+    public userCount: number = 0;
+
+    constructor(data: Partial<AdminModel> = {}, opts: IBaseModelOptions = {}) {
+        super(opts);
+
+        this.update(data);
+    }
+
+    public update(data: Partial<AdminModel>): void {
+        super.update(data);
+    }
+}
diff --git a/__tests__/data/models/InfoModel.ts b/__tests__/data/models/InfoModel.ts
@@ -1,11 +1,14 @@
 import {IBaseModelOptions} from '../../../src/IBaseModelOptions';
-import {BaseModel} from '../../../src';
+import {IConversionOption} from '../../../src/IConversionOption';
+import {BaseModel, ConversionTypeEnum} from '../../../src';
+import {AdminModel} from './AdminModel';
 
 export class InfoModel extends BaseModel {
     public seed: string = '';
     public results: number | null = null;
     public page: number | null = null;
     public version: string = '';
+    public stringified: AdminModel = AdminModel as any;
 
     constructor(data: Partial<InfoModel> = {}, opts: IBaseModelOptions = {}) {
         super(opts);
@@ -14,6 +17,10 @@ export class InfoModel extends BaseModel {
     }
 
     public update(data: Partial<InfoModel>): void {
-        super.update(data);
+        const conversionOptions: IConversionOption = {
+            stringified: ConversionTypeEnum.JSON,
+        };
+
+        super.update(data, conversionOptions);
     }
 }
diff --git a/__tests__/data/results.json b/__tests__/data/results.json
@@ -121,6 +121,7 @@
     "seed": "abc",
     "results": 3,
     "page": 1,
-    "version": "1.1"
+    "version": "1.1",
+    "stringified": "{\"id\":\"fb55b892-65c6-4a2f-9ce1-13ddb3ad6d98\",\"name\":\"Admin\",\"description\":\"Administrator\",\"userCount\":0}"
   }
 }
diff --git a/package.json b/package.json
@@ -46,29 +46,29 @@
   "dependencies": {},
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "7.2.2",
-    "@babel/plugin-proposal-class-properties": "7.3.0",
-    "@babel/plugin-proposal-object-rest-spread": "7.3.1",
-    "@babel/plugin-transform-runtime": "7.2.0",
-    "@babel/preset-env": "7.3.1",
-    "@babel/preset-typescript": "7.1.0",
-    "@babel/runtime": "7.3.1",
-    "@types/jest": "23.3.13",
-    "husky": "1.3.1",
-    "jest": "24.0.0",
-    "prettier": "1.16.2",
-    "pretty-quick": "1.10.0",
+    "@babel/core": "7.4.5",
+    "@babel/plugin-proposal-class-properties": "7.4.4",
+    "@babel/plugin-proposal-object-rest-spread": "7.4.4",
+    "@babel/plugin-transform-runtime": "7.4.4",
+    "@babel/preset-env": "7.4.5",
+    "@babel/preset-typescript": "7.3.3",
+    "@babel/runtime": "7.4.5",
+    "@types/jest": "24.0.15",
+    "husky": "2.4.1",
+    "jest": "24.8.0",
+    "prettier": "1.18.2",
+    "pretty-quick": "1.11.1",
     "rimraf": "2.6.3",
-    "rollup": "1.1.2",
+    "rollup": "1.16.1",
     "rollup-plugin-babel": "4.3.2",
-    "rollup-plugin-commonjs": "9.2.0",
-    "rollup-plugin-node-resolve": "4.0.0",
+    "rollup-plugin-commonjs": "10.0.0",
+    "rollup-plugin-node-resolve": "5.0.3",
     "rollup-plugin-uglify": "6.0.2",
-    "ts-jest": "23.10.5",
-    "tslib": "1.9.3",
-    "tslint": "5.12.1",
-    "tslint-config-prettier": "1.17.0",
-    "typescript": "3.2.4"
+    "ts-jest": "24.0.2",
+    "tslib": "1.10.0",
+    "tslint": "5.18.0",
+    "tslint-config-prettier": "1.18.0",
+    "typescript": "3.5.2"
   },
   "author": {
     "name": "Robert S. (codeBelt)",
diff --git a/src/BaseModel.ts b/src/BaseModel.ts
@@ -3,6 +3,7 @@ import {IBaseModelOptions} from './IBaseModelOptions';
 import {IBaseModel} from './IBaseModel';
 import {IConversionOption} from './IConversionOption';
 import {Util} from './Util';
+import {ConversionTypeEnum} from './ConversionTypeEnum';
 
 /**
  *  Base Model is a design pattern used to transfer data between software application subsystems.
@@ -113,18 +114,24 @@ export class BaseModel extends BaseObject implements IBaseModel {
     public update(data: any = {}, conversionOptions: IConversionOption = {}): any {
         const dataToUse: {[propertyName: string]: any} = this._isObject(data, true) ? data : {};
 
+        Util.validConversionOptionNames(this, conversionOptions);
+
         Object.keys(this).forEach((propertyName: string) => {
             // Ignore the sjsId property because it is set in the BaseObject constructor and we don't want to update it.
             if (propertyName !== 'sjsId' && propertyName !== 'sjsOptions') {
                 const currentPropertyData: any = this[propertyName];
-                const passedInDataForProperty: any = dataToUse[propertyName];
+                let passedInDataForProperty: any = dataToUse[propertyName];
+
+                if (Boolean(conversionOptions[propertyName])) {
+                    const conversionType: ConversionTypeEnum = conversionOptions[propertyName];
+
+                    passedInDataForProperty = Util.convertDataToConversionType(passedInDataForProperty, conversionType);
+                }
 
                 this[propertyName] = this._getPropertyData(currentPropertyData, passedInDataForProperty);
             }
         });
 
-        Util.convertDataUsingConversionOptions(this, conversionOptions);
-
         return this;
     }
 
diff --git a/src/Util.ts b/src/Util.ts
@@ -144,14 +144,9 @@ export class Util {
         return !(normalized == null || normalized <= 0 || normalized === 'false' || normalized === 'off');
     }
 
-    public static convertDataUsingConversionOptions(data: object, conversionOptions: IConversionOption): void {
+    public static validConversionOptionNames(data: object, conversionOptions: IConversionOption = {}): void {
         Object.keys(conversionOptions).forEach((conversionPropertyName: string) => {
-            if (data.hasOwnProperty(conversionPropertyName)) {
-                const propertyData: number | string | boolean = data[conversionPropertyName];
-                const conversionType: ConversionTypeEnum = conversionOptions[conversionPropertyName];
-
-                data[conversionPropertyName] = Util.convertDataToConversionType(propertyData, conversionType);
-            } else {
+            if (data.hasOwnProperty(conversionPropertyName) === false) {
                 throw new SyntaxError(`Conversion property name "${conversionPropertyName}" does not match a property name on the model.`);
             }
         });
@@ -178,6 +173,10 @@ export class Util {
                 try {
                     return JSON.parse(propertyData as string);
                 } catch (error) {
+                    // Don't throw or console.log errors because it's by design to return the data on error.
+                    // For example the first time the model is created it needs to parse the data but if the
+                    // models update method is called we want to keep the data the same.
+
                     return propertyData;
                 }
             default:
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,7 @@`
`121`	`121`	`"seed": "abc",`
`122`	`122`	`"results": 3,`
`123`	`123`	`"page": 1,`
`124`		`- "version": "1.1"`
	`124`	`+ "version": "1.1",`
	`125`	`+ "stringified": "{\"id\":\"fb55b892-65c6-4a2f-9ce1-13ddb3ad6d98\",\"name\":\"Admin\",\"description\":\"Administrator\",\"userCount\":0}"`
`125`	`126`	`}`
`126`	`127`	`}`