Skip to content

Commit

Permalink
Include excluded files (#2593)
Browse files Browse the repository at this point in the history 
* Take hirarchy into account

* Simplifying the implemenation

* Adding test for default behaviour

* Fixing the path sorting

* CS

* Adding comments to explain the behaviour.
  • Loading branch information
@mamazu
mamazu committed Mar 14, 2024
1 parent 22ae0f7 commit ea02ce0
Show file tree
Hide file tree
Showing 5 changed files with 164 additions and 37 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Expand Up @@ -7,6 +7,9 @@ Improvements:

- Basic support for `array_reduce` stub #2576

Bug fixes:

- Fixing include and exclude patterns #2593 @mamazu

## 2024-03-09

Expand Down Expand Up @@ -58,7 +61,7 @@ Bug fixes:

Documentation:

- Added Helix LSP instructions #2581 @lens0021
- Added Helix LSP instructions #2581 @lens0021
- Fix typos in Behat #2534 @vuon9
- Fix broken external links #2500 @einenlum

Expand Down
60 changes: 42 additions & 18 deletions lib/Filesystem/Domain/FileList.php
View file
Expand Up @@ -86,30 +86,51 @@ public function byExtensions(array $extensions): self
}

/**
* @param string[] $globPatterns
* @param string[] $includePatterns
* @param string[] $excludePatterns
*/
public function excludePatterns(array $globPatterns): self
public function includeAndExclude(array $includePatterns = [], array $excludePatterns = []): self
{
return $this->filter(function (SplFileInfo $info) use ($globPatterns) {
foreach ($globPatterns as $pattern) {
if (Glob::match($info->getPathname(), $pattern)) {
return false;
}
$inclusionMap = [];
if ($includePatterns === []) {
$inclusionMap['/**/*'] = true;
}

foreach ($includePatterns as $includePattern) {
$inclusionMap[$includePattern] = true;
}
foreach ($excludePatterns as $excludePattern) {
$inclusionMap[$excludePattern] = false;
}

// Sort map by keys so that more specific paths are getting matched first
uksort($inclusionMap, function (string $a, string $b) {
$partsA = explode(DIRECTORY_SEPARATOR, $a);
$partsB = explode(DIRECTORY_SEPARATOR, $b);
$countDiff = count($partsA) <=> count($partsB);
if ($countDiff !== 0) {
// Longer paths should come first
return -$countDiff;
}

return true;
foreach ($partsA as $i => $pathPartA) {
if ($pathPartA === '**' || $pathPartA === '*') {
return 1;
}

$compare = strcmp($pathPartA, $partsB[$i]);
if($compare !== 0) {
return $compare;
}
}
// If none of the path segments were different, then they must be equal
return 0;
});
}

/**
* @param string[] $globPatterns
*/
public function includePatterns(array $globPatterns): self
{
return $this->filter(function (SplFileInfo $info) use ($globPatterns) {
foreach ($globPatterns as $pattern) {
if (Glob::match($info->getPathname(), $pattern)) {
return true;
return $this->filter(function (SplFileInfo $info) use ($inclusionMap): bool {
foreach($inclusionMap as $glob => $isIncluded) {
if (Glob::match($info->getPathname(), $glob)) {
return $isIncluded;
}
}

Expand All @@ -133,6 +154,9 @@ public function named(string $name): self
)));
}

/**
* @param Closure(SplFileInfo): bool $closure
*/
public function filter(Closure $closure): self
{
return new self(new CallbackFilterIterator($this->iterator, $closure));
Expand Down
119 changes: 113 additions & 6 deletions lib/Filesystem/Tests/Unit/Domain/FileListTest.php
View file
Expand Up @@ -2,6 +2,7 @@

namespace Phpactor\Filesystem\Tests\Unit\Domain;

use Generator;
use Phpactor\Filesystem\Domain\FileList;
use Phpactor\Filesystem\Domain\FilePath;
use Phpactor\Filesystem\Tests\IntegrationTestCase;
Expand Down Expand Up @@ -121,9 +122,16 @@ public function testExcludesFilesMatchingPatterns(): void
FilePath::fromString('/vendor/foo/bar/src/foo.php'),
]);

self::assertCount(2, $list->excludePatterns([
'/vendor/**/tests/*',
]));
self::assertEquals(
[
FilePath::fromString('/vendor/foo/bar/src/bar.php'),
FilePath::fromString('/vendor/foo/bar/src/foo.php'),
],
iterator_to_array($list->includeAndExclude(
includePatterns: ['/**/*'],
excludePatterns: [ '/vendor/**/tests/*']
))
);
}

public function testIncldesFilesMatchingPatterns(): void
Expand All @@ -135,9 +143,108 @@ public function testIncldesFilesMatchingPatterns(): void
FilePath::fromString('/vendor/foo/bar/src/foo.php'),
]);

self::assertCount(2, $list->excludePatterns([
'/vendor/**/tests/*',
]));
self::assertEquals(
[
FilePath::fromString('/vendor/foo/bar/tests/bartest.php'),
FilePath::fromString('/vendor/foo/bar/tests/footest.php'),
],
iterator_to_array($list->includeAndExclude(
includePatterns: [ '/vendor/**/tests/*'],
))
);
}

public function testIncludesEverythingByDefault(): void
{
$list = FileList::fromFilePaths([
FilePath::fromString('/vendor/cache/important/bartest.php'),
FilePath::fromString('/vendor/cache/important/footest.php'),
FilePath::fromString('/vendor/cache/bar.php'),
FilePath::fromString('/vendor/cache/foo.php'),
])->includeAndExclude(
includePatterns: [],
excludePatterns: [],
);

self::assertEquals(
[
FilePath::fromString('/vendor/cache/important/bartest.php'),
FilePath::fromString('/vendor/cache/important/footest.php'),
FilePath::fromString('/vendor/cache/bar.php'),
FilePath::fromString('/vendor/cache/foo.php'),
],
iterator_to_array($list)
);
}

public function testIncludesExcludePatterns(): void
{
$list = FileList::fromFilePaths([
FilePath::fromString('/vendor/cache/important/bartest.php'),
FilePath::fromString('/vendor/cache/important/footest.php'),
FilePath::fromString('/vendor/cache/bar.php'),
FilePath::fromString('/vendor/cache/foo.php'),
])->includeAndExclude(
includePatterns: [ '/src/**/*', '/vendor/cache/important/**/*'],
excludePatterns: [ '/vendor/**/*' ],
);

self::assertEquals(
[
FilePath::fromString('/vendor/cache/important/bartest.php'),
FilePath::fromString('/vendor/cache/important/footest.php'),
],
iterator_to_array($list)
);
}

/**
* @param array<FilePath> $fileList
* @param array<string> $includePatterns
* @param array<string> $excludePatterns
* @param array<FilePath> $expected
*
* @dataProvider provideExcludesWithShortFolderName
*/
public function testExcludesWithShortFolderName(
array $fileList,
array $includePatterns,
array $excludePatterns,
array $expected,
): void {
$list = FileList::fromFilePaths($fileList)->includeAndExclude(
includePatterns:$includePatterns,
excludePatterns: $excludePatterns
);

self::assertEquals($expected, array_map(fn (FilePath $x) => (string) $x, iterator_to_array($list)));
}

public function provideExcludesWithShortFolderName(): Generator
{
yield 'ascii file name' => [
[
FilePath::fromString('/src/package/test.php'),
FilePath::fromString('/src/a/test.php'),
],
[ '/src/**/*'],
[ '/src/a/*' ],
[
'/src/package/test.php',
],
];

yield 'unicode file name' => [
[
FilePath::fromString('/src/package/test.php'),
FilePath::fromString('/src/ü/test.php'),
],
[ '/src/**/*'],
[ '/src/ü/*' ],
[
'/src/package/test.php',
],
];
}

public function testContainingString(): void
Expand Down
13 changes: 4 additions & 9 deletions lib/Indexer/Adapter/Filesystem/FilesystemFileListProvider.php
View file
Expand Up @@ -30,15 +30,10 @@ public function provideFileList(Index $index, ?string $subPath = null): FileList
return FileList::fromSingleFilePath($subPath);
}

