refactor: transform functional lib into class object

Author: GillianPerard

examples/index.ts

@@ -0,0 +1,18 @@
+// Models
+export * from './models/animal';
+export * from './models/dummy';
+export * from './models/employee';
+export * from './models/gender';
+export * from './models/human';
+export * from './models/living-being';
+export * from './models/organization';
+export * from './models/panther';
+export * from './models/phone-number';
+export * from './models/snake';
+export * from './models/society';
+export * from './models/status';
+export * from './models/unknown-animal';
+export * from './models/zoo';
+
+// Json
+export * from './json/data';

examples/json/data.ts

@@ -10,8 +10,8 @@ import { Zoo } from '../models/zoo';
 import { PhoneNumber } from '../models/phone-number';
 
 export const data: any = {
-    _id: '1',
-    _name: 'Zoos Organization',
+    id: '1',
+    name: 'Zoos Organization',
     zoos: [
         {
             id: 15,
@@ -149,17 +149,17 @@ export const data: any = {
             unknownAnimals: {}
         }
     ],
-    _zoosName: {
+    zoosName: {
         '15': 'The Greatest Zoo',
         '16': 'Zoo Zoo'
     },
-    _mainShareholder: {
+    mainShareholder: {
         humanId: 100,
         name: 'Elon Musk',
         birthDate: '1971-06-28T22:00:00.000Z',
         gender: 1
     },
-    _secondaryShareholder: null
+    secondaryShareholder: null
 };
 
 const bob = new Employee(
@@ -208,7 +208,6 @@ const fried = new Employee(
     new Date(data.zoos[0].employees[3].birthDate)
 );
 fried.email = data.zoos[0].employees[3].email;
-fried.phoneNumber = data.zoos[0].employees[3].phoneNumber;
 
 const bagheera = new Panther(data.zoos[0].Animals[0].name, data.zoos[0].Animals[0].isSpeckled);
 bagheera.color = data.zoos[0].Animals[0].color;
@@ -238,7 +237,6 @@ ka.numberOfPaws = data.zoos[0].Animals[2].numberOfPaws;
 
 const schrodinger = new Panther(data.zoos[0].Animals[3].name, data.zoos[0].Animals[3].isSpeckled);
 schrodinger.color = data.zoos[0].Animals[3].color;
-schrodinger.birthDate = data.zoos[0].Animals[3].birthDate;
 schrodinger.gender = Gender.Male;
 schrodinger.id = data.zoos[0].Animals[3].id;
 schrodinger.numberOfPaws = data.zoos[0].Animals[3].numberOfPaws;
@@ -284,15 +282,15 @@ zooZoo.name = data.zoos[1].name;
 zooZoo.unknownAnimals = {};
 
 const elonMusk = new Human(
-    data._mainShareholder.name,
-    data._mainShareholder.humanId,
-    data._mainShareholder.gender,
-    new Date(data._mainShareholder.birthDate)
+    data.mainShareholder.name,
+    data.mainShareholder.humanId,
+    data.mainShareholder.gender,
+    new Date(data.mainShareholder.birthDate)
 );
 
 const organization = new Organization();
-organization.id = data._id;
-organization.name = data._name;
+organization.id = data.id;
+organization.name = data.name;
 organization.zoos = [greatZoo, zooZoo];
 organization.zoosName = {};
 organization.zoosName[greatZoo.id] = greatZoo.name;

examples/models/organization.ts

@@ -3,21 +3,19 @@ import { Human } from './human';
 import { Society } from './society';
 import { Zoo } from './zoo';
 
-const prefixWithUnderscore = (propertyName: string) => `_${propertyName}`;
-
-@JsonObject({ formatPropertyNames: prefixWithUnderscore })
+@JsonObject()
 export class Organization extends Society {
     @JsonProperty({ name: 'zoos', type: Zoo }) zoos: Array<Zoo>;
     @JsonProperty({ isDictionary: true })
     zoosName: { [id: string]: string };
     @JsonProperty({
-        name: ['_mainShareholder', '_secondaryShareholder', '_thirdShareholder'],
+        name: ['mainShareholder', 'secondaryShareholder', 'thirdShareholder'],
         type: Human,
         beforeDeserialize: value => Object.values(value),
         afterSerialize: value => ({
-            _mainShareholder: value[0],
-            _secondaryShareholder: value[1],
-            _thirdShareholder: value[2]
+            mainShareholder: value[0],
+            secondaryShareholder: value[1],
+            thirdShareholder: value[2]
         })
     })
     shareholders: Array<Human | null | undefined>;

jest.config.js

@@ -1,6 +1,7 @@
 module.exports = {
     coverageReporters: ['text', 'lcov'],
-    coveragePathIgnorePatterns: ['examples'],
+    coveragePathIgnorePatterns: ['examples', '/node_modules/'],
+    coverageProvider: 'v8',
     reporters: ['default', 'jest-junit'],
     roots: ['spec'],
     transform: {

package.json

@@ -8,13 +8,13 @@
     "types": "dist/index.d.ts",
     "scripts": {
         "build": "rollup -c",
-        "cover": "jest --coverage",
+        "cover": "rimraf coverage && jest --coverage",
         "lint": "eslint . --ext .ts --fix",
         "lint:ci": "eslint . --ext .ts",
         "postbuild": "npm run types",
         "prebuild": "rimraf dist",
         "test": "jest",
-        "test:ci": "jest --reporters=default --reporters=jest-junit --coverage --coverageReporters=lcov --coverageReporters=text-lcov",
+        "test:ci": "jest --coverage",
         "types": "tsc src/index.ts -d --emitDeclarationOnly --declarationDir dist"
     },
     "repository": {

spec/helpers.spec.ts

@@ -0,0 +1,95 @@
+import {
+    isNumber,
+    isString,
+    isBoolean,
+    isObject,
+    isArray,
+    isDateObject,
+    isDateValue,
+    isNullish,
+    tryParse
+} from '../src/helpers';
+
+const values = [
+    undefined,
+    null,
+    4,
+    '4',
+    'test',
+    false,
+    true,
+    new Date(),
+    new Date().toISOString(),
+    [],
+    [4],
+    {},
+    { test: 'test' }
+];
+
+const test = (fn: Function, ...trueIndexes: Array<number>): void => {
+    values.forEach((value, i) => {
+        const result = trueIndexes.includes(i) ? true : false;
+        expect(fn(value)).toBe(result);
+    });
+};
+
+describe('Helpers', () => {
+    describe('Type check', () => {
+        it('should return true for string and false otherwise', () => {
+            test(isString, 3, 4, 8);
+        });
+
+        it('should return true for number and false otherwise', () => {
+            test(isNumber, 2);
+        });
+
+        it('should return true for boolean and false otherwise', () => {
+            test(isBoolean, 5, 6);
+        });
+
+        it('should return true for object and false otherwise', () => {
+            test(isObject, 7, 11, 12);
+        });
+
+        it('should return true for array and false otherwise', () => {
+            test(isArray, 9, 10);
+        });
+
+        it('should return true for date object and false otherwise', () => {
+            test(isDateObject, 7);
+        });
+
+        it('should return true for date value and false otherwise', () => {
+            test(isDateValue, 2, 3, 8);
+        });
+
+        it('should return true for nullish and false otherwise', () => {
+            test(isNullish, 0, 1);
+        });
+    });
+
+    describe('tryParse', () => {
+        it('should return parsed json for object string', () => {
+            // no need to test undefined value because JSON does not support it
+            const obj = {
+                test: 'test',
+                value: 4,
+                array: ['4', 4, false],
+                bool: false,
+                subObj: { test: 'test' },
+                date: new Date().toISOString(),
+                n: null
+            };
+
+            const string = JSON.stringify(obj);
+            const parsed = tryParse(string);
+            expect(parsed).toStrictEqual(obj);
+        });
+
+        it('should return the given value', () => {
+            values.slice(1).forEach(value => {
+                expect(tryParse(value)).toStrictEqual(value);
+            });
+        });
+    });
+});