Skip to content

Commit

Permalink
Merge pull request #9813 from 2e3s/recursive-glob
Browse files Browse the repository at this point in the history 
Add a support for multilevel glob wildcards
  • Loading branch information
@orklah
orklah committed May 24, 2023
2 parents 8e8a11d + 72b4ab9 commit b99857c
Show file tree
Hide file tree
Showing 2 changed files with 145 additions and 20 deletions.
79 changes: 60 additions & 19 deletions src/Psalm/Config/FileFilter.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,17 @@

use function array_filter;
use function array_map;
use function array_merge;
use function array_shift;
use function count;
use function explode;
use function glob;
use function in_array;
use function is_dir;
use function is_iterable;
use function preg_match;
use function preg_replace;
use function preg_split;
use function readlink;
use function realpath;
use function restore_error_handler;
Expand Down Expand Up @@ -129,10 +134,12 @@ public static function loadFromArray(
}

if (strpos($prospective_directory_path, '*') !== false) {
$globs = array_map(
'realpath',
glob($prospective_directory_path, GLOB_ONLYDIR),
);
// Strip meaningless trailing recursive wildcard like "path/**/" or "path/**"
$prospective_directory_path = preg_replace('#(\/\*\*)+\/?$#', '/', $prospective_directory_path);
// Split by /**/, allow duplicated wildcards like "path/**/**/path" and any leading dir separator.
/** @var non-empty-list<non-empty-string> $path_parts */
$path_parts = preg_split('#(\/|\\\)(\*\*\/)+#', $prospective_directory_path);
$globs = self::recursiveGlob($path_parts, true);

if (empty($globs)) {
if ($allow_missing_files) {
Expand All @@ -145,8 +152,8 @@ public static function loadFromArray(
);
}

foreach ($globs as $glob_index => $directory_path) {
if (!$directory_path) {
foreach ($globs as $glob_index => $glob_directory_path) {
if (!$glob_directory_path) {
if ($allow_missing_files) {
continue;
}
Expand All @@ -158,14 +165,14 @@ public static function loadFromArray(
}

if ($ignore_type_stats && $filter instanceof ProjectFileFilter) {
$filter->ignore_type_stats[$directory_path] = true;
$filter->ignore_type_stats[$glob_directory_path] = true;
}

if ($declare_strict_types && $filter instanceof ProjectFileFilter) {
$filter->declare_strict_types[$directory_path] = true;
$filter->declare_strict_types[$glob_directory_path] = true;
}

$filter->addDirectory($directory_path);
$filter->addDirectory($glob_directory_path);
}
continue;
}
Expand Down Expand Up @@ -246,13 +253,10 @@ public static function loadFromArray(
}

if (strpos($prospective_file_path, '*') !== false) {
$globs = array_map(
'realpath',
array_filter(
glob($prospective_file_path, GLOB_NOSORT),
'file_exists',
),
);
// Split by /**/, allow duplicated wildcards like "path/**/**/path" and any leading dir separator.
/** @var non-empty-list<non-empty-string> $path_parts */
$path_parts = preg_split('#(\/|\\\)(\*\*\/)+#', $prospective_file_path);
$globs = self::recursiveGlob($path_parts, false);

if (empty($globs)) {
if ($allow_missing_files) {
Expand All @@ -265,14 +269,18 @@ public static function loadFromArray(
);
}

foreach ($globs as $glob_index => $file_path) {
if (!$file_path && !$allow_missing_files) {
foreach ($globs as $glob_index => $glob_file_path) {
if (!$glob_file_path) {
if ($allow_missing_files) {
continue;
}

throw new ConfigException(
'Could not resolve config path to ' . $base_dir . DIRECTORY_SEPARATOR .
$file_path . ':' . $glob_index,
);
}
$filter->addFile($file_path);
$filter->addFile($glob_file_path);
}
continue;
}
Expand Down Expand Up @@ -445,6 +453,39 @@ private static function isRegularExpression(string $string): bool
return $is_regexp;
}

/**
* @mutation-free
* @param non-empty-list<non-empty-string> $parts
* @return array<string|false>
*/
private static function recursiveGlob(array $parts, bool $only_dir): array
{
if (count($parts) < 2) {
if ($only_dir) {
$list = glob($parts[0], GLOB_ONLYDIR | GLOB_NOSORT) ?: [];
} else {
$list = array_filter(
glob($parts[0], GLOB_NOSORT) ?: [],
'file_exists',
);
}

return array_map('realpath', $list);
}

$first_dir = self::slashify($parts[0]);
$paths = glob($first_dir . '*', GLOB_ONLYDIR | GLOB_NOSORT);
$result = [];
foreach ($paths as $path) {
$parts[0] = $path;
$result = array_merge($result, self::recursiveGlob($parts, $only_dir));
}
array_shift($parts);
$parts[0] = $first_dir . $parts[0];

return array_merge($result, self::recursiveGlob($parts, $only_dir));
}

/**
* @psalm-pure
*/
Expand Down
86 changes: 85 additions & 1 deletion tests/Config/ConfigTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ public function testIgnoreWildcardProjectDirectory(): void
<projectFiles>
<directory name="src" />
<ignoreFiles>
<directory name="src/**/Internal/Analyzer" />
<directory name="src/*/Internal/Analyzer" />
</ignoreFiles>
</projectFiles>
</psalm>',
Expand All @@ -248,6 +248,54 @@ public function testIgnoreWildcardProjectDirectory(): void
$this->assertFalse($config->isInProjectDirs(realpath('examples/TemplateScanner.php')));
}

public function testIgnoreRecursiveWildcardProjectDirectory(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<ignoreFiles>
<directory name="src/**/BinaryOp*" />
</ignoreFiles>
</projectFiles>
</psalm>',
),
);

$config = $this->project_analyzer->getConfig();

$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOpAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOp/OrAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Node/Expr/BinaryOp/VirtualPlus.php')));
}

public function testIgnoreRecursiveDoubleWildcardProjectFiles(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<ignoreFiles>
<file name="src/**/*Analyzer.php" />
</ignoreFiles>
</projectFiles>
</psalm>',
),
);

$config = $this->project_analyzer->getConfig();

$this->assertTrue($config->isInProjectDirs(realpath('src/Psalm/Type.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/FileAnalyzer.php')));
$this->assertFalse($config->isInProjectDirs(realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));
}

public function testIgnoreWildcardFiles(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Expand Down Expand Up @@ -1682,6 +1730,42 @@ public function testConfigFileWithXIncludeWithFallback(): void
$this->assertFalse($config->reportIssueInFile('MixedAssignment', realpath('src/Psalm/Type.php')));
}

public function testConfigFileWithWildcardPathIssueHandler(): void
{
$this->project_analyzer = $this->getProjectAnalyzerWithConfig(
Config::loadFromXML(
dirname(__DIR__, 2),
'<?xml version="1.0"?>
<psalm>
<projectFiles>
<directory name="src" />
<directory name="tests" />
</projectFiles>
<issueHandlers>
<MissingReturnType>
<errorLevel type="suppress">
<file name="src/**/*TypeAlias.php" />
<directory name="src/**/BinaryOp*" />
</errorLevel>
</MissingReturnType>
</issueHandlers>
</psalm>',
),
);

$config = $this->project_analyzer->getConfig();

$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath(__FILE__)));
$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Type.php')));
$this->assertTrue($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php')));

$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Node/Expr/BinaryOp/VirtualPlus.php')));
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Analyzer/Statements/Expression/BinaryOp/OrAnalyzer.php')));
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Type/TypeAlias.php')));
$this->assertFalse($config->reportIssueInFile('MissingReturnType', realpath('src/Psalm/Internal/Type/TypeAlias/ClassTypeAlias.php')));
}

/**
* @requires extension apcu
* @deprecated Remove in Psalm 6.
Expand Down

0 comments on commit b99857c

Please sign in to comment.