Ddd refactor

.github/workflows/main.yml

@@ -0,0 +1,70 @@
+name: Testing
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Validate composer.json and composer.lock
+        run: make lint-composer
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        run: make composer
+
+      - name: Pack and upload the build
+        uses: actions/upload-artifact@v2
+        with:
+          name: website
+          path: .
+
+  test:
+    if: ${{ success() }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download site build
+        uses: actions/download-artifact@v2
+        with:
+          name: website
+          path: .
+
+      - name: Cache Composer packages
+        uses: actions/cache@v2
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+      - name: Lint PHP files
+        run: make lint-php
+
+      - name: Check PHP styles
+        run: make phpcs
+
+      - name: Static Analysis
+        run: make stan
+
+      - name: Unit Tests
+        run: make tests
+

.gitignore

@@ -1,2 +1,6 @@
 vendor/*
 coverage/*
+bin/*
+
+!bin/.gitkeep
+.phpunit.result.cache

Makefile

@@ -1,32 +1,72 @@
 COMPOSER ?= composer
-PROJECT = "Tic-Tac-Toe"
+DOCKER_COMPOSE = docker-compose
+PROJECT = "TicTacToe."
+COMPOSE_PROJECT_NAME ?= $(notdir $(shell pwd))
+PHP_SERVICE = php
+PHP_CMD = php
 
-all: clear lint-composer lint-php composer phpcs test coverage
+ifeq ($(RUNNER), travis)
+	CMD :=
+else
+	CMD := docker-compose exec $(PHP_SERVICE)
+endif
+
+all: container-up clear composer lint-composer lint-php  phpcs tests
 
 lint-composer:
 	@echo "\n==> Validating composer.json and composer.lock:"
-	$(COMPOSER) validate --strict
+	$(CMD) $(COMPOSER) validate --strict
 
 lint-php:
 	@echo "\n==> Validating all php files:"
-	@find src -type f -name \*.php | while read file; do php -l "$$file" || exit 1; done
+	$(CMD) find src tests -type f -iname '*php' -exec $(PHP_CMD) -l {} \;
 
 composer:
-	$(COMPOSER) install
+	@echo "\n==> Running composer install, runner $(RUNNER)"
+	$(CMD) $(COMPOSER) install
+
+lint: lint-composer lint-php
 
 clear:
-	rm -rf vendor
+	$(CMD) rm -rf vendor
+	$(CMD) rm -rf bin/php*
 
 phpcs:
-	php vendor/bin/phpcs . -np
+	@echo "\n==> Checking style guidelines"
+	$(CMD) bin/phpcs --standard=phpcs.xml -p
 
 phpcbf:
-	vendor/bin/phpcbf src/*
-
-test:
-	vendor/bin/phpunit
+	$(CMD) bin/phpcbf
 
 coverage:
-	vendor/bin/phpunit --coverage-html coverage
+	@echo "\n==> Generating coverage report"
+	$(CMD) bin/phpunit --coverage-html coverage
+
+tests:
+	@echo "\n==> Running tests"
+	$(CMD) bin/phpunit
+
+stan:
+	@echo "\n==> Running stan for analysis"
+	$(CMD) bin/phpstan analyse --memory-limit=-1 src
+
+container-stop:
+	@echo "\n==> Stopping docker container"
+	$(DOCKER_COMPOSE) stop
+
+container-down:
+	@echo "\n==> Removing docker container"
+	$(DOCKER_COMPOSE) down
+
+container-remove:
+	@echo "\n==> Removing docker container(s)"
+	$(DOCKER_COMPOSE) rm
+
+container-up:
+	@echo "\n==> Docker container building and starting ..."
+	$(DOCKER_COMPOSE) up --build -d
+
+tear-down: clear container-stop container-down container-remove
+
 
-.PHONY: lint-php lint-composer phpcs phpcbf test coverage composer clear
+.PHONY: lint-php lint-composer phpcs phpcbf composer clear tests coverage container-up container-stop container-down container-remove

README.md

@@ -1,14 +1,13 @@
-# tic-tac-toe-sami
-
-[![Build Status](https://travis-ci.org/mnsami/tic-tac-toe.svg?branch=master)](https://travis-ci.org/mnsami/tic-tac-toe)
+# tic-tac-toe
 
 ### Description
 
 A php-cli Tic-Tac-Toe simple two players game.
 
 ### Requirements
 
-1. `php >= 7.0` (required for `phpunit v6.1`)
+1. `php >= 8`
+2. `Docker`
 
 ### Installation
 
@@ -18,11 +17,11 @@ Run `make all` will do all the magic for you.
 
 ### Start playing
 
-To start playing the game, you need to run `php main.php`
+TODO, refactoring has to be finished first.
 
 ### Unit tests
 
-To generate tests report, run `make test`.
+To generate tests report, run `make tests`.
 
 ### Coverage
 

composer.json

@@ -5,19 +5,34 @@
     "type": "project",
     "authors": [
         {
-            "name": "Mina Nabil Sami"
+            "name": "Mina Nabil Sami",
+            "email": "[email protected]"
         }
     ],
     "require": {
-        "php": ">=7",
-        "squizlabs/php_codesniffer": "2.*"
-    },
-    "require-dev": {
-        "phpunit/phpunit": "6.1.*"
+        "php": ">=8",
+        "ramsey/uuid": "^3.8"
     },
     "autoload": {
         "psr-0": {
-            "TicTacToe": "src/"
+            "TicTacToe": "./src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "unit\\TicTacToe\\": "./tests/unit"
         }
+    },
+    "config": {
+        "bin-dir": "bin",
+        "platform": {
+            "php": "8"
+        },
+        "sort-packages": true
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^1.8",
+        "phpunit/phpunit": "^9.5",
+        "squizlabs/php_codesniffer": "^3.7"
     }
 }