Initial version

Author: Thomas Schissler

.vscode/launch.json

@@ -0,0 +1,28 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}\\index.js",
+            "console": "externalTerminal" 
+        },
+        {
+            "name": "DebugCucumber",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceRoot}/node_modules/cucumber/bin/cucumber-js",
+            "args": [
+                "${workspaceRoot}/GameController_ATDD/*.feature",
+                "--tags", "@debug"
+            ]
+        }
+    ]
+}

Battleship_Tests/parsePositionTests.js

@@ -0,0 +1,12 @@
+const assert=require('assert').strict;
+const battleship=require("../battleship.js");
+const letters=require("../GameController/letters.js");
+const position=require("../GameController/position.js")
+
+describe('parsePositionTests', function() {
+  it('should return a valid position for valid input', function() {
+    var expected = new position(letters.B, 3);
+    var actual = battleship.ParsePosition("B3");
+    assert.deepStrictEqual(actual, expected);
+  });
+});

GameController/gameController.js

@@ -0,0 +1,38 @@
+class GameController {
+    static InitializeShips ()
+    {
+        var colors = require("cli-color");
+        const Ship = require("./ship.js");
+        var ships = 
+        [
+            new Ship("Aircraft Carrier", 5, colors.CadetBlue ), 
+            new Ship("Battleship", 4, colors.Red ), 
+            new Ship("Submarine", 3, colors.Chartreuse ), 
+            new Ship("Destroyer", 3, colors.Yellow ), 
+            new Ship("Patrol Boat", 2, colors.Orange )
+        ];
+        return ships;
+    }
+    
+    static CheckIsHit (ships, shot)
+    {
+        if (shot == undefined)
+            throw "The shooting position is not defined";
+        if (ships == undefined)
+            throw "No ships defined";
+        var returnvalue = false;
+        ships.forEach(function(ship) {
+            ship.positions.forEach(position => {
+                if (position.row == shot.row && position.column == shot.column)
+                    returnvalue = true;
+            });
+        });
+        return returnvalue;
+    }
+
+    static isShipValid (ship) {
+        return ship.positions.length == ship.size;
+    }
+}
+
+module.exports = GameController;

GameController/letters.js

@@ -0,0 +1,4 @@
+require('enum').register();
+var Letters = new Enum({'A': 1, 'B': 2, 'C': 3, 'D': 4, 'E': 5, 'F': 6, 'G': 7, 'H': 8}, { ignoreCase: true });
+
+module.exports = Letters;

GameController/position.js

@@ -0,0 +1,10 @@
+class Position
+{
+    constructor(column, row)
+    {
+        this.column = column;
+        this.row = row;
+    }
+}
+
+module.exports = Position;

GameController/ship.js

@@ -0,0 +1,15 @@
+class Ship
+{
+    constructor (name, size, color) {
+        this.name = name;
+        this.size = size;
+        this.color = color;
+        this.positions = [];
+    }
+
+    addPosition(position) {
+        this.positions.push(position);
+    }
+}
+
+module.exports = Ship;

GameController_ATDD/isShipValid.feature

@@ -0,0 +1,16 @@
+Feature: IsShipValid
+	In order to avoid cheeting
+	As a player
+	I want to be notified if my ship has a invalid placement
+
+@debug
+Scenario: Valid ship placement
+	Given I have a 5 ship with 5 positions
+	When I check if the ship is valid
+	Then the result should be "true"
+
+@debug
+Scenario: Invalid ship placement
+	Given I have a 5 ship with 4 positions
+	When I check if the ship is valid
+	Then the result should be "false"

GameController_ATDD/support/steps.js

@@ -0,0 +1,27 @@
+const { Given, When, Then, defineParameterType } = require("cucumber");
+const assert = require('assert').strict;
+const shipDef = require("../../GameController/ship.js");
+const position = require("../../GameController/position.js");
+const letters = require("../../GameController/letters.js");
+const gameController = require("../../GameController/gameController.js");
+
+var ship;
+var actual;
+
+defineParameterType({name: "bool", regexp: /"([^"]*)"/, transformer(text) {return text.toLowerCase()=="true"}});
+
+Given("I have a {int} ship with {int} positions", function(size, positions){
+  ship = new shipDef();
+  ship.size = size;
+  for(var i = 1; i <= positions; i++) {
+    ship.addPosition(new position(letters.A, i))
+  }
+});
+
+When("I check if the ship is valid", function(){
+  actual = gameController.isShipValid(ship);
+});
+
+Then("the result should be {bool}", function(expected){
+  assert.strictEqual(actual, expected);
+});

GameController_Tests/checkIsHitTests.js

@@ -0,0 +1,52 @@
+const assert = require('assert').strict;
+const gameController=require("../GameController/gameController.js");
+const letters=require("../GameController/letters.js");
+const position=require("../GameController/position.js")
+
+describe('checkIsHitTests', function() {
+
+  it('should return true if there is a ship at the shooting position', function() {
+    var ships = gameController.InitializeShips();
+    counter=1;
+    ships.forEach(ship => {
+      for(var i = 1; i <= ship.size; i++) {
+        column = letters.get(counter);
+        ship.addPosition(new position(letters.get(counter), i))
+      }
+      counter++;
+    })
+    var actual = gameController.CheckIsHit(ships, new position(letters.B,3));
+    assert.ok(actual);
+  });
+
+  it('should return false if there is no ship at the shooting position', function() {
+    var ships = gameController.InitializeShips();
+    counter=1;
+    ships.forEach(ship => {
+      for(var i = 1; i <= ship.size; i++) {
+        ship.addPosition(new position(letters.get(counter), i))
+      }
+      counter++;
+    })
+    var actual = gameController.CheckIsHit(ships, new position(letters.G,1));
+    assert.strictEqual(actual, false );
+  });
+
+  it('should throw an exception if positstion is undefined', function() {
+    var ships = gameController.InitializeShips();
+    assert.throws(
+      () => {
+        var actual = gameController.CheckIsHit(ships, undefined);
+      }
+    )
+  });
+
+  it('should throw an exception if ship is undefined', function() {
+    assert.throws(
+      () => {
+        var actual = gameController.CheckIsHit(undefined, new position(letters.G,1));
+      }
+    )
+  });
+});
+

GameController_Tests/isShipValidTests.js

@@ -0,0 +1,27 @@
+const assert = require('assert').strict;
+const gameController=require("../GameController/gameController.js");
+const letters=require("../GameController/letters.js");
+const position=require("../GameController/position.js")
+const ship=require("../GameController/ship");
+
+describe('isShipValidTests', function() {
+
+  it('should return true if the ship is valid', function() {
+    var testship = new ship("Battleship", 3, 0);
+    testship.addPosition(new position(letters.A, 1));
+    testship.addPosition(new position(letters.A, 2));
+    testship.addPosition(new position(letters.A, 3));
+
+    var actual = gameController.isShipValid(testship);
+    assert.ok(actual);
+  });
+
+  it('should return false if the ship is invalid', function() {
+    var testship = new ship("Battleship", 3, 0);
+
+    var actual = gameController.isShipValid(testship);
+    assert.ok(!actual);
+  });
+});
+
+

README.md

@@ -1,2 +1,11 @@
-# battleship-nodejs
-Battleship case study for NodeJs
+Start application
+node index.js
+
+Execute all tests
+npm test
+ 
+Execute Mocha tests (Unit Tests)
+mocha './**/*Tests.js'
+
+Execute Cucumber tests
+./node_modules/.bin/cucumber-js .\GameController_ATDD