Raise minimum PHP version to 8.0, add rector (#59)

xepozz · vjik · web-flow · commit 954cbed17b90 · 2022-11-01T09:30:37.000+03:00
Co-authored-by: Sergei Predvoditelev &lt;sergei@predvoditelev.ru&gt;
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -28,4 +28,4 @@ jobs:
       os: >-
         ['ubuntu-latest', 'windows-latest']
       php: >-
-        ['7.4', '8.0', '8.1']
+        ['8.0', '8.1']
diff --git a/.github/workflows/rector.yml b/.github/workflows/rector.yml
@@ -0,0 +1,21 @@
+on:
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'psalm.xml'
+
+name: rector
+
+jobs:
+  rector:
+    uses: yiisoft/actions/.github/workflows/rector.yml@master
+    with:
+      os: >-
+        ['ubuntu-latest']
+      php: >-
+        ['8.0']
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -28,4 +28,4 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['7.4', '8.0', '8.1']
+        ['8.0', '8.1']
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## 3.0.1 under development
 
-- no changes in this release.
+- Enh #59: Raise minimum PHP version to 8.0 (@xepozz, @vjik)
 
 ## 3.0.0 September 07, 2022
 
diff --git a/README.md b/README.md
@@ -20,14 +20,14 @@ request instance, dispatcher executes it produces a response instance.
 
 ## Requirements
 
-- PHP 7.4 or higher.
+- PHP 8.0 or higher.
 
 ## Installation
 
 The package could be installed with composer:
 
 ```shell
-composer require yiisoft/middleware-dispatcher --prefer-dist
+composer require yiisoft/middleware-dispatcher
 ```
 
 ## General usage
diff --git a/composer.json b/composer.json
@@ -17,7 +17,7 @@
         "source": "https://github.com/yiisoft/middleware-dispatcher"
     },
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "^8.0",
         "psr/container": "^1.0|^2.0",
         "psr/event-dispatcher": "^1.0",
         "psr/http-message": "^1.0",
