Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix auto completion by partial property or method #10320

Merged
merged 2 commits into from
Nov 3, 2023
Merged

Fix auto completion by partial property or method #10320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6faff2
Fix auto comletion by partial property or method
issidorov Oct 26, 2023
2f039f9
Fix auto-completion with declared static method by DocBlock
issidorov Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
57 changes: 53 additions & 4 deletions src/Psalm/Codebase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
use UnexpectedValueException;

use function array_combine;
use function array_merge;
use function array_pop;
use function array_reverse;
use function array_values;
Expand Down Expand Up @@ -1742,6 +1743,9 @@ public function getCompletionDataAtPosition(string $file_path, Position $positio

$offset = $position->toOffset($file_contents);

$literal_part = $this->getBeginedLiteralPart($file_path, $position);
$begin_literal_offset = $offset - strlen($literal_part);

[$reference_map, $type_map] = $this->analyzer->getMapsForFile($file_path);

if (!$reference_map && !$type_map) {
Expand Down Expand Up @@ -1776,7 +1780,7 @@ public function getCompletionDataAtPosition(string $file_path, Position $positio
}
}

if ($offset - $end_pos === 2 || $offset - $end_pos === 3) {
if ($begin_literal_offset - $end_pos === 2) {
$candidate_gap = substr($file_contents, $end_pos, 2);

if ($candidate_gap === '->' || $candidate_gap === '::') {
Expand All @@ -1801,6 +1805,11 @@ public function getCompletionDataAtPosition(string $file_path, Position $positio
return [$possible_reference, '::', $offset];
}

if ($offset <= $end_pos && substr($file_contents, $begin_literal_offset - 2, 2) === '::') {
$class_name = explode('::', $possible_reference)[0];
return [$class_name, '::', $offset];
}

// Only continue for references that are partial / don't exist.
if ($possible_reference[0] !== '*') {
continue;
Expand All @@ -1816,6 +1825,23 @@ public function getCompletionDataAtPosition(string $file_path, Position $positio
return null;
}

public function getBeginedLiteralPart(string $file_path, Position $position): string
{
$is_open = $this->file_provider->isOpen($file_path);

if (!$is_open) {
throw new UnanalyzedFileException($file_path . ' is not open');
}

$file_contents = $this->getFileContents($file_path);

$offset = $position->toOffset($file_contents);

preg_match('/\$?\w+$/', substr($file_contents, 0, $offset), $matches);

return $matches[0] ?? '';
}

public function getTypeContextAtPosition(string $file_path, Position $position): ?Union
{
$file_contents = $this->getFileContents($file_path);
Expand Down Expand Up @@ -1858,9 +1884,12 @@ public function getCompletionItemsForClassishThing(
try {
$class_storage = $this->classlike_storage_provider->get($atomic_type->value);

foreach ($class_storage->appearing_method_ids as $declaring_method_id) {
$method_storage = $this->methods->getStorage($declaring_method_id);

$methods = array_merge(
$class_storage->methods,
$class_storage->pseudo_methods,
$class_storage->pseudo_static_methods,
);
foreach ($methods as $method_storage) {
if ($method_storage->is_static || $gap === '->') {
$completion_item = new CompletionItem(
$method_storage->cased_name,
Expand Down Expand Up @@ -1957,6 +1986,26 @@ public function getCompletionItemsForClassishThing(
return $completion_items;
}

/**
* @param list<CompletionItem> $items
* @return list<CompletionItem>
*/
public function filterCompletionItemsByBeginLiteralPart(array $items, string $literal_part): array
{
if (!$literal_part) {
return $items;
}

$res = [];
foreach ($items as $item) {
if ($item->insertText && strpos($item->insertText, $literal_part) === 0) {
$res[] = $item;
}
}

return $res;
}

/**
* @return list<CompletionItem>
*/
Expand Down
3 changes: 3 additions & 0 deletions src/Psalm/Internal/LanguageServer/Server/TextDocument.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ public function completion(TextDocumentIdentifier $textDocument, Position $posit

try {
$completion_data = $this->codebase->getCompletionDataAtPosition($file_path, $position);
$literal_part = $this->codebase->getBeginedLiteralPart($file_path, $position);
if ($completion_data) {
[$recent_type, $gap, $offset] = $completion_data;

Expand All @@ -305,6 +306,8 @@ public function completion(TextDocumentIdentifier $textDocument, Position $posit
->textDocument->completion->completionItem->snippetSupport ?? false;
$completion_items =
$this->codebase->getCompletionItemsForClassishThing($recent_type, $gap, $snippetSupport);
$completion_items =
$this->codebase->filterCompletionItemsByBeginLiteralPart($completion_items, $literal_part);
} elseif ($gap === '[') {
$completion_items = $this->codebase->getCompletionItemsForArrayKeys($recent_type);
} else {
Expand Down
230 changes: 229 additions & 1 deletion tests/LanguageServer/CompletionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Psalm\Tests\TestConfig;
use Psalm\Type;

use function array_map;
use function count;

class CompletionTest extends TestCase
Expand Down Expand Up @@ -370,7 +371,7 @@ public function foo() : void {
$codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());

$this->assertNull($codebase->getCompletionDataAtPosition('somefile.php', new Position(16, 41)));
$this->assertSame(['B\C', '->', 456], $codebase->getCompletionDataAtPosition('somefile.php', new Position(16, 41)));
}

public function testCompletionOnTemplatedThisProperty(): void
Expand Down Expand Up @@ -725,6 +726,201 @@ public function baz() {}
$this->assertSame('baz()', $completion_items[1]->insertText);
}

public function testObjectPropertyOnAppendToEnd(): void
{
$codebase = $this->codebase;
$config = $codebase->config;
$config->throw_exception = false;

$this->addFile(
'somefile.php',
'<?php
namespace B;

class A {
public $aProp = 123;
public $bProp = 234;

public function bar() {
$this->aPr
}
}',
);

$codebase->file_provider->openFile('somefile.php');
$codebase->scanFiles();

$this->analyzeFile('somefile.php', new Context());

$position = new Position(8, 34);
$completion_data = $codebase->getCompletionDataAtPosition('somefile.php', $position);
$literal_part = $codebase->getBeginedLiteralPart('somefile.php', $position);

$this->assertSame(['B\A&static', '->', 223], $completion_data);

$completion_items = $codebase->getCompletionItemsForClassishThing($completion_data[0], $completion_data[1], true);
$completion_items = $codebase->filterCompletionItemsByBeginLiteralPart($completion_items, $literal_part);
$completion_item_texts = array_map(fn($item) => $item->insertText, $completion_items);

$this->assertSame(['aProp'], $completion_item_texts);
}

public function testObjectPropertyOnReplaceEndPart(): void
{
$codebase = $this->codebase;
$config = $codebase->config;
$config->throw_exception = false;

$this->addFile(
'somefile.php',
'<?php
namespace B;

class A {
public $aProp1 = 123;
public $aProp2 = 234;

public function bar() {
$this->aProp2;
}
}',
);

$codebase->file_provider->openFile('somefile.php');
$codebase->scanFiles();

$this->analyzeFile('somefile.php', new Context());

$position = new Position(8, 34);
$completion_data = $codebase->getCompletionDataAtPosition('somefile.php', $position);
$literal_part = $codebase->getBeginedLiteralPart('somefile.php', $position);

$this->assertSame(['B\A&static', '->', 225], $completion_data);

$completion_items = $codebase->getCompletionItemsForClassishThing($completion_data[0], $completion_data[1], true);
$completion_items = $codebase->filterCompletionItemsByBeginLiteralPart($completion_items, $literal_part);
$completion_item_texts = array_map(fn($item) => $item->insertText, $completion_items);

$this->assertSame(['aProp1', 'aProp2'], $completion_item_texts);
}

public function testSelfPropertyOnAppendToEnd(): void
{
$codebase = $this->codebase;
$config = $codebase->config;
$config->throw_exception = false;

$this->addFile(
'somefile.php',
'<?php
namespace B;

class A {
public static $aProp = 123;
public static $bProp = 234;

public function bar() {
self::$aPr
}
}',
);

$codebase->file_provider->openFile('somefile.php');
$codebase->scanFiles();

$this->analyzeFile('somefile.php', new Context());

$position = new Position(8, 34);
$completion_data = $codebase->getCompletionDataAtPosition('somefile.php', $position);
$literal_part = $codebase->getBeginedLiteralPart('somefile.php', $position);

$this->assertSame(['B\A', '::', 237], $completion_data);

$completion_items = $codebase->getCompletionItemsForClassishThing($completion_data[0], $completion_data[1], true);
$completion_items = $codebase->filterCompletionItemsByBeginLiteralPart($completion_items, $literal_part);
$completion_item_texts = array_map(fn($item) => $item->insertText, $completion_items);

$this->assertSame(['$aProp'], $completion_item_texts);
}

public function testStaticPropertyOnAppendToEnd(): void
{
$codebase = $this->codebase;
$config = $codebase->config;
$config->throw_exception = false;

$this->addFile(
'somefile.php',
'<?php
namespace B;

class A {
public static $aProp = 123;
public static $bProp = 234;

public function bar() {
static::$aPr
}
}',
);

$codebase->file_provider->openFile('somefile.php');
$codebase->scanFiles();

$this->analyzeFile('somefile.php', new Context());

$position = new Position(8, 36);
$completion_data = $codebase->getCompletionDataAtPosition('somefile.php', $position);
$literal_part = $codebase->getBeginedLiteralPart('somefile.php', $position);

$this->assertSame(['B\A', '::', 239], $completion_data);

$completion_items = $codebase->getCompletionItemsForClassishThing($completion_data[0], $completion_data[1], true);
$completion_items = $codebase->filterCompletionItemsByBeginLiteralPart($completion_items, $literal_part);
$completion_item_texts = array_map(fn($item) => $item->insertText, $completion_items);

$this->assertSame(['$aProp'], $completion_item_texts);
}

public function testStaticPropertyOnReplaceEndPart(): void
{
$codebase = $this->codebase;
$config = $codebase->config;
$config->throw_exception = false;

$this->addFile(
'somefile.php',
'<?php
namespace B;

class A {
public static $aProp1 = 123;
public static $aProp2 = 234;

public function bar() {
self::$aProp2;
}
}',
);

$codebase->file_provider->openFile('somefile.php');
$codebase->scanFiles();

$this->analyzeFile('somefile.php', new Context());

$position = new Position(8, 34);
$completion_data = $codebase->getCompletionDataAtPosition('somefile.php', $position);
$literal_part = $codebase->getBeginedLiteralPart('somefile.php', $position);

$this->assertSame(['B\A', '::', 239], $completion_data);

$completion_items = $codebase->getCompletionItemsForClassishThing($completion_data[0], $completion_data[1], true);
$completion_items = $codebase->filterCompletionItemsByBeginLiteralPart($completion_items, $literal_part);
$completion_item_texts = array_map(fn($item) => $item->insertText, $completion_items);

$this->assertSame(['$aProp1', '$aProp2'], $completion_item_texts);
}

public function testCompletionOnNewExceptionWithoutNamespace(): void
{
$codebase = $this->codebase;
Expand Down Expand Up @@ -1260,6 +1456,38 @@ static function add() : void {
$this->assertCount(2, $completion_items);
}

public function testCompletionStaticMethodOnDocBlock(): void
{
$codebase = $this->codebase;
$config = $codebase->config;
$config->throw_exception = false;

$this->addFile(
'somefile.php',
'<?php
namespace Bar;

/**
* @method static void foo()
*/
class Alpha {}
Alpha::',
);

$codebase->file_provider->openFile('somefile.php');
$codebase->scanFiles();
$this->analyzeFile('somefile.php', new Context());

$position = new Position(7, 23);
$completion_data = $codebase->getCompletionDataAtPosition('somefile.php', $position);

$this->assertSame(['Bar\Alpha', '::', 177], $completion_data);

$completion_items = $codebase->getCompletionItemsForClassishThing($completion_data[0], $completion_data[1], true);
$this->assertCount(1, $completion_items);
$this->assertSame('foo()', $completion_items[0]->insertText);
}

public function testCompletionOnClassInstanceReferenceWithAssignmentAfter(): void
{

Expand Down