better listing and test structure

Author: kevbaldwyn

.eslintignore

@@ -2,3 +2,4 @@ node_modules
 dist
 coverage
 reports
+.eslintrc.js

.eslintrc.js

@@ -6,10 +6,10 @@ module.exports = {
     "eslint-comments",
     "jest",
     "promise",
-    "unicorn",
+    "unicorn"
   ],
   parserOptions: {
-    project: "./tsconfig.json",
+    project: "./tsconfig.json"
   },
   extends: [
     "airbnb-typescript/base",
@@ -18,21 +18,22 @@ module.exports = {
     "plugin:jest/recommended",
     "plugin:promise/recommended",
     "prettier",
-    "prettier/@typescript-eslint",
+    "prettier/@typescript-eslint"
   ],
   rules: {
+    "max-classes-per-file": ["error", 3],
     "import/prefer-default-export": "off",
     "no-use-before-define": [
       "error",
-      { functions: false, classes: true, variables: true },
+      { functions: false, classes: true, variables: true }
     ],
     "@typescript-eslint/explicit-function-return-type": [
       "error",
-      { allowExpressions: true, allowTypedFunctionExpressions: true },
+      { allowExpressions: true, allowTypedFunctionExpressions: true }
     ],
     "@typescript-eslint/no-use-before-define": [
       "error",
-      { functions: false, classes: true, variables: true, typedefs: true },
-    ],
-  },
+      { functions: false, classes: true, variables: true, typedefs: true }
+    ]
+  }
 };

package.json

@@ -26,7 +26,7 @@
     "changelog:update": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
     "clean": "(rm -r ./coverage || true) && (rm -r ./dist || true)",
     "clean:all": "npm run clean && (rm -r ./node_modules || true)",
-    "lint": "eslint src/**/*.ts test/**/*.ts",
+    "lint": "eslint src/**/*.ts",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:mutations": "stryker run",

src/Scalars/FloatScalar.ts

@@ -7,6 +7,7 @@ import {
 
 export const FloatScalar: ValueObjectStatic<number> = class FloatScalar {
   type: string;
+
   value: number;
 
   constructor(value: number) {
@@ -16,7 +17,7 @@ export const FloatScalar: ValueObjectStatic<number> = class FloatScalar {
     enforceExtension(this, FloatScalar);
   }
 
-  public static fromNative(value: number) {
+  public static fromNative(value: number): ValueObject<number> {
     return new this(value);
   }
 

src/Scalars/StringScalar.ts

@@ -7,6 +7,7 @@ import {
 
 export const StringScalar: ValueObjectStatic<string> = class StringScalar {
   type: string;
+
   value: string;
 
   constructor(value: string) {
@@ -16,7 +17,7 @@ export const StringScalar: ValueObjectStatic<string> = class StringScalar {
     enforceExtension(this, StringScalar);
   }
 
-  public static fromNative(value: string) {
+  public static fromNative(value: string): ValueObject<string> {
     return new this(value);
   }
 

src/Scalars/__tests__/StringScalar.test.ts

@@ -0,0 +1,41 @@
+import { StringScalar } from "../StringScalar";
+
+describe("Test StringScalar", () => {
+  const testString = "Test String";
+  class TESTString1 extends StringScalar {}
+  const testStringClass = new TESTString1(testString);
+
+  test("must be extended (not instantiated)", () => {
+    expect(() => {
+      return new StringScalar(testString);
+    }).toThrow(
+      "StringScalar cannot be instantiated, you should create your own domain value objects that extend it"
+    );
+  });
+
+  test("fromNative() initialises object with correct type", () => {
+    const obj = TESTString1.fromNative(testString);
+    expect(obj.type).toBe("TESTString1");
+  });
+
+  test(`toNative() returns "${testString}"`, () => {
+    expect(testStringClass.toNative()).toBe(testString);
+  });
+
+  test("isSame() returns true when values and type match", () => {
+    expect(testStringClass.isSame(new TESTString1(testString))).toBeTruthy();
+  });
+
+  test("isSame() returns false when values mismatch and type match", () => {
+    expect(
+      testStringClass.isSame(new TESTString1("Not the same"))
+    ).not.toBeTruthy();
+  });
+
+  test("isSame() returns false when values match and type mismatch", () => {
+    class TestStringClass2 extends StringScalar {}
+    expect(
+      testStringClass.isSame(new TestStringClass2(testString))
+    ).not.toBeTruthy();
+  });
+});

src/__tests__/ValueObject.test.ts

@@ -0,0 +1,21 @@
+import { ValueObject, getValueObjectType } from "../ValueObject";
+
+class Stub implements ValueObject<string> {
+  type = "TYPE";
+
+  value = "some value";
+
+  isSame = (): boolean => {
+    return false;
+  };
+
+  toNative = (): string => {
+    return this.value;
+  };
+}
+
+describe("Test getValueObjectType()", () => {
+  test("should return 'Stub' for stubbed class", () => {
+    expect(getValueObjectType(new Stub())).toBe("Stub");
+  });
+});