Bump PHP version to ^8.1 and refactor code (#269)

vjik · web-flow · commit 64cec48d7098 · 2024-09-27T22:06:22.000+03:00
diff --git a/.gitattributes b/.gitattributes
@@ -31,6 +31,7 @@
 /infection.json.dist    export-ignore
 /phpunit.xml.dist       export-ignore
 /psalm.xml              export-ignore
+/psalm83.xml            export-ignore
 /tests                  export-ignore
 /docs                   export-ignore
 
diff --git a/.github/workflows/bc.yml b/.github/workflows/bc.yml
@@ -30,4 +30,4 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.0']
+        ['8.3']
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -31,4 +31,4 @@ jobs:
       os: >-
         ['ubuntu-latest', 'windows-latest']
       php: >-
-        ['8.0', '8.1', '8.2', '8.3']
+        ['8.1', '8.2', '8.3']
diff --git a/.github/workflows/composer-require-checker.yml b/.github/workflows/composer-require-checker.yml
@@ -31,4 +31,4 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.0', '8.1', '8.2', '8.3']
+        ['8.1', '8.2', '8.3']
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -30,14 +30,6 @@ jobs:
         ['ubuntu-latest']
       php: >-
         ['8.1', '8.2']
-  psalm80:
-    uses: yiisoft/actions/.github/workflows/psalm.yml@master
-    with:
-      psalm-config: psalm80.xml
-      os: >-
-        ['ubuntu-latest']
-      php: >-
-        ['8.0']
   psalm83:
     uses: yiisoft/actions/.github/workflows/psalm.yml@master
     with:
diff --git a/.gitignore b/.gitignore
@@ -29,12 +29,10 @@ composer.phar
 # Mac DS_Store Files
 .DS_Store
 
-# phpunit itself is not needed
-phpunit.phar
-# local phpunit config
+# PhpUnit
+/phpunit.phar
 /phpunit.xml
-# phpunit cache
-.phpunit.result.cache
+/.phpunit.cache
 
 # ignore dev installed apps and extensions
 /apps
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ## 10.0.1 under development
 
-- no changes in this release.
+- Enh #269: Bump PHP version to `^8.1` and refactor code (@vjik)
 
 ## 10.0.0 June 28, 2024
 
diff --git a/composer.json b/composer.json
@@ -27,7 +27,7 @@
         }
     ],
     "require": {
-        "php": "^8.0",
+        "php": "^8.1",
         "psr/event-dispatcher": "1.0.0",
         "psr/event-dispatcher-implementation": "1.0.0",
         "yiisoft/arrays": "^2.0|^3.0",
@@ -38,15 +38,15 @@
     },
     "require-dev": {
         "maglnet/composer-require-checker": "^4.2",
-        "phpunit/phpunit": "^9.5",
+        "phpunit/phpunit": "^10.5",
         "rector/rector": "^1.2",
         "roave/infection-static-analysis-plugin": "^1.25",
         "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.30|^5.20",
+        "vimeo/psalm": "^5.26",
         "yiisoft/aliases": "^3.0",
         "yiisoft/di": "^1.2",
         "yiisoft/psr-dummy-provider": "^1.0",
-        "yiisoft/test-support": "^1.4|^3.0"
+        "yiisoft/test-support": "^3.0"
     },
     "extra": {
         "config-plugin-options": {
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,19 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
-    bootstrap="vendor/autoload.php"
-    colors="true"
-    verbose="true"
-    failOnRisky="true"
-    failOnWarning="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
-    stopOnFailure="false"
-    executionOrder="random"
-    resolveDependencies="true"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         requireCoverageMetadata="false"
+         beStrictAboutCoverageMetadata="true"
+         beStrictAboutOutputDuringTests="true"
+         executionOrder="random"
+         failOnRisky="true"
+         failOnWarning="true"
+         stopOnFailure="false"
+         colors="true"
+         displayDetailsOnPhpunitDeprecations="true"
 >
     <php>
-        <ini name="error_reporting" value="-1" />
+        <ini name="error_reporting" value="-1"/>
     </php>
 
     <testsuites>
@@ -22,9 +23,9 @@
         </testsuite>
     </testsuites>
 
-    <coverage>
+    <source>
         <include>
-            <directory>./src</directory>
+            <directory suffix=".php">./src</directory>
         </include>
-    </coverage>
+    </source>
 </phpunit>
diff --git a/psalm80.xml b/psalm80.xml
diff --git a/rector.php b/rector.php
@@ -5,6 +5,7 @@
 use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
 use Rector\Config\RectorConfig;
 use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
+use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
 use Rector\Set\ValueObject\LevelSetList;
 
 return static function (RectorConfig $rectorConfig): void {
@@ -18,10 +19,12 @@
 
     // define sets of rules
     $rectorConfig->sets([
-        LevelSetList::UP_TO_PHP_80,
+        LevelSetList::UP_TO_PHP_81,
     ]);
 
     $rectorConfig->skip([
+        __DIR__ . '/tests/public/view/parameters.php',
         RemoveExtraParametersRector::class => [__DIR__ . '/src/PhpTemplateRenderer.php'],
+        NullToStrictStringFuncCallArgRector::class,
     ]);
 };
diff --git a/src/Cache/CachedContent.php b/src/Cache/CachedContent.php
@@ -20,7 +20,7 @@
  */
 final class CachedContent
 {
-    private CacheKeyNormalizer $cacheKeyNormalizer;
+    private readonly CacheKeyNormalizer $cacheKeyNormalizer;
 
     /**
      * @var array<string, DynamicContent>
@@ -39,8 +39,8 @@ final class CachedContent
      * @param string[] $variations List of string factors that would cause the variation of the content being cached.
      */
     public function __construct(
-        private string $id,
-        private CacheInterface $cache,
+        private readonly string $id,
+        private readonly CacheInterface $cache,
         array $dynamicContents = [],
         array $variations = []
     ) {
diff --git a/src/Cache/DynamicContent.php b/src/Cache/DynamicContent.php
@@ -20,9 +20,9 @@ final class DynamicContent
      * @param array $parameters The parameters (name-value pairs) that will be passed in the $contentGenerator context.
      */
     public function __construct(
-        private string $id,
+        private readonly string $id,
         callable $contentGenerator,
-        private array $parameters = []
+        private readonly array $parameters = []
     ) {
         $this->contentGenerator = $contentGenerator;
     }
diff --git a/src/Event/View/AfterRender.php b/src/Event/View/AfterRender.php
@@ -17,10 +17,10 @@ final class AfterRender implements AfterRenderEventInterface
      * @param array $parameters The parameters array passed to the {@see View::render()} method.
      */
     public function __construct(
-        private View $view,
-        private string $file,
-        private array $parameters,
-        private string $result
+        private readonly View $view,
+        private readonly string $file,
+        private readonly array $parameters,
+        private readonly string $result
     ) {
     }
 
diff --git a/src/Event/View/BeforeRender.php b/src/Event/View/BeforeRender.php
@@ -19,9 +19,9 @@ final class BeforeRender implements StoppableEventInterface
      * @param array $parameters The parameters array passed to the {@see View::render()} method.
      */
     public function __construct(
-        private View $view,
-        private string $file,
-        private array $parameters
+        private readonly View $view,
+        private readonly string $file,
+        private readonly array $parameters
     ) {
     }
 
diff --git a/src/Event/View/ViewEvent.php b/src/Event/View/ViewEvent.php
@@ -12,7 +12,7 @@
 abstract class ViewEvent
 {
     final public function __construct(
-        private View $view
+        private readonly View $view
     ) {
     }
 
diff --git a/src/Event/WebView/AfterRender.php b/src/Event/WebView/AfterRender.php
@@ -17,10 +17,10 @@ final class AfterRender implements AfterRenderEventInterface
      * @param array $parameters The parameters array passed to the {@see WebView::render()} method.
      */
     public function __construct(
-        private WebView $view,
-        private string $file,
-        private array $parameters,
-        private string $result
+        private readonly WebView $view,
+        private readonly string $file,
+        private readonly array $parameters,
+        private readonly string $result
     ) {
     }
 
diff --git a/src/Event/WebView/BeforeRender.php b/src/Event/WebView/BeforeRender.php
@@ -19,9 +19,9 @@ final class BeforeRender implements StoppableEventInterface
      * @param array $parameters The parameters array passed to the {@see WebView::render()} method.
      */
     public function __construct(
-        private WebView $view,
-        private string $file,
-        private array $parameters
+        private readonly WebView $view,
+        private readonly string $file,
+        private readonly array $parameters
     ) {
     }
 
diff --git a/src/Event/WebView/WebViewEvent.php b/src/Event/WebView/WebViewEvent.php
@@ -12,7 +12,7 @@
 abstract class WebViewEvent
 {
     final public function __construct(
-        private WebView $view
+        private readonly WebView $view
     ) {
     }
 
diff --git a/src/Theme.php b/src/Theme.php
@@ -69,7 +69,7 @@ final class Theme
     /**
      * @var array<string, string|string[]>
      */
-    private array $pathMap;
+    private readonly array $pathMap;
     private string $basePath = '';
     private string $baseUrl = '';
 
@@ -209,7 +209,7 @@ private function validatePathMap(array $pathMap): void
         }
     }
 
-    private function throwInvalidPathMapException(): void
+    private function throwInvalidPathMapException(): never
     {
         throw new InvalidArgumentException(
             'The path map should contain the mapping between view directories and corresponding theme directories.'
diff --git a/src/ViewContext.php b/src/ViewContext.php
@@ -7,7 +7,7 @@
 final class ViewContext implements ViewContextInterface
 {
     public function __construct(
-        private string $viewPath
+        private readonly string $viewPath
     ) {
     }
 
diff --git a/tests/CachedContentTest.php b/tests/CachedContentTest.php
@@ -5,6 +5,7 @@
 namespace Yiisoft\View\Tests;
 
 use InvalidArgumentException;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 use Yiisoft\Cache\ArrayCache;
 use Yiisoft\Cache\Cache;
@@ -24,7 +25,7 @@ protected function setUp(): void
         $this->cache = new Cache(new ArrayCache());
     }
 
-    public function cacheParametersProvider(): array
+    public static function cacheParametersProvider(): array
     {
         return [
             'ttl-null-dependency-null' => [null, null],
@@ -33,9 +34,7 @@ public function cacheParametersProvider(): array
         ];
     }
 
-    /**
-     * @dataProvider cacheParametersProvider
-     */
+    #[DataProvider('cacheParametersProvider')]
     public function testCache(?int $ttl, ?Dependency $dependency): void
     {
         $cacheContent = new CachedContent('test', $this->cache);
diff --git a/tests/Event/View/PageBeginTest.php b/tests/Event/View/PageBeginTest.php
@@ -8,7 +8,7 @@
 use Yiisoft\View\Event\View\ViewEvent;
 use Yiisoft\View\View;
 
-final class PageBeginTest extends ViewEventTest
+final class PageBeginTest extends ViewEventTestCase
 {
     protected function createEvent(View $view): ViewEvent
     {
diff --git a/tests/Event/View/PageEndTest.php b/tests/Event/View/PageEndTest.php
@@ -8,7 +8,7 @@
 use Yiisoft\View\Event\View\ViewEvent;
 use Yiisoft\View\View;
 
-final class PageEndTest extends ViewEventTest
+final class PageEndTest extends ViewEventTestCase
 {
     protected function createEvent(View $view): ViewEvent
     {
diff --git a/tests/Event/View/ViewEventTestCase.php b/tests/Event/View/ViewEventTestCase.php
@@ -9,7 +9,7 @@
 use Yiisoft\View\Tests\TestSupport\TestHelper;
 use Yiisoft\View\View;
 
-abstract class ViewEventTest extends TestCase
+abstract class ViewEventTestCase extends TestCase
 {
     public function testBase(): void
     {
diff --git a/tests/Event/WebView/BodyBeginTest.php b/tests/Event/WebView/BodyBeginTest.php
@@ -8,7 +8,7 @@
 use Yiisoft\View\Event\WebView\WebViewEvent;
 use Yiisoft\View\WebView;
 
-final class BodyBeginTest extends WebViewEventTest
+final class BodyBeginTest extends WebViewEventTestCase
 {
     protected function createEvent(WebView $view): WebViewEvent
     {
diff --git a/tests/Event/WebView/BodyEndTest.php b/tests/Event/WebView/BodyEndTest.php
@@ -8,7 +8,7 @@
 use Yiisoft\View\Event\WebView\WebViewEvent;
 use Yiisoft\View\WebView;
 
-final class BodyEndTest extends WebViewEventTest
+final class BodyEndTest extends WebViewEventTestCase
 {
     protected function createEvent(WebView $view): WebViewEvent
     {
diff --git a/tests/Event/WebView/HeadTest.php b/tests/Event/WebView/HeadTest.php
@@ -8,7 +8,7 @@
 use Yiisoft\View\Event\WebView\WebViewEvent;
 use Yiisoft\View\WebView;
 
-final class HeadTest extends WebViewEventTest
+final class HeadTest extends WebViewEventTestCase
 {
     protected function createEvent(WebView $view): WebViewEvent
     {
diff --git a/tests/Event/WebView/PageBeginTest.php b/tests/Event/WebView/PageBeginTest.php
diff --git a/tests/Event/WebView/PageEndTest.php b/tests/Event/WebView/PageEndTest.php
diff --git a/tests/Event/WebView/WebViewEventTestCase.php b/tests/Event/WebView/WebViewEventTestCase.php
diff --git a/tests/ViewTest.php b/tests/ViewTest.php
diff --git a/tests/WebViewTest.php b/tests/WebViewTest.php

-Original file line number
+Diff line change
       os: >-
         ['ubuntu-latest']
       php: >-
 -        ['8.0']
 +        ['8.3']