Refactoring + Unit tests

.github/workflows/code-analysis.yml

@@ -0,0 +1,26 @@
+name: code-analysis
+
+on:
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - '**.md'
+  workflow_call:
+
+concurrency:
+  group: 'test-${{ github.ref_name }}'
+  cancel-in-progress: true
+
+env:
+  APP_VERSION: ${{ format('0.0.0-build{0}', github.run_number) }}
+
+jobs:
+  app:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Disable Xdebug
+        run: sudo phpdismod xdebug
+      - run: composer install --prefer-dist --no-ansi --no-interaction --no-progress
+      - run: composer cs:check
+      - run: composer phpstan

.github/workflows/test-application.yml

@@ -0,0 +1,32 @@
+name: test
+
+on:
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - '**.md'
+  workflow_call:
+
+concurrency:
+  group: 'test-${{ github.ref_name }}'
+  cancel-in-progress: true
+
+env:
+  APP_VERSION: ${{ format('0.0.0-build{0}', github.run_number) }}
+
+jobs:
+  app:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        testsuite:
+          - core
+          - data
+    steps:
+      - uses: actions/checkout@v5
+      - name: Disable Xdebug
+        run: sudo phpdismod xdebug
+      - name: Create test folder
+        run: mkdir tmp && mkdir tmp/test-drafts
+      - run: composer install --prefer-dist --no-ansi --no-interaction --no-progress
+      - run: composer paratest -- --processes=4 --testsuite ${{ matrix.testsuite }}

.gitignore

@@ -8,4 +8,6 @@ clean.php
 .DS_Store
 supervisord.log
 supervisord.pid
-tmp
+tmp
+.phpunit.cache
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+use Symfony\Component\Finder\Finder;
+
+$finder = Finder::create()
+    ->in([
+        __DIR__ . '/app',
+    ])
+    ->name('*.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return (new Config())
+    ->setParallelConfig(ParallelConfigFactory::detect())
+    ->setRiskyAllowed(true)
+    ->setRules([
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => [
+            'imports_order' => ['class', 'function', 'const'],
+            'sort_algorithm' => 'alpha',
+        ],
+        'fully_qualified_strict_types' => [
+            'phpdoc_tags' => [],
+        ],
+        'no_unused_imports' => true,
+        'blank_line_after_opening_tag' => true,
+        'declare_strict_types' => true,
+        'not_operator_with_successor_space' => true,
+        'trailing_comma_in_multiline' => [
+            'elements' => ['arguments', 'arrays', 'match', 'parameters'],
+        ],
+        'phpdoc_scalar' => true,
+        'unary_operator_spaces' => true,
+        'binary_operator_spaces' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+        ],
+        'no_extra_blank_lines' => [
+            'tokens' => ['parenthesis_brace_block', 'return', 'square_brace_block', 'extra'],
+        ],
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_var_without_name' => true,
+        'method_argument_space' => [
+            'on_multiline' => 'ensure_fully_multiline',
+            'keep_multiple_spaces_after_comma' => true,
+        ],
+        'void_return' => true,
+        'single_quote' => true,
+        'multiline_promoted_properties' => [
+            'minimum_number_of_parameters' => 1,
+        ],
+    ])
+    ->setFinder($finder);

README.md

@@ -15,24 +15,26 @@ To install a local copy of this app you can clone it from the Git Repo:
 
 Then follow these steps:
 
-1. Add `127.0.0.1 miltydraft.test` to your `/etc/hosts` file. This first step is optional though. You can use
+1. Add `127.0.0.1 milty.localhost` to your `/etc/hosts` file. This first step is optional though. You can use
    127.0.0.1 directly as well.
 2. Run `docker-compose up -d --build`. This will first build the image, then start all services.
 3. Run `docker-compose exec app composer install`. This will install all php dependencies.
 4. Create a `.env` file. See `.env.example` for details.
