danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #9157 from annervisser/narrow-union-case-values

Browse Source 
Narrow ->value of enum case(s) to only the possible values
This commit is contained in:
orklah 2023-01-21 12:21:27 +01:00 committed by GitHub
commit 9725dafb7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 85 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/Psalm/Internal/Analyzer/Statements/Expression/Fetch/AtomicPropertyFetchAnalyzer.php
View File

@ -62,7 +62,9 @@ use Psalm\Type\Atomic\TString;
use Psalm\Type\Atomic\TTemplateParam;
use Psalm\Type\Union;
use function array_filter;
use function array_keys;
use function array_map;
use function array_search;
use function count;
use function in_array;
@ -70,6 +72,8 @@ use function is_int;
use function is_string;
use function strtolower;
use const ARRAY_FILTER_USE_KEY;
/**
* @internal
*/
@ -198,7 +202,7 @@ class AtomicPropertyFetchAnalyzer
]),
);
} elseif ($prop_name === 'value' && $class_storage->enum_type !== null && $class_storage->enum_cases) {
self::handleEnumValue($statements_analyzer, $stmt, $class_storage);
self::handleEnumValue($statements_analyzer, $stmt, $stmt_var_type, $class_storage);
} elseif ($prop_name === 'name') {
self::handleEnumName($statements_analyzer, $stmt, $lhs_type_part);
} else {
@ -941,11 +945,31 @@ class AtomicPropertyFetchAnalyzer
private static function handleEnumValue(
StatementsAnalyzer $statements_analyzer,
PropertyFetch $stmt,
Union $stmt_var_type,
ClassLikeStorage $class_storage
): void {
$relevant_enum_cases = array_filter(
$stmt_var_type->getAtomicTypes(),
static fn(Atomic $type): bool => $type instanceof TEnumCase,
);
$relevant_enum_case_names = array_map(
static fn(TEnumCase $enumCase): string => $enumCase->case_name,
$relevant_enum_cases,
);
$enum_cases = $class_storage->enum_cases;
if (!empty($relevant_enum_case_names)) {
// If we have a known subset of enum cases, include only those
$enum_cases = array_filter(
$enum_cases,
static fn(string $key) => in_array($key, $relevant_enum_case_names, true),
ARRAY_FILTER_USE_KEY,
);
}
$case_values = [];
foreach ($class_storage->enum_cases as $enum_case) {
foreach ($enum_cases as $enum_case) {
if (is_string($enum_case->value)) {
$case_values[] = new TLiteralString($enum_case->value);
} elseif (is_int($enum_case->value)) {
@ -956,7 +980,6 @@ class AtomicPropertyFetchAnalyzer
}
}
// todo: this is suboptimal when we reference enum directly, e.g. Status::Open->value
/** @psalm-suppress ArgumentTypeCoercion */
$statements_analyzer->node_data->setType(
$stmt,

60
tests/EnumTest.php
View File

@ -94,12 +94,70 @@ class EnumTest extends TestCase
$z = Mask::Two->value;
',
'assertions' => [
// xxx: we should be able to do better when we reference a case explicitly, like above
'$z===' => '2',
],
'ignored_issues' => [],
'php_version' => '8.1',
],
'EnumCaseValue #8568' => [
'code' => '<?php
enum Mask: int {
case One = 1 << 0;
case Two = 1 << 1;
}
/** @return Mask */
function a() {
return Mask::One;
}
$z = a()->value;
',
'assertions' => [
'$z===' => '1|2',
],
'ignored_issues' => [],
'php_version' => '8.1',
],
'EnumUnionAsCaseValue #8568' => [
'code' => '<?php
enum Mask: int {
case One = 1 << 0;
case Two = 1 << 1;
case Four = 1 << 2;
}
/** @return Mask::One|Mask::Two */
function a() {
return Mask::One;
}
$z = a()->value;
',
'assertions' => [
'$z===' => '1|2',
],
'ignored_issues' => [],
'php_version' => '8.1',
],
'matchCaseOnEnumValue #8812' => [
'code' => '<?php
enum SomeType: string
{
case FOO = "FOO";
case BAR = "BAR";
}
function getSomething(string $moduleString): int
{
return match ($moduleString) {
SomeType::FOO->value => 1,
SomeType::BAR->value => 2,
};
}
',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.1',
],
'namePropertyFromOutside' => [
'code' => '<?php
enum Status