add the feature to DoctrineAnnotationCompletor

Author: camilledejoye

lib/Bridge/TolerantParser/WorseReflection/DoctrineAnnotationCompletor.php

@@ -6,19 +6,21 @@
 use Microsoft\PhpParser\Node;
 use Microsoft\PhpParser\Node\SourceFileNode;
 use Microsoft\PhpParser\Parser;
+use Phpactor\Completion\Bridge\TolerantParser\ResolveAliasSuggestionsTrait;
 use Phpactor\Completion\Core\Completor;
 use Phpactor\Completion\Core\Completor\NameSearcherCompletor;
 use Phpactor\Completion\Core\Suggestion;
 use Phpactor\Completion\Core\Util\OffsetHelper;
 use Phpactor\ReferenceFinder\NameSearcher;
-use Phpactor\ReferenceFinder\Search\NameSearchResult;
 use Phpactor\TextDocument\ByteOffset;
 use Phpactor\TextDocument\TextDocument;
 use Phpactor\WorseReflection\Core\Exception\NotFound;
 use Phpactor\WorseReflection\Reflector;
 
 class DoctrineAnnotationCompletor extends NameSearcherCompletor implements Completor
 {
+    use ResolveAliasSuggestionsTrait;
+
     /**
      * @var Reflector
      */
@@ -61,26 +63,23 @@ public function complete(TextDocument $source, ByteOffset $byteOffset): Generato
             return true;
         }
 
+        $importTable = $this->getClassImportTablesForNode($node);
         $suggestions = $this->completeName($annotation);
 
         foreach ($suggestions as $suggestion) {
             if (!$this->isAnAnnotation($suggestion)) {
                 continue;
             }
 
-            yield $suggestion;
+            $resolvedSuggestions = $this->resolveAliasSuggestions($importTable, $suggestion);
+            foreach ($resolvedSuggestions as $resolvedSuggestion) {
+                yield $resolvedSuggestion->withSnippet($resolvedSuggestion->name().'($1)$0');
+            }
         }
 
         return $suggestions->getReturn();
     }
 
-    protected function createSuggestionOptions(NameSearchResult $result): array
-    {
-        return array_merge(parent::createSuggestionOptions($result), [
-            'snippet' => (string) $result->name()->head() .'($1)$0',
-        ]);
-    }
-
     private function truncateSource(string $source, int $byteOffset): string
     {
         // truncate source at byte offset - we don't want the rest of the source

lib/Core/Suggestion.php

@@ -146,6 +146,14 @@ public function withoutNameImport(): self
         return $suggestion;
     }
 
+    public function withSnippet(string $snippet): self
+    {
+        $suggestion = clone $this;
+        $suggestion->snippet = $snippet;
+
+        return $suggestion;
+    }
+
     public function toArray(): array
     {
         return [

tests/Integration/Bridge/TolerantParser/DoctrineAnnotationCompletorTest.php

@@ -104,7 +104,45 @@ class Foo {}
                 'type' => Suggestion::TYPE_CLASS,
                 'name' => 'Entity',
                 'short_description' => 'App\Annotation\Entity',
-                'snippet' => 'Entity($1)$0'
+                'snippet' => 'Entity($1)$0',
+                'name_import' => 'App\Annotation\Entity',
+            ]
+        ]];
+
+
+        yield 'in a namespace with an import' => [
+            <<<'EOT'
+<?php
+
+namespace App\Annotation;
+
+/**
+ * @Annotation
+ */
+class Entity {}
+
+namespace App;
+
+use App\Annotation as APP;
+
+/**
+ * @Ent<>
+ */
+class Foo {}
+EOT
+        , [
+            [
+                'type' => Suggestion::TYPE_CLASS,
+                'name' => 'APP\Entity',
+                'short_description' => 'App\Annotation\Entity',
+                'snippet' => 'APP\Entity($1)$0',
+                'name_import' => null,
+            ], [
+                'type' => Suggestion::TYPE_CLASS,
+                'name' => 'Entity',
+                'short_description' => 'App\Annotation\Entity',
+                'snippet' => 'Entity($1)$0',
+                'name_import' => 'App\Annotation\Entity',
             ]
         ]];
 

tests/Unit/Core/SuggestionTest.php

@@ -89,4 +89,13 @@ public function testWithoutNameImport()
         )->withoutNameImport();
         $this->assertNull($suggestion->nameImport());
     }
+
+    public function testWithSnippet()
+    {
+        $suggestion = Suggestion::createWithOptions(
+            'name',
+            ['snippet' => 'snippet'],
+        )->withSnippet('test');
+        $this->assertEquals('test', $suggestion->snippet());
+    }
 }