[Naming] Skip used by trait on RenamePropertyToMatchTypeRector (#2077)

* [Naming] Skip used by trait on RenamePropertyToMatchTypeRector * Fixed 🎉 * [ci-review] Rector Rectify * [ci-review] Rector Rectify * [ci-review] Rector Rectify Co-authored-by: GitHub Action <action@github.com>
rectorphp · Apr 15, 2022 · 8be11db · 8be11db
1 parent 4519646
commit 8be11db
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 31 deletions.
diff --git a/...s/Naming/Rector/Class_/RenamePropertyToMatchTypeRector/Fixture/skip_used_by_trait.php.inc b/...s/Naming/Rector/Class_/RenamePropertyToMatchTypeRector/Fixture/skip_used_by_trait.php.inc
@@ -0,0 +1,21 @@
+<?php
+
+namespace Rector\Tests\Naming\Rector\Class_\RenamePropertyToMatchTypeRector\Fixture;
+
+use Rector\Tests\Naming\Rector\Class_\RenamePropertyToMatchTypeRector\Source\EliteManager;
+use Rector\Tests\Naming\Rector\Class_\RenamePropertyToMatchTypeRector\Source\UseEliteManagerTrait;
+
+class SkipUsedByTrait
+{
+    use UseEliteManagerTrait;
+
+    /**
+     * @var EliteManager
+     */
+    private $eventManager;
+
+    public function __construct(EliteManager $eventManager)
+    {
+        $this->eventManager = $eventManager;
+    }
+}
diff --git a/...ests/Naming/Rector/Class_/RenamePropertyToMatchTypeRector/Source/UseEliteManagerTrait.php b/...ests/Naming/Rector/Class_/RenamePropertyToMatchTypeRector/Source/UseEliteManagerTrait.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Naming\Rector\Class_\RenamePropertyToMatchTypeRector\Source;
+
+trait UseEliteManagerTrait
+{
+    public function trigger($name)
+    {
+        $this->eventManager->trigger($name);
+    }
+}
diff --git a/rules/Naming/ExpectedNameResolver/MatchPropertyTypeExpectedNameResolver.php b/rules/Naming/ExpectedNameResolver/MatchPropertyTypeExpectedNameResolver.php
@@ -4,8 +4,11 @@
 
 namespace Rector\Naming\ExpectedNameResolver;
 
+use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\Property;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\Core\NodeManipulator\PropertyManipulator;
+use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\Naming\Naming\PropertyNaming;
 use Rector\Naming\ValueObject\ExpectedName;
 use Rector\NodeNameResolver\NodeNameResolver;
@@ -15,12 +18,24 @@ final class MatchPropertyTypeExpectedNameResolver
     public function __construct(
         private readonly PropertyNaming $propertyNaming,
         private readonly PhpDocInfoFactory $phpDocInfoFactory,
-        private readonly NodeNameResolver $nodeNameResolver
+        private readonly NodeNameResolver $nodeNameResolver,
+        private readonly BetterNodeFinder $betterNodeFinder,
+        private readonly PropertyManipulator $propertyManipulator
     ) {
     }
 
     public function resolve(Property $property): ?string
     {
+        $class = $this->betterNodeFinder->findParentType($property, Class_::class);
+        if (! $class instanceof Class_) {
+            return null;
+        }
+
+        $propertyName = $this->nodeNameResolver->getName($property);
+        if ($this->propertyManipulator->isUsedByTrait($class, $propertyName)) {
+            return null;
+        }
+
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($property);
 
         $expectedName = $this->propertyNaming->getExpectedNameFromType($phpDocInfo->getVarType());

diff --git a/rules/Php74/Guard/MakePropertyTypedGuard.php b/rules/Php74/Guard/MakePropertyTypedGuard.php
@@ -7,12 +7,10 @@
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\Property;
-use PhpParser\Node\Stmt\Trait_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use Rector\Core\NodeAnalyzer\PropertyAnalyzer;
-use Rector\Core\NodeAnalyzer\PropertyFetchAnalyzer;
-use Rector\Core\PhpParser\AstResolver;
+use Rector\Core\NodeManipulator\PropertyManipulator;
 use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\NodeNameResolver\NodeNameResolver;
 use Rector\NodeTypeResolver\Node\AttributeKey;
@@ -22,9 +20,8 @@ final class MakePropertyTypedGuard
     public function __construct(
         private readonly BetterNodeFinder $betterNodeFinder,
         private readonly NodeNameResolver $nodeNameResolver,
-        private readonly AstResolver $astResolver,
-        private readonly PropertyFetchAnalyzer $propertyFetchAnalyzer,
-        private readonly PropertyAnalyzer $propertyAnalyzer
+        private readonly PropertyAnalyzer $propertyAnalyzer,
+        private readonly PropertyManipulator $propertyManipulator
     ) {
     }
 
@@ -59,7 +56,7 @@ public function isLegal(Property $property, bool $inlinePublic = true): bool
 
         $propertyName = $this->nodeNameResolver->getName($property);
 
-        if ($this->isModifiedByTrait($class, $propertyName)) {
+        if ($this->propertyManipulator->isUsedByTrait($class, $propertyName)) {
             return false;
         }
 
@@ -74,24 +71,6 @@ public function isLegal(Property $property, bool $inlinePublic = true): bool
         return $this->isSafeProtectedProperty($property, $class);
     }
 
-    private function isModifiedByTrait(Class_ $class, string $propertyName): bool
-    {
-        foreach ($class->getTraitUses() as $traitUse) {
-            foreach ($traitUse->traits as $traitName) {
-                $trait = $this->astResolver->resolveClassFromName($traitName->toString());
-                if (! $trait instanceof Trait_) {
-                    continue;
-                }
-
-                if ($this->propertyFetchAnalyzer->containsLocalPropertyFetchName($trait, $propertyName)) {
-                    return true;
-                }
-            }
-        }
-
-        return false;
-    }
-
     private function isSafeProtectedProperty(Property $property, Class_ $class): bool
     {
         if (! $property->isProtected()) {

diff --git a/src/Application/VersionResolver.php b/src/Application/VersionResolver.php
@@ -25,21 +25,26 @@ final class VersionResolver
      */
     public const RELEASE_DATE = '@release_date@';
 
+    /**
+     * @var string
+     */
+    private const GIT = 'git';
+
     public static function resolvePackageVersion(): string
     {
-        $pointsAtProcess = new Process(['git', 'tag', '--points-at'], __DIR__);
+        $pointsAtProcess = new Process([self::GIT, 'tag', '--points-at'], __DIR__);
         if ($pointsAtProcess->run() !== Command::SUCCESS) {
             throw new VersionException(
                 'You must ensure to run compile from composer git repository clone and that git binary is available.'
             );
         }
 
         $tag = trim($pointsAtProcess->getOutput());
-        if ($tag) {
+        if ($tag !== '' && $tag !== '0') {
             return $tag;
         }
 
-        $process = new Process(['git', 'log', '--pretty="%H"', '-n1', 'HEAD'], __DIR__);
+        $process = new Process([self::GIT, 'log', '--pretty="%H"', '-n1', 'HEAD'], __DIR__);
         if ($process->run() !== Command::SUCCESS) {
             throw new VersionException(
                 'You must ensure to run compile from composer git repository clone and that git binary is available.'
@@ -52,7 +57,7 @@ public static function resolvePackageVersion(): string
 
     public static function resolverReleaseDateTime(): DateTime
     {
-        $process = new Process(['git', 'log', '-n1', '--pretty=%ci', 'HEAD'], __DIR__);
+        $process = new Process([self::GIT, 'log', '-n1', '--pretty=%ci', 'HEAD'], __DIR__);
         if ($process->run() !== Command::SUCCESS) {
             throw new VersionException(
                 'You must ensure to run compile from composer git repository clone and that git binary is available.'

diff --git a/src/NodeManipulator/PropertyManipulator.php b/src/NodeManipulator/PropertyManipulator.php
@@ -24,11 +24,14 @@
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Interface_;
 use PhpParser\Node\Stmt\Property;
+use PhpParser\Node\Stmt\Trait_;
 use PhpParser\Node\Stmt\Unset_;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Type\Type;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
+use Rector\Core\NodeAnalyzer\PropertyFetchAnalyzer;
+use Rector\Core\PhpParser\AstResolver;
 use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\Core\PhpParser\NodeFinder\PropertyFetchFinder;
 use Rector\Core\Reflection\ReflectionResolver;
@@ -83,7 +86,9 @@ public function __construct(
         private readonly PhpAttributeAnalyzer $phpAttributeAnalyzer,
         private readonly NodeTypeResolver $nodeTypeResolver,
         private readonly PromotedPropertyResolver $promotedPropertyResolver,
-        private readonly ConstructorAssignDetector $constructorAssignDetector
+        private readonly ConstructorAssignDetector $constructorAssignDetector,
+        private readonly AstResolver $astResolver,
+        private readonly PropertyFetchAnalyzer $propertyFetchAnalyzer
     ) {
     }
 
@@ -229,6 +234,24 @@ public function resolveExistingClassPropertyNameByType(Class_ $class, Type $type
         return null;
     }
 
+    public function isUsedByTrait(Class_ $class, string $propertyName): bool
+    {
+        foreach ($class->getTraitUses() as $traitUse) {
+            foreach ($traitUse->traits as $traitName) {
+                $trait = $this->astResolver->resolveClassFromName($traitName->toString());
+                if (! $trait instanceof Trait_) {
+                    continue;
+                }
+
+                if ($this->propertyFetchAnalyzer->containsLocalPropertyFetchName($trait, $propertyName)) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
     private function isPropertyAssignedOnlyInConstructor(
         ClassLike $classLike,
         string $propertyName,