-5. Go to [http://miltydraft.test](http://miltydraft.test) or [127.0.0.1](127.0.0.1) in your browser.
+5. Go to [https://milty.localhost](https://milty.localhost) in your browser (or http://localhost if you don't want to go through the hassle of the following steps) 
+6. Your browser might give you some scary warnings about untrusted certificates. That's because we're using a self-signed certificate.
+If you want to, you can add the certificate to your device's truster certificate.
+7. Run `docker compose exec app cat /home/app/.local/share/caddy/pki/authorities/local/root.crt > caddy-cert.crt` to make a copy of the certificate in `caddy-cert.crt` (which you can then import wherever you need it)
 
 ### Libraries and Dependencies
 
 Frontend runs on vanilla JS/jQuery (I'm aware jQuery is a bit of a blast from the past at this point; sue me and/or change it and PR me if you want) and the Back-end is vanilla PHP.
 As such there's no build-system, or compiling required except for the steps described above.
 
-To make this app as lean and mean (and easy to understand for anyone) as possible, external dependencies, both in the front- and backend should be kept to an absolute minimum. 
+To make this app as lean and mean (and easy to understand for anyone) as possible, external dependencies, both in the front- and backend should be kept to an absolute minimum.
 
 ### Understanding the App flow
 
 1. Players come in on index.php and choose their options. 
 2. A JSON config file is created (either locally or remotely, depending on .env settings) with a unique ID
-3. That Draft ID is also the Draft URL: APP_URL/d/{draft-id} (URL rewriting is done via Caddy)
+3. That Draft ID is also the Draft URL: APP_URL/d/{draft-id} (URL rewriting is done via Caddy locally)
 4. Players (or the Admin) make draft choices, which updates the draft json file (with very loose security, since we're assuming a very low amount of bad actors)
-

app/Application.php

@@ -0,0 +1,130 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+use App\Draft\Repository\DraftRepository;
+use App\Draft\Repository\LocalDraftRepository;
+use App\Draft\Repository\S3DraftRepository;
+use App\Http\ErrorResponse;
+use App\Http\HttpRequest;
+use App\Http\HttpResponse;
+use App\Http\RequestHandler;
+use App\Http\Route;
+use App\Http\RouteMatch;
+use App\Shared\Command;
+use App\Testing\DispatcherSpy;
+
+/**
+ * Unsure why I did this from scratch. I was on a bit of a refactoring roll and I couldn't resist.
+ */
+class Application
+{
+    public readonly DraftRepository $repository;
+    private static self $instance;
+
+    public bool $spyOnDispatcher = false;
+    public DispatcherSpy $spy;
+
+    public function __construct()
+    {
+        if (env('STORAGE', ' local') == 'spaces') {
+            $this->repository = new S3DraftRepository();
+        } else {
+            $this->repository = new LocalDraftRepository();
+        }
+    }
+
+    public function run(): void
+    {
+        $response = $this->handleIncomingRequest();
+
+        http_response_code($response->code);
+        header('Content-type: ' . $response->getContentType());
+        echo $response->getBody();
+        exit;
+    }
+
+    private function handleIncomingRequest(): HttpResponse
+    {
+        try {
+            $handler = $this->handlerForRequest($_SERVER['REQUEST_URI']);
+            if ($handler == null) {
+                return new ErrorResponse('Page not found', 404, true);
+            } else {
+                return $handler->handle();
+            }
+
+        } catch (\Exception $e) {
+            return new ErrorResponse($e->getMessage());
+        }
+    }
+
+    private function matchToRoute(string $path): ?RouteMatch
+    {
+        $routes = include 'app/routes.php';
+
+        foreach($routes as $route => $handlerClass) {
+            $route = new Route($route, $handlerClass);
+            $match = $route->match($path);
+
+            if ($match != null) {
+                return $match;
+            }
+        }
+
+        return null;
+    }
+
+    public function handlerForRequest(string $requestUri): ?RequestHandler
+    {
+        $requestChunks = explode('?', $requestUri);
+
+        $match = $this->matchToRoute($requestChunks[0]);
+
+        if ($match == null) {
+            return null;
+        } else {
+            $request = HttpRequest::fromRequest($match->requestParameters);
+
+            $handler = new $match->requestHandlerClass($request);
+
+            if (! $handler instanceof RequestHandler) {
+                throw new \Exception('Handler does not implement RequestHandler');
+            }
+
+            return $handler;
+        }
+    }
+
+    public function spyOnDispatcher($commandReturnValue = null): void
+    {
+        $this->spyOnDispatcher = true;
+        $this->spy = new DispatcherSpy($commandReturnValue);
+    }
+
+    public function dontSpyOnDispatcher(): void
+    {
+        $this->spyOnDispatcher = false;
+        unset($this->spy);
+    }
+
+    public function handle(Command $command)
+    {
+        if ($this->spyOnDispatcher) {
+            return $this->spy->handle($command);
+        } else {
+            return $command->handle();
+        }
+    }
+
+    public static function getInstance(): self
+    {
+        if (! isset(self::$instance)) {
+            self::$instance = new Application();
+        }
+
+        return self::$instance;
+    }
+}

app/ApplicationTest.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App;
+
+use App\Http\RequestHandlers\HandleClaimOrUnclaimPlayerRequest;
+use App\Http\RequestHandlers\HandleGenerateDraftRequest;
+use App\Http\RequestHandlers\HandleGetDraftRequest;
+use App\Http\RequestHandlers\HandlePickRequest;
+use App\Http\RequestHandlers\HandleRegenerateDraftRequest;
+use App\Http\RequestHandlers\HandleRestoreClaimRequest;
+use App\Http\RequestHandlers\HandleUndoRequest;
+use App\Http\RequestHandlers\HandleViewDraftRequest;
+use App\Http\RequestHandlers\HandleViewFormRequest;
+use App\Testing\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+
+/**
+ * @todo: fix trailing slash
+ */
+class ApplicationTest extends TestCase
+{
+    public static function allRoutes()
+    {
+        yield 'For viewing the form' => [
+            'route' => '/',
+            'handler' => HandleViewFormRequest::class,
+        ];
+
+        yield 'For viewing a draft' => [
+            'route' => '/d/1234',
+            'handler' => HandleViewDraftRequest::class,
+        ];
+
+        yield 'For fetching draft data' => [
+            'route' => '/api/draft/1234',
+            'handler' => HandleGetDraftRequest::class,
+        ];
+
+        yield 'For generating a draft' => [
+            'route' => '/api/generate',
+            'handler' => HandleGenerateDraftRequest::class,
+        ];
+
+        yield 'For making a pick' => [
+            'route' => '/api/pick',
+            'handler' => HandlePickRequest::class,
+        ];
+
+        yield 'For claiming a player' => [
+            'route' => '/api/claim',
+            'handler' => HandleClaimOrUnclaimPlayerRequest::class,
+        ];
+
+        yield 'For restoring a claim' => [
+            'route' => '/api/restore',
+            'handler' => HandleRestoreClaimRequest::class,
+        ];
+
+        yield 'For undoing a pick' => [
+            'route' => '/api/undo',
+            'handler' => HandleUndoRequest::class,
+        ];
+
+        yield 'For regenerating a draft' => [
+            'route' => '/api/regenerate',
+            'handler' => HandleRegenerateDraftRequest::class,
+        ];
+    }
+
+    #[Test]
+    #[DataProvider('allRoutes')]
+    public function itHasHandlerForAllRoutes($route, $handler): void
+    {
+        $application = new Application();
+        $determinedHandler = $application->handlerForRequest($route);
+
+        $this->assertInstanceOf($handler, $determinedHandler);
+    }
+}