Fixing CI

Author: hollandjake

.github/workflows/main.yml

@@ -2,9 +2,11 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
 
 jobs:
   jest-tests:
@@ -14,10 +16,8 @@ jobs:
       - name: Install modules
         run: yarn
       - name: Run tests
-        run: yarn jest --json --outputFile="jest.results.json"
-      - uses: mattallty/jest-github-action@v1.0.3
-        if: github.event_name == 'pull_request'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: yarn jest --json --outputFile=jest.results.json
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
         with:
-          changes-only: true
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,5 +1,5 @@
 # IntelliJ project files
 .idea
 *.iml
-package-lock.json
-yarn.lock
+yarn.lock
+coverage

README.md

@@ -1,3 +1,3 @@
 # PDA-CFG Question Generator
 ![CI](https://github.com/hollandjake/pda-cfg-generator/workflows/CI/badge.svg)
-
+[![codecov](https://codecov.io/gh/hollandjake/pda-cfg-generator/branch/master/graph/badge.svg?token=FS9WF9ZYTT)](https://codecov.io/gh/hollandjake/pda-cfg-generator)

jest.config.js

@@ -5,7 +5,10 @@
     "babel-jest": "^26.6.0",
     "jest": "^26.6.0"
   },
-  "dependencies": {
-    "@jest/globals": "^26.6.0"
+  "scripts": {
+    "test": "jest"
+  },
+  "jest": {
+    "collectCoverage": true
   }
 }

package.json

@@ -2,7 +2,6 @@ import Symbol from "../Symbol.js";
 import ArrayHelper from "../helper/ArrayHelper.js";
 import Variable from "./Variable.js";
 import Terminal from "./Terminal.js";
-import CFGSymbol from "./CFGSymbol.js";
 import Rule from "./Rule.js";
 
 export default class CFG {
@@ -55,6 +54,8 @@ export default class CFG {
                     variables.push(symbol);
                 } else if (symbol instanceof Terminal) {
                     terminals.push(symbol);
+                } else {
+                    throw new Error("One of the Rule's outputList elements isn't supported, please use 'Terminal' or  'Variable'");
                 }
             })
         })
@@ -63,7 +64,7 @@ export default class CFG {
             throw new Error("Start variable not found in variables");
         }
 
-        return new CFG(variables, terminals, rules, startVariable)
+        return new CFG(variables, terminals, rules, startVariable);
     }
 
     /**
@@ -79,7 +80,7 @@ export default class CFG {
         if (inputString !== null && inputString.length > 0) {
             let ruleStrings = inputString.split(/[,\n]/);
 
-            let rules = ruleStrings.map(rule => Rule.fromString(rule))
+            let rules = ruleStrings.map(rule => Rule.fromString(rule)).filter(rule => rule !== null);
 
             if (rules.length > 0) {
                 let startVariable = rules[0].inputVariable;

src/internal/cfg/CFG.js

@@ -20,6 +20,14 @@ export default class Rule {
         this._outputList = outputList;
     }
 
+    get inputVariable() {
+        return this._inputVariable;
+    }
+
+    get outputList() {
+        return this._outputList;
+    }
+
     /**
      * Parse a {Rule} from a string using the format <Variable> -> <Variable|Terminal>*
      * @param {String} ruleString
@@ -44,17 +52,8 @@ export default class Rule {
         return null;
     }
 
-
-    get inputVariable() {
-        return this._inputVariable;
-    }
-
-    get outputList() {
-        return this._outputList;
-    }
-
     /* istanbul ignore next */
     toString() {
-        return `${this._inputVariable} → ${this.outputList.map(s => s.id).join('')}`
+        return `${this._inputVariable} → ${this.outputList.map(s => s.id).join('')}`;
     }
 }

src/internal/cfg/Rule.js

@@ -77,7 +77,7 @@ export default class PDA {
             throw new Error("Start start not found in transition states");
         }
 
-        return new PDA(states, inputAlphabet, stackAlphabet, transitions, startState, acceptStates)
+        return new PDA(states, inputAlphabet, stackAlphabet, transitions, startState, acceptStates);
     }
 
     /* istanbul ignore next */

src/internal/pda/PDA.js

@@ -4,10 +4,10 @@ test('Sorting symbols correctly', () => {
     let input = [Symbol.of("B"), Symbol.of("A")];
     let target = [Symbol.of("A"), Symbol.of("B")];
     expect(Symbol.sort(input)).toEqual(target);
-})
+});
 
 test('Sorting symbols correctly with duplicates', () => {
     let input = [Symbol.of("B"), Symbol.of("A"), Symbol.of("A")];
-    let target = [Symbol.of("A"), Symbol.of("A"),Symbol.of("B")];
+    let target = [Symbol.of("A"), Symbol.of("A"), Symbol.of("B")];
     expect(Symbol.sort(input)).toEqual(target);
 })

test/internal/Symbol.test.js

@@ -2,6 +2,7 @@ import Rule from "../../../src/internal/cfg/Rule.js";
 import CFG from "../../../src/internal/cfg/CFG.js";
 import CFGSymbol from "../../../src/internal/cfg/CFGSymbol.js";
 import Variable from "../../../src/internal/cfg/Variable.js";
