PHP 8.4 support (#105)

vjik · Tigrov · web-flow · commit db848c69a1ff · 2025-02-20T14:17:37.000+03:00
Co-authored-by: Sergei Tigrov &lt;rrr-r@ya.ru&gt;
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -30,4 +30,4 @@ jobs:
       os: >-
         ['ubuntu-latest', 'windows-latest']
       php: >-
-        ['8.1', '8.2', '8.3']
+        ['8.1', '8.2', '8.3', '8.4']
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.1', '8.2', '8.3']
+        ['8.1', '8.2', '8.3', '8.4']
diff --git a/.github/workflows/mutation.yml b/.github/workflows/mutation.yml
@@ -29,6 +29,6 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.3']
+        ['8.4']
     secrets:
       STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -30,4 +30,4 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.1', '8.2', '8.3']
+        ['8.1', '8.2', '8.3', '8.4']
diff --git a/.github/workflows/yiisoft-di.yml b/.github/workflows/yiisoft-di.yml
@@ -37,6 +37,7 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
+          - "8.4"
 
     steps:
       - name: Checkout Yii Definitions
diff --git a/.github/workflows/yiisoft-factory.yml b/.github/workflows/yiisoft-factory.yml
@@ -37,6 +37,7 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
+          - "8.4"
 
     steps:
       - name: Checkout Yii Definitions
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -6,10 +6,12 @@
 use PhpCsFixer\Finder;
 use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
 
-$finder = (new Finder())->in([
-    __DIR__ . '/src',
-    __DIR__ . '/tests',
-]);
+$finder = (new Finder())
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->exclude('Php8_4/');
 
 return (new Config())
     ->setParallelConfig(ParallelConfigFactory::detect())
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,12 @@
 
 ## 3.3.2 under development
 
+- Chg #105: Change PHP constraint in `composer.json` to `~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0` (@vjik)
 - 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)
+- Bug #105: Explicitly mark nullable parameters (@vjik)
+- Enh #105: Improve definition validation for readonly properties and properties with asymmetric visibility (@vjik)
 
 ## 3.3.1 December 16, 2024
 
