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

Fix get_object_vars on enums #8973

Merged
merged 1 commit into from
Dec 22, 2022
Merged

Fix get_object_vars on enums #8973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,14 @@
"cs": "phpcs -ps",
"cs-fix": "phpcbf -ps",
"lint": "parallel-lint ./src ./tests",
"phpunit": "paratest --runner=WrapperRunner",
"phpunit-std": "phpunit",
"phpunit": [
"Composer\\Config::disableProcessTimeout",
"paratest --runner=WrapperRunner"
],
"phpunit-std": [
"Composer\\Config::disableProcessTimeout",
"phpunit"
],
"verify-callmap": "phpunit tests/Internal/Codebase/InternalCallMapHandlerTest.php",
"psalm": "@php ./psalm --find-dead-code",
"tests": [
Expand Down
19 changes: 19 additions & 0 deletions src/Psalm/Internal/Codebase/Populator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

namespace Psalm\Internal\Codebase;

use BackedEnum;
use InvalidArgumentException;
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
use Psalm\Internal\MethodIdentifier;
Expand All @@ -14,8 +15,13 @@
use Psalm\Storage\ClassConstantStorage;
use Psalm\Storage\ClassLikeStorage;
use Psalm\Storage\FileStorage;
use Psalm\Storage\PropertyStorage;
use Psalm\Type\Atomic\TInt;
use Psalm\Type\Atomic\TNonEmptyString;
use Psalm\Type\Atomic\TString;
use Psalm\Type\Atomic\TTemplateParam;
use Psalm\Type\Union;
use UnitEnum;

use function array_filter;
use function array_intersect_key;
Expand Down Expand Up @@ -688,6 +694,19 @@ private function populateInterfaceDataFromParentInterface(
$parent_interface_storage->parent_interfaces,
$storage->parent_interfaces,
);

if (isset($storage->parent_interfaces[strtolower(UnitEnum::class)])) {
$storage->declaring_property_ids['name'] = $storage->name;
$storage->appearing_property_ids['name'] = "{$storage->name}::\$name";
$storage->properties['name'] = new PropertyStorage();
$storage->properties['name']->type = new Union([new TNonEmptyString()]);
}
if (isset($storage->parent_interfaces[strtolower(BackedEnum::class)])) {
$storage->declaring_property_ids['value'] = $storage->name;
$storage->appearing_property_ids['value'] = "{$storage->name}::\$value";
$storage->properties['value'] = new PropertyStorage();
$storage->properties['value']->type = new Union([new TInt(), new TString()]);
}
}

