Merge pull request #4 from wintondeshong/feature/porting-code-batch3

A few ports from previous projects; Largely wrapping lodash

Author: wintondeshong

package-lock.json

@@ -9,13 +9,15 @@
     },
     "dependencies": {
         "axios": "0.19.2",
-        "immutable": "4.0.0-rc.12"
+        "immutable": "4.0.0-rc.12",
+        "lodash": "4.17.15"
     },
     "description": "Common patterns, functions, etc... used when building react applications",
     "devDependencies": {
         "@testing-library/jest-dom": "5.5.0",
         "@testing-library/react": "10.0.4",
         "@types/jest": "25.1.5",
+        "@types/lodash": "4.14.108",
         "@types/node": "13.11.0",
         "@types/rosie": "0.0.37",
         "jest": "25.5.4",

package.json

@@ -0,0 +1,65 @@
+const VideoResolutions = [
+    {
+        height: 1080,
+        label: "1080p(FHD)",
+        ratio: "16:9",
+        width: 1920,
+    },
+    {
+        height: 1200,
+        label: "UXGA",
+        ratio: "4:3",
+        width: 1600,
+    },
+    {
+        height: 720,
+        label: "720p(HD)",
+        ratio: "16:9",
+        width: 1280,
+    },
+    {
+        height: 600,
+        label: "SVGA",
+        ratio: "4:3",
+        width: 800,
+    },
+    {
+        height: 480,
+        label: "VGA",
+        ratio: "4:3",
+        width: 640,
+    },
+    {
+        height: 360,
+        label: "360p(nHD)",
+        ratio: "16:9",
+        width: 640,
+    },
+    {
+        height: 288,
+        label: "CIF",
+        ratio: "4:3",
+        width: 352,
+    },
+    {
+        height: 240,
+        label: "QVGA",
+        ratio: "4:3",
+        width: 320,
+    },
+    {
+        height: 144,
+        label: "QCIF",
+        ratio: "4:3",
+        width: 176,
+    },
+    {
+        height: 120,
+        label: "QQVGA",
+        ratio: "4:3",
+        width: 160,
+    },
+
+];
+
+export { VideoResolutions };

src/constants/video-resolutions.ts

@@ -0,0 +1,6 @@
+interface KeyValuePair<TKey, TValue> {
+    key: TKey;
+    value: TValue;
+}
+
+export { KeyValuePair };

src/interfaces/key-value-pair.ts

@@ -64,19 +64,19 @@ interface MockAxios {
 // ---------------------------------------------------------
 
 const deleteSuccess = (record?: any, delay?: number) =>
-    _mockSuccess(mockAxios.delete, record, delay);
+    _mockSuccess(MockAxios.delete, record, delay);
 
 const getSuccess = (record: any, delay?: number) =>
-    _mockSuccess(mockAxios.get, record, delay);
+    _mockSuccess(MockAxios.get, record, delay);
 
 const listSuccess = (records: any[], delay?: number) =>
-    _mockSuccess(mockAxios.get, records, delay);
+    _mockSuccess(MockAxios.get, records, delay);
 
 const postSuccess = (record: any, delay?: number) =>
-    _mockSuccess(mockAxios.post, record, delay);
+    _mockSuccess(MockAxios.post, record, delay);
 
 const putSuccess = (record: any, delay?: number) =>
-    _mockSuccess(mockAxios.put, record, delay);
+    _mockSuccess(MockAxios.put, record, delay);
 
 // #endregion Public Functions
 
@@ -131,7 +131,7 @@ const _resultObjectToJS = (resultObject: any | any[]): any | any[] => {
 // #region Exports
 // ---------------------------------------------------------
 
-const mockAxios: MockAxios = {
+export const MockAxios: MockAxios = {
     delete: axios.delete as AxiosJestMock,
     deleteSuccess,
     get: axios.get as AxiosJestMock,
@@ -143,6 +143,4 @@ const mockAxios: MockAxios = {
     putSuccess,
 };
 
-export default mockAxios;
-
 // #endregion Exports

src/tests/mocks/mock-axios.ts

@@ -0,0 +1,6 @@
+type CancellablePromise<T = any> = {
+    cancel: () => void;
+    promise: Promise<T>;
+};
+
+export { CancellablePromise };

src/types/cancellable-promise.ts

@@ -1,4 +1,5 @@
 import { List } from "immutable";
+import _ from "lodash";
 
 // -----------------------------------------------------------------------------------------
 // #region Private Methods
@@ -180,12 +181,18 @@ const _replaceElementAt = <T>(
 // -----------------------------------------------------------------------------------------
 
 export const CollectionUtils = {
+    difference: _.difference,
     equalsBy: _equalsBy,
+    first: _.head,
+    flattenDeep: _.flattenDeep,
     hasValues: _hasValues,
     isEmpty: _isEmpty,
     isNotEmpty: _isNotEmpty,
     length: _length,
     replaceElementAt: _replaceElementAt,
+    sample: _.sample,
+    sampleSize: _.sampleSize,
+    take: _.take,
 };
 
 // #endregion Exports

src/utilities/collection-utils.ts

@@ -1,4 +1,5 @@
 import { CollectionUtils } from "./collection-utils";
+import _ from "lodash";
 
 // -----------------------------------------------------------------------------------------
 // #region Private Methods
@@ -84,10 +85,16 @@ const _timer = (name: string) => {
 // -----------------------------------------------------------------------------------------
 
 export const CoreUtils = {
+    bindAll: _.bindAll,
+    curry: _.curry,
+    memoize: _.memoize,
     numericEnumToPojo: _numericEnumToPojo,
     objectToArray: _objectToArray,
+    range: _.range,
     sleep: _sleep,
+    throttle: _.throttle,
     timer: _timer,
+    times: _.times,
 };
 
 // #endregion Exports

src/utilities/core-utils.ts

@@ -0,0 +1,87 @@
+import { EnvironmentUtils } from "./environment-utils";
+
+describe("EnvironmentUtils", () => {
+    const originalEnv = process.env;
+
+    // Save old process.env and replace it after each test
+    // See https://stackoverflow.com/a/48042799 for reference
+    beforeEach(() => {
+        jest.resetModules(); // this is important - it clears the cache
+        process.env = { ...originalEnv };
+        delete process.env;
+    });
+
+    afterEach(() => {
+        process.env = originalEnv;
+    });
+
+    // -----------------------------------------------------------------------------------------
+    // #region isDevelopment()
+    // -----------------------------------------------------------------------------------------
+
+    describe("isDevelopment()", () => {
+        test("when process.env.NODE_ENV is set to 'development', it returns true", () => {
+            // Arrange
+            const newEnv = { ...originalEnv };
+            newEnv.NODE_ENV = "development";
+            process.env = newEnv;
+
+            // Act
+            const result = EnvironmentUtils.isDevelopment();
+
+            // Assert
+            expect(result).toBeTrue();
+        });
+
+        test("when process.env.NODE_ENV is set to 'production', it returns false", () => {
+            // Arrange
+            const newEnv = { ...originalEnv };
+            newEnv.NODE_ENV = "production";
+            process.env = newEnv;
+
+            // Act
+            const result = EnvironmentUtils.isDevelopment();
+
+            // Assert
+            expect(result).toBeFalse();
+        });
+    });
+
+    // #endregion isDevelopment()
+
+    // -----------------------------------------------------------------------------------------
+    // #region runIfDevelopment()
+    // -----------------------------------------------------------------------------------------
+
+    describe("runIfDevelopment()", () => {
+        test("when process.env.NODE_ENV is set to 'development', it runs the function", () => {
+            // Arrange
+            const newEnv = { ...originalEnv };
+            newEnv.NODE_ENV = "development";
+            process.env = newEnv;
+            const fn = jest.fn();
+
+            // Act
+            EnvironmentUtils.runIfDevelopment(() => fn());
+
+            // Assert
+            expect(fn).toHaveBeenCalled();
+        });
+
+        test("when process.env.NODE_ENV is set to 'production', it does not run the function", () => {
+            // Arrange
+            const newEnv = { ...originalEnv };
+            newEnv.NODE_ENV = "production";
+            process.env = newEnv;
+            const fn = jest.fn();
+
+            // Act
+            EnvironmentUtils.runIfDevelopment(() => fn());
+
+            // Assert
+            expect(fn).not.toHaveBeenCalled();
+        });
+    });
+
+    // #endregion runIfDevelopment()
+});

src/utilities/environment-utils.test.ts

@@ -0,0 +1,38 @@
+// -----------------------------------------------------------------------------------------
+// #region Functions
+// -----------------------------------------------------------------------------------------
+
+/**
+ * Function to return whether or not the current environment is development.
+ *
+ * @returns {boolean}
+ */
+const isDevelopment = (): boolean => {
+    return process.env.NODE_ENV === "development";
+};
+
+/**
+ * Conditionally runs the given function, depending on whether the current environment is development or not.
+ *
+ * @param {() => any} fn Function to be run in a development environment only.
+ */
+const runIfDevelopment = (fn: () => any): void => {
+    if (!isDevelopment()) {
+        return;
+    }
+
+    fn();
+};
+
+// #endregion Functions
+
+// -----------------------------------------------------------------------------------------
+// #region Export
+// -----------------------------------------------------------------------------------------
+
+export const EnvironmentUtils = {
+    isDevelopment,
+    runIfDevelopment,
+};
+
+// #endregion Export