[DX] Make use of FilePathHelper over inner magic of FileSystem in Sma…

…rtFileInfo (#2862)
rectorphp · Aug 30, 2022 · b01ea04 · b01ea04
1 parent bb3ced4
commit b01ea04
Show file tree

Hide file tree

Showing 14 changed files with 82 additions and 58 deletions.
diff --git a/...s-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/AbstractPhpDocInfoPrinterTest.php b/...s-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/AbstractPhpDocInfoPrinterTest.php
@@ -10,11 +10,14 @@
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\BetterPhpDocParser\Printer\PhpDocInfoPrinter;
+use Rector\Core\FileSystem\FilePathHelper;
 use Rector\Testing\PHPUnit\AbstractTestCase;
 use Symplify\EasyTesting\DataProvider\StaticFixtureFinder;
 
 abstract class AbstractPhpDocInfoPrinterTest extends AbstractTestCase
 {
+    protected FilePathHelper $filePathHelper;
+
     protected PhpDocInfoPrinter $phpDocInfoPrinter;
 
     private PhpDocInfoFactory $phpDocInfoFactory;
@@ -23,6 +26,7 @@ protected function setUp(): void
     {
         $this->boot();
 
+        $this->filePathHelper = $this->getService(FilePathHelper::class);
         $this->phpDocInfoFactory = $this->getService(PhpDocInfoFactory::class);
         $this->phpDocInfoPrinter = $this->getService(PhpDocInfoPrinter::class);
     }

diff --git a/packages-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/DoctrineTest.php b/packages-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/DoctrineTest.php
@@ -11,7 +11,6 @@
 use Rector\Tests\BetterPhpDocParser\PhpDocInfo\PhpDocInfoPrinter\Source\Doctrine\CaseSensitive;
 use Rector\Tests\BetterPhpDocParser\PhpDocInfo\PhpDocInfoPrinter\Source\Doctrine\IndexInTable;
 use Rector\Tests\BetterPhpDocParser\PhpDocInfo\PhpDocInfoPrinter\Source\Doctrine\Short;
-use Symplify\SmartFileSystem\SmartFileInfo;
 
 final class DoctrineTest extends AbstractPhpDocInfoPrinterTest
 {
@@ -23,8 +22,7 @@ public function testClass(string $docFilePath, Node $node): void
         $docComment = FileSystem::read($docFilePath);
         $phpDocInfo = $this->createPhpDocInfoFromDocCommentAndNode($docComment, $node);
 
-        $fileInfo = new SmartFileInfo($docFilePath);
-        $relativeFilePathFromCwd = $fileInfo->getRelativeFilePathFromCwd();
+        $relativeFilePathFromCwd = $this->filePathHelper->relativePath($docFilePath);
 
         $printedPhpDocInfo = $this->phpDocInfoPrinter->printFormatPreserving($phpDocInfo);
         $this->assertSame($docComment, $printedPhpDocInfo, $relativeFilePathFromCwd);

diff --git a/packages-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/MultilineTest.php b/packages-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/MultilineTest.php
@@ -14,7 +14,6 @@
 use PhpParser\Node\Stmt\Property;
 use Rector\Tests\BetterPhpDocParser\PhpDocInfo\PhpDocInfoPrinter\Source\Class_\SomeEntityClass;
 use Rector\Tests\BetterPhpDocParser\PhpDocInfo\PhpDocInfoPrinter\Source\TableClass;
-use Symplify\SmartFileSystem\SmartFileInfo;
 
 final class MultilineTest extends AbstractPhpDocInfoPrinterTest
 {
@@ -28,11 +27,8 @@ public function test(string $docFilePath, Node $node): void
         $docComment = FileSystem::read($docFilePath);
         $phpDocInfo = $this->createPhpDocInfoFromDocCommentAndNode($docComment, $node);
 
-        $fileInfo = new SmartFileInfo($docFilePath);
-        $relativeFilePathFromCwd = $fileInfo->getRelativeFilePathFromCwd();
-
         $printedPhpDocInfo = $this->phpDocInfoPrinter->printFormatPreserving($phpDocInfo);
-        $this->assertSame($docComment, $printedPhpDocInfo, $relativeFilePathFromCwd);
+        $this->assertSame($docComment, $printedPhpDocInfo);
     }
 
     public function provideData(): Iterator

diff --git a/packages-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/PhpDocInfoPrinterTest.php b/packages-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/PhpDocInfoPrinterTest.php
@@ -6,6 +6,7 @@
 
 use Iterator;
 use PhpParser\Node\Stmt\Nop;
+use Rector\Core\FileSystem\FilePathHelper;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
 final class PhpDocInfoPrinterTest extends AbstractPhpDocInfoPrinterTest
@@ -56,10 +57,9 @@ private function doComparePrintedFileEquals(SmartFileInfo $inputFileInfo, SmartF
         $phpDocInfo = $this->createPhpDocInfoFromDocCommentAndNode($inputFileInfo->getContents(), new Nop());
         $printedDocComment = $this->phpDocInfoPrinter->printFormatPreserving($phpDocInfo);
 
-        $this->assertSame(
-            $expectedFileInfo->getContents(),
-            $printedDocComment,
-            $inputFileInfo->getRelativeFilePathFromCwd()
-        );
+        $filePathHelper = $this->getService(FilePathHelper::class);
+        $relativeInputFilePath = $filePathHelper->relativePath($inputFileInfo->getRealPath());
+
+        $this->assertSame($expectedFileInfo->getContents(), $printedDocComment, $relativeInputFilePath);
     }
 }
diff --git a/...DocParser/PhpDocParser/ClassAnnotationMatcher/ResolveTagToKnownFullyQualifiedNameTest.php b/...DocParser/PhpDocParser/ClassAnnotationMatcher/ResolveTagToKnownFullyQualifiedNameTest.php
@@ -75,7 +75,6 @@ public function testResolvesClass(SmartFileInfo $file): void
      */
     public function provideData(): Iterator
     {
-        $directory = __DIR__ . '/Fixture';
-        return StaticFixtureFinder::yieldDirectory($directory);
+        return StaticFixtureFinder::yieldDirectory(__DIR__ . '/Fixture');
     }
 }
diff --git a/...ges-tests/BetterPhpDocParser/PhpDocParser/TagValueNodeReprint/TagValueNodeReprintTest.php b/...ges-tests/BetterPhpDocParser/PhpDocParser/TagValueNodeReprint/TagValueNodeReprintTest.php
@@ -11,6 +11,7 @@
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\BetterPhpDocParser\Printer\PhpDocInfoPrinter;
 use Rector\Core\Exception\ShouldNotHappenException;
+use Rector\Core\FileSystem\FilePathHelper;
 use Rector\Core\PhpParser\Node\BetterNodeFinder;
 use Rector\FileSystemRector\Parser\FileInfoParser;
 use Rector\Testing\PHPUnit\AbstractTestCase;
@@ -29,12 +30,14 @@ final class TagValueNodeReprintTest extends AbstractTestCase
 
     private PhpDocInfoFactory $phpDocInfoFactory;
 
+    private FilePathHelper $filePathHelper;
+
     protected function setUp(): void
     {
         $this->boot();
 
         $this->fileInfoParser = $this->getService(FileInfoParser::class);
-
+        $this->filePathHelper = $this->getService(FilePathHelper::class);
         $this->betterNodeFinder = $this->getService(BetterNodeFinder::class);
         $this->phpDocInfoPrinter = $this->getService(PhpDocInfoPrinter::class);
         $this->phpDocInfoFactory = $this->getService(PhpDocInfoFactory::class);
@@ -153,6 +156,7 @@ private function doTestContainsTagValueNodeType(
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
         $hasByAnnotationClass = $phpDocInfo->hasByAnnotationClass($annotationClass);
 
-        $this->assertTrue($hasByAnnotationClass, $smartFileInfo->getRelativeFilePathFromCwd());
+        $relativeFilePath = $this->filePathHelper->relativePath($smartFileInfo->getRealPath());
+        $this->assertTrue($hasByAnnotationClass, $relativeFilePath);
     }
 }
diff --git a/...ngesReporting/Annotation/AppliedRectorsChangelogResolver/RectorsChangelogResolverTest.php b/...ngesReporting/Annotation/AppliedRectorsChangelogResolver/RectorsChangelogResolverTest.php
@@ -6,6 +6,7 @@
 
 use Rector\ChangesReporting\Annotation\RectorsChangelogResolver;
 use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
+use Rector\Core\FileSystem\FilePathHelper;
 use Rector\Core\ValueObject\Reporting\FileDiff;
 use Rector\Testing\PHPUnit\AbstractTestCase;
 use Rector\Tests\ChangesReporting\Annotation\AppliedRectorsChangelogResolver\Source\RectorWithChangelog;
@@ -18,10 +19,13 @@ final class RectorsChangelogResolverTest extends AbstractTestCase
 
     private FileDiff $fileDiff;
 
+    private FilePathHelper $filePathHelper;
+
     protected function setUp(): void
     {
         $this->boot();
         $this->rectorsChangelogResolver = $this->getService(RectorsChangelogResolver::class);
+        $this->filePathHelper = $this->getService(FilePathHelper::class);
 
         $this->fileDiff = $this->createFileDiff();
     }
@@ -39,13 +43,16 @@ public function test(): void
     private function createFileDiff(): FileDiff
     {
         // This is by intention to test the array_unique functionality
-        $rectorWithLineChanges = [];
-        $rectorWithLineChanges[] = new RectorWithLineChange(RectorWithChangelog::class, 1);
-        $rectorWithLineChanges[] = new RectorWithLineChange(RectorWithChangelog::class, 1);
-        $rectorWithLineChanges[] = new RectorWithLineChange(RectorWithOutChangelog::class, 1);
+        $rectorWithLineChanges = [
+            new RectorWithLineChange(RectorWithChangelog::class, 1),
+            new RectorWithLineChange(RectorWithChangelog::class, 1),
+            new RectorWithLineChange(RectorWithOutChangelog::class, 1),
+        ];
 
         $smartFileInfo = new SmartFileInfo(__FILE__);
 
-        return new FileDiff($smartFileInfo->getRelativeFilePathFromCwd(), 'foo', 'foo', $rectorWithLineChanges);
+        $relativeFilePath = $this->filePathHelper->relativePath($smartFileInfo->getRealPath());
+
+        return new FileDiff($relativeFilePath, 'foo', 'foo', $rectorWithLineChanges);
     }
 }
