refactoring & fix getValues return type

Author: marc-mabe

composer.json

@@ -10,7 +10,7 @@
         "phpstan/phpstan": "^0.12"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5"
+        "phpunit/phpunit": "^7.5.20"
     },
     "autoload": {
         "psr-4": {

extension.neon

@@ -3,6 +3,6 @@ services:
     tags:
       - phpstan.broker.methodsClassReflectionExtension
 
-  - class: MabeEnumPHPStan\EnumGetValueDynamicReturnTypeExtension
+  - class: MabeEnumPHPStan\EnumDynamicReturnTypeExtension
     tags:
       - phpstan.broker.dynamicMethodReturnTypeExtension

src/EnumDynamicReturnTypeExtension.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStan;
+
+use MabeEnum\Enum;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\IntegerType;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+
+class EnumDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+    /**
+     * Buffer of known return types of Enum::getValues()
+     * @var Type[]
+     * @phpstan-var array<class-string<Enum>, Type>
+     */
+    private $enumValuesTypeBuffer = [];
+
+    public function getClass(): string
+    {
+        return Enum::class;
+    }
+
+    public function isMethodSupported(MethodReflection $methodReflection): bool
+    {
+        $supportedMethods = ['getvalue'];
+        if (method_exists(Enum::class, 'getValues')) {
+            array_push($supportedMethods, 'getvalues');
+        }
+
+        return in_array(strtolower($methodReflection->getName()), $supportedMethods, true);
+    }
+
+    public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type
+    {
+        $enumType   = $scope->getType($methodCall->var);
+        $methodName    = $methodReflection->getName();
+        $methodClasses = $enumType->getReferencedClasses();
+        if (count($methodClasses) !== 1) {
+            return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+        }
+
+        $enumeration = $methodClasses[0];
+
+        switch (strtolower($methodName)) {
+            case 'getvalue':
+                return $this->getEnumValuesType($enumeration, $scope);
+            case 'getvalues':
+                return new ArrayType(
+                    new IntegerType(),
+                    $this->getEnumValuesType($enumeration, $scope)
+                );
+            default:
+                throw new ShouldNotHappenException("Method {$methodName} is not supported");
+        }
+    }
+
+    /**
+     * Returns union type of all values of an enumeration
+     * @phpstan-param class-string<Enum> $enumClass
+     */
+    private function getEnumValuesType(string $enumeration, Scope $scope): Type
+    {
+        if (isset($this->enumValuesTypeBuffer[$enumeration])) {
+            return $this->enumValuesTypeBuffer[$enumeration];
+        }
+
+        $values = array_values($enumeration::getConstants());
+        $types  = array_map(function ($value) use ($scope): Type {
+            return $scope->getTypeFromValue($value);
+        }, $values);
+
+        return $this->enumValuesTypeBuffer[$enumeration] = TypeCombinator::union(...$types);
+    }
+}

src/EnumGetValueDynamicReturnTypeExtension.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class AllTypeEnum extends Enum
+{
+    const NIL = null;
+    const BOOL = true;
+    const INT = 1;
+    const FLOAT = 1.1;
+    const STR = 'str';
+    const ARR = [null, true, 1, 1.1, 'str', []];
+}

tests/Assets/AllTypeEnum.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class ArrayTypeEnum extends Enum
+{
+    const ARRAY = [[]];
+}

tests/Assets/ArrayTypeEnum.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class BoolTypeEnum extends Enum
+{
+    const BOOL_TRUE = true;
+    const BOOL_FALSE = false;
+}

tests/Assets/BoolTypeEnum.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class DocCommentEnum extends Enum
+{
+    /**
+     * With doc block
+     *
+     * @var string
+     */
+    const WITH_DOC_BLOCK = 'with doc block';
+
+    const WITHOUT_DOC_BLOCK = 'without doc block';
+}

tests/Assets/DocCommentEnum.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class FloatTypeEnum extends Enum
+{
+    const FLOAT11 = 1.1;
+    const FLOAT12 = 1.2;
+}

tests/Assets/FloatTypeEnum.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class IntTypeEnum extends Enum
+{
+    const INT0 = 0;
+    const INT1 = 1;
+}

tests/Assets/IntTypeEnum.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class NullTypeEnum extends Enum
+{
+    const NULL = null;
+}

tests/Assets/NullTypeEnum.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class StrTypeEnum extends Enum
+{
+    const STR1 = 'str1';
+    const STR2 = 'str2';
+}

tests/Assets/StrTypeEnum.php

@@ -6,7 +6,7 @@
 
 use MabeEnum\Enum;
 
-class StrEnum extends Enum
+class VisibilityEnum extends Enum
 {
     /**
      * String const without visibility declaration
@@ -29,6 +29,4 @@ class StrEnum extends Enum
      * Public string const
      */
     public const PUBLIC_STR = 'public str';
-
-    public const NO_DOC_BLOCK = 'no doc block';
 }