Skip to content

Commit

Permalink
Merge pull request #10150 from boesing/bugfix/enum-values
Browse files Browse the repository at this point in the history
  • Loading branch information
@weirdan
weirdan committed Aug 25, 2023
2 parents 5332853 + ad0a132 commit 9b6edff
Show file tree
Hide file tree
Showing 5 changed files with 111 additions and 40 deletions.
38 changes: 0 additions & 38 deletions src/Psalm/Internal/Type/Comparator/AtomicTypeComparator.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

use Psalm\Codebase;
use Psalm\Internal\MethodIdentifier;
use Psalm\Type;
use Psalm\Type\Atomic;
use Psalm\Type\Atomic\Scalar;
use Psalm\Type\Atomic\TArray;
Expand All @@ -18,12 +17,10 @@
use Psalm\Type\Atomic\TEmptyMixed;
use Psalm\Type\Atomic\TEnumCase;
use Psalm\Type\Atomic\TGenericObject;
use Psalm\Type\Atomic\TInt;
use Psalm\Type\Atomic\TIterable;
use Psalm\Type\Atomic\TKeyOf;
use Psalm\Type\Atomic\TKeyedArray;
use Psalm\Type\Atomic\TList;
use Psalm\Type\Atomic\TLiteralInt;
use Psalm\Type\Atomic\TLiteralString;
use Psalm\Type\Atomic\TMixed;
use Psalm\Type\Atomic\TNamedObject;
Expand All @@ -46,7 +43,6 @@
use function assert;
use function count;
use function get_class;
use function is_int;
use function strtolower;

/**
Expand Down Expand Up @@ -635,40 +631,6 @@ public static function isContainedBy(
}
}

if ($input_type_part instanceof TEnumCase
&& $codebase->classlike_storage_provider->has($input_type_part->value)
) {
if ($container_type_part instanceof TString || $container_type_part instanceof TInt) {
$input_type_classlike_storage = $codebase->classlike_storage_provider->get($input_type_part->value);
if ($input_type_classlike_storage->enum_type === null
|| !isset($input_type_classlike_storage->enum_cases[$input_type_part->case_name])
) {
// Not a backed enum or non-existent enum case
return false;
}

$input_type_enum_case_storage = $input_type_classlike_storage->enum_cases[$input_type_part->case_name];
assert(
$input_type_enum_case_storage->value !== null,
'Backed enums cannot have values without a value.',
);

if (is_int($input_type_enum_case_storage->value)) {
return self::isContainedBy(
$codebase,
new TLiteralInt($input_type_enum_case_storage->value),
$container_type_part,
);
}

return self::isContainedBy(
$codebase,
Type::getAtomicStringFromLiteral($input_type_enum_case_storage->value),
$container_type_part,
);
}
}

if ($container_type_part instanceof TString || $container_type_part instanceof TScalar) {
if ($input_type_part instanceof TNamedObject) {
// check whether the object has a __toString method
Expand Down
72 changes: 71 additions & 1 deletion src/Psalm/Internal/Type/SimpleAssertionReconciler.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
use function count;
use function explode;
use function get_class;
use function in_array;
use function is_int;
use function min;
use function strlen;
Expand Down Expand Up @@ -533,7 +534,11 @@ public static function reconcile(
}

if ($assertion_type instanceof TValueOf) {
return $assertion_type->type;
return self::reconcileValueOf(
$codebase,
$assertion_type,
$failed_reconciliation,
);
}

return null;
Expand Down Expand Up @@ -2951,6 +2956,71 @@ private static function reconcileClassConstant(
return TypeCombiner::combine(array_values($matched_class_constant_types), $codebase);
}

/**
* @param Reconciler::RECONCILIATION_* $failed_reconciliation
*/
private static function reconcileValueOf(
Codebase $codebase,
TValueOf $assertion_type,
int &$failed_reconciliation
): ?Union {
$reconciled_types = [];

// For now, only enums are supported here
foreach ($assertion_type->type->getAtomicTypes() as $atomic_type) {
$enum_case_to_assert = null;
if ($atomic_type instanceof TClassConstant) {
$class_name = $atomic_type->fq_classlike_name;
$enum_case_to_assert = $atomic_type->const_name;
} elseif ($atomic_type instanceof TNamedObject) {
$class_name = $atomic_type->value;
} else {
return null;
}

if (!$codebase->classOrInterfaceOrEnumExists($class_name)) {
return null;
}

$class_storage = $codebase->classlike_storage_provider->get($class_name);
if (!$class_storage->is_enum) {
return null;
}

if (!in_array($class_storage->enum_type, ['string', 'int'], true)) {
return null;
}

// For value-of<MyBackedEnum>, the assertion is meant to return *ANY* value of *ANY* enum case
if ($enum_case_to_assert === null) {
foreach ($class_storage->enum_cases as $enum_case) {
assert(
$enum_case->value !== null,
'Verified enum type above, value can not contain `null` anymore.',
);
$reconciled_types[] = Type::getLiteral($enum_case->value);
}

continue;
}

$enum_case = $class_storage->enum_cases[$atomic_type->const_name] ?? null;
if ($enum_case === null) {
return null;
}

assert($enum_case->value !== null, 'Verified enum type above, value can not contain `null` anymore.');
$reconciled_types[] = Type::getLiteral($enum_case->value);
}

if ($reconciled_types === []) {
$failed_reconciliation = Reconciler::RECONCILIATION_EMPTY;
return Type::getNever();
}

return TypeCombiner::combine($reconciled_types, $codebase, false, false);
}

