PHP 8.1 + Minor refactoring (#106)

vjik · web-flow · commit 54ac328d667a · 2025-02-18T09:27:26.000+03:00
diff --git a/.github/workflows/bc.yml b/.github/workflows/bc.yml
@@ -1,6 +1,25 @@
 on:
-  - pull_request
-  - push
+  pull_request:
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'phpunit.xml.dist'
+      - 'psalm.xml'
+  push:
+    branches: ['master']
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - '.gitignore'
+      - '.gitattributes'
+      - 'infection.json.dist'
+      - 'phpunit.xml.dist'
+      - 'psalm.xml'
 
 name: backwards compatibility
 
@@ -11,4 +30,4 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.0']
+        ['8.1']
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -30,4 +30,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
@@ -32,4 +32,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/rector.yml b/.github/workflows/rector.yml
@@ -1,5 +1,5 @@
 on:
-  pull_request:
+  pull_request_target:
     paths-ignore:
       - 'docs/**'
       - 'README.md'
@@ -17,6 +17,7 @@ jobs:
     secrets:
       token: ${{ secrets.YIISOFT_GITHUB_TOKEN }}
     with:
+      repository: ${{ github.event.pull_request.head.repo.full_name }}
       os: >-
         ['ubuntu-latest']
       php: >-
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -31,11 +31,3 @@ jobs:
         ['ubuntu-latest']
       php: >-
         ['8.1', '8.2', '8.3']
-  psalm80:
-    uses: yiisoft/actions/.github/workflows/psalm.yml@master
-    with:
-      psalm-config: psalm80.xml
-      os: >-
-        ['ubuntu-latest']
-      php: >-
-        ['8.0']
diff --git a/.gitignore b/.gitignore
@@ -22,9 +22,7 @@ Thumbs.db
 # composer itself is not needed
 composer.phar
 
-# phpunit itself is not needed
-phpunit.phar
-# local phpunit config
+# PHPUnit
+/phpunit.phar
 /phpunit.xml
-# phpunit cache
-.phpunit.result.cache
+/.phpunit.cache
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,9 @@
 
 ## 3.3.2 under development
 
-- no changes in this release.
+- Chg #106: Bump minimal required PHP version to 8.1 (@vjik)
+- Enh #106: Minor performance optimization: use FQN for PHP functions, remove unnecessary conditions (@vjik)
+- Enh #106: Mark readonly properties (@vjik)
 
 ## 3.3.1 December 16, 2024
 
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ The following are provided:
 
 ## Requirements
 
-- PHP 8.0 or higher.
+- PHP 8.1 or higher.
 
 ## Installation
 
diff --git a/composer.json b/composer.json
@@ -26,16 +26,16 @@
         }
     ],
     "require": {
-        "php": "^8.0",
-        "psr/container": "^1.0|^2.0"
+        "php": "^8.1",
+        "psr/container": "^1.0 || ^2.0"
     },
     "require-dev": {
-        "maglnet/composer-require-checker": "^4.2",
-        "phpunit/phpunit": "^9.5",
-        "rector/rector": "^1.0.0",
-        "roave/infection-static-analysis-plugin": "^1.18",
-        "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.30|^5.21",
+        "maglnet/composer-require-checker": "^4.7.1",
+        "phpunit/phpunit": "^10.5.45",
+        "rector/rector": "^2.0.9",
+        "roave/infection-static-analysis-plugin": "^1.35",
+        "spatie/phpunit-watcher": "^1.24",
+        "vimeo/psalm": "^5.26.1 || ^6.7.1",
         "yiisoft/test-support": "^1.4"
     },
     "autoload": {
@@ -50,6 +50,7 @@
     },
     "config": {
         "sort-packages": true,
+        "bump-after-update": "dev",
         "allow-plugins": {
             "infection/extension-installer": true,
             "composer/package-versions-deprecated": true
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,31 +1,32 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<phpunit bootstrap="vendor/autoload.php"
-         colors="true"
-         verbose="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"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
          stopOnFailure="false"
-         executionOrder="random"
-         resolveDependencies="true">
+         colors="true"
+         displayDetailsOnPhpunitDeprecations="true"
+>
     <php>
         <ini name="error_reporting" value="-1"/>
     </php>
 
     <testsuites>
         <testsuite name="Yii Definitions tests">
             <directory>./tests/Unit</directory>
-            <directory phpVersion="8.1" phpVersionOperator=">=">./tests/Php8_1</directory>
             <directory phpVersion="8.2" phpVersionOperator=">=">./tests/Php8_2</directory>
         </testsuite>
     </testsuites>
 
-    <coverage>
+    <source>
         <include>
-            <directory>./src</directory>
+            <directory suffix=".php">./src</directory>
         </include>
-    </coverage>
+    </source>
 </phpunit>
diff --git a/psalm.xml b/psalm.xml
@@ -16,11 +16,6 @@
     <issueHandlers>
         <MixedAssignment errorLevel="suppress" />
         <RiskyTruthyFalsyComparison errorLevel="suppress" />
-        <InvalidThrow>
-            <errorLevel type="suppress">
-                <referencedClass name="Psr\Container\ContainerExceptionInterface" />
-                <referencedClass name="Psr\Container\NotFoundExceptionInterface" />
-            </errorLevel>
-        </InvalidThrow>
+        <MissingOverrideAttribute errorLevel="suppress" />
     </issueHandlers>
 </psalm>
diff --git a/psalm80.xml b/psalm80.xml
diff --git a/rector.php b/rector.php
@@ -4,19 +4,25 @@
 
 use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
 use Rector\Config\RectorConfig;
-use Rector\Set\ValueObject\LevelSetList;
+use Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector;
+use Rector\Php81\Rector\Property\ReadOnlyPropertyRector;
+use Rector\Php81\Rector\FuncCall\NullToStrictStringFuncCallArgRector;
+use Rector\PHPUnit\AnnotationsToAttributes\Rector\ClassMethod\DataProviderAnnotationToAttributeRector;
+use Rector\PHPUnit\PHPUnit100\Rector\Class_\StaticDataProviderClassMethodRector;
 
-return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->paths([
+return RectorConfig::configure()
+    ->withPaths([
         __DIR__ . '/src',
         __DIR__ . '/tests',
+    ])
+    ->withPhpSets(php81: true)
+    ->withRules([
+        InlineConstructorDefaultToPropertyRector::class,
+        DataProviderAnnotationToAttributeRector::class,
+        StaticDataProviderClassMethodRector::class,
+    ])
+    ->withSkip([
+        ClosureToArrowFunctionRector::class,
+        ReadOnlyPropertyRector::class,
+        NullToStrictStringFuncCallArgRector::class,
     ]);
-
-    // register a single rule
-    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
-
-    // define sets of rules
-    $rectorConfig->sets([
-        LevelSetList::UP_TO_PHP_80,
-    ]);
-};
diff --git a/src/ArrayDefinition.php b/src/ArrayDefinition.php
@@ -17,7 +17,10 @@
 use function array_key_exists;
 use function call_user_func_array;
 use function count;
+use function gettype;
+use function is_array;
 use function is_string;
+use function sprintf;
 
 /**
  * Builds an object by array config.
diff --git a/src/DefinitionStorage.php b/src/DefinitionStorage.php
@@ -12,6 +12,8 @@
 use Yiisoft\Definitions\Exception\CircularReferenceException;
 use Yiisoft\Definitions\Helpers\DefinitionExtractor;
 
+use function sprintf;
+
 /**
  * Stores service definitions and checks if a definition could be instantiated.
  */
@@ -30,7 +32,7 @@ final class DefinitionStorage
      */
     public function __construct(
         private array $definitions = [],
-        private bool $useStrictMode = false
+        private readonly bool $useStrictMode = false
     ) {
     }
 
@@ -157,7 +159,7 @@ private function isResolvable(string $id, array $building): bool
                     $unionTypes = [];
                     foreach ($type->getTypes() as $unionType) {
                         /**
-                         * @psalm-suppress DocblockTypeContradiction Need for PHP 8.0 and 8.1 only
+                         * @psalm-suppress DocblockTypeContradiction Need for PHP 8.1 only
                          */
                         if (!$unionType instanceof ReflectionNamedType || $unionType->isBuiltin()) {
                             continue;
diff --git a/src/Helpers/ArrayDefinitionHelper.php b/src/Helpers/ArrayDefinitionHelper.php
@@ -9,6 +9,7 @@
 use Yiisoft\Definitions\Exception\InvalidConfigException;
 
 use function is_array;
+use function is_string;
 
 final class ArrayDefinitionHelper
 {
diff --git a/src/Helpers/DefinitionValidator.php b/src/Helpers/DefinitionValidator.php
@@ -11,10 +11,12 @@
 use Yiisoft\Definitions\Contract\ReferenceInterface;
 use Yiisoft\Definitions\Exception\InvalidConfigException;
 
+use function in_array;
 use function is_array;
 use function is_callable;
 use function is_object;
 use function is_string;
+use function sprintf;
 
 /**
  * Definition validator checks if definition is valid.
@@ -43,7 +45,7 @@ public static function validate(mixed $definition, ?string $id = null): void
         }
 
         // Callable definition
-        if ($definition !== '' && is_callable($definition, true)) {
+        if (is_callable($definition, true)) {
             return;
         }
 
diff --git a/src/Helpers/ExceptionHelper.php b/src/Helpers/ExceptionHelper.php
@@ -6,6 +6,8 @@
 
 use Yiisoft\Definitions\Exception\InvalidConfigException;
 
+use function sprintf;
+
 /**
  * @internal
  */
diff --git a/src/ParameterDefinition.php b/src/ParameterDefinition.php
@@ -14,13 +14,15 @@
 use Yiisoft\Definitions\Exception\NotInstantiableException;
 use Yiisoft\Definitions\Exception\InvalidConfigException;
 
+use function sprintf;
+
 /**
  * Parameter definition resolves an object based on information from `ReflectionParameter` instance.
  */
 final class ParameterDefinition implements DefinitionInterface
 {
     public function __construct(
-        private ReflectionParameter $parameter
+        private readonly ReflectionParameter $parameter
     ) {
     }
 
@@ -52,8 +54,7 @@ public function resolve(ContainerInterface $container): mixed
             return $this->resolveUnionType($type, $container);
         }
 
-        if ($type === null
-            || !$type instanceof ReflectionNamedType
+        if (!$type instanceof ReflectionNamedType
             || $this->isVariadic()
             || $type->isBuiltin()
         ) {
@@ -144,7 +145,7 @@ private function resolveUnionType(ReflectionUnionType $parameterType, ContainerI
 
         foreach ($types as $type) {
             /**
-             * @psalm-suppress DocblockTypeContradiction Need for PHP 8.0 and 8.1 only
+             * @psalm-suppress DocblockTypeContradiction Need for PHP 8.1 only
              */
             if (!$type instanceof ReflectionNamedType || $type->isBuiltin()) {
                 continue;
diff --git a/src/Reference.php b/src/Reference.php
@@ -33,8 +33,10 @@ final class Reference implements ReferenceInterface
     /**
      * @throws InvalidConfigException
      */
-    private function __construct(mixed $id, private bool $optional)
-    {
+    private function __construct(
+        mixed $id,
+        private readonly bool $optional,
+    ) {
         if (!is_string($id)) {
             throw new InvalidConfigException('Reference ID must be string.');
         }
diff --git a/src/ValueDefinition.php b/src/ValueDefinition.php
@@ -17,8 +17,8 @@ final class ValueDefinition implements DefinitionInterface
      * @param string|null $type Value type.
      */
     public function __construct(
-        private mixed $value,
-        private ?string $type = null
+        private readonly mixed $value,
+        private readonly ?string $type = null
     ) {
     }
 
diff --git a/tests/Php8_1/Helpers/DefinitionExtractorTest.php b/tests/Php8_1/Helpers/DefinitionExtractorTest.php
diff --git a/tests/Php8_1/ParameterDefinitionTest.php b/tests/Php8_1/ParameterDefinitionTest.php
diff --git a/tests/Unit/ArrayDefinitionTest.php b/tests/Unit/ArrayDefinitionTest.php
diff --git a/tests/Unit/DefinitionStorageTest.php b/tests/Unit/DefinitionStorageTest.php
diff --git a/tests/Unit/DynamicReferenceTest.php b/tests/Unit/DynamicReferenceTest.php
diff --git a/tests/Unit/Helpers/ArrayDefinitionHelperTest.php b/tests/Unit/Helpers/ArrayDefinitionHelperTest.php
diff --git a/tests/Unit/Helpers/DefinitionExtractorTest.php b/tests/Unit/Helpers/DefinitionExtractorTest.php
diff --git a/tests/Unit/Helpers/DefinitionValidatorTest.php b/tests/Unit/Helpers/DefinitionValidatorTest.php
diff --git a/tests/Unit/ParameterDefinitionTest.php b/tests/Unit/ParameterDefinitionTest.php
