Reintroduce used traits

Fixes a regression in v5, used traits were missing.

Fixes #208

Author: jaapio

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

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Reflection\Php\Factory;
+
+use InvalidArgumentException;
+use phpDocumentor\Reflection\Fqsen;
+use phpDocumentor\Reflection\Php\Class_;
+use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
+use phpDocumentor\Reflection\Php\StrategyContainer;
+use phpDocumentor\Reflection\Php\Trait_;
+use PhpParser\Node\Stmt\TraitUse as TraitUseNode;
+
+final class TraitUse implements ProjectFactoryStrategy
+{
+    public function matches(ContextStack $context, object $object) : bool
+    {
+        return $object instanceof TraitUseNode;
+    }
+
+    /**
+     * @param ContextStack $context of the created object
+     * @param TraitUseNode $object
+     */
+    public function create(ContextStack $context, object $object, StrategyContainer $strategies) : void
+    {
+        if ($this->matches($context, $object) === false) {
+            throw new InvalidArgumentException('Does not match expected node');
+        }
+
+        $class = $context->peek();
+
+        if ($class instanceof Class_ === false && $class instanceof Trait_ === false) {
+            throw new InvalidArgumentException('Traits can only be used in class or trait');
+        }
+
+        foreach ($object->traits as $trait) {
+            $class->addUsedTrait(new Fqsen($trait->toCodeString()));
+        }
+    }
+}

src/phpDocumentor/Reflection/Php/ProjectFactory.php

@@ -19,6 +19,7 @@
 use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\Php\Factory\ContextStack;
 use phpDocumentor\Reflection\Php\Factory\Noop;
+use phpDocumentor\Reflection\Php\Factory\TraitUse;
 use phpDocumentor\Reflection\Project as ProjectInterface;
 use phpDocumentor\Reflection\ProjectFactory as ProjectFactoryInterface;
 use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
@@ -67,6 +68,7 @@ public static function createInstance() : self
                 new Factory\Property($docblockFactory, new PrettyPrinter()),
                 new Factory\Trait_($docblockFactory),
                 new Factory\IfStatement(),
+                new TraitUse(),
             ]
         );
 

tests/integration/ClassesTest.php

@@ -79,6 +79,19 @@ public function testTypedPropertiesReturnTheirType() : void
         $this->assertEquals(new Integer(), $pizzaClass->getProperties()['\\Luigi\\Pizza::$size']->getType());
     }
 
+    public function testUsedTraitsAreIncludedInClass() : void
+    {
+        $fileName = self::FILE_LUIGI_PIZZA;
+        $project = $this->fixture->create(
+            'MyProject',
+            [new LocalFile($fileName)]
+        );
+
+        /** @var Class_ $pizzaClass */
+        $pizzaClass = $project->getFiles()[$fileName]->getClasses()['\\Luigi\\Pizza'];
+        $this->assertEquals(['\\Luigi\\ExampleNestedTrait' => new Fqsen('\\Luigi\\ExampleNestedTrait')], $pizzaClass->getUsedTraits());
+    }
+
     public function testWithNamespacedClass() : void
     {
         $fileName = self::FILE_LUIGI_PIZZA;

tests/integration/data/Luigi/Pizza.php

@@ -19,6 +19,8 @@ class Pizza extends \Pizza
         /** @var string PICKUP   designates that the delivery method is that the customer picks the pizza up. */
         PICKUP = 'pickup';
 
+    use ExampleNestedTrait;
+
     /** @var static contains the active instance for this Pizza. */
     static private $instance;
 

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

@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Reflection\Php\Factory;
+
+use InvalidArgumentException;
+use phpDocumentor\Reflection\Element;
+use phpDocumentor\Reflection\Fqsen;
+use phpDocumentor\Reflection\Php\Class_ as Class_Element;
+use phpDocumentor\Reflection\Php\Interface_;
+use phpDocumentor\Reflection\Php\ProjectFactoryStrategies;
+use phpDocumentor\Reflection\Php\Trait_ as Trait_Element;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Stmt\TraitUse as TraitUseNode;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\Php\Factory\TraitUse
+ */
+final class TraitUseTest extends TestCase
+{
+    /** @return mixed[][] */
+    public function consumerProvider() : array
+    {
+        return [
+            [new Class_Element(new Fqsen('\MyClass'))],
+            [new Trait_Element(new Fqsen('\MyTrait'))],
+        ];
+    }
+
+    protected function setUp() : void
+    {
+        $this->fixture = new TraitUse();
+    }
+
+    /**
+     * @covers ::matches
+     */
+    public function testMatchesOnlyTraitUseNode() : void
+    {
+        self::assertTrue(
+            $this->fixture->matches(
+                self::createContext(),
+                $this->givenTraitUse()
+            )
+        );
+    }
+
+    /** @covers ::create */
+    public function testCreateThrowsExceptionWhenStackDoesNotContainClass() : void
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        $context = self::createContext()->push(new Interface_(new Fqsen('\Interface')));
+        $this->fixture->create($context, $this->givenTraitUse(), new ProjectFactoryStrategies([]));
+    }
+
+    /**
+     * @param Class_Element|Trait_Element $traitConsumer
+     *
+     * @covers ::create
+     * @dataProvider consumerProvider
+     */
+    public function testCreateWillAddUsedTraitToContextTop(Element $traitConsumer) : void
+    {
+        $context = self::createContext()->push($traitConsumer);
+        $this->fixture->create($context, $this->givenTraitUse(), new ProjectFactoryStrategies([]));
+
+        self::assertEquals(['\Foo' => new Fqsen('\Foo')], $traitConsumer->getUsedTraits());
+    }
+
+    private function givenTraitUse() : TraitUseNode
+    {
+        return new TraitUseNode([new FullyQualified('Foo')]);
+    }
+}