PHP_CodeSniffer/tests/Core/Tokenizers/PHP/ScopeOwnerTest.php at 7b06040e50a40304cd68310ab599ad2c3f2e89ec · PHPCSStandards/PHP_CodeSniffer · GitHub

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
<?php
/**
 * Tests that scope owner (scope_condition, conditions) is set correctly
 *
 * @author  Dan Wallis <dan@wallis.nz>
 * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 */

namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP;

use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase;

final class ScopeOwnerTest extends AbstractTokenizerTestCase
{


    /**
     * Test that a basic 'if' condition gets scope opener/closer set as expected.
     *
     * @param string $testMarker     The comment which prefaces the target token in the test file.
     * @param int    $conditionWidth How many tokens wide the 'if' condition should be.
     *
     * @dataProvider dataIfCondition
     * @covers       PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap
     *
     * @return void
     */
    public function testIfCondition($testMarker, $conditionWidth)
    {
        $tokens   = $this->phpcsFile->getTokens();
        $targetIf = $this->getTargetToken($testMarker, T_IF);

        $this->assertSame($targetIf, $tokens[$targetIf]['parenthesis_owner'], 'parenthesis owner is self for if');
        $this->assertSame(($targetIf + 2), $tokens[$targetIf]['parenthesis_opener'], 'expected parenthesis opener');
        $this->assertSame(($targetIf + 2 + $conditionWidth), $tokens[$targetIf]['parenthesis_closer'], 'expected parenthesis closer');
        $this->assertSame($targetIf, $tokens[$targetIf]['scope_condition']);

        $targetOpenCurly = $this->phpcsFile->findNext(T_OPEN_CURLY_BRACKET, $targetIf);
        $this->assertSame($targetIf, $tokens[$targetOpenCurly]['scope_condition'], 'scope_condition set on open curly');

        $targetCloseCurly = $tokens[$targetOpenCurly]['bracket_closer'];
        $this->assertSame($targetIf, $tokens[$targetCloseCurly]['scope_condition'], 'scope_condition set on close curly');

        $targetReturn = $this->phpcsFile->findNext(T_RETURN, $targetIf);
        $this->assertSame([$targetIf => T_IF], $tokens[$targetReturn]['conditions'], 'conditions set on if statement body');

    }//end testIfCondition()


    /**
     * Data provider.
     *
     * @see testIfCondition()
     *
     * @return array<string, array<string, int|string>>
     */
    public static function dataIfCondition()
    {
        return [
            'Basic if'                      => [
                'testMarker'     => '/* testNormalIfCondition */',
                'conditionWidth' => 2,
            ],
            'Function call in if condition' => [
                'testMarker'     => '/* testFunctionCallInIfCondition */',
                'conditionWidth' => 5,
            ],
            'Heredoc in if condition'       => [
                'testMarker'     => '/* testHeredocInIfCondition */',
                'conditionWidth' => 8,
            ],
        ];

    }//end dataIfCondition()


}//end class