Merge pull request #2 from imunew/upgrade-php8.x

Upgrade PHP 7.x to 8.x

Author: imunew

.github/workflows/qa.yml

@@ -0,0 +1,51 @@
+name: Quality Assurance
+
+on:
+  push:
+    paths:
+      - '.github/workflows/qa.yml'
+      - 'src/**'
+      - 'tests/**'
+      - 'composer.json'
+      - 'composer.lock'
+      - 'phpunit.xml.dist'
+
+jobs:
+  phpunit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Install dependencies
+        uses: php-actions/composer@v6
+        with:
+          php_version: "8.3"
+
+      - name: Run PHPUnit
+        uses: php-actions/phpunit@v3
+        with:
+          version: "9.6"
+          php_version: "8.3"
+
+  phpstan:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Install dependencies
+        uses: php-actions/composer@v6
+        with:
+          php_version: "8.3"
+
+      - name: Run PHPStan
+        uses: php-actions/phpstan@v3
+        with:
+          php_version: "8.3"
+          path: 'src tests'
+          level: 'max'

.gitignore

@@ -4,6 +4,7 @@ composer.lock
 
 # PHPUnit
 phpunit.xml
+.phpunit.result.cache
 
 # Mac
 .DS_Store

.phpunit.cache/test-results

@@ -0,0 +1 @@
+{"version":1,"defects":{"Imunew\\Pipeline\\Test\\Context\\ContextTest::setStatus":8},"times":{"Imunew\\Pipeline\\Test\\Context\\StatusTest::isInitialized":0,"Imunew\\Pipeline\\Test\\Context\\StatusTest::isStarted":0,"Imunew\\Pipeline\\Test\\Context\\StatusTest::isStopped":0,"Imunew\\Pipeline\\Test\\Pipe\\PipesTest::mergeNumberPipes":0,"Imunew\\Pipeline\\Test\\PipelineTest::processSuccessWithIncrementNumberPipes":0,"Imunew\\Pipeline\\Test\\PipelineTest::processSuccessWithMessagePipes":0,"Imunew\\Pipeline\\Test\\PipelineTest::processSuccessWithExtraMessagePipes":0,"Imunew\\Pipeline\\Test\\PipelineTest::processFailedByNotReturnContext":0.001,"Imunew\\Pipeline\\Test\\Context\\ContextTest::setStatus":0.004,"Imunew\\Pipeline\\Test\\Context\\ContextTest::setStatus#0":0.001,"Imunew\\Pipeline\\Test\\Context\\ContextTest::setStatus#1":0,"Imunew\\Pipeline\\Test\\Context\\ContextTest::setStatus#2":0}}

composer.json

@@ -14,10 +14,16 @@
             "Imunew\\Pipeline\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Imunew\\Pipeline\\Test\\": "tests"
+        }
+    },
     "require": {
-        "php": "^5.6 || ^7.0"
+        "php": ">=8.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7"
+        "phpunit/phpunit": "^11.0",
+        "phpstan/phpstan": "^1.10"
     }
 }

phpunit.xml.dist

@@ -1,17 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.0/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         verbose="true">
-    <testsuite>
-        <directory suffix="Test.php">tests</directory>
-    </testsuite>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
-
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd" bootstrap="vendor/autoload.php" backupGlobals="false" cacheDirectory=".phpunit.cache">
+  <testsuite name="tests">
+    <directory suffix="Test.php">tests</directory>
+  </testsuite>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
 </phpunit>

src/Context/Context.php

@@ -10,12 +10,12 @@ class Context implements ContextInterface
     /** @var StatusInterface */
     private $status;
 
