Merge pull request #8283 from AndrolGenhald/feature/value-of-backed-enum

Allow `value-of` to work with backed enums (fixes #7874).
vimeo · Jul 20, 2022 · 85fe7e8 · 85fe7e8
2 parents 33b553e + 66ebf4a
commit 85fe7e8
Show file tree

Hide file tree

Showing 12 changed files with 174 additions and 64 deletions.
diff --git a/UPGRADING.md b/UPGRADING.md
@@ -42,7 +42,7 @@
    - `Psalm\Type\Atomic\TIntRange`
    - `Psalm\Type\Atomic\TIterable`
    - `Psalm\Type\Atomic\TKeyedArray`
-   - `Psalm\Type\Atomic\TKeyOfArray`
+   - `Psalm\Type\Atomic\TKeyOf`
    - `Psalm\Type\Atomic\TList`
    - `Psalm\Type\Atomic\TLiteralClassString`
    - `Psalm\Type\Atomic\TLowercaseString`
@@ -64,7 +64,7 @@
    - `Psalm\Type\Atomic\TTraitString`
    - `Psalm\Type\Atomic\TTrue`
    - `Psalm\Type\Atomic\TTypeAlias`
-   - `Psalm\Type\Atomic\TValueOfArray`
+   - `Psalm\Type\Atomic\TValueOf`
    - `Psalm\Type\Atomic\TVoid`
    - `Psalm\Type\Union`
 
@@ -92,7 +92,7 @@
    - `Psalm\Type\Atomic\TInt`
    - `Psalm\Type\Atomic\TIterable`
    - `Psalm\Type\Atomic\TKeyedArray`
-   - `Psalm\Type\Atomic\TKeyOfArray`
+   - `Psalm\Type\Atomic\TKeyOf`
    - `Psalm\Type\Atomic\TList`
    - `Psalm\Type\Atomic\TLiteralClassString`
    - `Psalm\Type\Atomic\TMixed`
@@ -109,7 +109,7 @@
    - `Psalm\Type\Atomic\TTemplateParam`
    - `Psalm\Type\Atomic\TTraitString`
    - `Psalm\Type\Atomic\TTypeAlias`
-   - `Psalm\Type\Atomic\TValueOfArray`
+   - `Psalm\Type\Atomic\TValueOf`
    - `Psalm\Type\Atomic\TVoid`
    - `Psalm\Type\Union`
 - While not a BC break per se, all classes / interfaces / traits / enums under
@@ -155,8 +155,8 @@
 - [BC] Atomic::getId() has now a first param $exact. Calling the method with false will return a less detailed version of the type in some cases (similarly to what `__toString` used to return)
 - [BC] To remove a variable from the context, use `Context::remove()`. Calling
   `unset($context->vars_in_scope[$var_id])` can cause problems when using references.
-- [BC] `TKeyOfClassConstant` has been renamed to `TKeyOfArray`.
-- [BC] `TValueOfClassConstant` has been renamed to `TValueOfArray`.
+- [BC] `TKeyOfClassConstant` has been renamed to `TKeyOf`.
+- [BC] `TValueOfClassConstant` has been renamed to `TValueOf`.
 - [BC] `TKeyOfTemplate` base class has been changed from `Scalar` to `Atomic`.
 - [BC] Class `Psalm\FileManipulation` became final
 - [BC] Class `Psalm\Context` became final
@@ -742,13 +742,13 @@
     - [BC] Class `Psalm\Type\Atomic\TLiteralInt` became final
     - [BC] Class `Psalm\Type\Atomic\TTrue` became final
     - [BC] Class `Psalm\Type\Atomic\TDependentGetClass` became final
-    - [BC] Class `Psalm\Type\Atomic\TValueOfArray` became final
+    - [BC] Class `Psalm\Type\Atomic\TValueOf` became final
     - [BC] Class `Psalm\Type\Atomic\TGenericObject` became final
     - [BC] Class `Psalm\Type\Atomic\TNonEmptyLowercaseString` became final
     - [BC] Class `Psalm\Type\Atomic\TEnumCase` became final
     - [BC] Class `Psalm\Type\Atomic\TCallableKeyedArray` became final
     - [BC] Class `Psalm\Type\Atomic\TDependentGetDebugType` became final
-    - [BC] Class `Psalm\Type\Atomic\TKeyOfArray` became final
+    - [BC] Class `Psalm\Type\Atomic\TKeyOf` became final
     - [BC] Class `Psalm\Type\Atomic\TNonspecificLiteralInt` became final
     - [BC] Class `Psalm\Type\Atomic\TObjectWithProperties` became final
     - [BC] Class `Psalm\Type\Atomic\TTemplateValueOf` became final

diff --git a/docs/running_psalm/plugins/plugins_type_system.md b/docs/running_psalm/plugins/plugins_type_system.md
@@ -49,15 +49,15 @@ The classes are as follows:
 
 `TIntMaskOf` - as above, but used with a reference to constants in code `int-mask-of<MyClass::CLASS_CONSTANT_*>` will corresponds to `1|2|3|4|5|6|7` if there are three constant 1, 2 and 4
 
-`TKeyOfArray` - Represents an offset of an array (e.g. `key-of<MyClass::CLASS_CONSTANT>`).
+`TKeyOf` - Represents an offset of an array (e.g. `key-of<MyClass::CLASS_CONSTANT>`).
 
-`TValueOfArray` - Represents a value of an array (e.g. `value-of<MyClass::CLASS_CONSTANT>`).
+`TValueOf` - Represents a value of an array or enum (e.g. `value-of<MyClass::CLASS_CONSTANT>`).
 
 `TTemplateIndexedAccess` - To be documented
 
-`TTemplateKeyOf` - Represents the type used when using TKeyOfArray when the type of the array is a template
+`TTemplateKeyOf` - Represents the type used when using TKeyOf when the type of the array is a template
 
-`TTemplateValueOf` - Represents the type used when using TValueOfArray when the type of the array is a template
+`TTemplateValueOf` - Represents the type used when using TValueOf when the type of the array or enum is a template
 
 `TPropertiesOf` - Represents properties and their types of a class as a keyed array (e.g. `properties-of<MyClass>`)
 

diff --git a/src/Psalm/Internal/Type/Comparator/AtomicTypeComparator.php b/src/Psalm/Internal/Type/Comparator/AtomicTypeComparator.php
@@ -19,7 +19,7 @@
 use Psalm\Type\Atomic\TEnumCase;
 use Psalm\Type\Atomic\TGenericObject;
 use Psalm\Type\Atomic\TIterable;
-use Psalm\Type\Atomic\TKeyOfArray;
+use Psalm\Type\Atomic\TKeyOf;
 use Psalm\Type\Atomic\TKeyedArray;
 use Psalm\Type\Atomic\TList;
 use Psalm\Type\Atomic\TLiteralString;
@@ -36,7 +36,7 @@
 use Psalm\Type\Atomic\TTemplateKeyOf;
 use Psalm\Type\Atomic\TTemplateParam;
 use Psalm\Type\Atomic\TTemplateValueOf;
-use Psalm\Type\Atomic\TValueOfArray;
+use Psalm\Type\Atomic\TValueOf;
 
 use function array_merge;
 use function array_values;
@@ -341,7 +341,7 @@ public static function isContainedBy(
         }
 
         if ($input_type_part instanceof TTemplateKeyOf) {
-            $array_key_type = TKeyOfArray::getArrayKeyType($input_type_part->as);
+            $array_key_type = TKeyOf::getArrayKeyType($input_type_part->as);
             if ($array_key_type === null) {
                 return false;
             }
@@ -375,7 +375,7 @@ public static function isContainedBy(
         }
 
         if ($input_type_part instanceof TTemplateValueOf) {
-            $array_value_type = TValueOfArray::getArrayValueType($input_type_part->as);
+            $array_value_type = TValueOf::getValueType($input_type_part->as, $codebase);
             if ($array_value_type === null) {
                 return false;
             }

diff --git a/src/Psalm/Internal/Type/TemplateInferredTypeReplacer.php b/src/Psalm/Internal/Type/TemplateInferredTypeReplacer.php
@@ -11,7 +11,7 @@
 use Psalm\Type\Atomic\TConditional;
 use Psalm\Type\Atomic\TInt;
 use Psalm\Type\Atomic\TIterable;
-use Psalm\Type\Atomic\TKeyOfArray;
+use Psalm\Type\Atomic\TKeyOf;
 use Psalm\Type\Atomic\TKeyedArray;
 use Psalm\Type\Atomic\TLiteralInt;
 use Psalm\Type\Atomic\TLiteralString;
@@ -26,7 +26,7 @@
 use Psalm\Type\Atomic\TTemplateParamClass;
 use Psalm\Type\Atomic\TTemplatePropertiesOf;
 use Psalm\Type\Atomic\TTemplateValueOf;
-use Psalm\Type\Atomic\TValueOfArray;
+use Psalm\Type\Atomic\TValueOf;
 use Psalm\Type\Union;
 use UnexpectedValueException;
 
@@ -345,15 +345,15 @@ private static function replaceTemplateKeyOfValueOf(
         );
 
         if ($atomic_type instanceof TTemplateKeyOf
-            && TKeyOfArray::isViableTemplateType($template_type)
+            && TKeyOf::isViableTemplateType($template_type)
         ) {
-            return new TKeyOfArray(clone $template_type);
+            return new TKeyOf(clone $template_type);
         }
 
         if ($atomic_type instanceof TTemplateValueOf
-            && TValueOfArray::isViableTemplateType($template_type)
+            && TValueOf::isViableTemplateType($template_type)
         ) {
-            return new TValueOfArray(clone $template_type);
+            return new TValueOf(clone $template_type);
         }
 
         return null;

diff --git a/src/Psalm/Internal/Type/TypeExpander.php b/src/Psalm/Internal/Type/TypeExpander.php
@@ -22,7 +22,7 @@
 use Psalm\Type\Atomic\TIntMask;
 use Psalm\Type\Atomic\TIntMaskOf;
 use Psalm\Type\Atomic\TIterable;
-use Psalm\Type\Atomic\TKeyOfArray;
+use Psalm\Type\Atomic\TKeyOf;
 use Psalm\Type\Atomic\TKeyedArray;
 use Psalm\Type\Atomic\TList;
 use Psalm\Type\Atomic\TLiteralClassString;
@@ -34,7 +34,7 @@
 use Psalm\Type\Atomic\TPropertiesOf;
 use Psalm\Type\Atomic\TTemplateParam;
 use Psalm\Type\Atomic\TTypeAlias;
-use Psalm\Type\Atomic\TValueOfArray;
+use Psalm\Type\Atomic\TValueOf;
 use Psalm\Type\Atomic\TVoid;
 use Psalm\Type\Union;
 use ReflectionProperty;
@@ -363,10 +363,10 @@ public static function expandAtomic(
             return [$return_type];
         }
 
-        if ($return_type instanceof TKeyOfArray
-            || $return_type instanceof TValueOfArray
+        if ($return_type instanceof TKeyOf
+            || $return_type instanceof TValueOf
         ) {
-            return self::expandKeyOfValueOfArray(
+            return self::expandKeyOfValueOf(
                 $codebase,
                 $return_type,
                 $self_class,
@@ -965,11 +965,11 @@ function (?Union $property_type): bool {
     }
 
     /**
-     * @param TKeyOfArray|TValueOfArray $return_type
+     * @param TKeyOf|TValueOf $return_type
      * @param string|TNamedObject|TTemplateParam|null $static_class_type
      * @return non-empty-list<Atomic>
      */
-    private static function expandKeyOfValueOfArray(
+    private static function expandKeyOfValueOf(
         Codebase $codebase,
         Atomic &$return_type,
         ?string $self_class,
@@ -1025,12 +1025,12 @@ private static function expandKeyOfValueOfArray(
 
             if (!$constant_type
                 || (
-                    $return_type instanceof TKeyOfArray
-                    && !TKeyOfArray::isViableTemplateType($constant_type)
+                    $return_type instanceof TKeyOf
+                    && !TKeyOf::isViableTemplateType($constant_type)
                 )
                 || (
-                    $return_type instanceof TValueOfArray
-                    && !TValueOfArray::isViableTemplateType($constant_type)
+                    $return_type instanceof TValueOf
+                    && !TValueOf::isViableTemplateType($constant_type)
                 )
             ) {
                 if ($throw_on_unresolvable_constant) {
@@ -1049,10 +1049,10 @@ private static function expandKeyOfValueOfArray(
             return [$return_type];
         }
 
-        if ($return_type instanceof TKeyOfArray) {
-            $new_return_types = TKeyOfArray::getArrayKeyType(new Union($type_atomics));
+        if ($return_type instanceof TKeyOf) {
+            $new_return_types = TKeyOf::getArrayKeyType(new Union($type_atomics));
         } else {
-            $new_return_types = TValueOfArray::getArrayValueType(new Union($type_atomics));
+            $new_return_types = TValueOf::getValueType(new Union($type_atomics), $codebase);
         }
         if ($new_return_types === null) {
             return [$return_type];

diff --git a/src/Psalm/Internal/Type/TypeParser.php b/src/Psalm/Internal/Type/TypeParser.php
@@ -41,7 +41,7 @@
 use Psalm\Type\Atomic\TIntMaskOf;
 use Psalm\Type\Atomic\TIntRange;
 use Psalm\Type\Atomic\TIterable;
-use Psalm\Type\Atomic\TKeyOfArray;
+use Psalm\Type\Atomic\TKeyOf;
 use Psalm\Type\Atomic\TKeyedArray;
 use Psalm\Type\Atomic\TList;
 use Psalm\Type\Atomic\TLiteralClassString;
@@ -63,7 +63,7 @@
 use Psalm\Type\Atomic\TTemplatePropertiesOf;
 use Psalm\Type\Atomic\TTemplateValueOf;
 use Psalm\Type\Atomic\TTypeAlias;
-use Psalm\Type\Atomic\TValueOfArray;
+use Psalm\Type\Atomic\TValueOf;
 use Psalm\Type\TypeNode;
 use Psalm\Type\Union;
 
@@ -743,13 +743,13 @@ private static function getTypeFromGenericTree(
                 );
             }
 
-            if (!TKeyOfArray::isViableTemplateType($generic_params[0])) {
+            if (!TKeyOf::isViableTemplateType($generic_params[0])) {
                 throw new TypeParseTreeException(
                     'Untemplated key-of param ' . $param_name . ' should be an array'
                 );
             }
 
-            return new TKeyOfArray($generic_params[0]);
+            return new TKeyOf($generic_params[0]);
         }
 
         if ($generic_type_value === 'value-of') {
@@ -765,13 +765,13 @@ private static function getTypeFromGenericTree(
                 );
             }
 
-            if (!TValueOfArray::isViableTemplateType($generic_params[0])) {
+            if (!TValueOf::isViableTemplateType($generic_params[0])) {
                 throw new TypeParseTreeException(
                     'Untemplated value-of param ' . $param_name . ' should be an array'
                 );
             }
 
-            return new TValueOfArray($generic_params[0]);
+            return new TValueOf($generic_params[0]);
         }
 
         if ($generic_type_value === 'int-mask') {
@@ -842,8 +842,8 @@ private static function getTypeFromGenericTree(
             $param_type = $param_union_types[0];
 
             if (!$param_type instanceof TClassConstant
-                && !$param_type instanceof TValueOfArray
-                && !$param_type instanceof TKeyOfArray
+                && !$param_type instanceof TValueOf
+                && !$param_type instanceof TKeyOf
             ) {
                 throw new TypeParseTreeException(
                     'Invalid reference passed to int-mask-of'

diff --git a/src/Psalm/Type/Atomic/TIntMaskOf.php b/src/Psalm/Type/Atomic/TIntMaskOf.php
@@ -11,11 +11,11 @@
  */
 final class TIntMaskOf extends TInt
 {
-    /** @var TClassConstant|TKeyOfArray|TValueOfArray */
+    /** @var TClassConstant|TKeyOf|TValueOf */
     public $value;
 
     /**
-     * @param TClassConstant|TKeyOfArray|TValueOfArray $value
+     * @param TClassConstant|TKeyOf|TValueOf $value
      */
     public function __construct(Atomic $value)
     {

diff --git a/src/Psalm/Type/Atomic/TKeyOfArray.php → src/Psalm/Type/Atomic/TKeyOf.php b/src/Psalm/Type/Atomic/TKeyOfArray.php → src/Psalm/Type/Atomic/TKeyOf.php
@@ -11,7 +11,7 @@
 /**
  * Represents an offset of an array.
  */
-final class TKeyOfArray extends TArrayKey
+final class TKeyOf extends TArrayKey
 {
     /** @var Union */
     public $type;

diff --git a/src/Psalm/Type/Atomic/TTemplateKeyOf.php b/src/Psalm/Type/Atomic/TTemplateKeyOf.php
@@ -9,7 +9,7 @@
 use Psalm\Type\Union;
 
 /**
- * Represents the type used when using TKeyOfArray when the type of the array is a template
+ * Represents the type used when using TKeyOf when the type of the array is a template
  */
 final class TTemplateKeyOf extends Atomic
 {

diff --git a/src/Psalm/Type/Atomic/TTemplateValueOf.php b/src/Psalm/Type/Atomic/TTemplateValueOf.php
@@ -9,7 +9,7 @@
 use Psalm\Type\Union;
 
 /**
- * Represents the type used when using TValueOfArray when the type of the array is a template
+ * Represents the type used when using TValueOf when the type of the array or enum is a template
  */
 final class TTemplateValueOf extends Atomic
 {