Initial commit

Author: Peter Götz

.coverage

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = crlf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+

.editorconfig

@@ -0,0 +1,23 @@
+.DS_Store
+
+# Virtual Environment
+venv/
+
+# Python
+__pycache__/
+*.pyc
+
+# Python Setuptools
+out/
+dist/
+build/
+
+# JetBrains
+.idea/
+*.iml
+*.iws
+*.ipr
+
+# Visual Studio (code)
+.vs*
+/reports

.gitignore

@@ -0,0 +1,9 @@
+FROM python:3.6
+LABEL author="Peter Götz ([email protected])"
+
+WORKDIR /torpydo
+
+COPY requirements.txt /torpydo
+
+RUN pip install --upgrade pip
+RUN pip install -r requirements.txt

Dockerfile

@@ -0,0 +1,82 @@
+# Torpydo
+
+A simple game of Battleship, written in Python.
+
+# Getting started
+
+This project requires Python 3.6. To prepare to work with it, pick one of these
+options:
+
+## Linux and macOS
+
+Create and activate a [virtual environment][venv]. This assumes python3 is
+already installed.
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+export PYTHONPATH=.
+```
+
+If you stop working on this project, close your shell, and return later, make
+sure you run the `source bin/venv/activate` command again.
+
+[venv]:https://docs.python.org/3/library/venv.html
+
+## Windows
+
+[Download][pywin] and install Python 3.6 for Windows. Make sure python is on
+your `PATH`. Open a command prompt:
+
+```commandline
+python -m venv venv
+venv\Scripts\activate.bat
+pip install -r requirements.txt
+set PYTHONPATH=.
+```
+
+[pywin]:https://www.python.org/downloads/windows/
+
+## Docker
+
+If you don't want to install anything Python-related on your system, you can
+run the game inside Docker instead.
+
+### Build the Docker Image
+
+```bash
+docker build -t torpydo .
+```
+
+### Run a Docker Container from the Image
+
+```bash
+docker run -it --env PYTHONPATH=/torpydo -v ${PWD}:/torpydo torpydo bash
+```
+
+# Launching the game
+
+```bash
+python -m torpydo
+
+# alternatively:
+python torpydo/battleship.py
+```
+
+# Running the Tests
+
+```
+nosetests --exe
+behave
+```
+
+to run with coverage:
+```
+nosetests --exe --with-coverage
+```
+
+Run behave tests with coverage:
+```
+https://stackoverflow.com/a/37447392/736079
+```

README.md

@@ -0,0 +1,14 @@
+Feature: IsShipValid
+	In order to avoid cheating
+	As a player
+	I want to be notified if my ship has a invalid placement
+
+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
+
+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

features/battleship.feature

@@ -0,0 +1,17 @@
+from behave import given, when, then
+from torpydo.ship import Color, Letter, Ship
+
+@given('I have a {ship_length:d} ship with {positions:d} positions')
+def step_impl(context, ship_length, positions):
+    context.ship = Ship('Test', ship_length, Color.RED)
+
+    for i in range(positions):
+        context.ship.add_position(f"A{i+1}")
+
+@when('I check if the ship is valid')
+def step_impl(context):
+    context.success = str(len(context.ship.positions) == context.ship.size)
+
+@then('the result should be {result}')
+def step_impl(context, result):
+    assert context.success == result

features/steps/battleship_steps.py

@@ -0,0 +1,5 @@
+behave==1.2.5
+nose==1.3.7
+pylint==1.7.4
+coverage==4.4.2
+colorama==0.3.9

requirements.txt

@@ -0,0 +1,10 @@
+import unittest
+
+from torpydo.battleship import parse_position
+
+class TestBattleship(unittest.TestCase):
+    def test_parse_position_true(self):
+        self.assertTrue(parse_position("A1"))
+
+if '__main__' == __name__:
+    unittest.main()

tests/test_battleship.py

@@ -0,0 +1,37 @@
+import unittest
+
+from torpydo.game_controller import GameController
+from torpydo.ship import Color, Letter, Position, Ship
+
+class TestShip(unittest.TestCase):
+    def setUp(self):
+        self.ships = []
+        self.ships.append(init_ship(Ship("Test", 2, Color.RED), [Position(Letter.A, 1), Position(Letter.A, 2)]))
+
+    def test_check_is_hit_true(self):
+        self.assertTrue(GameController.check_is_hit(self.ships, Position(Letter.A, 1)))
+
+    def test_check_is_hit_false(self):
+        self.assertFalse(GameController.check_is_hit(self.ships, Position(Letter.B, 1)))
+
+    def test_check_is_hit_position_none(self):
+        with self.assertRaises(ValueError):
+            self.assertRaises(GameController.check_is_hit(self.ships, None))
+
+    def test_check_is_hit_ship_none(self):
+        with self.assertRaises(ValueError):
+            self.assertRaises(GameController.check_is_hit(None, Position(Letter.A, 1)))
+
+    def test_is_ship_valid_false(self):
+        self.assertFalse(GameController.is_ship_valid(Ship("Not Valid", 3, Color.RED)))
+
+    def test_is_ship_valid_true(self):
+        self.assertTrue(GameController.is_ship_valid(self.ships[0]))
+
+def init_ship(ship: Ship, positions: list):
+    ship.positions = positions
+
+    return ship
+
+if '__main__' == __name__:
+    unittest.main()