Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Dirname return type non empty string #9837

Merged
merged 6 commits into from May 30, 2023
Merged

Dirname return type non empty string #9837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f9f1cc2
dirname returns non-empty-string when a non-empty-string is passed an…
kkmuffme May 30, 2023
a33c80d
dirname level must be > 0 otherwise fatal
kkmuffme May 30, 2023
25c7f37
add test, fix wrong test and fix shepherd
kkmuffme May 30, 2023
9d7d4bf
non-empty-string always returs non-empty-string, fix tests
kkmuffme May 30, 2023
c185437
fix string format in test
kkmuffme May 30, 2023
e3e7373
fix test string format
kkmuffme May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion dictionaries/CallMap.php
View file
Open in desktop
Expand Up @@ -1613,7 +1613,7 @@
'DirectoryIterator::setFileClass' => ['void', 'class='=>'class-string'],
'DirectoryIterator::setInfoClass' => ['void', 'class='=>'class-string'],
'DirectoryIterator::valid' => ['bool'],
'dirname' => ['string', 'path'=>'string', 'levels='=>'int'],
'dirname' => ['string', 'path'=>'string', 'levels='=>'int<1, max>'],
'disk_free_space' => ['float|false', 'directory'=>'string'],
'disk_total_space' => ['float|false', 'directory'=>'string'],
'diskfreespace' => ['float|false', 'directory'=>'string'],
Expand Down
2 changes: 1 addition & 1 deletion dictionaries/CallMap_historical.php
View file
Open in desktop
Expand Up @@ -9995,7 +9995,7 @@
'dio_truncate' => ['bool', 'fd'=>'resource', 'offset'=>'int'],
'dio_write' => ['int', 'fd'=>'resource', 'data'=>'string', 'length='=>'int'],
'dir' => ['Directory|false', 'directory'=>'string', 'context='=>'resource'],
'dirname' => ['string', 'path'=>'string', 'levels='=>'int'],
'dirname' => ['string', 'path'=>'string', 'levels='=>'int<1, max>'],
'disk_free_space' => ['float|false', 'directory'=>'string'],
'disk_total_space' => ['float|false', 'directory'=>'string'],
'diskfreespace' => ['float|false', 'directory'=>'string'],
Expand Down
4 changes: 4 additions & 0 deletions src/Psalm/Internal/Analyzer/Statements/Expression/IncludeAnalyzer.php
View file
Open in desktop
Expand Up @@ -369,6 +369,10 @@ public static function getPathTo(
return null;
}

if ($dir_level < 1) {
return null;
}

return dirname($evaled_path, $dir_level);
}
} elseif ($stmt instanceof PhpParser\Node\Expr\ConstFetch) {
Expand Down
11 changes: 11 additions & 0 deletions src/Psalm/Internal/Provider/ReturnTypeProvider/DirnameReturnTypeProvider.php
View file
Open in desktop
Expand Up @@ -9,6 +9,7 @@
use Psalm\Plugin\EventHandler\FunctionReturnTypeProviderInterface;
use Psalm\Type;
use Psalm\Type\Atomic\TLiteralInt;
use Psalm\Type\Atomic\TNonEmptyString;
use Psalm\Type\Union;

use function array_values;
Expand Down Expand Up @@ -61,6 +62,16 @@ public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $ev
$statements_source->getCodebase()->config,
);

if ($evaled_path === null) {
$type = $node_type_provider->getType($call_args[0]->value);
if ($type !== null && $type->isSingle()) {
$atomic_type = array_values($type->getAtomicTypes())[0];
if ($atomic_type instanceof TNonEmptyString) {
return Type::getNonEmptyString();
}
}
}

if ($evaled_path === null) {
return Type::getString();
}
Expand Down
15 changes: 12 additions & 3 deletions tests/ReturnTypeProvider/DirnameTest.php
View file
Open in desktop
Expand Up @@ -35,12 +35,21 @@ public function providerValidCodeParse(): iterable
],
];

yield 'dirnameOfIntLevelReturnsString' => [
yield 'dirnameOfIntLevelLiteralReturnsLiteral' => [
'code' => '<?php
$dir = dirname("' . $input . '", 0);
$dir = dirname("' . $input . '", 10);
',
'assertions' => [
'$dir===' => 'string',
'$dir===' => "'.'",
],
];

yield 'dirnameOfNonEmptyStringIntLevelOneReturnsNonEmptyString' => [
'code' => '<?php
$dir = dirname(uniqid() . "abc", 2);
',
'assertions' => [
'$dir===' => 'non-empty-string',
],
];
}
Expand Down