Test when the fixer writes new class names (#6934)

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

Author: SanderMuller

tests/PHPStan/Fixable/AddNamesRule.php

@@ -12,13 +12,15 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use function count;
+use function in_array;
 use function preg_match_all;
 use function sprintf;
 
 /**
  * Turns each `@add-name \Some\Class` tag into a native parameter type
  * and a `@param` tag, to show new names are written the same way
- * in PHP code and in PHPDocs.
+ * in PHP code and in PHPDocs. An `@add-doc-name \Some\Class` tag becomes
+ * only a `@param` tag.
  *
  * @implements Rule<Node\Stmt\ClassMethod>
  */
@@ -37,19 +39,27 @@ public function getNodeType(): string
 	public function processNode(Node $node, Scope $scope): array
 	{
 		$docComment = $node->getDocComment();
-		if ($docComment === null || preg_match_all('/@add-name\s+\\\\?(\S+)/', $docComment->getText(), $matches) === 0) {
+		if ($docComment === null || preg_match_all('/@add-(doc-)?name\s+\\\\?(\S+)/', $docComment->getText(), $matches) === 0) {
 			return [];
 		}
 
-		$names = $matches[1];
+		$names = $matches[2];
+		$parameterNames = [];
+		foreach ($matches[1] as $j => $docOnly) {
+			if ($docOnly !== '') {
+				continue;
+			}
+
+			$parameterNames[] = $names[$j];
+		}
 
 		return [
 			RuleErrorBuilder::message(sprintf('Adding %d names.', count($names)))
 				->identifier('tests.addNames')
-				->fixNode($node, function (Node\Stmt\ClassMethod $method) use ($names) {
+				->fixNode($node, function (Node\Stmt\ClassMethod $method) use ($parameterNames) {
 					$i = 0;
 					$this->phpDocEditor->edit($method, static function (\PHPStan\PhpDocParser\Ast\Node $phpDocNode) use (&$i) {
-						if (!$phpDocNode instanceof PhpDocTagNode || $phpDocNode->name !== '@add-name') {
+						if (!$phpDocNode instanceof PhpDocTagNode || !in_array($phpDocNode->name, ['@add-name', '@add-doc-name'], true)) {
 							return null;
 						}
 
@@ -64,7 +74,7 @@ public function processNode(Node $node, Scope $scope): array
 						));
 					});
 
-					foreach ($names as $j => $name) {
+					foreach ($parameterNames as $j => $name) {
 						$method->params[] = new Node\Param(
 							new Node\Expr\Variable('p' . ($j + 1)),
 							type: new FullyQualified($name),

tests/PHPStan/Fixable/AddNamesRuleTest.php

@@ -37,4 +37,9 @@ public function testFixSortedUses(): void
 		$this->fix(__DIR__ . '/data/add-names-sorted-uses.php', __DIR__ . '/data/add-names-sorted-uses.php.fixed');
 	}
 
+	public function testFixPhpDocOnly(): void
+	{
+		$this->fix(__DIR__ . '/data/add-names-phpdoc-only.php', __DIR__ . '/data/add-names-phpdoc-only.php.fixed');
+	}
+
 }

tests/PHPStan/Fixable/NewClassNamesVisitorTest.php

@@ -0,0 +1,97 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Fixable;
+
+use PhpParser\Comment\Doc;
+use PhpParser\Node;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\NodeFinder;
+use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitor\CloningVisitor;
+use PhpParser\ParserFactory;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+
+class NewClassNamesVisitorTest extends TestCase
+{
+
+	private const CODE = <<<'PHP'
+		<?php
+
+		namespace HasWork;
+
+		class Foo
+		{
+
+			/** @return int */
+			#[\Override]
+			public function doFoo(\Bar\Baz $baz): int
+			{
+				return strlen('');
+			}
+
+		}
+		PHP;
+
+	/**
+	 * @return iterable<string, array{callable(ClassMethod): Node, bool}>
+	 */
+	public static function dataHasNewNames(): iterable
+	{
+		yield 'unchanged' => [
+			static fn (ClassMethod $method): Node => $method,
+			false,
+		];
+
+		yield 'removed attribute' => [
+			static function (ClassMethod $method): Node {
+				$method->attrGroups = [];
+				return $method;
+			},
+			false,
+		];
+
+		yield 'added name' => [
+			static function (ClassMethod $method): Node {
+				$method->params[] = new Node\Param(new Node\Expr\Variable('qux'), type: new FullyQualified('Qux\Quux'));
+				return $method;
+			},
+			true,
+		];
+
+		yield 'changed PHPDoc' => [
+			static function (ClassMethod $method): Node {
+				$method->setDocComment(new Doc('/** @return positive-int */'));
+				return $method;
+			},
+			true,
+		];
+
+		yield 'new node with a PHPDoc' => [
+			static function (ClassMethod $method): Node {
+				$newMethod = new ClassMethod('doBar');
+				$newMethod->setDocComment(new Doc('/** @return void */'));
+				return $newMethod;
+			},
+			true,
+		];
+	}
+
+	/**
+	 * @param callable(ClassMethod): Node $fix
+	 */
+	#[DataProvider('dataHasNewNames')]
+	public function testHasNewNames(callable $fix, bool $expected): void
+	{
+		$stmts = (new ParserFactory())->createForHostVersion()->parse(self::CODE);
+		$this->assertNotNull($stmts);
+
+		$newStmts = (new NodeTraverser(new CloningVisitor()))->traverse($stmts);
+		$method = (new NodeFinder())->findFirstInstanceOf($newStmts, ClassMethod::class);
+		$this->assertNotNull($method);
+
+		$this->assertSame($expected, NewClassNamesVisitor::hasNewNames([$fix($method)]));
+	}
+
+}

tests/PHPStan/Fixable/data/add-names-phpdoc-only.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace AddNamesPhpDocOnly;
+
+use AddNamesImported\Foo;
+
+class Bar
+{
+
+	/**
+	 * @add-doc-name \AddNamesImported\Foo
+	 * @add-doc-name \AddNamesOther\AddNamesUnique
+	 */
+	public function doFoo($p1, $p2): void
+	{
+	}
+
+}

tests/PHPStan/Fixable/data/add-names-phpdoc-only.php.fixed

@@ -0,0 +1,19 @@
+<?php
+
+namespace AddNamesPhpDocOnly;
+
+use AddNamesImported\Foo;
+use AddNamesOther\AddNamesUnique;
+
+class Bar
+{
+
+	/**
+	 * @param Foo $p1
+	 * @param AddNamesUnique $p2
+	 */
+	public function doFoo($p1, $p2): void
+	{
+	}
+
+}