$files = $this->filesystem->fileList()->byExtensions($this->supportedExtensions);

if ($this->includePatterns) {
$files = $files->includePatterns($this->includePatterns);
}

if ($this->excludePatterns) {
$files = $files->excludePatterns($this->excludePatterns);
}
$files = $this->filesystem->fileList()
->byExtensions($this->supportedExtensions)
->includeAndExclude($this->includePatterns, $this->excludePatterns)
;

if ($subPath) {
$files = $files->within(FilePath::fromString($subPath));
Expand Down
4 changes: 1 addition & 3 deletions lib/Indexer/Extension/IndexerExtension.php
View file
Expand Up @@ -224,9 +224,7 @@ private function registerModel(ContainerBuilder $container): void
->setIncludePatterns($container->get(self::SERVICE_INDEXER_INCLUDE_PATTERNS))
/** @phpstan-ignore-next-line */
->setSupportedExtensions($container->parameter(self::PARAM_SUPPORTED_EXTENSIONS)->value())
->setFollowSymlinks(
(bool) $container->getParameter(self::PARAM_INDEXER_FOLLOW_SYMLINKS),
)
->setFollowSymlinks($container->parameter(self::PARAM_INDEXER_FOLLOW_SYMLINKS)->bool())
->setStubPaths($container->getParameter(self::PARAM_STUB_PATHS));
});

Expand Down

0 comments on commit ea02ce0

Please sign in to comment.