diff --git a/composer.json b/composer.json
@@ -26,7 +26,7 @@
         }
     ],
     "require": {
-        "php": "^8.1",
+        "php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0",
         "psr/container": "^1.0 || ^2.0"
     },
     "require-dev": {
@@ -37,7 +37,7 @@
         "roave/infection-static-analysis-plugin": "^1.35",
         "spatie/phpunit-watcher": "^1.24",
         "vimeo/psalm": "^5.26.1 || ^6.7.1",
-        "yiisoft/test-support": "^3.0"
+        "yiisoft/test-support": "^3.0.1"
     },
     "autoload": {
         "psr-4": {
@@ -58,7 +58,7 @@
         }
     },
     "scripts": {
-        "php-cs-fixer": "php-cs-fixer fix",
+        "php-cs-fixer": "PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix",
         "rector": "rector",
         "test": "phpunit --testdox --no-interaction",
         "test-watch": "phpunit-watcher watch"
diff --git a/infection.json.dist b/infection.json.dist
@@ -11,6 +11,11 @@
         }
     },
     "mutators": {
-        "@default": true
+        "@default": true,
+        "LessThan": {
+            "ignoreSourceCodeByRegex": [
+                ".*\\(PHP_VERSION_ID .*"
+            ]
+        }
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -21,6 +21,7 @@
         <testsuite name="Yii Definitions tests">
             <directory>./tests/Unit</directory>
             <directory phpVersion="8.2" phpVersionOperator=">=">./tests/Php8_2</directory>
+            <directory phpVersion="8.4" phpVersionOperator=">=">./tests/Php8_4</directory>
         </testsuite>
     </testsuites>
 
diff --git a/src/Exception/NotInstantiableClassException.php b/src/Exception/NotInstantiableClassException.php
@@ -11,7 +11,7 @@
  */
 final class NotInstantiableClassException extends NotInstantiableException
 {
-    public function __construct(string $class, string $message = null, int $code = 0, Exception $previous = null)
+    public function __construct(string $class, ?string $message = null, int $code = 0, ?Exception $previous = null)
     {
         if ($message === null) {
             $message = "Can not instantiate $class.";
diff --git a/src/Helpers/DefinitionValidator.php b/src/Helpers/DefinitionValidator.php
@@ -6,11 +6,13 @@
 
 use ReflectionClass;
 use ReflectionException;
+use ReflectionProperty;
 use Yiisoft\Definitions\ArrayDefinition;
 use Yiisoft\Definitions\Contract\DefinitionInterface;
 use Yiisoft\Definitions\Contract\ReferenceInterface;
 use Yiisoft\Definitions\Exception\InvalidConfigException;
 
+use function count;
 use function in_array;
 use function is_array;
 use function is_callable;
@@ -85,7 +87,7 @@ public static function validateArrayDefinition(array $definition, ?string $id =
         }
         $classPublicProperties = [];
         foreach ($classReflection->getProperties() as $reflectionProperty) {
-            if ($reflectionProperty->isPublic()) {
+            if (self::isPublicWritableProperty($reflectionProperty)) {
                 $classPublicProperties[] = $reflectionProperty->getName();
             }
         }
@@ -261,7 +263,7 @@ private static function validateProperty(
         } elseif (!in_array($parsedKey, $classPublicProperties, true)) {
             throw new InvalidConfigException(
                 sprintf(
-                    'Invalid definition: property "%s" must be public.',
+                    'Invalid definition: property "%s" must be public and writable.',
                     $className . '::' . $key,
                 ),
             );
@@ -327,4 +329,26 @@ private static function validateString(mixed $class): void
             throw new InvalidConfigException('Invalid definition: class name must be a non-empty string.');
         }
     }
+
+    private static function isPublicWritableProperty(ReflectionProperty $property): bool
+    {
+        if (!$property->isPublic()) {
+            return false;
+        }
+
+        if ($property->isReadOnly()) {
+            return false;
+        }
+
+        if (PHP_VERSION_ID < 80400) {
+            return true;
+        }
+
+        $modifiers = $property->getModifiers();
+
+        /**
+         * @psalm-suppress UndefinedConstant, MixedOperand Needs for PHP 8.3 or lower
+         */
+        return ($modifiers & (ReflectionProperty::IS_PRIVATE_SET | ReflectionProperty::IS_PROTECTED_SET)) === 0;
+    }
 }
diff --git a/src/ParameterDefinition.php b/src/ParameterDefinition.php
@@ -216,10 +216,7 @@ private function getCallable(): string
         if ($class !== null) {
             $callable[] = $class->getName();
         }
-        $callable[] = $this->parameter
-                ->getDeclaringFunction()
-                ->getName() .
-            '()';
+        $callable[] = $this->parameter->getDeclaringFunction()->getName() . '()';
 
         return implode('::', $callable);
     }
diff --git a/tests/Php8_2/ParameterDefinitionTest.php b/tests/Php8_2/ParameterDefinitionTest.php
@@ -22,7 +22,7 @@ public function testResolveUnionTypeWithIntersectionType(): void
         ]);
 
         $definition = new ParameterDefinition(
-            $this->getFirstParameter(fn (Bike|(GearBox&stdClass)|Chair $class) => true)
+            $this->getFirstParameter(fn(Bike|(GearBox&stdClass)|Chair $class) => true),
         );
 
         $result = $definition->resolve($container);
