icedream
/
php-language-server
1
0
Fork 0
Code Releases Activity

Merge f016e7fb25 into 9dc1656592

pull/682/merge
Gabriel Noé González 2019-02-11 11:26:04 +00:00 committed by GitHub
parent 9dc1656592 f016e7fb25
commit f22ec705b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 380 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -6,3 +6,4 @@ composer.lock
stubs
*.ast
node_modules/
/nbproject/

11
.vscode/settings.json vendored
View File

@ -3,5 +3,16 @@
"search.exclude": {
"**/validation": true,
"**/tests/Validation/cases": true
},
"files.trimTrailingWhitespace": true,
"files.eol": "\n",
"files.exclude": {
"**/.git": true,
"**/.svn": true,
"**/.hg": true,
"**/CVS": true,
"**/.DS_Store": true,
"**/tests": false
}
}

50
fixtures/completion/child_class_visibility.php Normal file
View File

@ -0,0 +1,50 @@
<?php
class ThisChildClass extends TestClass
{
public function canSeeMethod()
{
$this->
}
}
class Foo extends Bar
{
public function getRandom()
{
$this->c;
return random_bytes(25);
}
}
class Bar
{
private $test;
protected $seeme;
public function __construct()
{
$this->test = 'Basic';
}
public function getTest()
{
return $this->test;
}
private function cantSee()
{
}
protected function canSee($arg)
{
# code...
}
}
$foo = new Foo();
$foo->getRandom();

77
fixtures/visibility_class.php Normal file
View File

@ -0,0 +1,77 @@
<?php
/**
* Pariatur ut laborum tempor voluptate consequat ea deserunt.
*
* Deserunt enim minim sunt sint ea nisi. Deserunt excepteur tempor id nostrud
* laboris commodo ad commodo velit mollit qui non officia id. Nulla duis veniam
* veniam officia deserunt et non dolore mollit ea quis eiusmod sit non. Occaecat
* consequat sunt culpa exercitation pariatur id reprehenderit nisi incididunt Lorem
* sint. Officia culpa pariatur laborum nostrud cupidatat consequat mollit.
*/
class TestClass
{
/**
* Anim labore veniam consectetur laboris minim quis aute aute esse nulla ad.
*
* @var int
*/
const TEST_CLASS_CONST = 123;
/**
* Lorem excepteur officia sit anim velit veniam enim.
*
* @var TestClass[]
*/
public static $staticTestProperty;
/**
* Reprehenderit magna velit mollit ipsum do.
*
* @var TestClass
*/
public $testProperty;
/**
* Reprehenderit magna velit mollit ipsum do.
*
* @var TestClass
*/
private $privateProperty;
/**
* Reprehenderit magna velit mollit ipsum do.
*
* @var TestClass
*/
protected $protectedProperty;
/**
* Do magna consequat veniam minim proident eiusmod incididunt aute proident.
*/
public static function staticTestMethod()
{
echo self::TEST_CLASS_CONST;
}
/**
* Non culpa nostrud mollit esse sunt laboris in irure ullamco cupidatat amet.
*
* @param TestClass $testParameter Lorem sunt velit incididunt mollit
* @return TestClass
*/
public function testMethod($testParameter): TestInterface
{
$this->testProperty = $testParameter;
}
private function privateTestMethod()
{
return $this->privateProperty;
}
protected function protectedTestMethod()
{
return $this->protectedProperty;
}
}

9
src/CompletionProvider.php
View File