diff --git a/packages-tests/Comments/CommentRemover/CommentRemoverTest.php b/packages-tests/Comments/CommentRemover/CommentRemoverTest.php
@@ -47,8 +47,7 @@ public function test(SmartFileInfo $smartFileInfo): void
         $fileContent = trim($fileContent);
 
         $expectedContent = trim((string) $fileInfoToLocalInputAndExpected->getExpected());
-
-        $this->assertSame($fileContent, $expectedContent, $smartFileInfo->getRelativeFilePathFromCwd());
+        $this->assertSame($fileContent, $expectedContent);
 
         // original nodes are not touched
         $originalContent = $this->nodePrinter->print($nodes);

diff --git a/packages/ChangesReporting/ValueObjectFactory/ErrorFactory.php b/packages/ChangesReporting/ValueObjectFactory/ErrorFactory.php
@@ -6,13 +6,15 @@
 
 use PHPStan\AnalysedCodeException;
 use Rector\Core\Error\ExceptionCorrector;
+use Rector\Core\FileSystem\FilePathHelper;
 use Rector\Core\ValueObject\Error\SystemError;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
 final class ErrorFactory
 {
     public function __construct(
-        private readonly ExceptionCorrector $exceptionCorrector
+        private readonly ExceptionCorrector $exceptionCorrector,
+        private readonly FilePathHelper $filePathHelper
     ) {
     }
 
@@ -21,6 +23,8 @@ public function createAutoloadError(
         SmartFileInfo $smartFileInfo
     ): SystemError {
         $message = $this->exceptionCorrector->getAutoloadExceptionMessageAndAddLocation($analysedCodeException);
-        return new SystemError($message, $smartFileInfo->getRelativeFilePathFromCwd());
+        $relativeFilePath = $this->filePathHelper->relativePath($smartFileInfo->getRealPath());
+
+        return new SystemError($message, $relativeFilePath);
     }
 }