/**
* @psalm-assert-if-true TCallableObject|TObjectWithProperties|TNamedObject $type
*/
Expand Down
14 changes: 14 additions & 0 deletions src/Psalm/Type.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
use function explode;
use function get_class;
use function implode;
use function is_int;
use function preg_quote;
use function preg_replace;
use function stripos;
Expand Down Expand Up @@ -258,6 +259,19 @@ public static function getNumericString(): Union
return new Union([$type]);
}

/**
* @param int|string $value
* @return TLiteralString|TLiteralInt
*/
public static function getLiteral($value): Atomic
{
if (is_int($value)) {
return new TLiteralInt($value);
}

return TLiteralString::make($value);
}

public static function getString(?string $value = null): Union
{
return new Union([$value === null ? new TString() : self::getAtomicStringFromLiteral($value)]);
Expand Down
12 changes: 11 additions & 1 deletion tests/AssertAnnotationTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2194,6 +2194,10 @@ function assertSomeString(string $foo): void
function assertSomeInt(int $foo): void
{}
/** @psalm-assert value-of<StringEnum|IntEnum> $foo */
function assertAnyEnumValue(string|int $foo): void
{}
/** @param "foo"|"bar" $foo */
function takesSomeStringFromEnum(string $foo): StringEnum
{
Expand All @@ -2216,8 +2220,14 @@ function takesSomeIntFromEnum(int $foo): IntEnum
assertSomeInt($int);
takesSomeIntFromEnum($int);
/** @var string|int $potentialEnumValue */
$potentialEnumValue = null;
assertAnyEnumValue($potentialEnumValue);
',
'assertions' => [],
'assertions' => [
'$potentialEnumValue===' => "'bar'|'baz'|'foo'|1|2|3",
],
'ignored_issues' => [],
'php_version' => '8.1',
],
Expand Down
15 changes: 15 additions & 0 deletions tests/EnumTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1015,6 +1015,21 @@ function withA(WithState $_): void {}
'ignored_issues' => [],
'php_version' => '8.1',
],
'backedEnumDoesNotPassNativeType' => [
'code' => '<?php
enum State: string
{
case A = "A";
case B = "B";
case C = "C";
}
function f(string $state): void {}
f(State::A);
',
'error_message' => 'InvalidArgument',
'ignored_issues' => [],
'php_version' => '8.1',
],
];
}
}

0 comments on commit 9b6edff

Please sign in to comment.