@@ -30,6 +30,7 @@
     "require-dev": {
         "nyholm/psr7": "^1.4",
         "phpunit/phpunit": "^9.5",
+        "rector/rector": "^0.14.3",
         "roave/infection-static-analysis-plugin": "^1.16",
         "spatie/phpunit-watcher": "^1.23",
         "vimeo/psalm": "^4.18",
diff --git a/rector.php b/rector.php
@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
+use Rector\Config\RectorConfig;
+use Rector\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromotionRector;
+use Rector\Set\ValueObject\LevelSetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);
+
+    // register a single rule
+    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
+
+    // define sets of rules
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_80,
+    ]);
+
+    $rectorConfig->skip([
+        ClassPropertyAssignToConstructorPromotionRector::class,
+    ]);
+};
diff --git a/src/Event/AfterMiddleware.php b/src/Event/AfterMiddleware.php
@@ -12,17 +12,14 @@
  */
 final class AfterMiddleware
 {
-    private MiddlewareInterface $middleware;
-    private ?ResponseInterface $response;
-
     /**
      * @param MiddlewareInterface $middleware Middleware that was executed.
      * @param ResponseInterface|null $response Response generated by middleware or null in case there was an error.
      */
-    public function __construct(MiddlewareInterface $middleware, ?ResponseInterface $response)
-    {
-        $this->middleware = $middleware;
-        $this->response = $response;
+    public function __construct(
+        private MiddlewareInterface $middleware,
+        private ?ResponseInterface $response
+    ) {
     }
 
     /**
diff --git a/src/Event/BeforeMiddleware.php b/src/Event/BeforeMiddleware.php
@@ -12,17 +12,14 @@
  */
 final class BeforeMiddleware
 {
-    private MiddlewareInterface $middleware;
-    private ServerRequestInterface $request;
-
     /**
      * @param MiddlewareInterface $middleware Middleware to be executed.
      * @param ServerRequestInterface $request Request to be passed to the middleware.
      */
-    public function __construct(MiddlewareInterface $middleware, ServerRequestInterface $request)
-    {
-        $this->middleware = $middleware;
-        $this->request = $request;
+    public function __construct(
+        private MiddlewareInterface $middleware,
+        private ServerRequestInterface $request
+    ) {
     }
 
     /**
diff --git a/src/InvalidMiddlewareDefinitionException.php b/src/InvalidMiddlewareDefinitionException.php
@@ -12,7 +12,6 @@
 
 use function array_slice;
 use function count;
-use function get_class;
 use function gettype;
 use function is_array;
 use function is_bool;
@@ -23,19 +22,12 @@
 
 final class InvalidMiddlewareDefinitionException extends InvalidArgumentException implements FriendlyExceptionInterface
 {
-    /**
-     * @var mixed
-     */
-    private $definition;
     private string $definitionString;
 
-    /**
-     * @param mixed $middlewareDefinition
-     */
-    public function __construct($middlewareDefinition)
-    {
-        $this->definition = $middlewareDefinition;
-        $this->definitionString = $this->convertDefinitionToString($middlewareDefinition);
+    public function __construct(
+        private mixed $definition
+    ) {
+        $this->definitionString = $this->convertDefinitionToString($definition);
 
         parent::__construct(
             'Parameter should be either PSR middleware class name or a callable. Got ' . $this->definitionString . '.'
@@ -199,13 +191,10 @@ private function isControllerWithNonExistAction(): bool
             && class_exists($this->definition[0]);
     }
 
-    /**
-     * @param mixed $middlewareDefinition
-     */
-    private function convertDefinitionToString($middlewareDefinition): string
+    private function convertDefinitionToString(mixed $middlewareDefinition): string
     {
         if (is_object($middlewareDefinition)) {
-            return 'an instance of "' . get_class($middlewareDefinition) . '"';
+            return 'an instance of "' . $middlewareDefinition::class . '"';
         }
 
         if (is_string($middlewareDefinition)) {
@@ -224,10 +213,7 @@ private function convertDefinitionToString($middlewareDefinition): string
         return $this->convertToString($middlewareDefinition);
     }
 
-    /**
-     * @param mixed $value
-     */
-    private function convertToString($value): string
+    private function convertToString(mixed $value): string
     {
         if (is_string($value)) {
             return '"' . $value . '"';
@@ -246,7 +232,7 @@ private function convertToString($value): string
         }
 
         if (is_object($value)) {
-            return get_class($value);
+            return $value::class;
         }
 
         return gettype($value);
diff --git a/src/MiddlewareDispatcher.php b/src/MiddlewareDispatcher.php
@@ -19,18 +19,16 @@ final class MiddlewareDispatcher
      * @var MiddlewareStack|null The middleware stack.
      */
     private ?MiddlewareStack $stack = null;
-    private MiddlewareFactory $middlewareFactory;
-    private ?EventDispatcherInterface $eventDispatcher;
 
     /**
      * @var array[]|callable[]|string[]
      */
     private array $middlewareDefinitions = [];
 
-    public function __construct(MiddlewareFactory $middlewareFactory, ?EventDispatcherInterface $eventDispatcher = null)
-    {
-        $this->middlewareFactory = $middlewareFactory;
-        $this->eventDispatcher = $eventDispatcher;
+    public function __construct(
+        private MiddlewareFactory $middlewareFactory,
+        private ?EventDispatcherInterface $eventDispatcher = null
+    ) {
     }
 
     /**
@@ -68,8 +66,6 @@ public function dispatch(
      * typed parameters are automatically injected using dependency injection container.
      * Current request and handler could be obtained by type-hinting for {@see ServerRequestInterface}
      * and {@see RequestHandlerInterface}.
-     *
-     * @return self
      */
     public function withMiddlewares(array $middlewareDefinitions): self
     {
diff --git a/src/MiddlewareFactory.php b/src/MiddlewareFactory.php
@@ -25,16 +25,13 @@
  */
 final class MiddlewareFactory
 {
-    private ContainerInterface $container;
-    private WrapperFactoryInterface $wrapperFactory;
-
     /**
      * @param ContainerInterface $container Container to use for resolving definitions.
      */
-    public function __construct(ContainerInterface $container, WrapperFactoryInterface $wrapperFactory)
-    {
-        $this->container = $container;
-        $this->wrapperFactory = $wrapperFactory;
+    public function __construct(
+        private ContainerInterface $container,
+        private WrapperFactoryInterface $wrapperFactory
+    ) {
     }
 
     /**
@@ -55,7 +52,7 @@ public function __construct(ContainerInterface $container, WrapperFactoryInterfa
      *
      * @throws InvalidMiddlewareDefinitionException
      */
-    public function create($middlewareDefinition): MiddlewareInterface
+    public function create(array|callable|string $middlewareDefinition): MiddlewareInterface
     {
         if ($this->isMiddlewareClassDefinition($middlewareDefinition)) {
             /** @var MiddlewareInterface */
@@ -80,22 +77,18 @@ public function create($middlewareDefinition): MiddlewareInterface
     }
 
     /**
-     * @param mixed $definition
-     *
      * @psalm-assert-if-true class-string<MiddlewareInterface> $definition
      */
-    private function isMiddlewareClassDefinition($definition): bool
+    private function isMiddlewareClassDefinition(mixed $definition): bool
     {
         return is_string($definition)
             && is_subclass_of($definition, MiddlewareInterface::class);
     }
 
     /**
-     * @param mixed $definition
-     *
      * @psalm-assert-if-true array|Closure $definition
      */
-    private function isCallableDefinition($definition): bool
+    private function isCallableDefinition(mixed $definition): bool
     {
         if ($definition instanceof Closure) {
             return true;
@@ -113,19 +106,17 @@ class_exists($definition[0]) ? get_class_methods($definition[0]) : [],
     }
 
     /**
-     * @param mixed $definition
-     *
      * @psalm-assert-if-true ArrayDefinitionConfig $definition
      */
-    private function isArrayDefinition($definition): bool
+    private function isArrayDefinition(mixed $definition): bool
     {
         if (!is_array($definition)) {
             return false;
         }
 
         try {
             DefinitionValidator::validateArrayDefinition($definition);
-        } catch (InvalidConfigException $e) {
+        } catch (InvalidConfigException) {
             return false;
         }
 
diff --git a/src/MiddlewareStack.php b/src/MiddlewareStack.php
diff --git a/src/WrapperFactory.php b/src/WrapperFactory.php
diff --git a/src/WrapperFactoryInterface.php b/src/WrapperFactoryInterface.php
diff --git a/tests/InvalidMiddlewareDefinitionExceptionTest.php b/tests/InvalidMiddlewareDefinitionExceptionTest.php
diff --git a/tests/MiddlewareDispatcherTest.php b/tests/MiddlewareDispatcherTest.php
diff --git a/tests/MiddlewareFactoryTest.php b/tests/MiddlewareFactoryTest.php
