Merge pull request #78 from jaapio/feature/constantStrategy

Feature/constant strategy

Author: mvriel

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

@@ -17,6 +17,7 @@
 use phpDocumentor\Reflection\Php\Factory;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\StrategyContainer;
+use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
 use PhpParser\Node\Param;
 
@@ -28,6 +29,20 @@
  */
 final class Argument implements ProjectFactoryStrategy
 {
+    /**
+     * @var PrettyPrinter
+     */
+    private $valueConverter;
+
+    /**
+     * Initializes the object.
+     *
+     * @param PrettyPrinter $prettyPrinter
+     */
+    public function __construct(PrettyPrinter $prettyPrinter)
+    {
+        $this->valueConverter = $prettyPrinter;
+    }
 
     /**
      * Returns true when the strategy is able to handle the object.
@@ -61,6 +76,11 @@ public function create($object, StrategyContainer $strategies, Context $context
             );
         }
 
-        return new ArgumentDescriptor($object->name, $object->default, $object->byRef, $object->variadic);
+        $default = null;
+        if ($object->default !== null) {
+            $default = $this->valueConverter->prettyPrintExpr($object->default);
+        }
+
+        return new ArgumentDescriptor($object->name, $default, $object->byRef, $object->variadic);
     }
 }

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

@@ -87,6 +87,11 @@ public function getDocComment()
         return $docComment;
     }
 
+    public function getValue()
+    {
+        return $this->classConstants->consts[$this->index]->value;
+    }
+
     /**
      * (PHP 5 &gt;= 5.0.0)<br/>
      * Return the current element

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

@@ -16,7 +16,9 @@
 use phpDocumentor\Reflection\Php\Constant as ConstantElement;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\StrategyContainer;
+use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
+use PhpParser\Comment\Doc;
 
 /**
  * Strategy to convert ClassConstantIterator to ConstantElement
@@ -26,6 +28,21 @@
  */
 class Constant implements ProjectFactoryStrategy
 {
+    /**
+     * @var PrettyPrinter
+     */
+    private $valueConverter;
+
+    /**
+     * Initializes the object.
+     *
+     * @param PrettyPrinter $prettyPrinter
+     */
+    public function __construct(PrettyPrinter $prettyPrinter)
+    {
+        $this->valueConverter = $prettyPrinter;
+    }
+
     /**
      * Returns true when the strategy is able to handle the object.
      *
@@ -49,6 +66,28 @@ public function matches($object)
      */
     public function create($object, StrategyContainer $strategies, Context $context = null)
     {
-        return new ConstantElement($object->getFqsen());
+        $docBlock = $this->createDocBlock($object->getDocComment(), $strategies, $context);
+        $default = null;
+        if ($object->getValue() !== null) {
+            $default = $this->valueConverter->prettyPrintExpr($object->getValue());
+        }
+
+        return new ConstantElement($object->getFqsen(), $docBlock, $default);
+    }
+
+    /**
+     * @param Doc $docBlock
+     * @param StrategyContainer $strategies
+     * @param Context $context
+     * @return null|\phpDocumentor\Reflection\DocBlock
+     */
+    private function createDocBlock(Doc $docBlock = null, StrategyContainer $strategies, Context $context = null)
+    {
+        if ($docBlock === null) {
+            return null;
+        }
+
+        $strategy = $strategies->findMatching($docBlock);
+        return $strategy->create($docBlock, $strategies, $context);
     }
 }

src/phpDocumentor/Reflection/Php/ProjectFactory.php

@@ -48,9 +48,9 @@ public static function createInstance()
     {
        return new static(
             [
-                new Factory\Argument(),
+                new Factory\Argument(new PrettyPrinter()),
                 new Factory\Class_(),
-                new Factory\Constant(),
+                new Factory\Constant(new PrettyPrinter()),
                 new Factory\DocBlock(DocBlockFactory::createInstance()),
                 new Factory\File(NodesFactory::createInstance()),
                 new Factory\Function_(),

tests/component/ProjectCreationTest.php

@@ -56,6 +56,9 @@ public function testCreateProjectWithClass()
         $this->assertArrayHasKey($fileName, $project->getFiles());
         $this->assertArrayHasKey('\\Pizza', $project->getFiles()[$fileName]->getClasses());
         $this->assertArrayHasKey('\\Pizza::PACKAGING', $project->getFiles()[$fileName]->getClasses()['\\Pizza']->getConstants());
+        $constant = $project->getFiles()[$fileName]->getClasses()['\\Pizza']->getConstants()['\\Pizza::PACKAGING'];
+
+        $this->assertEquals('box',$constant->getValue());
     }
 
     public function testWithNamespacedClass()

tests/component/ProjectNamespaceTest.php

@@ -43,22 +43,7 @@ class ProjectNamespaceTest extends \PHPUnit_Framework_TestCase
      */
     protected function setUp()
     {
-        $docBlockFactory = DocBlockFactory::createInstance();
-
-        $this->fixture = new ProjectFactory(
-            array(
-                new Argument(),
-                new Class_(),
-                new Constant(),
-                new DocBlockStrategy($docBlockFactory),
-                new File(NodesFactory::createInstance()),
-                new Function_(),
-                new Interface_(),
-                new Method(),
-                new Property(new PrettyPrinter()),
-                new Trait_(),
-            )
-        );
+        $this->fixture = $this->fixture = ProjectFactory::createInstance();
     }
 
     public function testWithNamespacedClass()

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

@@ -13,9 +13,11 @@
 
 use phpDocumentor\Reflection\Php\Argument as ArgumentDescriptor;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategies;
+use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
 use PhpParser\Node\Param;
 use Mockery as m;
+use PhpParser\Node\Scalar\String_;
 
 /**
  * Class ArgumentTest
@@ -25,7 +27,7 @@ class ArgumentTest extends TestCase
 {
     protected function setUp()
     {
-        $this->fixture = new Argument();
+        $this->fixture = new Argument(new PrettyPrinter());
     }
 
     /**
@@ -46,7 +48,7 @@ public function testCreate()
 
         $argMock = m::mock(Param::class);
         $argMock->name = 'myArgument';
-        $argMock->default = 'MyDefault';
+        $argMock->default = new String_('MyDefault');
         $argMock->byRef = true;
         $argMock->variadic = true;