ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: opt / cpanel / ea-wappspector / vendor / squizlabs / php_codesniffer / tests / Core / Tokenizers / PHP

<?php
/**
 * Tests the comment tokenization with Windows line endings.
 *
 * Basically the same as the StableCommentWhitespaceTest, but now for
 * Windows line endings.
 *
 * @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\PHP;

use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase;
use PHP_CodeSniffer\Util\Tokens;

final class StableCommentWhitespaceWinTest extends AbstractTokenizerTestCase
{

/**
     * Test that comment tokenization with new lines at the end of the comment is stable.
     *
     * @param string                       $testMarker     The comment prefacing the test.
     * @param array<array<string, string>> $expectedTokens The tokenization expected.
     *
     * @dataProvider dataCommentTokenization
     * @covers       PHP_CodeSniffer\Tokenizers\PHP::tokenize
     *
     * @return void
     */
    public function testCommentTokenization($testMarker, $expectedTokens)
    {
        $tokens  = $this->phpcsFile->getTokens();
        $comment = $this->getTargetToken($testMarker, Tokens::$commentTokens);

foreach ($expectedTokens as $tokenInfo) {
            $this->assertSame(
                constant($tokenInfo['type']),
                $tokens[$comment]['code'],
                'Token tokenized as '.Tokens::tokenName($tokens[$comment]['code']).', not '.$tokenInfo['type'].' (code)'
            );
            $this->assertSame(
                $tokenInfo['type'],
                $tokens[$comment]['type'],
                'Token tokenized as '.$tokens[$comment]['type'].', not '.$tokenInfo['type'].' (type)'
            );
            $this->assertSame($tokenInfo['content'], $tokens[$comment]['content']);

++$comment;
        }

}//end testCommentTokenization()