diff --git a/tests/Php8_4/AsymmetricVisibility/DefinitionValidatorTest.php b/tests/Php8_4/AsymmetricVisibility/DefinitionValidatorTest.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Definitions\Tests\Php8_4\AsymmetricVisibility;
+
+use PHPUnit\Framework\TestCase;
+use Yiisoft\Definitions\Exception\InvalidConfigException;
+use Yiisoft\Definitions\Helpers\DefinitionValidator;
+
+final class DefinitionValidatorTest extends TestCase
+{
+    public function testPrivateSet(): void
+    {
+        $definition = [
+            'class' => PublicGet::class,
+            '$privateVar' => 'test',
+        ];
+
+        $this->expectException(InvalidConfigException::class);
+        $this->expectExceptionMessage(
+            'Invalid definition: property "Yiisoft\Definitions\Tests\Php8_4\AsymmetricVisibility\PublicGet::$privateVar" must be public and writable.',
+        );
+        DefinitionValidator::validate($definition);
+    }
+
+    public function testProtectedSet(): void
+    {
+        $definition = [
+            'class' => PublicGet::class,
+            '$protectedVar' => 'test',
+        ];
+
+        $this->expectException(InvalidConfigException::class);
+        $this->expectExceptionMessage(
+            'Invalid definition: property "Yiisoft\Definitions\Tests\Php8_4\AsymmetricVisibility\PublicGet::$protectedVar" must be public and writable.',
+        );
+        DefinitionValidator::validate($definition);
+    }
+}
diff --git a/tests/Php8_4/AsymmetricVisibility/PublicGet.php b/tests/Php8_4/AsymmetricVisibility/PublicGet.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Definitions\Tests\Php8_4\AsymmetricVisibility;
+
+final class PublicGet
+{
+    public private(set) string $privateVar = '';
+    public protected(set) string $protectedVar = '';
+}
diff --git a/tests/Support/OptionalConcreteDependency.php b/tests/Support/OptionalConcreteDependency.php
diff --git a/tests/Support/OptionalInterfaceDependency.php b/tests/Support/OptionalInterfaceDependency.php
diff --git a/tests/Support/ReadonlyProperty.php b/tests/Support/ReadonlyProperty.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Definitions\Tests\Support;
+
+final class ReadonlyProperty
+{
+    public readonly string $var;
+}
diff --git a/tests/Support/UnionTypeWithIntersectionTypeDependency.php b/tests/Support/UnionTypeWithIntersectionTypeDependency.php
@@ -7,7 +7,6 @@
 final class UnionTypeWithIntersectionTypeDependency
 {
     public function __construct(
-        public Bike|(GearBox&stdClass)|Chair $dependency
-    ) {
-    }
+        public Bike|(GearBox&stdClass)|Chair $dependency,
+    ) {}
 }
diff --git a/tests/Unit/Helpers/DefinitionExtractorTest.php b/tests/Unit/Helpers/DefinitionExtractorTest.php
@@ -20,8 +20,6 @@
 use Yiisoft\Definitions\Tests\Support\GearBox;
 use Yiisoft\Definitions\Tests\Support\NullableConcreteDependency;
 use Yiisoft\Definitions\Tests\Support\NullableInterfaceDependency;
-use Yiisoft\Definitions\Tests\Support\OptionalConcreteDependency;
-use Yiisoft\Definitions\Tests\Support\OptionalInterfaceDependency;
 use Yiisoft\Definitions\Tests\Support\NullableOptionalConcreteDependency;
 use Yiisoft\Definitions\Tests\Support\NullableOptionalInterfaceDependency;
 use Yiisoft\Definitions\Tests\Support\RedChair;
@@ -102,15 +100,6 @@ public function testResolveGearBoxConstructor(): void
         $this->assertEquals(5, $dependencies['maxGear']->resolve($container));
     }
 
-    public function testOptionalInterfaceDependency(): void
-    {
-        $container = new SimpleContainer();
-        /** @var DefinitionInterface[] $dependencies */
-        $dependencies = DefinitionExtractor::fromClassName(OptionalInterfaceDependency::class);
-        $this->assertCount(1, $dependencies);
-        $this->assertEquals(null, $dependencies['engine']->resolve($container));
-    }
-
     public function testNullableInterfaceDependency(): void
     {
         $container = new SimpleContainer();
@@ -121,15 +110,6 @@ public function testNullableInterfaceDependency(): void
         $dependencies['engine']->resolve($container);
     }
 
