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

Object names may not be present for all objects #147

Merged
merged 1 commit into from
Apr 3, 2024
+54 −5
Merged

Object names may not be present for all objects #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions moodle/Tests/Util/TokenUtilTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ class TokenUtilTest extends MoodleCSBaseTestCase
*/
public function testGetObjectProperties(
string $content,
int $type,
string $expectedType,
string $expectedName
$type,
?string $expectedType,
?string $expectedName
): void {
$config = new Config([]);
$ruleset = new Ruleset($config);
Expand Down Expand Up @@ -90,6 +90,25 @@ public static function objectPropertiesProvider(): array {
'function',
'exampleFunction',
],
'Unnamed anonymous class' => [
<<<EOF
<?php
return new class extends phpunit_coverage_info {
/** @var array The list of folders relative to the plugin root to include in coverage generation. */
protected \$includelistfolders = ['classes'];
};
EOF,
T_ANON_CLASS,
'class',
'anonymous class',
],
'Unnamed closure' => [
'<?php $fn = function() {};',
T_CLOSURE,
'function',
'closure',
],
];

if (version_compare(PHP_VERSION, '8.1.0') >= 0) {
Expand Down Expand Up @@ -161,4 +180,17 @@ public static function countGlobalScopesInFileProvider(): array {

return $cases;
}

public function testObjectPropertiesInvalidPointer(): void {
$config = new Config([]);
$ruleset = new Ruleset($config);

$phpcsFile = new DummyFile('<?php', $ruleset, $config);
$phpcsFile->process();

$stackPtr = 1000;

$this->assertEquals('', TokenUtil::getObjectType($phpcsFile, $stackPtr));
$this->assertEquals('', TokenUtil::getObjectName($phpcsFile, $stackPtr));
}
}
21 changes: 19 additions & 2 deletions moodle/Util/TokenUtil.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ public static function getObjectType(
int $stackPtr
): string {
$tokens = $phpcsFile->getTokens();

if (!isset($tokens[$stackPtr])) {
return '';
}

if ($tokens[$stackPtr]['code'] === T_OPEN_TAG) {
return 'file';
}
Expand All @@ -46,17 +51,29 @@ public static function getObjectType(
*
* @param File $phpcsFile
* @param int $stackPtr
* @return string
* @return null|string
*/
public static function getObjectName(
File $phpcsFile,
int $stackPtr
): string {
): ?string {
$tokens = $phpcsFile->getTokens();
if (!isset($tokens[$stackPtr])) {
return '';
}

if ($tokens[$stackPtr]['code'] === T_OPEN_TAG) {
return basename($phpcsFile->getFilename());
}

if ($tokens[$stackPtr]['code'] === T_ANON_CLASS) {
return 'anonymous class';
}

if ($tokens[$stackPtr]['code'] === T_CLOSURE) {
return 'closure';
}

return ObjectDeclarations::getName($phpcsFile, $stackPtr);
}

Expand Down