feat: factory

Author: Nejc

.eslintrc

@@ -58,6 +58,7 @@
     "react/jsx-indent": "off",
     "jsx-a11y/label-has-for": "off",
     "jsx-a11y/label-has-associated-control": "off",
-    "@typescript-eslint/no-non-null-assertion": "off"
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "no-useless-constructor": "off"
   }
 }

.vscode/settings.json

@@ -6,5 +6,6 @@
     "titleBar.activeForeground": "#ffffff", // change this color!
     "titleBar.inactiveForeground": "#ffffff" // change this color!
   },
-  "editor.fontSize": 13
+  "editor.fontSize": 13,
+  "jestrunner.jestCommand": "npm run test:nocov"
 }

package.json

@@ -34,6 +34,7 @@
     "lint": "eslint ./src/**/*.{js,jsx,ts,tsx}",
     "lint:fix": "npm run lint --fix",
     "test": "npm run lint && jest",
+    "test:nocov": "jest --coverage=false",
     "test:cov": "jest --coverage --colors && jest-coverage-badges",
     "test:build": "jest --coverage --colors --silent && jest-coverage-badges",
     "test:watch": "jest --watch",

src/patterns/factory/index.test.ts

@@ -0,0 +1,20 @@
+import AlgorithmFactory, {BubbleSort, QuickSort} from './';
+
+describe('Factory', () => {
+  it('should create an algorithm', () => {
+    const factory = new AlgorithmFactory();
+
+    const algorithm = factory.createAlgorithm('bubble-sort', {values: [1, 5, 2]});
+    expect(algorithm instanceof BubbleSort).toBeTruthy();
+
+    const algorithm2 = factory.createAlgorithm('quick-sort', {
+      values: [1, 5, 2],
+      type: 'test',
+    });
+    expect(algorithm2 instanceof QuickSort).toBeTruthy();
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const algorithm3 = factory.createAlgorithm('missing' as any, {values: [1, 5, 2]});
+    expect(algorithm3).toBeUndefined();
+  });
+});

src/patterns/factory/index.ts

@@ -0,0 +1,28 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export class BubbleSort {
+  constructor(public values: number[]) {}
+}
+
+export class QuickSort {
+  constructor(public values: number[], public type: string) {}
+}
+
+// Algorithm Factory
+class AlgorithmFactory {
+  createAlgorithm(
+    type: 'bubble-sort' | 'quick-sort',
+    props: Record<string, any>,
+  ): BubbleSort | QuickSort | undefined {
+    switch (type) {
+      case 'bubble-sort':
+        return new BubbleSort(props.values);
+      case 'quick-sort':
+        return new QuickSort(props.values, props.type);
+      default:
+        // noop
+        return undefined;
+    }
+  }
+}
+
+export default AlgorithmFactory;

src/patterns/readme.md

@@ -0,0 +1,4 @@
+https://www.dofactory.com/javascript/design-patterns/singleton
+https://loredanacirstea.github.io/es6-design-patterns/
+https://www.velotio.com/engineering-blog/design-patterns-in-es6
+https://www.javascriptjanuary.com/blog/writing-maintainable-and-readable-javascript-design-patterns