Added support for doc block comment and @Deprecation annotation

Author: marc-mabe

src/EnumMethodReflection.php

@@ -86,17 +86,24 @@ public function getVariants(): array
 
     public function getDocComment(): ?string
     {
-        return null;
+        $docComment = $this->classReflection->getConstant($this->name)->getDocComment();
+
+        if ($docComment) {
+            // remove @var annotation of constant definition
+            $docComment = preg_replace('/@var.*/', '', $docComment);
+        }
+
+        return $docComment;
     }
 
     public function isDeprecated(): TrinaryLogic
     {
-        return TrinaryLogic::createNo();
+        return $this->classReflection->getConstant($this->name)->isDeprecated();
     }
 
     public function getDeprecatedDescription(): ?string
     {
-        return null;
+        return $this->classReflection->getConstant($this->name)->getDeprecatedDescription();
     }
 
     public function isFinal(): TrinaryLogic

tests/Assets/DeprecatedEnum.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MabeEnumPHPStanTest\Assets;
+
+use MabeEnum\Enum;
+
+class DeprecatedEnum extends Enum
+{
+    /**
+     * @deprecated Test deprecated reflection
+     */
+    const DEPRECATED = 'deprecated';
+
+    const NOT_DEPRECATED = 'not deprecated';
+}

tests/Assets/StrEnum.php

@@ -8,8 +8,27 @@
 
 class StrEnum extends Enum
 {
+    /**
+     * String const without visibility declaration
+     *
+     * @var string
+     */
     const STR = 'str';
+
+    /**
+     * Private string const
+     */
     private const PRIVATE_STR = 'private str';
+
+    /**
+     * Protected string const
+     */
     protected const PROTECTED_STR = 'protected str';
+
+    /**
+     * Public string const
+     */
     public const PUBLIC_STR = 'public str';
+
+    public const NO_DOC_BLOCK = 'no doc block';
 }

tests/EnumMethodReflectionTest.php

@@ -6,10 +6,12 @@
 
 use MabeEnumPHPStan\EnumMethodReflection;
 use MabeEnumPHPStan\EnumMethodsClassReflectionExtension;
+use MabeEnumPHPStanTest\Assets\DeprecatedEnum;
 use MabeEnumPHPStanTest\Assets\NotAnEnum;
 use MabeEnumPHPStanTest\Assets\StrEnum;
 use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Testing\TestCase;
+use PHPStan\TrinaryLogic;
 use PHPStan\Type\VerbosityLevel;
 
 class EnumMethodReflectionTest extends TestCase
@@ -70,4 +72,40 @@ public function testGetVariants()
 
         $this->assertSame(StrEnum::class, $parametersAcceptor->getReturnType()->describe(VerbosityLevel::value()));
     }
+
+    public function testGetDocComment()
+    {
+        $classReflection = $this->broker->getClass(StrEnum::class);
+        $docMethodRefl = $this->reflectionExtension->getMethod($classReflection, 'STR');
+        $noDocMethodRefl = $this->reflectionExtension->getMethod($classReflection, 'NO_DOC_BLOCK');
+
+        // return null on no doc block
+        $this->assertSame(null, $noDocMethodRefl->getDocComment());
+
+        // return the correct doc block
+        $this->assertRegExp('/String const without visibility declaration/', $docMethodRefl->getDocComment());
+
+        // remove @var declaration
+        $this->assertNotRegExp('/@var/', $docMethodRefl->getDocComment());
+    }
+
+    public function testIsDeprecated()
+    {
+        $classReflection = $this->broker->getClass(DeprecatedEnum::class);
+        $deprecatedRefl = $this->reflectionExtension->getMethod($classReflection, 'DEPRECATED');
+        $notDeprecatedRefl = $this->reflectionExtension->getMethod($classReflection, 'NOT_DEPRECATED');
+
+        $this->assertTrue($deprecatedRefl->isDeprecated()->yes());
+        $this->assertTrue($notDeprecatedRefl->isDeprecated()->no());
+    }
+
+    public function testGetDeprecatedDescription()
+    {
+        $classReflection = $this->broker->getClass(DeprecatedEnum::class);
+        $deprecatedRefl = $this->reflectionExtension->getMethod($classReflection, 'DEPRECATED');
+        $notDeprecatedRefl = $this->reflectionExtension->getMethod($classReflection, 'NOT_DEPRECATED');
+
+        $this->assertSame('Test deprecated reflection', $deprecatedRefl->getDeprecatedDescription());
+        $this->assertNull($notDeprecatedRefl->getDeprecatedDescription());
+    }
 }