Add support for final constants

Author: jaapio

src/phpDocumentor/Reflection/Php/Constant.php

@@ -38,6 +38,9 @@ final class Constant implements Element
     /** @var Visibility */
     private $visibility;
 
+    /** @var bool */
+    private $final;
+
     /**
      * Initializes the object.
      */
@@ -46,13 +49,15 @@ public function __construct(
         ?DocBlock $docBlock = null,
         ?string $value = null,
         ?Location $location = null,
-        ?Visibility $visibility = null
+        ?Visibility $visibility = null,
+        bool $final = false
     ) {
         $this->fqsen = $fqsen;
         $this->docBlock = $docBlock;
         $this->value = $value;
         $this->location = $location ?: new Location(-1);
         $this->visibility = $visibility ?: new Visibility(Visibility::PUBLIC_);
+        $this->final = $final;
     }
 
     /**
@@ -96,4 +101,9 @@ public function getVisibility(): Visibility
     {
         return $this->visibility;
     }
+
+    public function isFinal(): bool
+    {
+        return $this->final;
+    }
 }

src/phpDocumentor/Reflection/Php/Factory/ClassConstant.php

@@ -78,7 +78,8 @@ protected function doCreate(
                 $this->createDocBlock($const->getDocComment(), $context->getTypeContext()),
                 $const->getValue() !== null ? $this->valueConverter->prettyPrintExpr($const->getValue()) : null,
                 new Location($const->getLine()),
-                $this->buildVisibility($const)
+                $this->buildVisibility($const),
+                $const->isFinal()
             ));
         }
     }

src/phpDocumentor/Reflection/Php/Factory/ClassConstantIterator.php

@@ -109,6 +109,11 @@ public function getValue(): Expr
         return $this->classConstants->consts[$this->index]->value;
     }
 
+    public function isFinal(): bool
+    {
+        return $this->classConstants->isFinal();
+    }
+
     /**
      * @link http://php.net/manual/en/iterator.current.php
      */

tests/unit/phpDocumentor/Reflection/Php/ConstantTest.php

@@ -60,6 +60,15 @@ public function testGetValue(): void
         $this->assertSame($this->value, $this->fixture->getValue());
     }
 
+    /**
+     * @covers ::isFinal
+     * @covers ::__construct
+     */
+    public function testIsFinal(): void
+    {
+        $this->assertFalse($this->fixture->isFinal());
+    }
+
     /**
      * @covers ::getFqsen
      * @covers ::getName

tests/unit/phpDocumentor/Reflection/Php/Factory/ClassConstantIteratorTest.php

@@ -34,13 +34,14 @@ final class ClassConstantIteratorTest extends MockeryTestCase
      * @covers ::valid()
      * @covers ::rewind()
      * @covers ::getName()
+     * @covers ::getValue()
      * @covers ::getFqsen()
      */
     public function testIterateProps(): void
     {
-        $const1 = new Const_('\Space\MyClass::MY_CONST1', new Variable('a'));
+        $const1 = new Const_('\Space\MyClass::MY_CONST1', new Variable('1'));
         $const1->fqsen = new Fqsen((string) $const1->name);
-        $const2 = new Const_('\Space\MyClass::MY_CONST2', new Variable('b'));
+        $const2 = new Const_('\Space\MyClass::MY_CONST2', new Variable('2'));
         $const2->fqsen = new Fqsen((string) $const2->name);
 
         $classConstantNode = new ClassConst([$const1, $const2]);
@@ -49,7 +50,7 @@ public function testIterateProps(): void
         foreach (new ClassConstantIterator($classConstantNode) as $constant) {
             $this->assertEquals('\Space\MyClass::MY_CONST' . $i, $constant->getName());
             $this->assertEquals('\Space\MyClass::MY_CONST' . $i, (string) $constant->getFqsen());
-
+            $this->assertEquals($i, $constant->getValue()->name);
             ++$i;
         }
     }

tests/unit/phpDocumentor/Reflection/Php/Factory/ClassConstantTest.php

@@ -60,14 +60,15 @@ public function testMatches(): void
     }
 
     /** @dataProvider visibilityProvider */
-    public function testCreateWithVisibility(int $input, string $expectedVisibility): void
+    public function testCreateWithVisibility(int $input, string $expectedVisibility, bool $isFinal = false): void
     {
         $constantStub = $this->buildConstantIteratorStub($input);
 
         $class = $this->performCreate($constantStub);
 
         $constant = current($class->getConstants());
         $this->assertConstant($constant, $expectedVisibility);
+        $this->assertSame($isFinal, $constant->isFinal());
     }
 
     /** @return array<string|int[]> */
@@ -86,6 +87,11 @@ public function visibilityProvider(): array
                 ClassNode::MODIFIER_PRIVATE,
                 'private',
             ],
+            [
+                ClassNode::MODIFIER_PRIVATE | ClassNode::MODIFIER_FINAL,
+                'private',
+                true,
+            ],
         ];
     }