Skip to content

Commit

Permalink
[tests] Keep original methods naming for easier upgrade (#2893)
Browse files Browse the repository at this point in the history
Co-authored-by: GitHub Action <action@github.com>
  • Loading branch information
TomasVotruba and actions-user committed Sep 2, 2022
1 parent dc22a95 commit 6fa3ade
Show file tree
Hide file tree
Showing 542 changed files with 555 additions and 563 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"rector/rector-phpunit": "dev-main",
"rector/rector-symfony": "dev-main",
"sebastian/diff": "^4.0.4",
"symfony/config": "^6.0",
"symfony/console": "^6.0",
"symfony/contracts": "^3.1",
"symfony/dependency-injection": "^6.1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ protected function createPhpDocInfoFromDocCommentAndNode(string $docComment, Nod
* This is a new way to load test fixtures :)
* @return Iterator<array<int, string>>
*/
protected function yieldFilePathsFromDirectory(string $directory, string $suffix = '*.php'): Iterator
protected function yieldFilesFromDirectory(string $directory, string $suffix = '*.php'): Iterator
{
return FixtureFileFinder::yieldFilePathsFromDirectory($directory, $suffix);
return FixtureFileFinder::yieldDirectory($directory, $suffix);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ public function testRemoveSpace(): void

public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/FixtureBasic', '*.txt');
return $this->yieldFilesFromDirectory(__DIR__ . '/FixtureBasic', '*.txt');
}

public function provideDataCallable(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/FixtureCallable', '*.txt');
return $this->yieldFilesFromDirectory(__DIR__ . '/FixtureCallable', '*.txt');
}

/**
Expand All @@ -51,7 +51,7 @@ public function testEmpty(string $filePath): void

public function provideDataEmpty(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/FixtureEmpty', '*.txt');
return $this->yieldFilesFromDirectory(__DIR__ . '/FixtureEmpty', '*.txt');
}

private function doComparePrintedFileEquals(string $inputFilePath, string $expectedFilePath): void
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ public function testResolvesClass(string $filePath): void

public function provideData(): Iterator
{
return FixtureFileFinder::yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return FixtureFileFinder::yieldDirectory(__DIR__ . '/Fixture');
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ public function test(string $filePath): void

public function provideData(): Iterator
{
return FixtureFileFinder::yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return FixtureFileFinder::yieldDirectory(__DIR__ . '/Fixture');
}

public function provideDataNested(): Iterator
{
return FixtureFileFinder::yieldFilePathsFromDirectory(__DIR__ . '/FixtureNested');
return FixtureFileFinder::yieldDirectory(__DIR__ . '/FixtureNested');
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ public function test(string $filePath): void

public function provideData(): Iterator
{
return FixtureFileFinder::yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return FixtureFileFinder::yieldDirectory(__DIR__ . '/Fixture');
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public function test(string $filePath): void

public function provideData(): Iterator
{
return FixtureFileFinder::yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return FixtureFileFinder::yieldDirectory(__DIR__ . '/Fixture');
}

private function doTestFile(string $filePath): void
Expand Down
18 changes: 4 additions & 14 deletions packages/Testing/Fixture/FixtureFileFinder.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,16 @@ final class FixtureFileFinder
/**
* @return Iterator<array<int, string>>
*/
public static function yieldFilePathsFromDirectory(string $directory, string $suffix = '*.php.inc'): Iterator
{
$fileInfos = self::findFilesInDirectory($directory, $suffix);

foreach ($fileInfos as $fileInfo) {
yield [$fileInfo->getRealPath()];
}
}

/**
* @return SplFileInfo[]
*/
private static function findFilesInDirectory(string $directory, string $suffix): array
public static function yieldDirectory(string $directory, string $suffix = '*.php.inc'): Iterator
{
$finder = (new Finder())
->in($directory)
->files()
->name($suffix);

$fileInfos = iterator_to_array($finder);
return array_values($fileInfos);
foreach ($fileInfos as $fileInfo) {
yield [$fileInfo->getRealPath()];
}
}
}
7 changes: 4 additions & 3 deletions packages/Testing/PHPUnit/AbstractRectorTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,19 +83,20 @@ protected function tearDown(): void
}

/**
* @deprecated Use \Rector\Testing\PHPUnit\AbstractRectorTestCase::yieldFilePathsFromDirectory() instead
* @return Iterator<<string>>
*/
protected function yieldFilesFromDirectory(string $directory, string $suffix = '*.php.inc'): Iterator
{
return FixtureFileFinder::yieldDirectory($directory, $suffix);
}

/**
* @return Iterator<<string>>
* @api
* @deprecated BC alias for yieldFilesFromDirectory()
*/
protected function yieldFilePathsFromDirectory(string $directory, string $suffix = '*.php.inc'): Iterator
{
return FixtureFileFinder::yieldFilePathsFromDirectory($directory, $suffix);
return $this->yieldFilesFromDirectory($directory, $suffix);
}

protected function isWindows(): bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public function test(string $filePath): void

public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/FixtureUnionTypes');
return $this->yieldFilesFromDirectory(__DIR__ . '/FixtureUnionTypes');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function test(string $filePath): void
*/
public function provideData(): Iterator
{
return $this->yieldFilePathsFromDirectory(__DIR__ . '/Fixture');
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
Expand Down
Loading

0 comments on commit 6fa3ade

Please sign in to comment.