diff --git a/packages/NodeNameResolver/Error/InvalidNameNodeReporter.php b/packages/NodeNameResolver/Error/InvalidNameNodeReporter.php
@@ -9,9 +9,9 @@
 use Rector\Core\Contract\PhpParser\NodePrinterInterface;
 use Rector\Core\Contract\Rector\RectorInterface;
 use Rector\Core\Exception\ShouldNotHappenException;
+use Rector\Core\FileSystem\FilePathHelper;
 use Rector\Core\Provider\CurrentFileProvider;
 use Rector\Core\ValueObject\Application\File;
-use Symplify\SmartFileSystem\SmartFileInfo;
 
 final class InvalidNameNodeReporter
 {
@@ -22,7 +22,8 @@ final class InvalidNameNodeReporter
 
     public function __construct(
         private readonly CurrentFileProvider $currentFileProvider,
-        private readonly NodePrinterInterface $nodePrinter
+        private readonly NodePrinterInterface $nodePrinter,
+        private readonly FilePathHelper $filePathHelper
     ) {
     }
 
@@ -35,9 +36,12 @@ public function reportInvalidNodeForName(MethodCall | StaticCall $node): void
         if ($file instanceof File) {
             $smartFileInfo = $file->getSmartFileInfo();
             $message .= PHP_EOL . PHP_EOL;
+
+            $relatilveFilePath = $this->filePathHelper->relativePath($smartFileInfo->getRealPath());
+
             $message .= sprintf(
                 'Caused in "%s" file on line %d on code "%s"',
-                $smartFileInfo->getRelativeFilePathFromCwd(),
+                $relatilveFilePath,
                 $node->getStartLine(),
                 $this->nodePrinter->print($node)
             );
@@ -49,8 +53,9 @@ public function reportInvalidNodeForName(MethodCall | StaticCall $node): void
         if ($rectorBacktrace !== null) {
             // issues to find the file in prefixed
             if (file_exists($rectorBacktrace[self::FILE])) {
-                $smartFileInfo = new SmartFileInfo($rectorBacktrace[self::FILE]);
-                $fileAndLine = $smartFileInfo->getRelativeFilePathFromCwd() . ':' . $rectorBacktrace['line'];
+                $filePath = $rectorBacktrace[self::FILE];
+                $relatilveFilePath = $this->filePathHelper->relativePath($filePath);
+                $fileAndLine = $relatilveFilePath . ':' . $rectorBacktrace['line'];
             } else {
                 $fileAndLine = $rectorBacktrace[self::FILE] . ':' . $rectorBacktrace['line'];
             }

diff --git a/packages/Testing/PHPUnit/AbstractRectorTestCase.php b/packages/Testing/PHPUnit/AbstractRectorTestCase.php
@@ -44,20 +44,7 @@ protected function setUp(): void
     {
         // speed up
         @ini_set('memory_limit', '-1');
-
-        // include local files
-        if (file_exists(__DIR__ . '/../../../preload.php')) {
-            if (file_exists(__DIR__ . '/../../../vendor')) {
-                require_once __DIR__ . '/../../../preload.php';
-            // test case in rector split package
-            } elseif (file_exists(__DIR__ . '/../../../../../../vendor')) {
-                require_once __DIR__ . '/../../../preload-split-package.php';
-            }
-        }
-
-        if (\file_exists(__DIR__ . '/../../../vendor/scoper-autoload.php')) {
-            require_once __DIR__ . '/../../../vendor/scoper-autoload.php';
-        }
+        $this->includePreloadFilesAndScoperAutoload();
 
         $configFile = $this->provideConfigFilePath();
         $this->bootFromConfigFiles([$configFile]);
@@ -131,6 +118,22 @@ protected function getFixtureTempDirectory(): string
         return sys_get_temp_dir() . '/_temp_fixture_easy_testing';
     }
 
+    private function includePreloadFilesAndScoperAutoload(): void
+    {
+        if (file_exists(__DIR__ . '/../../../preload.php')) {
+            if (file_exists(__DIR__ . '/../../../vendor')) {
+                require_once __DIR__ . '/../../../preload.php';
+            // test case in rector split package
+            } elseif (file_exists(__DIR__ . '/../../../../../../vendor')) {
+                require_once __DIR__ . '/../../../preload-split-package.php';
+            }
+        }
+
+        if (\file_exists(__DIR__ . '/../../../vendor/scoper-autoload.php')) {
+            require_once __DIR__ . '/../../../vendor/scoper-autoload.php';
+        }
+    }
+
     private function doTestFileMatchesExpectedContent(
         SmartFileInfo $originalFileInfo,
         SmartFileInfo $expectedFileInfo,
@@ -146,10 +149,8 @@ private function doTestFileMatchesExpectedContent(
             return;
         }
 
-        $relativeFilePathFromCwd = $fixtureFileInfo->getRelativeFilePathFromCwd();
-
         try {
-            $this->assertStringEqualsFile($expectedFileInfo->getRealPath(), $changedContent, $relativeFilePathFromCwd);
+            $this->assertStringEqualsFile($expectedFileInfo->getRealPath(), $changedContent);
         } catch (ExpectationFailedException $expectationFailedException) {
             if (! $allowMatches) {
                 throw $expectationFailedException;
@@ -162,7 +163,7 @@ private function doTestFileMatchesExpectedContent(
             $contents = $this->normalizeNewlines($contents);
 
             // if not exact match, check the regex version (useful for generated hashes/uuids in the code)
-            $this->assertStringMatchesFormat($contents, $changedContent, $relativeFilePathFromCwd);
+            $this->assertStringMatchesFormat($contents, $changedContent);
         }
     }
 

diff --git a/rules-tests/Naming/Naming/UseImportsResolver/UseImportsResolverTest.php b/rules-tests/Naming/Naming/UseImportsResolver/UseImportsResolverTest.php
@@ -61,7 +61,6 @@ public function testUsesFromProperty(SmartFileInfo $file): void
      */
     public function provideData(): Iterator
     {
-        $directory = __DIR__ . '/Fixture';
-        return StaticFixtureFinder::yieldDirectoryExclusively($directory);
+        return StaticFixtureFinder::yieldDirectoryExclusively(__DIR__ . '/Fixture');
     }
 }
diff --git a/src/FileSystem/FilePathHelper.php b/src/FileSystem/FilePathHelper.php
@@ -5,6 +5,7 @@
 namespace Rector\Core\FileSystem;
 
 use Symfony\Component\Filesystem\Filesystem;
+use Webmozart\Assert\Assert;
 
 final class FilePathHelper
 {
@@ -15,14 +16,21 @@ public function __construct(
 
     public function relativePath(string $fileRealPath): string
     {
+        return $this->relativeFilePathFromDirectory($fileRealPath, getcwd());
+    }
+
+    /**
+     * @api
+     */
+    public function relativeFilePathFromDirectory(string $fileRealPath, string $directory): string
+    {
+        Assert::directory($directory);
+
         $normalizedFileRealPath = $this->normalizePath($fileRealPath);
 
-        $relativeFilePath = $this->filesystem->makePathRelative(
-            $normalizedFileRealPath,
-            (string) realpath(getcwd())
-        );
+        $relativeFilePath = $this->filesystem->makePathRelative($normalizedFileRealPath, $directory);
 
-        return \rtrim($relativeFilePath, '/');
+        return rtrim($relativeFilePath, '/');
     }
 
     private function normalizePath(string $filePath): string

diff --git a/src/NonPhpFile/Rector/RenameClassNonPhpRector.php b/src/NonPhpFile/Rector/RenameClassNonPhpRector.php
@@ -88,7 +88,7 @@ public function configure(array $configuration): void
      */
     private function renameClasses(string $newContent, array $classRenames): string
     {
-        $classRenames = $this->addDoubleSlahed($classRenames);
+        $classRenames = $this->addDoubleSlashed($classRenames);
 
         foreach ($classRenames as $oldClass => $newClass) {
             // the old class is without slashes, it can make mess as similar to a word in the text, so we have to be more strict about it
@@ -109,7 +109,7 @@ private function renameClasses(string $newContent, array $classRenames): string
      * @param array<string, string> $classRenames
      * @return array<string, string>
      */
-    private function addDoubleSlahed(array $classRenames): array
+    private function addDoubleSlashed(array $classRenames): array
     {
         foreach ($classRenames as $oldClass => $newClass) {
             // to prevent no slash override