@ -159,7 +159,6 @@ class CompletionProvider
): CompletionList {
// This can be made much more performant if the tree follows specific invariants.
$node = $doc->getNodeAtPosition($pos);
// Get the node at the position under the cursor
$offset = $node === null ? -1 : $pos->toOffset($node->getFileContents());
if (
@ -247,7 +246,7 @@ class CompletionProvider
$fqns = FqnUtilities\getFqnsFromType(
$this->definitionResolver->resolveExpressionNodeToType($node->dereferencableExpression)
);
$isInMethodDeclaration = null !== $node->getFirstAncestor(\Microsoft\PhpParser\Node\MethodDeclaration::class);
// The FQNs of the symbol and its parents (eg the implemented interfaces)
foreach ($this->expandParentFqns($fqns) as $parentFqn) {
// Add the object access operator to only get members of all parents
@ -255,7 +254,10 @@ class CompletionProvider
$prefixLen = strlen($prefix);
// Collect fqn definitions
foreach ($this->index->getChildDefinitionsForFqn($parentFqn) as $fqn => $def) {
if (substr($fqn, 0, $prefixLen) === $prefix && $def->isMember) {
if (substr($fqn, 0, $prefixLen) === $prefix &&
$def->isMember &&
$def->isVisible($prefix, $fqns[0] . '->', $isInMethodDeclaration)
) {
$list->items[] = CompletionItemFactory::fromDefinition($def);
}
}
@ -278,7 +280,6 @@ class CompletionProvider
$fqns = FqnUtilities\getFqnsFromType(
$classType = $this->definitionResolver->resolveExpressionNodeToType($scoped->scopeResolutionQualifier)
);
// The FQNs of the symbol and its parents (eg the implemented interfaces)
foreach ($this->expandParentFqns($fqns) as $parentFqn) {
// Append :: operator to only get static members of all parents

31
src/Definition.php
View File

@ -133,4 +133,35 @@ class Definition
}
}
}
/**
* Checks the definition's visibility.
* @param string $match Owner of the FQNS
* @param string $caller Descendant of the FQNS owner
* @param bool $isInMethodDeclaration checking if the call is from inside a
* method
* @return bool
*/
public function isVisible(string $match, string $caller, bool $isInMethodDeclaration): bool
{
if ($isInMethodDeclaration) {
if ($match !== $caller && $this->isPrivate()) {
return false;
}
} else if ($this->isProtected() || $this->isPrivate()) {
return false;
}
return true;
}
private function isPrivate(): bool
{
return 'private' === substr($this->declarationLine, 0, 7);
}
private function isProtected(): bool
{
return 'protected' === substr($this->declarationLine, 0, 9);
}
}

197
tests/Server/TextDocument/CompletionWithVisibilityTest.php Normal file
View File

@ -0,0 +1,197 @@
<?php
declare(strict_types = 1);
namespace LanguageServer\Tests\Server\TextDocument;
use LanguageServer\ContentRetriever\FileSystemContentRetriever;
use LanguageServer\DefinitionResolver;
use LanguageServer\Index\DependenciesIndex;
use LanguageServer\Index\Index;
use LanguageServer\Index\ProjectIndex;
use LanguageServer\LanguageClient;
use LanguageServer\PhpDocumentLoader;
use LanguageServer\Server\TextDocument;
use LanguageServer\Tests\MockProtocolStream;
use LanguageServerProtocol\CompletionItem;
use LanguageServerProtocol\CompletionItemKind;
use LanguageServerProtocol\CompletionList;
use LanguageServerProtocol\Position;
use LanguageServerProtocol\TextDocumentIdentifier;
use PHPUnit\Framework\TestCase;
use function file_get_contents;
use function LanguageServer\pathToUri;
/**
* Description of CompletionWithVisibilityTest
*
* @author Gabriel Noé <jnoe@itnow.externos.es>
*/
class CompletionWithVisibilityTest extends TestCase
{
/**
* @var TextDocument
*/
private $textDocument;
/**
* @var PhpDocumentLoader
*/
private $loader;
/**
*
* @var string
*/
private $fixturesPath;
public function __construct($name = null, array $data = array(), $dataName = '')
{
parent::__construct($name, $data, $dataName);
$this->fixturesPath = __DIR__ . '/../../../fixtures';
}
public function setUp()
{
$client = new LanguageClient(new MockProtocolStream, new MockProtocolStream);
$projectIndex = new ProjectIndex(new Index, new DependenciesIndex);
$definitionResolver = new DefinitionResolver($projectIndex);
$contentRetriever = new FileSystemContentRetriever;
$this->loader = new PhpDocumentLoader($contentRetriever, $projectIndex, $definitionResolver);
$this->loader->load(pathToUri($this->fixturesPath . '/visibility_class.php'))->wait();
$this->textDocument = new TextDocument($this->loader, $definitionResolver, $client, $projectIndex);
}
/**
* Can access only to public properties and methods
*/
public function testVisibilityFromCall()
{
$items = $this->getCompletion('/completion/property.php', 3, 6);
// doesn't contain any of these properties and methods
$this->assertCompletionsListSubsetNotContains(new CompletionList([
new CompletionItem(
'privateProperty',
CompletionItemKind::PROPERTY,
'\TestClass',
'Reprehenderit magna velit mollit ipsum do.'
),
new CompletionItem(
'privateTestMethod',
CompletionItemKind::METHOD,
'mixed' // Return type of the method
),
new CompletionItem(
'protectedProperty',
CompletionItemKind::PROPERTY,
'\TestClass',
'Reprehenderit magna velit mollit ipsum do.'
),
new CompletionItem(
'protectedTestMethod',
CompletionItemKind::METHOD,
'mixed' // Return type of the method
)
], true), $items);
}
/**
* From a Child class only public and protected properties and methods are
* visible
*
*/
public function testVisibilityInsideADescendantClassMethod()
{
$items = $this->getCompletion('/completion/child_class_visibility.php', 6, 16);
// doesn't contain any of these properties and methods
$this->assertCompletionsListSubsetNotContains(new CompletionList([
new CompletionItem(
'privateProperty',
CompletionItemKind::PROPERTY,
'\TestClass',
'Reprehenderit magna velit mollit ipsum do.'
),
new CompletionItem(
'privateTestMethod',
CompletionItemKind::METHOD,
'mixed' // Return type of the method
)
], true), $items);
}
public function testVisibilityInsideClassMethod()
{
$items = $this->getCompletion('/visibility_class.php', 64, 15);
// can see all properties and methods
$this->assertCompletionsListSubset(new CompletionList([
new CompletionItem(
'privateProperty',
CompletionItemKind::PROPERTY,
'\TestClass',
'Reprehenderit magna velit mollit ipsum do.'
),
new CompletionItem(
'privateTestMethod',
CompletionItemKind::METHOD,
'mixed' // Return type of the method
),
new CompletionItem(
'protectedProperty',
CompletionItemKind::PROPERTY,
'\TestClass',
'Reprehenderit magna velit mollit ipsum do.'
),
new CompletionItem(
'protectedTestMethod',
CompletionItemKind::METHOD,
'mixed' // Return type of the method
),
new CompletionItem(
'testProperty',
CompletionItemKind::PROPERTY,
'\TestClass', // Type of the property
'Reprehenderit magna velit mollit ipsum do.'
),
new CompletionItem(
'testMethod',
CompletionItemKind::METHOD,
'\TestClass', // Return type of the method
'Non culpa nostrud mollit esse sunt laboris in irure ullamco cupidatat amet.'
)
], true), $items);
}
/**
*
* @param string $fixtureFile
* @param int $line
* @param int $char
* @return CompletionList
*/
private function getCompletion(string $fixtureFile, int $line, int $char)
{
$completionUri = pathToUri($this->fixturesPath . $fixtureFile);
$this->loader->open($completionUri, file_get_contents($completionUri));
return $this->textDocument->completion(
new TextDocumentIdentifier($completionUri),
new Position($line, $char)
)->wait();
}
private function assertCompletionsListSubset(CompletionList $subsetList, CompletionList $list)
{
foreach ($subsetList->items as $expectedItem) {
$this->assertContains($expectedItem, $list->items, null, null, false);
}
$this->assertEquals($subsetList->isIncomplete, $list->isIncomplete);
}
private function assertCompletionsListSubsetNotContains(CompletionList $subsetList, CompletionList $list)
{
foreach ($subsetList->items as $expectedItem) {
$this->assertNotContains($expectedItem, $list->items, null, null, false);
}
$this->assertEquals($subsetList->isIncomplete, $list->isIncomplete);
}
}

14
tests/Validation/ValidationTest.php
View File

@ -1,5 +1,4 @@
<?php
declare(strict_types = 1);
namespace LanguageServer\Tests;
@ -22,6 +21,7 @@ use Microsoft\PhpParser;
class ValidationTest extends TestCase
{
public function validationTestProvider()
{
$testProviderArray = array();
@ -31,7 +31,7 @@ class ValidationTest extends TestCase
$disabled = json_decode(file_get_contents(__DIR__ . '/disabled.json'));
foreach (new RecursiveIteratorIterator($iterator) as $file) {
if (strpos(\strrev((string)$file), \strrev(".php")) === 0 && !\in_array(basename((string)$file), $disabled)) {
if (strpos(\strrev((string) $file), \strrev(".php")) === 0 && !\in_array(basename((string) $file), $disabled)) {
if ($file->getSize() < 100000) {
$testProviderArray[] = [$file->getPathname()];
}
@ -57,17 +57,17 @@ class ValidationTest extends TestCase
$outputFile = getExpectedValuesFile($testCaseFile);
if (!file_exists($outputFile)) {
file_put_contents($outputFile, json_encode($actualValues, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES));
file_put_contents($outputFile, json_encode($actualValues, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
}
$expectedValues = (array)json_decode(file_get_contents($outputFile));
$expectedValues = (array) json_decode(file_get_contents($outputFile));
try {
$this->assertEquals($expectedValues['definitions'], $actualValues['definitions']);
$this->assertEquals((array)$expectedValues['references'], (array)$actualValues['references'], sprintf('references match in "%s"', $outputFile));
$this->assertEquals((array) $expectedValues['references'], (array) $actualValues['references'], sprintf('references match in "%s"', $outputFile));
} catch (\Throwable $e) {
$outputFile = getExpectedValuesFile($testCaseFile);
file_put_contents($outputFile, json_encode($actualValues, JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES));
file_put_contents($outputFile, json_encode($actualValues, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
throw $e;
}
@ -135,7 +135,7 @@ class ValidationTest extends TestCase
} elseif ($propertyName === 'extends') {
$definition->$propertyName = $definition->$propertyName ?? [];
} elseif ($propertyName === 'type' && $definition->type !== null) {
$defsForAssert[$fqn]['type__tostring'] = (string)$definition->type;
$defsForAssert[$fqn]['type__tostring'] = (string) $definition->type;
}
$defsForAssert[$fqn][$propertyName] = $definition->$propertyName;