-    public function testOptionalConcreteDependency(): void
-    {
-        $container = new SimpleContainer();
-        /** @var DefinitionInterface[] $dependencies */
-        $dependencies = DefinitionExtractor::fromClassName(OptionalConcreteDependency::class);
-        $this->assertCount(1, $dependencies);
-        $this->assertEquals(null, $dependencies['car']->resolve($container));
-    }
-
     public function testNullableConcreteDependency(): void
     {
         $container = new SimpleContainer();
@@ -152,7 +132,6 @@ public function testNullableOptionalConcreteDependency(): void
     public function testNullableOptionalInterfaceDependency(): void
     {
         $container = new SimpleContainer();
-        /** @var DefinitionInterface[] $dependencies */
         $dependencies = DefinitionExtractor::fromClassName(NullableOptionalInterfaceDependency::class);
         $this->assertCount(1, $dependencies);
         $this->assertEquals(null, $dependencies['engine']->resolve($container));
diff --git a/tests/Unit/Helpers/DefinitionValidatorTest.php b/tests/Unit/Helpers/DefinitionValidatorTest.php
@@ -17,6 +17,7 @@
 use Yiisoft\Definitions\Tests\Support\GearBox;
 use Yiisoft\Definitions\Tests\Support\MagicCall;
 use Yiisoft\Definitions\Tests\Support\Phone;
+use Yiisoft\Definitions\Tests\Support\ReadonlyProperty;
 use Yiisoft\Definitions\Tests\Support\Recorder;
 use Yiisoft\Definitions\Tests\Support\UTF8User;
 use Yiisoft\Definitions\ValueDefinition;
@@ -73,15 +74,15 @@ public static function dataInvalidProperty(): array
                 $object1::class,
                 '$invisible',
                 sprintf(
-                    'Invalid definition: property "%s" must be public.',
+                    'Invalid definition: property "%s" must be public and writable.',
                     $object1::class . '::$invisible',
                 ),
             ],
             [
                 UTF8User::class,
                 '$имя',
                 sprintf(
-                    'Invalid definition: property "%s" must be public.',
+                    'Invalid definition: property "%s" must be public and writable.',
                     UTF8User::class . '::$имя',
                 ),
             ],
@@ -367,4 +368,18 @@ public function testIncorrectMethodName(array $config, string $message): void
         $this->expectExceptionMessage($message);
         DefinitionValidator::validate($config);
     }
+
+    public function testReadonlyProperty(): void
+    {
+        $definition = [
+            'class' => ReadonlyProperty::class,
+            '$var' => 'test',
+        ];
+
+        $this->expectException(InvalidConfigException::class);
+        $this->expectExceptionMessage(
+            'Invalid definition: property "Yiisoft\Definitions\Tests\Support\ReadonlyProperty::$var" must be public and writable.',
+        );
+        DefinitionValidator::validate($definition);
+    }
 }
diff --git a/tests/Unit/ParameterDefinitionTest.php b/tests/Unit/ParameterDefinitionTest.php

-Original file line number
+Diff line change
           - "8.1"
           - "8.2"
           - "8.3"
 +          - "8.4"
     steps:
       - name: Checkout Yii Definitions
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,11 @@`
`11`	`11`	`}`
`12`	`12`	`},`
`13`	`13`	`"mutators": {`
`14`		`- "@default": true`
	`14`	`+ "@default": true,`
	`15`	`+ "LessThan": {`
	`16`	`+ "ignoreSourceCodeByRegex": [`
	`17`	`+ ".\\(PHP_VERSION_ID ."`
	`18`	`+ ]`
	`19`	`+ }`
`15`	`20`	`}`
`16`	`21`	`}`