+import Symbol from "../../../src/internal/Symbol.js";
 
 test('Creates a CFG', () => {
     let startVariable = Variable.S;
@@ -16,14 +17,14 @@ test('Creates a CFG', () => {
 })
 
 test('Throws Error When Constructing CFG with NULL startVariable', () => {
-   expect(() => {
-       new CFG([], [], [], null);
-   }).toThrowError();
+    expect(() => {
+        new CFG([], [], [], null);
+    }).toThrowError();
 });
 
 test('Throws Error When Constructing CFG with non Variable startVariable', () => {
     expect(() => {
-        new CFG([], [], [], {id:1});
+        new CFG([], [], [], {id: 1});
     }).toThrowError();
 });
 
@@ -41,11 +42,20 @@ test('Creates a CFG from rules', () => {
 })
 
 test('Throws Error When Creating a CFG from rules and startVariable isnt in rules', () => {
-    expect(()=> {
+    expect(() => {
         CFG.fromRules([], Variable.S)
     }).toThrowError();
 })
 
+
+test('Throws Error When Creating a CFG from rules and outputList contains a non Terminal or Variable', () => {
+    expect(() => {
+        CFG.fromRules([
+            new Rule(Variable.S,[Symbol.of("a")])
+        ])
+    }).toThrowError();
+})
+
 test('Can parse string input', () => {
     let cfg = CFG.fromString("A->aA,B->bB");
     let target = CFG.fromRules([
@@ -55,10 +65,14 @@ test('Can parse string input', () => {
     expect(cfg).toEqual(target);
 })
 
-test('Returns null when no rules given to string parser', () => {
+test('Returns null when empty input given to string parser', () => {
     expect(CFG.fromString("")).toBe(null);
 })
 
+test('Returns null when no rules given to string parser', () => {
+    expect(CFG.fromString(",")).toBe(null);
+})
+
 test('Returns null when null given to string parser', () => {
     expect(CFG.fromString(null)).toBe(null);
 })

test/internal/cfg/CFG.test.js

@@ -1,7 +1,6 @@
 import Rule from "../../../src/internal/cfg/Rule.js";
 import Variable from "../../../src/internal/cfg/Variable.js";
 import CFGSymbol from "../../../src/internal/cfg/CFGSymbol.js";
-import CFG from "../../../src/internal/cfg/CFG.js";
 
 test('Construct new Rule', () => {
     let S = CFGSymbol.of("S");
@@ -19,7 +18,7 @@ test('Expect error when creating a Rule with null inputVariable', () => {
 
 test('Expect error when creating a Rule with non Variable inputVariable', () => {
     expect(() => {
-        new Rule({id:1}, []);
+        new Rule({id: 1}, []);
     }).toThrowError();
 });
 
@@ -44,7 +43,7 @@ test('Expect error when creating a Rule with empty outputList', () => {
 test('Can parse string input', () => {
     let rule = Rule.fromString("A->aA");
     expect(rule.inputVariable).toEqual(CFGSymbol.of("A"));
-    expect(rule.outputList).toEqual([CFGSymbol.of("a"),CFGSymbol.of("A")]);
+    expect(rule.outputList).toEqual([CFGSymbol.of("a"), CFGSymbol.of("A")]);
 })
 
 test('Returns null when empty string given to string parser', () => {

test/internal/cfg/Rule.test.js

@@ -1,26 +1,26 @@
 import ObjectHelper from "../../../src/internal/helper/ObjectHelper.js";
 
 test('equals [NULL,NULL]', () => {
-    expect(ObjectHelper.equals(null,null)).toBe(true);
+    expect(ObjectHelper.equals(null, null)).toBe(true);
 })
 test('equals [NULL,primative]', () => {
-    expect(ObjectHelper.equals(null,'')).toBe(null == '');
+    expect(ObjectHelper.equals(null, '')).toBe(null == '');
 })
 test('equals [primative,NULL]', () => {
-    expect(ObjectHelper.equals('',null)).toBe('' == null);
+    expect(ObjectHelper.equals('', null)).toBe('' == null);
 })
 test('equals [{id:1},{id:1}]', () => {
-    expect(ObjectHelper.equals({id:1}, {id:1})).toBe(true);
+    expect(ObjectHelper.equals({id: 1}, {id: 1})).toBe(true);
 })
 
 test('equals != [{id:1},{id:2}]', () => {
-    expect(ObjectHelper.equals({id:1}, {id:2})).toBe(false);
+    expect(ObjectHelper.equals({id: 1}, {id: 2})).toBe(false);
 })
 
 test('equals [{id:1}, {id:1,name:\'test\'}]', () => {
-    expect(ObjectHelper.equals({id:1}, {id:1, name: 'test'})).toBe(false);
+    expect(ObjectHelper.equals({id: 1}, {id: 1, name: 'test'})).toBe(false);
 })
 
 test('equals [{id:1,name:\'test\'}, {id:1}]', () => {
-    expect(ObjectHelper.equals({id:1, name: 'test'}, {id:1})).toBe(false);
+    expect(ObjectHelper.equals({id: 1, name: 'test'}, {id: 1})).toBe(false);
 })

test/internal/helper/ObjectHelper.test.js

@@ -24,35 +24,36 @@ test('Creates a PDA', () => {
 
 test('Throws Error When Constructing PDA with NULL startState', () => {
     expect(() => {
-        new PDA([], [], [], [],null, []);
+        new PDA([], [], [], [], null, []);
     }).toThrowError();
 });
 
 test('Throws Error When Constructing PDA with non State startState', () => {
     expect(() => {
-        new PDA([], [], [], [], {id:1}, []);
+        new PDA([], [], [], [], {id: 1}, []);
     }).toThrowError();
 });
 
 test('Throws Error When Constructing PDA with NULL acceptState', () => {
     expect(() => {
-        new PDA([], [], [], [],State.q0, [null]);
+        new PDA([], [], [], [], State.q0, [null]);
     }).toThrowError();
 });
 
 test('Throws Error When Constructing PDA with non State acceptState', () => {
     expect(() => {
-        new PDA([], [], [], [], State.q0, [{id:1}]);
+        new PDA([], [], [], [], State.q0, [{id: 1}]);
     }).toThrowError();
 });
 
 test('Creates a PDA from transitions', () => {
     let acceptingState = State.q(1, true);
-    let states = [State.q0, acceptingState];
+    let states = [State.q0, acceptingState, State.q(2)];
     let inputAlphabet = [InputSymbol.EPSILON];
     let stackAlphabet = [StackSymbol.EMPTY_STACK];
     let transitions = [
-        new Transition(State.q0, acceptingState, InputSymbol.EPSILON, StackSymbol.EMPTY_STACK, StackSymbol.EMPTY_STACK)
+        new Transition(State.q0, acceptingState, InputSymbol.EPSILON, StackSymbol.EMPTY_STACK, StackSymbol.EMPTY_STACK),
+        new Transition(State.q0, State.q(2), InputSymbol.EPSILON, StackSymbol.EMPTY_STACK, StackSymbol.EMPTY_STACK)
     ];
     let startState = State.q0;
     let acceptStates = [acceptingState];
@@ -63,7 +64,7 @@ test('Creates a PDA from transitions', () => {
 })
 
 test('Throws Error When Creating a PDA from transitions and startState isn\'t in transitions', () => {
-    expect(()=> {
-        PDA.fromTransitions([], State.q0)
+    expect(() => {
+        PDA.fromTransitions([])
     }).toThrowError();
 })

test/internal/pda/PDA.test.js

@@ -21,55 +21,55 @@ test('Construct new Transition', () => {
 
 test('Expect error when creating a Transition with null fromState', () => {
     expect(() => {
-        new Transition(null, null, null,null,null);
+        new Transition(null, null, null, null, null);
     }).toThrowError();
 });
 
 test('Expect error when creating a Transition with non State fromState', () => {
     expect(() => {
-        new Transition({id:1}, null,null,null,null);
+        new Transition({id: 1}, null, null, null, null);
     }).toThrowError();
 });
 
 test('Expect error when creating a Transition with null toState', () => {
     expect(() => {
-        new Transition(State.q0, null, null,null,null);
+        new Transition(State.q0, null, null, null, null);
     }).toThrowError();
 });
 
 test('Expect error when creating a Transition with non State toState', () => {
     expect(() => {
-        new Transition(State.q0, {id: 1},null,null,null);
+        new Transition(State.q0, {id: 1}, null, null, null);
     }).toThrowError();
 });
 
 test('Expect error when creating a Transition with null input', () => {
     expect(() => {
-        new Transition(State.q0, State.q0, null,null,null);
+        new Transition(State.q0, State.q0, null, null, null);
     }).toThrowError();
 });
 
 test('Expect error when creating a Transition with non InputSymbol input', () => {
     expect(() => {
-        new Transition(State.q0, State.q0, {id: 1},null,null);
+        new Transition(State.q0, State.q0, {id: 1}, null, null);
     }).toThrowError();
 });
 
 test('Expect error when creating a Transition with null stackHead', () => {
     expect(() => {
-        new Transition(State.q0, State.q0, InputSymbol.EPSILON,null,null);
+        new Transition(State.q0, State.q0, InputSymbol.EPSILON, null, null);
     }).toThrowError();
 });
 
 test('Expect error when creating a Transition with non Symbol stackHead', () => {
     expect(() => {
-        new Transition(State.q0, State.q0, InputSymbol.EPSILON, {id: 1},null);
+        new Transition(State.q0, State.q0, InputSymbol.EPSILON, {id: 1}, null);
     }).toThrowError();
 });
 
 test('Expect error when creating a Transition with null stackPush', () => {
     expect(() => {
-        new Transition(State.q0, State.q0, InputSymbol.EPSILON, StackSymbol.EMPTY_STACK,null);
+        new Transition(State.q0, State.q0, InputSymbol.EPSILON, StackSymbol.EMPTY_STACK, null);
     }).toThrowError();
 });