Page MenuHomeWickedGov Phorge
Files F1430626

GetDeclarationNameTest.php
No OneTemporary
Actions

Size
8 KB
Referenced Files
None
Subscribers
None

GetDeclarationNameTest.php
View Options

<?php
/**
* Tests for the \PHP_CodeSniffer\Files\File::getDeclarationName method.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2022-2024 PHPCSStandards Contributors
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\File;
use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTest;
/**
* Tests for the \PHP_CodeSniffer\Files\File:getDeclarationName method.
*
* @covers \PHP_CodeSniffer\Files\File::getDeclarationName
*/
final class GetDeclarationNameTest extends AbstractMethodUnitTest
{
/**
* Test receiving an expected exception when a non-supported token is passed.
*
* @return void
*/
public function testInvalidTokenPassed()
{
$this->expectRunTimeException('Token type "T_STRING" is not T_FUNCTION, T_CLASS, T_INTERFACE, T_TRAIT or T_ENUM');
$target = $this->getTargetToken('/* testInvalidTokenPassed */', T_STRING);
self::$phpcsFile->getDeclarationName($target);
}//end testInvalidTokenPassed()
/**
* Test receiving "null" when passed an anonymous construct or in case of a parse error.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param int|string $targetType Token type of the token to get as stackPtr.
*
* @dataProvider dataGetDeclarationNameNull
*
* @return void
*/
public function testGetDeclarationNameNull($testMarker, $targetType)
{
$target = $this->getTargetToken($testMarker, $targetType);
$result = self::$phpcsFile->getDeclarationName($target);
$this->assertNull($result);
}//end testGetDeclarationNameNull()
/**
* Data provider.
*
* @see testGetDeclarationNameNull() For the array format.
*
* @return array<string, array<string, int|string>>
*/
public static function dataGetDeclarationNameNull()
{
return [
'closure' => [
'testMarker' => '/* testClosure */',
'targetType' => T_CLOSURE,
],
'anon-class-with-parentheses' => [
'testMarker' => '/* testAnonClassWithParens */',
'targetType' => T_ANON_CLASS,
],
'anon-class-with-parentheses-2' => [
'testMarker' => '/* testAnonClassWithParens2 */',
'targetType' => T_ANON_CLASS,
],
'anon-class-without-parentheses' => [
'testMarker' => '/* testAnonClassWithoutParens */',
'targetType' => T_ANON_CLASS,
],
'anon-class-extends-without-parentheses' => [
'testMarker' => '/* testAnonClassExtendsWithoutParens */',
'targetType' => T_ANON_CLASS,
],
'live-coding' => [
'testMarker' => '/* testLiveCoding */',
'targetType' => T_FUNCTION,
],
];
}//end dataGetDeclarationNameNull()
/**
* Test retrieving the name of a function or OO structure.
*
* @param string $testMarker The comment which prefaces the target token in the test file.
* @param string $expected Expected function output.
* @param int|string|null $targetType Token type of the token to get as stackPtr.
*
* @dataProvider dataGetDeclarationName
*
* @return void
*/
public function testGetDeclarationName($testMarker, $expected, $targetType=null)
{
if (isset($targetType) === false) {
$targetType = [
T_CLASS,
T_INTERFACE,
T_TRAIT,
T_ENUM,
T_FUNCTION,
];
}
$target = $this->getTargetToken($testMarker, $targetType);
$result = self::$phpcsFile->getDeclarationName($target);
$this->assertSame($expected, $result);
}//end testGetDeclarationName()
/**
* Data provider.
*
* @see testGetDeclarationName() For the array format.
*
* @return array<string, array<string, string>>
*/
public static function dataGetDeclarationName()
{
return [
'function' => [
'testMarker' => '/* testFunction */',
'expected' => 'functionName',
],
'function-return-by-reference' => [
'testMarker' => '/* testFunctionReturnByRef */',
'expected' => 'functionNameByRef',
],
'class' => [
'testMarker' => '/* testClass */',
'expected' => 'ClassName',
],
'method' => [
'testMarker' => '/* testMethod */',
'expected' => 'methodName',
],
'abstract-method' => [
'testMarker' => '/* testAbstractMethod */',
'expected' => 'abstractMethodName',
],
'method-return-by-reference' => [
'testMarker' => '/* testMethodReturnByRef */',
'expected' => 'MethodNameByRef',
],
'extended-class' => [
'testMarker' => '/* testExtendedClass */',
'expected' => 'ExtendedClass',
],
'interface' => [
'testMarker' => '/* testInterface */',
'expected' => 'InterfaceName',
],
'trait' => [
'testMarker' => '/* testTrait */',
'expected' => 'TraitName',
],
'function-name-ends-with-number' => [
'testMarker' => '/* testFunctionEndingWithNumber */',
'expected' => 'ValidNameEndingWithNumber5',
],
'class-with-numbers-in-name' => [
'testMarker' => '/* testClassWithNumber */',
'expected' => 'ClassWith1Number',
],
'interface-with-numbers-in-name' => [
'testMarker' => '/* testInterfaceWithNumbers */',
'expected' => 'InterfaceWith12345Numbers',
],
'class-with-comments-and-new-lines' => [
'testMarker' => '/* testClassWithCommentsAndNewLines */',
'expected' => 'ClassWithCommentsAndNewLines',
],
'function-named-fn' => [
'testMarker' => '/* testFunctionFn */',
'expected' => 'fn',
],
'enum-pure' => [
'testMarker' => '/* testPureEnum */',
'expected' => 'Foo',
],
'enum-backed-space-between-name-and-colon' => [
'testMarker' => '/* testBackedEnumSpaceBetweenNameAndColon */',
'expected' => 'Hoo',
],
'enum-backed-no-space-between-name-and-colon' => [
'testMarker' => '/* testBackedEnumNoSpaceBetweenNameAndColon */',
'expected' => 'Suit',
],
'function-return-by-reference-with-reserved-keyword-each' => [
'testMarker' => '/* testFunctionReturnByRefWithReservedKeywordEach */',
'expected' => 'each',
],
'function-return-by-reference-with-reserved-keyword-parent' => [
'testMarker' => '/* testFunctionReturnByRefWithReservedKeywordParent */',
'expected' => 'parent',
],
'function-return-by-reference-with-reserved-keyword-self' => [
'testMarker' => '/* testFunctionReturnByRefWithReservedKeywordSelf */',
'expected' => 'self',
],
'function-return-by-reference-with-reserved-keyword-static' => [
'testMarker' => '/* testFunctionReturnByRefWithReservedKeywordStatic */',
'expected' => 'static',
],
];
}//end dataGetDeclarationName()
}//end class

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 19:20 (4 h, 26 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
9f/3e/f0da3a39622b8706f587a6081d62
Default Alt Text
GetDeclarationNameTest.php (8 KB)

Event Timeline