Support @immutable phpdoc in RestoreDefaultNullToNullableTypePropertyRector (#5795)

staabm · web-flow · commit 3f1ccb3ea131 · 2024-04-03T18:19:17.000+07:00
* Added failling test

* Support `@immutable` phpdoc in RestoreDefaultNullToNullableTypePropertyRector
diff --git a/rules-tests/Php74/Rector/Property/RestoreDefaultNullToNullableTypePropertyRector/Fixture/skip_readonly_phpdoc_class.php.inc b/rules-tests/Php74/Rector/Property/RestoreDefaultNullToNullableTypePropertyRector/Fixture/skip_readonly_phpdoc_class.php.inc
@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\Php74\Rector\Property\RestoreDefaultNullToNullableTypePropertyRector\Fixture;
+
+/**
+ * @immutable
+ */
+final class SkipReadonlyPhpdocClass
+{
+    public string|null $display;
+}
diff --git a/rules/Php74/Rector/Property/RestoreDefaultNullToNullableTypePropertyRector.php b/rules/Php74/Rector/Property/RestoreDefaultNullToNullableTypePropertyRector.php
@@ -64,7 +64,7 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
-        if ($node->isReadonly()) {
+        if ($this->isReadonlyClass($node)) {
             return null;
         }
 
@@ -108,7 +108,7 @@ private function shouldSkip(Property $property, Class_ $class): bool
             return true;
         }
 
-        if ($this->isReadonly($property)) {
+        if ($this->isReadonlyProperty($property)) {
             return true;
         }
 
@@ -121,7 +121,7 @@ private function shouldSkip(Property $property, Class_ $class): bool
         return $this->constructorAssignDetector->isPropertyAssigned($class, $propertyName);
     }
 
-    private function isReadonly(Property $property): bool
+    private function isReadonlyProperty(Property $property): bool
     {
         // native readonly
         if ($property->isReadonly()) {
@@ -133,4 +133,17 @@ private function isReadonly(Property $property): bool
         $tags = $phpDocInfo->getTagsByName('@readonly');
         return $tags !== [];
     }
+
+    private function isReadonlyClass(Class_ $class): bool
+    {
+        // native readonly
+        if ($class->isReadonly()) {
+            return true;
+        }
+
+        // @immutable annotation
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($class);
+        $tags = $phpDocInfo->getTagsByName('@immutable');
+        return $tags !== [];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function getNodeTypes(): array`
`64`	`64`	`*/`
`65`	`65`	`public function refactor(Node $node): ?Node`
`66`	`66`	`{`
`67`		`- if ($node->isReadonly()) {`
	`67`	`+ if ($this->isReadonlyClass($node)) {`
`68`	`68`	`return null;`
`69`	`69`	`}`
`70`	`70`
`@@ -108,7 +108,7 @@ private function shouldSkip(Property $property, Class_ $class): bool`
`108`	`108`	`return true;`
`109`	`109`	`}`
`110`	`110`
`111`		`- if ($this->isReadonly($property)) {`
	`111`	`+ if ($this->isReadonlyProperty($property)) {`
`112`	`112`	`return true;`
`113`	`113`	`}`
`114`	`114`
`@@ -121,7 +121,7 @@ private function shouldSkip(Property $property, Class_ $class): bool`
`121`	`121`	`return $this->constructorAssignDetector->isPropertyAssigned($class, $propertyName);`
`122`	`122`	`}`
`123`	`123`
`124`		`- private function isReadonly(Property $property): bool`
	`124`	`+ private function isReadonlyProperty(Property $property): bool`
`125`	`125`	`{`
`126`	`126`	`// native readonly`
`127`	`127`	`if ($property->isReadonly()) {`
`@@ -133,4 +133,17 @@ private function isReadonly(Property $property): bool`
`133`	`133`	`$tags = $phpDocInfo->getTagsByName('@readonly');`
`134`	`134`	`return $tags !== [];`
`135`	`135`	`}`
	`136`	`+`
	`137`	`+ private function isReadonlyClass(Class_ $class): bool`
	`138`	`+ {`
	`139`	`+ // native readonly`
	`140`	`+ if ($class->isReadonly()) {`
	`141`	`+ return true;`
	`142`	`+ }`
	`143`	`+`
	`144`	`+ // @immutable annotation`
	`145`	`+ $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($class);`
	`146`	`+ $tags = $phpDocInfo->getTagsByName('@immutable');`
	`147`	`+ return $tags !== [];`
	`148`	`+ }`
`136`	`149`	`}`