refactor: use protocol package (#661)

Adapts the Language Server to use the extracted php language server protocol

Author: dantleech

composer.json

@@ -24,6 +24,7 @@
  "php": "^7.0",
  "composer/xdebug-handler": "^1.0",
  "felixfbecker/advanced-json-rpc": "^3.0.0",
+ "felixfbecker/language-server-protocol": "^1.0.1",
  "jetbrains/phpstorm-stubs": "dev-master",
  "microsoft/tolerant-php-parser": "0.0.*",
  "netresearch/jsonmapper": "^1.0",

src/Client/TextDocument.php

@@ -4,7 +4,7 @@
 namespace LanguageServer\Client;
 
 use LanguageServer\ClientHandler;
-use LanguageServer\Protocol\{TextDocumentItem, TextDocumentIdentifier};
+use LanguageServerProtocol\{TextDocumentItem, TextDocumentIdentifier};
 use Sabre\Event\Promise;
 use JsonMapper;
 

src/Client/Workspace.php

@@ -4,7 +4,7 @@
 namespace LanguageServer\Client;
 
 use LanguageServer\ClientHandler;
-use LanguageServer\Protocol\TextDocumentIdentifier;
+use LanguageServerProtocol\TextDocumentIdentifier;
 use Sabre\Event\Promise;
 use JsonMapper;
 

src/ClientHandler.php

@@ -41,12 +41,12 @@ public function request(string $method, $params): Promise
  {
  $id = $this->idGenerator->generate();
  return $this->protocolWriter->write(
- new Protocol\Message(
+ new Message(
  new AdvancedJsonRpc\Request($id, $method, (object)$params)
  )
  )->then(function () use ($id) {
  $promise = new Promise;
- $listener = function (Protocol\Message $msg) use ($id, $promise, &$listener) {
+ $listener = function (Message $msg) use ($id, $promise, &$listener) {
  if (AdvancedJsonRpc\Response::isResponse($msg->body) && $msg->body->id === $id) {
  // Received a response
  $this->protocolReader->removeListener('message', $listener);
@@ -72,7 +72,7 @@ public function request(string $method, $params): Promise
  public function notify(string $method, $params): Promise
  {
  return $this->protocolWriter->write(
- new Protocol\Message(
+ new Message(
  new AdvancedJsonRpc\Notification($method, (object)$params)
  )
  );

src/CompletionProvider.php

@@ -4,7 +4,8 @@
 namespace LanguageServer;
 
 use LanguageServer\Index\ReadableIndex;
-use LanguageServer\Protocol\{
+use LanguageServer\Factory\CompletionItemFactory;
+use LanguageServerProtocol\{
  TextEdit,
  Range,
  Position,
@@ -246,7 +247,7 @@ public function provideCompletion(PhpDocument $doc, Position $pos, CompletionCon
  foreach ($this->index->getDefinitions() as $fqn => $def) {
  foreach ($prefixes as $prefix) {
  if (substr($fqn, 0, strlen($prefix)) === $prefix && $def->isMember) {
- $list->items[] = CompletionItem::fromDefinition($def);
+ $list->items[] = CompletionItemFactory::fromDefinition($def);
  }
  }
  }
@@ -279,7 +280,7 @@ public function provideCompletion(PhpDocument $doc, Position $pos, CompletionCon
  foreach ($this->index->getDefinitions() as $fqn => $def) {
  foreach ($prefixes as $prefix) {
  if (substr(strtolower($fqn), 0, strlen($prefix)) === strtolower($prefix) && $def->isMember) {
- $list->items[] = CompletionItem::fromDefinition($def);
+ $list->items[] = CompletionItemFactory::fromDefinition($def);
  }
  }
  }
@@ -337,7 +338,7 @@ public function provideCompletion(PhpDocument $doc, Position $pos, CompletionCon
  foreach ($aliases as $alias => $fqn) {
  // Suggest symbols that have been `use`d and match the prefix
  if (substr($alias, 0, $prefixLen) === $prefix && ($def = $this->index->getDefinition($fqn))) {
- $list->items[] = CompletionItem::fromDefinition($def);
+ $list->items[] = CompletionItemFactory::fromDefinition($def);
  }
  }
  }
@@ -370,7 +371,7 @@ public function provideCompletion(PhpDocument $doc, Position $pos, CompletionCon
  // Only suggest classes for `new`
  && (!isset($creation) || $def->canBeInstantiated)
  ) {
- $item = CompletionItem::fromDefinition($def);
+ $item = CompletionItemFactory::fromDefinition($def);
  // Find the shortest name to reference the symbol
  if ($namespaceNode && ($alias = array_search($fqn, $aliases, true)) !== false) {
  // $alias is the name under which this definition is aliased in the current namespace

src/ContentRetriever/ClientContentRetriever.php

@@ -4,7 +4,7 @@
 namespace LanguageServer\ContentRetriever;
 
 use LanguageServer\LanguageClient;
-use LanguageServer\Protocol\{TextDocumentIdentifier, TextDocumentItem};
+use LanguageServerProtocol\{TextDocumentIdentifier, TextDocumentItem};
 use Sabre\Event\Promise;
 
 /**

src/Definition.php

@@ -5,7 +5,7 @@
 
 use LanguageServer\Index\ReadableIndex;
 use phpDocumentor\Reflection\{Types, Type, Fqsen, TypeResolver};
-use LanguageServer\Protocol\SymbolInformation;
+use LanguageServerProtocol\SymbolInformation;
 use Generator;
 
 /**

src/DefinitionResolver.php

@@ -4,7 +4,8 @@
 namespace LanguageServer;
 
 use LanguageServer\Index\ReadableIndex;
-use LanguageServer\Protocol\SymbolInformation;
+use LanguageServer\Factory\SymbolInformationFactory;
+use LanguageServerProtocol\SymbolInformation;
 use Microsoft\PhpParser;
 use Microsoft\PhpParser\Node;
 use Microsoft\PhpParser\FunctionLike;
@@ -36,7 +37,7 @@ class DefinitionResolver
  private $docBlockFactory;
 
  /**
- * Creates SignatureInformation
+ * Creates SignatureInformation instances
  *
  * @var SignatureInformationFactory
  */
@@ -233,7 +234,7 @@ public function createDefinitionFromNode(Node $node, string $fqn = null): Defini
  }
  }
 
- $def->symbolInformation = SymbolInformation::fromNode($node, $fqn);
+ $def->symbolInformation = SymbolInformationFactory::fromNode($node, $fqn);
 
  if ($def->symbolInformation !== null) {
  $def->type = $this->getTypeFromNode($node);

src/Factory/CompletionItemFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace LanguageServer\Factory;
+
+use LanguageServer\Definition;
+use LanguageServerProtocol\CompletionItem;
+use LanguageServerProtocol\CompletionItemKind;
+use LanguageServerProtocol\SymbolKind;
+
+class CompletionItemFactory
+{
+ /**
+ * Creates a CompletionItem for a Definition
+ *
+ * @param Definition $def
+ * @return CompletionItem|null
+ */
+ public static function fromDefinition(Definition $def)
+ {
+ $item = new CompletionItem;
+ $item->label = $def->symbolInformation->name;
+ $item->kind = CompletionItemKind::fromSymbolKind($def->symbolInformation->kind);
+ if ($def->type) {
+ $item->detail = (string)$def->type;
+ } else if ($def->symbolInformation->containerName) {
+ $item->detail = $def->symbolInformation->containerName;
+ }
+ if ($def->documentation) {
+ $item->documentation = $def->documentation;
+ }
+ if ($def->isStatic && $def->symbolInformation->kind === SymbolKind::PROPERTY) {
+ $item->insertText = '$' . $def->symbolInformation->name;
+ }
+ return $item;
+ }
+}

src/Factory/LocationFactory.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace LanguageServer\Factory;
+
+use LanguageServerProtocol\Location;
+use LanguageServerProtocol\Position;
+use LanguageServerProtocol\Range;
+use Microsoft\PhpParser\Node;
+use Microsoft\PhpParser\PositionUtilities;
+
+class LocationFactory
+{
+ /**
+ * Returns the location of the node
+ *
+ * @param Node $node
+ * @return self
+ */
+ public static function fromNode(Node $node): Location
+ {
+ $range = PositionUtilities::getRangeFromPosition(
+ $node->getStart(),
+ $node->getWidth(),
+ $node->getFileContents()
+ );
+
+ return new Location($node->getUri(), new Range(
+ new Position($range->start->line, $range->start->character),
+ new Position($range->end->line, $range->end->character)
+ ));
+ }
+}