Merge pull request #4 from hckrnews/feature/refactor-truth-table

Refactor the truth table, extend it for every logic type

README.md

@@ -20,9 +20,9 @@ or
 
 Example usage:
 ```
-import TruthTable from "@hckrnews/truth-table";
+import AndTruthTable from "@hckrnews/truth-table";
 
-const table = TruthTable.create(3);
+const table = AndTruthTable.create(3);
 ```
 
 Table inputs result:
@@ -45,7 +45,7 @@ Output:
 
 To receive results of the and operator:
 ```
-table.and
+table.output
 ```
 Output:
 ```
@@ -54,7 +54,7 @@ Output:
 
 Do you with te receive the result with the inputs of the and operator:
 ```
-table.andWithInputs
+table.result
 ```
 Output:
 ```
@@ -71,18 +71,12 @@ Output:
 ```
 
 All options:
-* and
-* andWithInputs
-* nand
-* nandWithInputs
-* or
-* orWithInputs
-* nor
-* norWithInputs
-* xor
-* xorWithInputs
-* xnor
-* xnorWithInputs
+* AndTruthTable
+* NandTruthTable
+* OrTruthTable
+* NorTruthTable
+* XoTruthTable
+* XnoTruthTable
 
 [npm-url]: https://www.npmjs.com/package/@hckrnews/truth-table
 [npm-image]: https://img.shields.io/npm/v/@hckrnews/truth-table.svg

package.json

@@ -1,10 +1,17 @@
 {
     "name": "@hckrnews/truth-table",
-    "version": "1.1.0",
+    "version": "2.0.0",
     "description": "",
     "main": "src/TruthTable.mjs",
     "files": [
         "src/TruthTable.mjs",
+        "src/BaseTruthTable.mjs",
+        "src/AndTruthTable.mjs",
+        "src/NandTruthTable.mjs",
+        "src/OrTruthTable.mjs",
+        "src/NorTruthTable.mjs",
+        "src/XorTruthTable.mjs",
+        "src/XnorTruthTable.mjs",
         "src/Helper.js",
         "src/InvalidInputError.js"
     ],

src/AndTruthTable.mjs

@@ -0,0 +1,10 @@
+import TruthTable from './BaseTruthTable.mjs';
+
+class AndTruthTable extends TruthTable {
+    generateOutput() {
+        this.output = this.inputs.map(row => row.every(Boolean));
+        this.result = this.inputs.map(row => [row.every(Boolean), ...row]);
+    }
+}
+
+export default AndTruthTable;

src/BaseTruthTable.mjs

@@ -0,0 +1,48 @@
+import Helper from './Helper';
+import InvalidInputError from './InvalidInputError';
+
+class TruthTable {
+    constructor(propositions) {
+        if (!Number.isInteger(propositions)) {
+            throw new InvalidInputError(
+                propositions,
+                'propositions isnt a number'
+            );
+        }
+
+        this.propositions = propositions;
+        this.inputs = [];
+        this.output = [];
+        this.result = [];
+    }
+
+    get combinations() {
+        return 2 ** this.propositions;
+    }
+
+    generateInputs() {
+        const inputs = Array(this.combinations).fill(false);
+
+        this.inputs = inputs.map((value, index) => this.addRow(index));
+    }
+
+    generateOutput() {}
+
+    addRow(row) {
+        const binary = Helper.dec2bin(row, this.propositions);
+        const inputs = Array(this.propositions).fill(false);
+
+        return inputs.map((value, index) => binary.substr(index, 1) === '1');
+    }
+
+    static create(propositions) {
+        const table = new this(propositions);
+
+        table.generateInputs();
+        table.generateOutput();
+
+        return table;
+    }
+}
+
+export default TruthTable;

src/NandTruthTable.mjs

@@ -0,0 +1,10 @@
+import TruthTable from './BaseTruthTable.mjs';
+
+class NandTruthTable extends TruthTable {
+    generateOutput() {
+        this.output = this.inputs.map(row => !row.every(Boolean));
+        this.result = this.inputs.map(row => [!row.every(Boolean), ...row]);
+    }
+}
+
+export default NandTruthTable;

src/NorTruthTable.mjs

@@ -0,0 +1,10 @@
+import TruthTable from './BaseTruthTable.mjs';
+
+class NorTruthTable extends TruthTable {
+    generateOutput() {
+        this.output = this.inputs.map(row => !row.some(Boolean));
+        this.result = this.inputs.map(row => [!row.some(Boolean), ...row]);
+    }
+}
+
+export default NorTruthTable;

src/OrTruthTable.mjs

@@ -0,0 +1,10 @@
+import TruthTable from './BaseTruthTable.mjs';
+
+class OrTruthTable extends TruthTable {
+    generateOutput() {
+        this.output = this.inputs.map(row => row.some(Boolean));
+        this.result = this.inputs.map(row => [row.some(Boolean), ...row]);
+    }
+}
+
+export default OrTruthTable;

src/TruthTable.mjs

@@ -1,97 +1,17 @@
-import Helper from './Helper';
-import InvalidInputError from './InvalidInputError';
-
-class TruthTable {
-    constructor(propositions) {
-        if (!Number.isInteger(propositions)) {
-            throw new InvalidInputError(
-                propositions,
-                'propositions isnt a number'
-            );
-        }
-
-        this.propositions = propositions;
-        this.inputs = [];
-    }
-
-    get combinations() {
-        return 2 ** this.propositions;
-    }
-
-    generate() {
-        const inputs = Array(this.combinations).fill(false);
-
-        this.inputs = inputs.map((value, index) => this.addRow(index));
-    }
-
-    addRow(row) {
-        const binary = Helper.dec2bin(row, this.propositions);
-        const inputs = Array(this.propositions).fill(false);
-
-        return inputs.map((value, index) => binary.substr(index, 1) === '1');
-    }
-
-    get and() {
-        return this.inputs.map(row => row.every(Boolean));
-    }
-
-    get nand() {
-        return this.inputs.map(row => !row.every(Boolean));
-    }
-
-    get or() {
-        return this.inputs.map(row => row.some(Boolean));
-    }
-
-    get nor() {
-        return this.inputs.map(row => !row.some(Boolean));
-    }
-
-    get xor() {
-        return this.inputs.map(row => Helper.totalTrueInputs(row) % 2 === 1);
-    }
-
-    get xnor() {
-        return this.inputs.map(row => Helper.totalTrueInputs(row) % 2 === 0);
-    }
-
-    get andWithInputs() {
-        return this.inputs.map(row => [row.every(Boolean), ...row]);
-    }
-
-    get nandWithInputs() {
-        return this.inputs.map(row => [!row.every(Boolean), ...row]);
-    }
-
-    get orWithInputs() {
-        return this.inputs.map(row => [row.some(Boolean), ...row]);
-    }
-
-    get norWithInputs() {
-        return this.inputs.map(row => [!row.some(Boolean), ...row]);
-    }
-
-    get xorWithInputs() {
-        return this.inputs.map(row => [
-            Helper.totalTrueInputs(row) % 2 === 1,
-            ...row,
-        ]);
-    }
-
-    get xnorWithInputs() {
-        return this.inputs.map(row => [
-            Helper.totalTrueInputs(row) % 2 === 0,
-            ...row,
-        ]);
-    }
-
-    static create(propositions) {
-        const table = new TruthTable(propositions);
-
-        table.generate();
-
-        return table;
-    }
-}
+import TruthTable from './BaseTruthTable.mjs';
+import AndTruthTable from './AndTruthTable.mjs';
+import NandTruthTable from './NandTruthTable.mjs';
+import OrTruthTable from './OrTruthTable.mjs';
+import NorTruthTable from './NorTruthTable.mjs';
+import XorTruthTable from './XorTruthTable.mjs';
+import XnorTruthTable from './XnorTruthTable.mjs';
 
 export default TruthTable;
+export {
+    AndTruthTable,
+    NandTruthTable,
+    OrTruthTable,
+    NorTruthTable,
+    XorTruthTable,
+    XnorTruthTable,
+};

src/XnorTruthTable.mjs

@@ -0,0 +1,16 @@
+import TruthTable from './BaseTruthTable.mjs';
+import Helper from './Helper';
+
+class XnorTruthTable extends TruthTable {
+    generateOutput() {
+        this.output = this.inputs.map(
+            row => Helper.totalTrueInputs(row) % 2 === 0
+        );
+        this.result = this.inputs.map(row => [
+            Helper.totalTrueInputs(row) % 2 === 0,
+            ...row,
+        ]);
+    }
+}
+
+export default XnorTruthTable;

src/XorTruthTable.mjs

@@ -0,0 +1,16 @@
+import TruthTable from './BaseTruthTable.mjs';
+import Helper from './Helper';
+
+class XorTruthTable extends TruthTable {
+    generateOutput() {
+        this.output = this.inputs.map(
+            row => Helper.totalTrueInputs(row) % 2 === 1
+        );
+        this.result = this.inputs.map(row => [
+            Helper.totalTrueInputs(row) % 2 === 1,
+            ...row,
+        ]);
+    }
+}
+
+export default XorTruthTable;

tests/unit/and.spec.js

@@ -1,4 +1,4 @@
-import TruthTable from '../../src/TruthTable.mjs';
+import { AndTruthTable } from '../../src/TruthTable.mjs';
 
 const TestCasesResult = [
     {
@@ -44,8 +44,8 @@ describe.each(TestCasesResult)(
     'Test and',
     ({ description, input, expectedResult }) => {
         it(description, () => {
-            const table = TruthTable.create(input);
-            expect(table.and).toMatchObject(expectedResult);
+            const table = AndTruthTable.create(input);
+            expect(table.output).toMatchObject(expectedResult);
         });
     }
 );

tests/unit/andResult.spec.js

@@ -1,4 +1,4 @@
-import TruthTable from '../../src/TruthTable.mjs';
+import { AndTruthTable } from '../../src/TruthTable.mjs';
 
 const TestCasesResult = [
     {
@@ -61,8 +61,8 @@ describe.each(TestCasesResult)(
     'Test and with inputs',
     ({ description, input, expectedResult }) => {
         it(description, () => {
-            const table = TruthTable.create(input);
-            expect(table.andWithInputs).toMatchObject(expectedResult);
+            const table = AndTruthTable.create(input);
+            expect(table.result).toMatchObject(expectedResult);
         });
     }
 );

tests/unit/result.spec.js → tests/unit/inputs.spec.js

@@ -55,7 +55,7 @@ const TestCasesResult = [
 ];
 
 describe.each(TestCasesResult)(
-    'Test result',
+    'Test inputs generator',
     ({ description, input, expectedResult }) => {
         it(description, () => {
             const table = TruthTable.create(input);

tests/unit/nand.spec.js

@@ -1,4 +1,4 @@
-import TruthTable from '../../src/TruthTable.mjs';
+import { NandTruthTable } from '../../src/TruthTable.mjs';
 
 const TestCasesResult = [
     {
@@ -44,8 +44,8 @@ describe.each(TestCasesResult)(
     'Test nand',
     ({ description, input, expectedResult }) => {
         it(description, () => {
-            const table = TruthTable.create(input);
-            expect(table.nand).toMatchObject(expectedResult);
+            const table = NandTruthTable.create(input);
+            expect(table.output).toMatchObject(expectedResult);
         });
     }
 );

tests/unit/nandResult.spec.js

@@ -1,4 +1,4 @@
-import TruthTable from '../../src/TruthTable.mjs';
+import { NandTruthTable } from '../../src/TruthTable.mjs';
 
 const TestCasesResult = [
     {
@@ -61,8 +61,8 @@ describe.each(TestCasesResult)(
     'Test nand with inputs',
     ({ description, input, expectedResult }) => {
         it(description, () => {
-            const table = TruthTable.create(input);
-            expect(table.nandWithInputs).toMatchObject(expectedResult);
+            const table = NandTruthTable.create(input);
+            expect(table.result).toMatchObject(expectedResult);
         });
     }
 );