Upgrade dependencies

.github/workflows/phpunit.yml → .github/workflows/ci.yml

@@ -1,7 +1,7 @@
 name: Tests
 
 env:
-  PHP_VERSION: 8.2
+  PHP_VERSION: 8.3
 
 on:
   push:
@@ -23,5 +23,11 @@ jobs:
       - name: Install dependencies
         run: composer install --prefer-dist --no-progress --no-suggest
 
+      - name: Lint
+        run: composer lint
+
+      - name: Static analysis
+        run: composer stan
+
       - name: Test
-        run: ./vendor/bin/phpunit
+        run: composer test

composer.json

@@ -13,12 +13,12 @@
         }
     ],
     "require": {
-        "php": ">=8.2"
+        "php": ">=8.3"
     },
     "require-dev": {
-        "phpunit/phpunit": "^10.0",
-        "doctrine/coding-standard": "^12.0",
-        "phpstan/phpstan": "^1.0"
+        "phpunit/phpunit": "^12.0",
+        "doctrine/coding-standard": "^13.0",
+        "phpstan/phpstan": "^2.0"
     },
     "autoload": {
         "psr-4": {
@@ -27,12 +27,17 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Test\\CustomerGauge\\TaskManager\\": "tests/"
+            "Tests\\CustomerGauge\\TaskManager\\": "tests/"
         }
     },
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true
         }
+    },
+    "scripts": {
+        "lint": "phpcs",
+        "stan": "phpstan analyze --level=9 ./src ./tests",
+        "test": "phpunit"
     }
 }

src/InvalidTaskAttribute.php

@@ -28,7 +28,7 @@
 use function implode;
 use function sprintf;
 
-class InvalidTaskAttribute extends InvalidArgumentException
+final class InvalidTaskAttribute extends InvalidArgumentException
 {
     /** @param array<int, int|string> $keys */
     public static function duplicatedKey(Task $task, array $keys): self

src/TaskManager.php

@@ -46,7 +46,7 @@ public function __construct(Strategy|null $strategy = null)
         $this->strategy = $strategy ?? new StopOnFailure();
     }
 
