1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<?php
/**
* Tests the tokenization of heredoc/nowdoc closer tokens.
*
* @author Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
* @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer;
use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase;
/**
* Heredoc/nowdoc closer token test.
*
* @requires PHP 7.3
*
* @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createPositionMap
*/
final class CreatePositionMapHeredocNowdocCloserTest extends AbstractTokenizerTestCase
{
/**
* Verify that leading (indent) whitespace in a heredoc/nowdoc closer token get the tab replacement treatment.
*
* @param string $testMarker The comment prefacing the target token.
* @param array<string, int|string|null> $expected Expectations for the token array.
*
* @dataProvider dataHeredocNowdocCloserTabReplacement
*
* @return void
*/
public function testHeredocNowdocCloserTabReplacement($testMarker, $expected)
{
$tokens = $this->phpcsFile->getTokens();
$closer = $this->getTargetToken($testMarker, [T_END_HEREDOC, T_END_NOWDOC]);
foreach ($expected as $key => $value) {
if ($key === 'orig_content' && $value === null) {
$this->assertArrayNotHasKey($key, $tokens[$closer], "Unexpected 'orig_content' key found in the token array.");
continue;
}
$this->assertArrayHasKey($key, $tokens[$closer], "Key $key not found in the token array.");
$this->assertSame($value, $tokens[$closer][$key], "Value for key $key does not match expectation.");
}
}//end testHeredocNowdocCloserTabReplacement()
/**
* Data provider.
*
* @see testHeredocNowdocCloserTabReplacement()
*
* @return array<string, array<string, string|array<string, int|string|null>>>
*/
public static function dataHeredocNowdocCloserTabReplacement()
{
return [
'Heredoc closer without indent' => [
'testMarker' => '/* testHeredocCloserNoIndent */',
'expected' => [
'length' => 3,
'content' => 'EOD',
'orig_content' => null,
],
],
'Nowdoc closer without indent' => [
'testMarker' => '/* testNowdocCloserNoIndent */',
'expected' => [
'length' => 3,
'content' => 'EOD',
'orig_content' => null,
],
],
'Heredoc closer with indent, spaces' => [
'testMarker' => '/* testHeredocCloserSpaceIndent */',
'expected' => [
'length' => 7,
'content' => ' END',
'orig_content' => null,
],
],
'Nowdoc closer with indent, spaces' => [
'testMarker' => '/* testNowdocCloserSpaceIndent */',
'expected' => [
'length' => 8,
'content' => ' END',
'orig_content' => null,
],
],
'Heredoc closer with indent, tabs' => [
'testMarker' => '/* testHeredocCloserTabIndent */',
'expected' => [
'length' => 8,
'content' => ' END',
'orig_content' => ' END',
],
],
'Nowdoc closer with indent, tabs' => [
'testMarker' => '/* testNowdocCloserTabIndent */',
'expected' => [
'length' => 7,
'content' => ' END',
'orig_content' => ' END',
],
],
];
}//end dataHeredocNowdocCloserTabReplacement()
}//end class
|