private function populateDataFromImplementedInterface(
Expand Down
34 changes: 31 additions & 3 deletions src/Psalm/Internal/PhpVisitor/Reflector/ClassLikeNodeScanner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@
use function count;
use function get_class;
use function implode;
use function is_int;
use function is_string;
use function preg_match;
use function preg_replace;
use function preg_split;
Expand Down Expand Up @@ -286,6 +288,7 @@ public function start(PhpParser\Node\Stmt\ClassLike $node): ?bool
$this->codebase->classlikes->addFullyQualifiedTraitName($fq_classlike_name, $this->file_path);
} elseif ($node instanceof PhpParser\Node\Stmt\Enum_) {
$storage->is_enum = true;
$storage->final = true;

if ($node->scalarType) {
if ($node->scalarType->name === 'string' || $node->scalarType->name === 'int') {
Expand Down Expand Up @@ -694,6 +697,33 @@ public function start(PhpParser\Node\Stmt\ClassLike $node): ?bool
}
}

if ($storage->is_enum) {
$name_types = [];
$values_types = [];
foreach ($storage->enum_cases as $name => $enumCaseStorage) {
$name_types[] = new Type\Atomic\TLiteralString($name);
if ($storage->enum_type !== null) {
if (is_string($enumCaseStorage->value)) {
$values_types[] = new Type\Atomic\TLiteralString($enumCaseStorage->value);
} elseif (is_int($enumCaseStorage->value)) {
$values_types[] = new Type\Atomic\TLiteralInt($enumCaseStorage->value);
}
}
}
if ($name_types !== []) {
$storage->declaring_property_ids['name'] = $storage->name;
$storage->appearing_property_ids['name'] = "{$storage->name}::\$name";
$storage->properties['name'] = new PropertyStorage();
$storage->properties['name']->type = new Union($name_types);
}
if ($values_types !== []) {
$storage->declaring_property_ids['value'] = $storage->name;
$storage->appearing_property_ids['value'] = "{$storage->name}::\$value";
$storage->properties['value'] = new PropertyStorage();
$storage->properties['value']->type = new Union($values_types);
}
}

foreach ($node->stmts as $node_stmt) {
if ($node_stmt instanceof PhpParser\Node\Stmt\Property) {
$this->visitPropertyDeclaration($node_stmt, $this->config, $storage, $fq_classlike_name);
Expand Down Expand Up @@ -1580,9 +1610,7 @@ private function visitPropertyDeclaration(
}

if ($doc_var_group_type) {
$property_storage->type = count($stmt->props) === 1
? $doc_var_group_type
: $doc_var_group_type;
$property_storage->type = $doc_var_group_type;
}
}

Expand Down
34 changes: 27 additions & 7 deletions src/Psalm/Internal/Provider/ReturnTypeProvider/GetObjectVarsReturnTypeProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<?php

declare(strict_types=1);

namespace Psalm\Internal\Provider\ReturnTypeProvider;

use Psalm\CodeLocation;
Expand All @@ -18,8 +20,11 @@
use Psalm\Type\Atomic\TNamedObject;
use Psalm\Type\Atomic\TObjectWithProperties;
use Psalm\Type\Union;
use UnitEnum;
use stdClass;

use function is_int;
use function is_string;
use function reset;
use function strtolower;

Expand All @@ -28,14 +33,9 @@
*/
class GetObjectVarsReturnTypeProvider implements FunctionReturnTypeProviderInterface
{
/**
* @return array<lowercase-string>
*/
public static function getFunctionIds(): array
{
return [
'get_object_vars',
];
return ['get_object_vars'];
}

private static ?TArray $fallback = null;
Expand All @@ -55,6 +55,22 @@ public static function getGetObjectVarsReturnType(
$atomics = $first_arg_type->getAtomicTypes();
$object_type = reset($atomics);

if ($object_type instanceof Atomic\TEnumCase) {
$properties = ['name' => new Union([new Atomic\TLiteralString($object_type->case_name)])];
$codebase = $statements_source->getCodebase();
$enum_classlike_storage = $codebase->classlike_storage_provider->get($object_type->value);
if ($enum_classlike_storage->enum_type === null) {
return new TKeyedArray($properties);
}
$enum_case_storage = $enum_classlike_storage->enum_cases[$object_type->case_name];
if (is_int($enum_case_storage->value)) {
$properties['value'] = new Union([new Atomic\TLiteralInt($enum_case_storage->value)]);
} elseif (is_string($enum_case_storage->value)) {
$properties['value'] = new Union([new Atomic\TLiteralString($enum_case_storage->value)]);
}
return new TKeyedArray($properties);
}

if ($object_type instanceof TObjectWithProperties) {
if ([] === $object_type->properties) {
return self::$fallback;
Expand Down Expand Up @@ -126,7 +142,11 @@ public static function getGetObjectVarsReturnType(
return new TKeyedArray(
$properties,
null,
$class_storage->final ? null : [Type::getString(), Type::getMixed()],
$class_storage->final
|| $class_storage->name === UnitEnum::class
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Annoying this is not covered by interfaceExtends() but I guess it makes sense.

|| $codebase->interfaceExtends($class_storage->name, UnitEnum::class)
? null
: [Type::getString(), Type::getMixed()],
);
}
}
Expand Down
2 changes: 2 additions & 0 deletions stubs/Php81.phpstub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ namespace {

interface BackedEnum extends UnitEnum
{
/** @var non-empty-string $name */
public readonly string $name;
jack-worman marked this conversation as resolved.
Show resolved Hide resolved
public readonly int|string $value;

/**
Expand Down
132 changes: 132 additions & 0 deletions tests/ReturnTypeProvider/GetObjectVarsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<?php

declare(strict_types=1);

namespace Psalm\Tests\ReturnTypeProvider;

use Psalm\Tests\TestCase;
Expand Down Expand Up @@ -168,5 +170,135 @@ public function __construct(public string $t) {}
],
'php_version' => '8.2',
];

yield 'UnitEnum generic' => [
'code' => <<<'PHP'
<?php
enum A { case One; case Two; }
function getUnitEnum(): UnitEnum { return A::One; }
$b = get_object_vars(getUnitEnum());
PHP,
'assertions' => [
'$b===' => 'array{name: non-empty-string}',
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'UnitEnum specific' => [
'code' => <<<'PHP'
<?php
enum A { case One; case Two; }
function getUnitEnum(): A { return A::One; }
$b = get_object_vars(getUnitEnum());
PHP,
'assertions' => [
'$b===' => "array{name: 'One'|'Two'}",
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'UnitEnum literal' => [
'code' => <<<'PHP'
<?php
enum A { case One; case Two; }
$b = get_object_vars(A::One);
PHP,
'assertions' => [
'$b===' => "array{name: 'One'}",
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'BackedEnum generic' => [
'code' => <<<'PHP'
<?php
enum A: int { case One = 1; case Two = 2; }
function getBackedEnum(): BackedEnum { return A::One; }
$b = get_object_vars(getBackedEnum());
PHP,
'assertions' => [
'$b===' => 'array{name: non-empty-string, value: int|string}',
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'Int BackedEnum specific' => [
'code' => <<<'PHP'
<?php
enum A: int { case One = 1; case Two = 2; }
function getBackedEnum(): A { return A::One; }
$b = get_object_vars(getBackedEnum());
PHP,
'assertions' => [
'$b===' => "array{name: 'One'|'Two', value: 1|2}",
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'String BackedEnum specific' => [
'code' => <<<'PHP'
<?php
enum A: string { case One = "one"; case Two = "two"; }
function getBackedEnum(): A { return A::One; }
$b = get_object_vars(getBackedEnum());
PHP,
'assertions' => [
'$b===' => "array{name: 'One'|'Two', value: 'one'|'two'}",
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'Int BackedEnum literal' => [
'code' => <<<'PHP'
<?php
enum A: int { case One = 1; case Two = 2; }
$b = get_object_vars(A::One);
PHP,
'assertions' => [
'$b===' => "array{name: 'One', value: 1}",
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'String BackedEnum literal' => [
'code' => <<<'PHP'
<?php
enum A: string { case One = "one"; case Two = "two"; }
$b = get_object_vars(A::One);
PHP,
'assertions' => [
'$b===' => "array{name: 'One', value: 'one'}",
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'Interface extending UnitEnum' => [
'code' => <<<'PHP'
<?php
interface A extends UnitEnum {}
enum B implements A { case One; }
function getA(): A { return B::One; }
$b = get_object_vars(getA());
PHP,
'assertions' => [
'$b===' => 'array{name: non-empty-string}',
],
'ignored_issues' => [],
'php_version' => '8.1',
];
yield 'Interface extending BackedEnum' => [
'code' => <<<'PHP'
<?php
interface A extends BackedEnum {}
enum B: int implements A { case One = 1; }
function getA(): A { return B::One; }
$b = get_object_vars(getA());
PHP,
'assertions' => [
'$b===' => 'array{name: non-empty-string, value: int|string}',
],
'ignored_issues' => [],
'php_version' => '8.1',
];
}
}