-    public function add(Task $task): self
+    public function add(Task|Reversible $task): self
     {
         $this->tasks[] = $task;
 
@@ -62,7 +62,9 @@ public function run(array $attributes): array
     {
         $this->attributes = $attributes;
 
-        foreach ($this->tasks as $task) {
+        $tasks = array_filter($this->tasks, static fn ($task) => $task instanceof Task);
+
+        foreach ($tasks as $task) {
             $this->strategy->execute(function () use ($task): Task {
                 $attributes = $task->run($this->attributes);
 
@@ -82,9 +84,7 @@ public function reverse(array $attributes): void
     {
         $tasks = array_reverse($this->tasks);
 
-        $tasks = array_filter($tasks, static function ($task): bool {
-            return $task instanceof Reversible;
-        });
+        $tasks = array_filter($tasks, static fn ($task) => $task instanceof Reversible);
 
         foreach ($tasks as $task) {
             $this->strategy->execute(static function () use ($task, $attributes): void {

tests/Strategy/ContinueOnFailureTest.php

@@ -30,7 +30,7 @@
 
 class ContinueOnFailureTest extends TestCase
 {
-    public function test_it_continues_when_a_task_fail(): void
+    public function testItContinuesWhenATaskFail(): void
     {
         $createEmail  = $this->createMock(Task::class);
         $createFolder = $this->createMock(Task::class);
@@ -52,7 +52,7 @@ public function test_it_continues_when_a_task_fail(): void
         });
     }
 
-    public function test_it_stores_exceptions(): void
+    public function testItStoresExceptions(): void
     {
         $createEmail  = $this->createMock(Task::class);
         $createFolder = $this->createMock(Task::class);

tests/Strategy/InvalidPermission.php

@@ -0,0 +1,30 @@
+<?php
+/*
+    Task Manager Library
+    Copyright (C) 2019 CustomerGauge
+    foss@customergauge.com
+
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 3 of the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program; if not, write to the Free Software Foundation,
+    Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+*/
+
+declare(strict_types=1);
+
+namespace Tests\CustomerGauge\TaskManager\Strategy;
+
+use Exception;
+
+class InvalidPermission extends Exception
+{
+}

tests/Strategy/ReversibleTask.php

@@ -0,0 +1,31 @@
+<?php
+/*
+    Task Manager Library
+    Copyright (C) 2019 CustomerGauge
+    foss@customergauge.com
+
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 3 of the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program; if not, write to the Free Software Foundation,
+    Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+*/
+
+declare(strict_types=1);
+
+namespace Tests\CustomerGauge\TaskManager\Strategy;
+
+use CustomerGauge\TaskManager\Reversible;
+use CustomerGauge\TaskManager\Task;
+
+interface ReversibleTask extends Task, Reversible
+{
+}

tests/Strategy/RollbackOnFailureTest.php

@@ -23,15 +23,13 @@
 
 namespace Tests\CustomerGauge\TaskManager\Strategy;
 
-use CustomerGauge\TaskManager\Reversible;
 use CustomerGauge\TaskManager\Strategy\RollbackOnFailure;
 use CustomerGauge\TaskManager\Task;
-use Exception;
 use PHPUnit\Framework\TestCase;
 
 class RollbackOnFailureTest extends TestCase
 {
-    public function test_it_rollback_when_a_task_fail(): void
+    public function testItRollbackWhenATaskFail(): void
     {
         $createEmail  = $this->createMock(ReversibleTask::class);
         $createFolder = $this->createMock(Task::class);
@@ -43,7 +41,7 @@ public function test_it_rollback_when_a_task_fail(): void
             ->method('reverse');
 
         $createFolder->method('run')
-            ->willThrowException(new CreateFolderException());
+            ->willThrowException(new InvalidPermission());
 
         $strategy = new RollbackOnFailure();
 
@@ -53,18 +51,10 @@ public function test_it_rollback_when_a_task_fail(): void
             return $createEmail;
         });
 
-        $this->expectException(CreateFolderException::class);
+        $this->expectException(InvalidPermission::class);
 
         $strategy->execute(static function () use ($createFolder): void {
             $createFolder->run([]);
         });
     }
 }
-
-class CreateFolderException extends Exception
-{
-}
-
-interface ReversibleTask extends Task, Reversible
-{
-}

tests/Strategy/StopOnFailureTest.php

@@ -31,7 +31,7 @@
 
 class StopOnFailureTest extends TestCase
 {
-    public function test_it_stops_when_a_task_fail(): void
+    public function testItStopsWhenATaskFail(): void
     {
         self::expectException(Throwable::class);
 

tests/TaskManagerTest.php

@@ -31,7 +31,7 @@
 
 class TaskManagerTest extends TestCase
 {
-    public function test_it_can_run_tasks(): void
+    public function testItCanRunTasks(): void
     {
         $createEmail  = $this->createMock(Task::class);
         $createFolder = $this->createMock(Task::class);
@@ -50,7 +50,7 @@ public function test_it_can_run_tasks(): void
         $manager->run([]);
     }
 
-    public function test_it_can_manage_attributes(): void
+    public function testItCanManageAttributes(): void
     {
         $createEmail    = $this->createMock(Task::class);
         $createFolder   = $this->createMock(Task::class);
@@ -75,7 +75,7 @@ public function test_it_can_manage_attributes(): void
         $manager->run([]);
     }
 
-    public function test_task_can_not_use_same_key_in_attributes(): void
+    public function testTaskCanNotUseSameKeyInAttributes(): void
     {
         $this->expectException(InvalidTaskAttribute::class);
 
@@ -96,10 +96,10 @@ public function test_task_can_not_use_same_key_in_attributes(): void
         $manager->run([]);
     }
 
-    public function test_task_can_be_revertable(): void
+    public function testTaskCanBeRevertable(): void
     {
-        $createEmail  = $this->createMock(ReversibleTask::class);
-        $createFolder = $this->createMock(ReversibleTask::class);
+        $createEmail  = $this->createMock(Reversible::class);
+        $createFolder = $this->createMock(Reversible::class);
 
         $createEmail->expects($this->once())
             ->method('reverse');
@@ -115,7 +115,3 @@ public function test_task_can_be_revertable(): void
         $manager->reverse([]);
     }
 }
-
-interface ReversibleTask extends Task, Reversible
-{
-}