Skip to content

Commit

Permalink
add basename return type provider
Browse files Browse the repository at this point in the history
Like dirname return type provider of #8611
  • Loading branch information
kkmuffme committed Oct 26, 2022
1 parent 4b96c20 commit 87eb836
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/Psalm/Internal/Provider/FunctionReturnTypeProvider.php
Expand Up @@ -21,6 +21,7 @@
use Psalm\Internal\Provider\ReturnTypeProvider\ArraySliceReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArraySpliceReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayUniqueReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\BasenameReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\DirnameReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ExplodeReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\FilterVarReturnTypeProvider;
Expand Down Expand Up @@ -87,6 +88,7 @@ public function __construct()
$this->registerClass(StrTrReturnTypeProvider::class);
$this->registerClass(VersionCompareReturnTypeProvider::class);
$this->registerClass(MktimeReturnTypeProvider::class);
$this->registerClass(BasenameReturnTypeProvider::class);
$this->registerClass(DirnameReturnTypeProvider::class);
$this->registerClass(ExplodeReturnTypeProvider::class);
$this->registerClass(GetObjectVarsReturnTypeProvider::class);
Expand Down
@@ -0,0 +1,54 @@
<?php

declare(strict_types=1);

namespace Psalm\Internal\Provider\ReturnTypeProvider;

use Psalm\Internal\Analyzer\Statements\Expression\IncludeAnalyzer;
use Psalm\Plugin\EventHandler\Event\FunctionReturnTypeProviderEvent;
use Psalm\Plugin\EventHandler\FunctionReturnTypeProviderInterface;
use Psalm\Type;
use Psalm\Type\Union;

use function basename;
use function count;

/**
* @internal
*/
class BasenameReturnTypeProvider implements FunctionReturnTypeProviderInterface
{
/**
* @return array<lowercase-string>
*/
public static function getFunctionIds(): array
{
return ['basename'];
}

public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $event): ?Union
{
$call_args = $event->getCallArgs();
if (count($call_args) === 0) {
return null;
}

$statements_source = $event->getStatementsSource();

$evaled_path = IncludeAnalyzer::getPathTo(
$call_args[0]->value,
null,
null,
$statements_source->getFileName(),
$statements_source->getCodebase()->config
);

if ($evaled_path === null) {
return Type::getString();
}

$basename = basename($evaled_path);

return Type::getString($basename);
}
}
36 changes: 36 additions & 0 deletions tests/ReturnTypeProvider/BasenameTest.php
@@ -0,0 +1,36 @@
<?php

namespace Psalm\Tests\ReturnTypeProvider;

use Psalm\Tests\TestCase;
use Psalm\Tests\Traits\ValidCodeAnalysisTestTrait;

use const DIRECTORY_SEPARATOR;

class BasenameTest extends TestCase
{
use ValidCodeAnalysisTestTrait;

public function providerValidCodeParse(): iterable
{
$input = 'a' . DIRECTORY_SEPARATOR . 'b' . DIRECTORY_SEPARATOR . 'c';

yield 'basenameOfLiteralStringPathReturnsLiteralString' => [
'code' => '<?php
$base = basename("' . $input . '");
',
'assertions' => [
'$base===' => "'c'",
],
];

yield 'basenameOfStringPathReturnsString' => [
'code' => '<?php
$base = basename(implode("", range("a", "c")));
',
'assertions' => [
'$base===' => 'string',
],
];
}
}

0 comments on commit 87eb836

Please sign in to comment.