/**
     * Data provider.
     *
     * @see testCommentTokenization()
     *
     * @return array<string, array<string, string|array<array<string, string>>>>
     */
    public static function dataCommentTokenization()
    {
        return [
            'slash comment, single line'                                  => [
                'testMarker'     => '/* testSingleLineSlashComment */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'slash comment, single line, trailing'                        => [
                'testMarker'     => '/* testSingleLineSlashCommentTrailing */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'slash ignore annotation, single line'                        => [
                'testMarker'     => '/* testSingleLineSlashAnnotation */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_PHPCS_DISABLE',
                        'content' => '// phpcs:disable Stnd.Cat
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'slash comment, multi-line'                                   => [
                'testMarker'     => '/* testMultiLineSlashComment */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment1
',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment2
',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment3
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'slash comment, multi-line, indented'                         => [
                'testMarker'     => '/* testMultiLineSlashCommentWithIndent */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment1
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '    ',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment2
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '    ',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment3
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'slash comment, multi-line, ignore annotation as first line'  => [
                'testMarker'     => '/* testMultiLineSlashCommentWithAnnotationStart */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_PHPCS_IGNORE',
                        'content' => '// phpcs:ignore Stnd.Cat
',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment2
',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment3
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'slash comment, multi-line, ignore annotation as middle line' => [
                'testMarker'     => '/* testMultiLineSlashCommentWithAnnotationMiddle */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment1
',
                    ],
                    [
                        'type'    => 'T_PHPCS_IGNORE',
                        'content' => '// @phpcs:ignore Stnd.Cat
',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment3
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'slash comment, multi-line, ignore annotation as last line'   => [
                'testMarker'     => '/* testMultiLineSlashCommentWithAnnotationEnd */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment1
',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Comment2
',
                    ],
                    [
                        'type'    => 'T_PHPCS_IGNORE',
                        'content' => '// phpcs:ignore Stnd.Cat
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'slash comment, single line, without new line at end'         => [
                'testMarker'     => '/* testSingleLineSlashCommentNoNewLineAtEnd */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '// Slash ',
                    ],
                    [
                        'type'    => 'T_CLOSE_TAG',
                        'content' => '?>
',
                    ],
                ],
            ],
            'hash comment, single line'                                   => [
                'testMarker'     => '/* testSingleLineHashComment */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Comment
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'hash comment, single line, trailing'                         => [
                'testMarker'     => '/* testSingleLineHashCommentTrailing */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Comment
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'hash comment, multi-line'                                    => [
                'testMarker'     => '/* testMultiLineHashComment */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Comment1
',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Comment2
',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Comment3
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'hash comment, multi-line, indented'                          => [
                'testMarker'     => '/* testMultiLineHashCommentWithIndent */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Comment1
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '    ',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Comment2
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '    ',
                    ],
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Comment3
',
                    ],
                    [
                        'type'    => 'T_WHITESPACE',
                        'content' => '
',
                    ],
                ],
            ],
            'hash comment, single line, without new line at end'          => [
                'testMarker'     => '/* testSingleLineHashCommentNoNewLineAtEnd */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '# Hash ',
                    ],
                    [
                        'type'    => 'T_CLOSE_TAG',
                        'content' => '?>
',
                    ],
                ],
            ],
            'unclosed star comment at end of file'                        => [
                'testMarker'     => '/* testCommentAtEndOfFile */',
                'expectedTokens' => [
                    [
                        'type'    => 'T_COMMENT',
                        'content' => '/* Comment',
                    ],
                ],
            ],
        ];

}//end dataCommentTokenization()

}//end class

[-] BackfillExplicitOctalNotationTest.php [edit]
[-] PHPOpenTagEOF2Test.inc [edit]
[-] BackfillEnumTest.inc [edit]
[-] PHPOpenTagEOF1Test.php [edit]
[-] BackfillAsymmetricVisibilityTest.php [edit]
[-] EnumCaseTest.php [edit]
[-] StableCommentWhitespaceTest.inc [edit]
[-] HeredocNowdocTest.inc [edit]
[-] TypeIntersectionTest.php [edit]
[-] DNFTypesParseError2Test.php [edit]
[-] TypeIntersectionTest.inc [edit]
[-] NamedFunctionCallArgumentsTest.inc [edit]
[-] TypedConstantsTest.inc [edit]
[-] UndoNamespacedNameSingleTokenTest.php [edit]
[-] BackfillFnTokenParseErrorTest.inc [edit]
[+] ..
[-] StableCommentWhitespaceWinTest.php [edit]
[-] DNFTypesTest.inc [edit]
[-] DNFTypesParseError1Test.inc [edit]
[-] BitwiseOrTest.php [edit]
[-] BackfillFnTokenParseErrorTest.php [edit]
[-] DoubleQuotedStringTest.php [edit]
[-] BackfillReadonlyTest.inc [edit]
[-] PHPOpenTagEOF1Test.inc [edit]
[-] PHPOpenTagEOF2Test.php [edit]
[-] BackfillNumericSeparatorTest.inc [edit]
[-] ArrayKeywordTest.inc [edit]
[-] BackfillMatchTokenTest.php [edit]
[-] DoubleArrowTest.inc [edit]
[-] HeredocStringTest.inc [edit]
[-] GotoLabelTest.inc [edit]
[-] OtherContextSensitiveKeywordsTest.php [edit]
[-] StableCommentWhitespaceTest.php [edit]
[-] NullsafeObjectOperatorTest.php [edit]
[-] DNFTypesParseError1Test.php [edit]
[-] AttributesTest.php [edit]
[-] ExitKeywordTest.inc [edit]
[-] HeredocParseErrorTest.php [edit]
[-] AnonClassParenthesisOwnerTest.php [edit]
[-] NullableVsInlineThenTest.inc [edit]
[-] ArrayKeywordTest.php [edit]
[-] NullsafeObjectOperatorTest.inc [edit]
[-] BackfillExplicitOctalNotationTest.inc [edit]
[-] ResolveSimpleTokenTest.inc [edit]
[-] DNFTypesParseError2Test.inc [edit]
[-] BackfillEnumTest.php [edit]
[-] YieldTest.inc [edit]
[-] BackfillReadonlyTest.php [edit]
[-] HeredocNowdocTest.php [edit]
[-] ShortArrayTest.inc [edit]
[-] DefaultKeywordTest.php [edit]
[-] StableCommentWhitespaceWinTest.inc [edit]
[-] BitwiseOrTest.inc [edit]
[-] DNFTypesTest.php [edit]
[-] DoubleArrowTest.php [edit]
[-] EnumCaseTest.inc [edit]
[-] TypedConstantsTest.php [edit]
[-] BackfillNumericSeparatorTest.php [edit]
[-] BackfillFnTokenTest.php [edit]
[-] FinallyTest.inc [edit]
[-] HeredocStringTest.php [edit]
[-] ShortArrayTest.php [edit]
[-] BackfillMatchTokenTest.inc [edit]
[-] NullableVsInlineThenTest.php [edit]
[-] DoubleQuotedStringTest.inc [edit]
[-] GotoLabelTest.php [edit]
[-] ExitKeywordTest.php [edit]
[-] HeredocParseErrorTest.inc [edit]
[-] ResolveSimpleTokenTest.php [edit]
[-] UndoNamespacedNameSingleTokenTest.inc [edit]
[-] OtherContextSensitiveKeywordsTest.inc [edit]
[-] NamedFunctionCallArgumentsTest.php [edit]
[-] AnonClassParenthesisOwnerTest.inc [edit]
[-] PHPOpenTagEOF3Test.inc [edit]
[-] BackfillFnTokenTest.inc [edit]
[-] BackfillAsymmetricVisibilityTest.inc [edit]
[-] AttributesTest.inc [edit]
[-] ContextSensitiveKeywordsTest.inc [edit]
[-] FinallyTest.php [edit]
[-] PHPOpenTagEOF3Test.php [edit]
[-] YieldTest.php [edit]
[-] DefaultKeywordTest.inc [edit]
[-] ContextSensitiveKeywordsTest.php [edit]