RuleTestCase::fix()

Author: ondrejmirtes

src/Fixable/FileChangedException.php

@@ -4,7 +4,7 @@
 
 use Exception;
 
-class FileChangedException extends Exception
+final class FileChangedException extends Exception
 {
 
 }

src/Fixable/MergeConflictException.php

@@ -4,7 +4,7 @@
 
 use Exception;
 
-class MergeConflictException extends Exception
+final class MergeConflictException extends Exception
 {
 
 }

src/Fixable/Patcher.php

@@ -12,6 +12,12 @@
 use PHPStan\File\FileReader;
 use ReflectionClass;
 use SebastianBergmann\Diff\Differ;
+use function array_map;
+use function count;
+use function implode;
+use function sha1;
+use const PREG_SPLIT_DELIM_CAPTURE;
+use const PREG_SPLIT_NO_EMPTY;
 
 #[AutowiredService]
 final class Patcher

src/Testing/RuleTestCase.php

@@ -20,6 +20,8 @@
 use PHPStan\DependencyInjection\Type\ParameterClosureTypeExtensionProvider;
 use PHPStan\DependencyInjection\Type\ParameterOutTypeExtensionProvider;
 use PHPStan\File\FileHelper;
+use PHPStan\File\FileReader;
+use PHPStan\Fixable\Patcher;
 use PHPStan\Php\PhpVersion;
 use PHPStan\PhpDoc\PhpDocInheritanceResolver;
 use PHPStan\PhpDoc\StubPhpDocProvider;
@@ -34,6 +36,8 @@
 use PHPStan\Rules\Properties\ReadWritePropertiesExtensionProvider;
 use PHPStan\Rules\Rule;
 use PHPStan\Type\FileTypeMapper;
+use SebastianBergmann\Diff\Differ;
+use SebastianBergmann\Diff\Output\DiffOnlyOutputBuilder;
 use function array_map;
 use function array_merge;
 use function count;
@@ -193,6 +197,25 @@ static function (Error $error) use ($strictlyTypedSprintf): string {
 		$this->assertSame($expectedErrorsString, $actualErrorsString);
 	}
 
+	public function fix(string $file, string $expectedDiff): void
+	{
+		[$errors] = $this->gatherAnalyserErrorsWithDelayedErrors([$file]);
+		$diffs = [];
+		foreach ($errors as $error) {
+			if ($error->getFixedErrorDiff() === null) {
+				continue;
+			}
+			$diffs[] = $error->getFixedErrorDiff();
+		}
+
+		$patcher = self::getContainer()->getByType(Patcher::class);
+		$originalFileContents = FileReader::read($file);
+		$newFileContents = $patcher->applyDiffs($file, $diffs); // @phpstan-ignore missingType.checkedException, missingType.checkedException
+
+		$differ = new Differ(new DiffOnlyOutputBuilder(''));
+		$this->assertSame($expectedDiff, $differ->diff($originalFileContents, $newFileContents));
+	}
+
 	/**
 	 * @param string[] $files
 	 * @return list<Error>

tests/PHPStan/Build/NamedArgumentsRuleTest.php

@@ -39,4 +39,22 @@ public function testRule(): void
 		]);
 	}
 
+	public function testNoFix(): void
+	{
+		$this->fix(__DIR__ . '/data/named-arguments-no-errors.php', '');
+	}
+
+	public function testFix(): void
+	{
+		$this->fix(__DIR__ . '/data/named-arguments.php', <<<DIFF
+-		new Exception('foo', 0, new Exception('previous'));
+-		new Exception('foo', code: 0, previous: new Exception('previous'));
++		new Exception('foo', previous: new Exception('previous'));
++		new Exception(previous: new Exception('previous'));
+-		new Exception('', 0, new Exception('previous'));
++		new Exception(previous: new Exception('previous'));
+
+DIFF);
+	}
+
 }

tests/PHPStan/Build/data/named-arguments-no-errors.php

@@ -0,0 +1,10 @@
+<?php // lint >= 8.0
+
+namespace NamedArgumentRuleNoErrors;
+
+use Exception;
+
+function (): void {
+	new Exception('foo', 0);
+	new Exception('foo', 0, null);
+};