Add readonly by default on new promoted property

rectorphp · Jan 5, 2025 · f9070c3 · f9070c3
1 parent 2e82ab4
commit f9070c3
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 13 deletions.
diff --git a/src/FileSystem/FilesFinder.php b/src/FileSystem/FilesFinder.php
@@ -59,7 +59,7 @@ public function findInDirectoriesAndFiles(
         // filter files by specific suffix
         if ($hasOnlySuffix) {
             /** @var string $onlySuffix */
-            $fileWithSuffixFilter = (static fn(string $filePath): bool => str_ends_with($filePath, $onlySuffix));
+            $fileWithSuffixFilter = (static fn (string $filePath): bool => str_ends_with($filePath, $onlySuffix));
         } elseif ($suffixes !== []) {
             $fileWithSuffixFilter = static function (string $filePath) use ($suffixes): bool {
                 $filePathExtension = pathinfo($filePath, PATHINFO_EXTENSION);
@@ -88,7 +88,13 @@ function (string $file): bool {
 
         // filtering files in directories collection
         $directories = $this->fileAndDirectoryFilter->filterDirectories($filesAndDirectories);
-        $filteredFilePathsInDirectories = $this->findInDirectories($directories, $suffixes, $hasOnlySuffix, $onlySuffix, $sortByName);
+        $filteredFilePathsInDirectories = $this->findInDirectories(
+            $directories,
+            $suffixes,
+            $hasOnlySuffix,
+            $onlySuffix,
+            $sortByName
+        );
 
         $filePaths = [...$filteredFilePaths, ...$filteredFilePathsInDirectories];
         return $this->unchangedFilesFilter->filterFilePaths($filePaths);

diff --git a/src/PhpParser/Node/NodeFactory.php b/src/PhpParser/Node/NodeFactory.php
@@ -45,10 +45,12 @@
 use Rector\Exception\ShouldNotHappenException;
 use Rector\NodeDecorator\PropertyTypeDecorator;
 use Rector\NodeTypeResolver\Node\AttributeKey;
+use Rector\Php\PhpVersionProvider;
 use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
 use Rector\PHPStanStaticTypeMapper\Enum\TypeKind;
 use Rector\PostRector\ValueObject\PropertyMetadata;
 use Rector\StaticTypeMapper\StaticTypeMapper;
+use Rector\ValueObject\PhpVersionFeature;
 
 /**
  * @see \Rector\Tests\PhpParser\Node\NodeFactoryTest
@@ -65,7 +67,8 @@ public function __construct(
         private PhpDocInfoFactory $phpDocInfoFactory,
         private StaticTypeMapper $staticTypeMapper,
         private PropertyTypeDecorator $propertyTypeDecorator,
-        private SimpleCallableNodeTraverser $simpleCallableNodeTraverser
+        private SimpleCallableNodeTraverser $simpleCallableNodeTraverser,
+        private PhpVersionProvider $phpVersionProvider,
     ) {
     }
 
@@ -291,6 +294,11 @@ public function createPromotedPropertyParam(PropertyMetadata $propertyMetadata):
         $propertyFlags = $propertyMetadata->getFlags();
         $param->flags = $propertyFlags !== 0 ? $propertyFlags : Modifiers::PRIVATE;
 
+        // make readonly by default
+        if ($this->phpVersionProvider->isAtLeastPhpVersion(PhpVersionFeature::READONLY_PROPERTY)) {
+            $param->flags |= Modifiers::READONLY;
+        }
+
         return $param;
     }
 

diff --git a/tests/FileSystem/FilesFinder/FilesFinderTest.php b/tests/FileSystem/FilesFinder/FilesFinderTest.php
@@ -130,10 +130,7 @@ public function testFilterBySuffix(): void
         $this->assertCount(3, $foundNoFilterFiles);
 
         $foundFiles = $this->filesFinder->findInDirectoriesAndFiles(
-            [
-                __DIR__ . '/SourceWithSuffix',
-                __DIR__ . '/SourceWithSuffix/other_unrelated_file.php',
-            ],
+            [__DIR__ . '/SourceWithSuffix', __DIR__ . '/SourceWithSuffix/other_unrelated_file.php'],
             ['php'],
             true,
             'Controller'

diff --git a/tests/NodeManipulator/ClassDependencyManipulatorTest.php b/tests/NodeManipulator/ClassDependencyManipulatorTest.php
@@ -17,9 +17,12 @@
 use PhpParser\NodeVisitor\NameResolver;
 use PhpParser\PrettyPrinter\Standard;
 use PHPStan\Type\ObjectType;
+use Rector\Configuration\Option;
+use Rector\Configuration\Parameter\SimpleParameterProvider;
 use Rector\NodeManipulator\ClassDependencyManipulator;
 use Rector\PostRector\ValueObject\PropertyMetadata;
 use Rector\Testing\PHPUnit\AbstractLazyTestCase;
+use Rector\ValueObject\PhpVersionFeature;
 
 final class ClassDependencyManipulatorTest extends AbstractLazyTestCase
 {
@@ -30,7 +33,11 @@ final class ClassDependencyManipulatorTest extends AbstractLazyTestCase
     protected function setUp(): void
     {
         $this->classDependencyManipulator = $this->make(ClassDependencyManipulator::class);
+
         $this->printerStandard = new Standard();
+
+        // use at least readonly property
+        SimpleParameterProvider::setParameter(Option::PHP_VERSION_FEATURES, PhpVersionFeature::READONLY_PROPERTY);
     }
 
     public function testEmptyClass(): void
@@ -46,7 +53,6 @@ public function testEmptyClass(): void
     public function testSingleMethod(): void
     {
         $someClass = new Class_(new Identifier('SingleMethodClass'));
-
         $this->setNamespacedName($someClass);
 
         $someClass->stmts[] = new ClassMethod('firstMethod');

diff --git a/tests/NodeManipulator/Fixture/expected_class_const_property.php.inc b/tests/NodeManipulator/Fixture/expected_class_const_property.php.inc
@@ -5,7 +5,7 @@ class ConstantProperties
     const SOME_CONST = 'value';
     public $someProperty;
     public $anotherProperty;
-    public function __construct(private \EventDispatcherInterface $eventDispatcher)
+    public function __construct(private readonly \EventDispatcherInterface $eventDispatcher)
     {
     }
 }
diff --git a/tests/NodeManipulator/Fixture/expected_empty_class.php.inc b/tests/NodeManipulator/Fixture/expected_empty_class.php.inc
@@ -2,7 +2,7 @@
 
 class EmptyClass
 {
-    public function __construct(private \EventDispatcherInterface $eventDispatcher)
+    public function __construct(private readonly \EventDispatcherInterface $eventDispatcher)
     {
     }
 }
diff --git a/tests/NodeManipulator/Fixture/expected_method_and_property.php.inc b/tests/NodeManipulator/Fixture/expected_method_and_property.php.inc
@@ -3,7 +3,7 @@
 class ClassWithMethodAndProperty
 {
     private $someProperty;
-    public function __construct(private \EventDispatcherInterface $eventDispatcher)
+    public function __construct(private readonly \EventDispatcherInterface $eventDispatcher)
     {
     }
     function someMethod()

diff --git a/tests/NodeManipulator/Fixture/expected_single_method.php.inc b/tests/NodeManipulator/Fixture/expected_single_method.php.inc
@@ -2,7 +2,7 @@
 
 class SingleMethodClass
 {
-    public function __construct(private \EventDispatcherInterface $eventDispatcher)
+    public function __construct(private readonly \EventDispatcherInterface $eventDispatcher)
     {
     }
     function firstMethod()

diff --git a/tests/NodeManipulator/Fixture/expected_single_property.php.inc b/tests/NodeManipulator/Fixture/expected_single_property.php.inc
@@ -3,7 +3,7 @@
 class ClassWithSingleProperty
 {
     private $someProperty;
-    public function __construct(private \EventDispatcherInterface $eventDispatcher)
+    public function __construct(private readonly \EventDispatcherInterface $eventDispatcher)
     {
     }
 }