-    /** @var array */
+    /** @var array<string, mixed> */
     private $data;
 
     /**
      * Context constructor.
-     * @param array $data
+     * @param array<string, mixed> $data
      */
     public function __construct($data = [])
     {
@@ -36,7 +36,7 @@ public function setStatus($status)
 
     /**
      * @param string $key
-     * @param $value
+     * @param mixed $value
      * @return ContextInterface
      */
     public function setData($key, $value)

src/Context/ContextInterface.php

@@ -9,7 +9,7 @@ interface ContextInterface
 {
     /**
      * Context constructor.
-     * @param array $data
+     * @param array<string, mixed> $data
      */
     public function __construct($data = []);
 
@@ -21,7 +21,7 @@ public function setStatus($status);
 
     /**
      * @param string $key
-     * @param $value
+     * @param mixed $value
      * @return ContextInterface
      */
     public function setData($key, $value);

src/Context/Status.php

@@ -4,6 +4,7 @@
 /**
  * Class Status
  * @package Imunew\Pipeline
+ * @phpstan-consistent-constructor
  */
 class Status implements StatusInterface
 {

src/Pipe/Pipes.php

@@ -1,6 +1,8 @@
 <?php
 namespace Imunew\Pipeline\Pipe;
 
+use ReturnTypeWillChange;
+
 /**
  * Class Pipes
  * @package Imunew\Pipeline\Pipe
@@ -46,8 +48,9 @@ public function merge($pipes)
     }
 
     /**
-     * {@inheritdoc}
+     * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function current()
     {
         return current($this->pipes);
@@ -56,14 +59,16 @@ public function current()
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function next()
     {
-        return next($this->pipes);
+        next($this->pipes);
     }
 
     /**
-     * {@inheritdoc}
+     * @return int|string|null
      */
+    #[ReturnTypeWillChange]
     public function key()
     {
         return key($this->pipes);
@@ -72,6 +77,7 @@ public function key()
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function valid()
     {
         return $this->key() !== null;
@@ -80,8 +86,9 @@ public function valid()
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function rewind()
     {
-        return reset($this->pipes);
+        reset($this->pipes);
     }
 }

src/Pipe/PipesInterface.php

@@ -6,6 +6,7 @@
 /**
  * Interface PipesInterface
  * @package Imunew\Pipeline\Pipe
+ * @extends Iterator<int, callable>
  */
 interface PipesInterface extends Iterator
 {

tests/Context/ContextTest.php

@@ -4,6 +4,8 @@
 use Imunew\Pipeline\Context\Context;
 use Imunew\Pipeline\Context\ContextInterface;
 use Imunew\Pipeline\Context\Status;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -13,22 +15,26 @@
 class ContextTest extends TestCase
 {
     /**
-     * @test
-     * @dataProvider getTestStatus
-     *
      * @param ContextInterface $context
-     * @param $isInitialized
-     * @param $isStarted
-     * @param $isStopped
+     * @param bool $isInitialized
+     * @param bool $isStarted
+     * @param bool $isStopped
+     *
+     * @return void
      */
+    #[Test]
+    #[DataProvider('getTestStatus')]
     public function setStatus($context, $isInitialized, $isStarted, $isStopped)
     {
         $this->assertSame($isInitialized, $context->isInitialized());
         $this->assertSame($isStarted, $context->isStarted());
         $this->assertSame($isStopped, $context->isStopped());
     }
 
-    public function getTestStatus()
+    /**
+     * @return array<string, mixed>[]
+     */
+    public static function getTestStatus()
     {
         $context = new Context();
 

tests/Context/StatusTest.php

@@ -2,13 +2,15 @@
 namespace Imunew\Pipeline\Test\Context;
 
 use Imunew\Pipeline\Context\Status;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 class StatusTest extends TestCase
 {
     /**
-     * @test
+     * @return void
      */
+    #[Test]
     public function isInitialized()
     {
         $status = Status::initialize();
@@ -19,8 +21,9 @@ public function isInitialized()
     }
 
     /**
-     * @test
+     * @return void
      */
+    #[Test]
     public function isStarted()
     {
         $status = Status::start();
@@ -31,8 +34,9 @@ public function isStarted()
     }
 
     /**
-     * @test
+     * @return void
      */
+    #[Test]
     public function isStopped()
     {
         $status = Status::stop();

tests/Pipe/PipesTest.php

@@ -5,6 +5,7 @@
 use Imunew\Pipeline\Context\ContextInterface;
 use Imunew\Pipeline\Pipe\Pipes;
 use Imunew\Pipeline\Pipeline;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -14,8 +15,9 @@
 class PipesTest extends TestCase
 {
     /**
-     * @test
+     * @return void
      */
+    #[Test]
     public function mergeNumberPipes()
     {
         $pipesA = (new Pipes())