Merge pull request #30 from wintondeshong/master

Added CoreUtils#enumToArray and #getRandomEnum; Added Auditable and E…

Author: wintondeshong

src/index.ts

@@ -32,8 +32,10 @@ export { HttpVerb } from "./enumerations/http-verb";
 // #region Interfaces
 // -----------------------------------------------------------------------------------------
 
+export { Auditable } from "./interfaces/auditable";
 export { Culture } from "./interfaces/culture";
 export { CultureParams } from "./interfaces/culture-params";
+export { Entity } from "./interfaces/entity";
 export { KeyValuePair } from "./interfaces/key-value-pair";
 export { PagedResult } from "./interfaces/paged-result";
 export { Result } from "./interfaces/result";

src/interfaces/auditable.ts

@@ -0,0 +1,10 @@
+import { Entity } from "./entity";
+
+export interface Auditable extends Entity {
+    createdById?: number;
+    createdOn?: string;
+    deletedById?: number;
+    deletedOn?: string;
+    updatedById?: number;
+    updatedOn?: string;
+}

src/interfaces/entity.ts

@@ -0,0 +1,3 @@
+export interface Entity {
+    id?: number;
+}

src/utilities/core-utils.test.ts

@@ -1,6 +1,14 @@
 import { CoreUtils } from "./core-utils";
 
 describe("CoreUtils", () => {
+    describe("enumToArray", () => {
+        test.skip("TODO: Backfill tests to complete issue https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/issues/29", () => {});
+    });
+
+    describe("getRandomEnum", () => {
+        test.skip("TODO: Backfill tests to complete issue https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/issues/29", () => {});
+    });
+
     describe("timer", () => {
         test("returns timer object", () => {
             // Act

src/utilities/core-utils.ts

@@ -5,6 +5,45 @@ import _ from "lodash";
 // #region Private Methods
 // -----------------------------------------------------------------------------------------
 
+/**
+ * Transforms an enum into an array of its values
+ *
+ * @example
+ * const roleTypes = TestUtils.enumToArray<RoleType>(RoleType);
+ * // Returns [0, 1, 2, 3, 4, 5]
+ * @template TEnum The enum to be transformed
+ * @param {*} enumObject The enum to be transformed (cannot be typed to TEnum, or TS will return 'typeof TEnum'
+ * instead of a value of TEnum)
+ * @returns {TEnum[]}
+ */
+const _enumToArray = <TEnum = any>(enumObject: any): TEnum[] =>
+    _objectToArray(_numericEnumToPojo(enumObject)) as TEnum[];
+
+/**
+ * Returns a random enum value from its type
+ *
+ * @example
+ * const randomRoleType = TestUtils.getRandomEnum<RoleType>(RoleType);
+ * // Might return the value '1', which is the value of RoleType.Team
+ * @template TEnum The enum to be transformed
+ * @param {*} enumObject The enum to be transformed (cannot be typed to TEnum, or TS will return 'typeof TEnum'
+ * instead of a value of TEnum)
+ * @param {TEnum} [excludeElement] A specific enum value to be excluded from the random selection.
+ * @returns {TEnum}
+ */
+const _getRandomEnum = <TEnum = any>(
+    enumObject: any,
+    excludeElement?: TEnum
+): TEnum => {
+    let enumValues = _enumToArray(enumObject);
+
+    if (excludeElement != null) {
+        enumValues = enumValues.filter((e: any) => e !== excludeElement);
+    }
+
+    return enumValues[Math.floor(Math.random() * enumValues.length)];
+};
+
 const _numericEnumToPojo = (enumObject: any): {} => {
     let pojo: { [k: string]: any } = {};
 
@@ -87,6 +126,8 @@ const _timer = (name: string) => {
 export const CoreUtils = {
     bindAll: _.bindAll,
     curry: _.curry,
+    enumToArray: _enumToArray,
+    getRandomEnum: _getRandomEnum,
     memoize: _.memoize,
     numericEnumToPojo: _numericEnumToPojo,
     objectToArray: _objectToArray,