Stop overriding previous tags (#331)

* Stop overriding previous tags

* Add check for multiple PHPDoc types in AddGenericReturnTypeToRelationsRector

---------

Co-authored-by: Geni Jaho <[email protected]>

Author: peterfox

src/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector.php

@@ -376,6 +376,8 @@ private function areGenericTypesEqual(
             $returnTagValueNode->type,
             $node
         );
+        $relationUsesPivots = $this->typeComparator->isSubtype($phpDocPHPStanType, new ObjectType('Illuminate\Database\Eloquent\Relations\BelongsToMany'))
+            || $this->typeComparator->isSubtype($phpDocPHPStanType, new ObjectType('Illuminate\Database\Eloquent\Relations\MorphToMany'));
 
         if (! $phpDocPHPStanType instanceof GenericObjectType) {
             return false;
@@ -386,8 +388,13 @@ private function areGenericTypesEqual(
             return false;
         }
 
-        if (! $this->typeComparator->areTypesEqual($phpDocTypes[0], new ObjectType($relatedClass))) {
-            return false;
+        if (
+            $this->typeComparator->areTypesEqual($phpDocTypes[0], new ObjectType($relatedClass))
+            && count($phpDocTypes) > 1
+            && $phpDocTypes[1] instanceof ThisType
+            && ! $relationUsesPivots
+        ) {
+            return true;
         }
 
         if (! $this->shouldUseNewGenerics) {
@@ -404,19 +411,21 @@ private function areGenericTypesEqual(
             return $this->typeComparator->areTypesEqual($phpDocTypes[1], new ObjectType($classForChildGeneric));
         }
 
-        $phpDocHasIntermediateGeneric = count($phpDocTypes) === 3;
-
-        if ($classForIntermediateGeneric === null && ! $phpDocHasIntermediateGeneric) {
+        if ($classForIntermediateGeneric === null && $relationUsesPivots) {
             // If there are less than three generics, it means method is using the old format. We should update it.
             if (count($phpDocTypes) < 3) {
                 return false;
             }
 
             // We want to convert the existing relationship definition to use `$this` as the second generic
-            return $phpDocTypes[1] instanceof ThisType;
+            // but only if the PHPDoc Tag doesn't look valid already
+            return
+                $this->typeComparator->areTypesEqual($phpDocTypes[0], new ObjectType($relatedClass))
+                && $phpDocTypes[1] instanceof ThisType
+                && $this->typeComparator->isSubtype($phpDocTypes[2], new ObjectType('Illuminate\Database\Eloquent\Relations\Pivot'));
         }
 
-        if ($classForIntermediateGeneric === null || ! $phpDocHasIntermediateGeneric) {
+        if ($classForIntermediateGeneric === null) {
             return false;
         }
 

tests/Rector/ClassMethod/AddGenericReturnTypeToRelationsRector/Fixture/NewGenerics/skip-already-set-generic.php.inc

@@ -0,0 +1,47 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector\Fixture\NewGenerics;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use RectorLaravel\Tests\Rector\ClassMethod\AddGenericReturnTypeToRelationsRector\Source\SomeModel;
+use Illuminate\Database\Eloquent\Relations\Pivot;
+
+class SkipAlreadySetGeneric extends Model
+{
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo<SomeModel, $this>
+     */
+    public function account(): BelongsTo
+    {
+        return $this->belongsTo(SomeModel::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany<SomeModel, $this>
+     */
+    public function posts(): HasMany
+    {
+        return $this->hasMany(SomeModel::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany<SomeModel, $this, Pivot>
+     */
+    public function comments(): BelongsToMany
+    {
+        return $this->belongsToMany(SomeModel::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\MorphToMany<SomeModel, $this, Pivot>
+     */
+    public function photos(): MorphToMany
+    {
+        return $this->morphToMany(SomeModel::class);
+    }
+}
+?>