123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416 |
- <?php
- declare(strict_types=1);
- /*
- * This file is part of PHP CS Fixer.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- * Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
- namespace PhpCsFixer\Tests\Fixer\Comment;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- use PhpCsFixer\Tokenizer\Tokens;
- /**
- * @internal
- *
- * @covers \PhpCsFixer\Fixer\Comment\NoEmptyCommentFixer
- *
- * @extends AbstractFixerTestCase<\PhpCsFixer\Fixer\Comment\NoEmptyCommentFixer>
- */
- final class NoEmptyCommentFixerTest extends AbstractFixerTestCase
- {
- /**
- * @dataProvider provideFixCases
- */
- public function testFix(string $expected, ?string $input = null): void
- {
- $this->doTest($expected, $input);
- }
- /**
- * @return iterable<array{0: string, 1?: string}>
- */
- public static function provideFixCases(): iterable
- {
- // fix cases
- yield [
- '<?php
- echo 0;
- echo 1;
- ',
- '<?php
- echo 0;//
- echo 1;
- ',
- ];
- yield [
- '<?php
- echo 0;
- echo 1;
- ',
- '<?php
- echo 0;//
- echo 1;
- ',
- ];
- yield [
- '<?php
- echo 1;
- ',
- '<?php
- echo 1;//
- ',
- ];
- yield [
- '<?php
- echo 2;
- '.'
- echo 1;
- ',
- '<?php
- echo 2;
- //
- echo 1;
- ',
- ];
- yield [
- '<?php
- ?>',
- '<?php
- //?>',
- ];
- yield [
- '<?php
- '.'
- ',
- '<?php
- //
- ',
- ];
- yield [
- '<?php
- '.'
- ',
- '<?php
- #
- ',
- ];
- yield [
- '<?php
- '.'
- ',
- '<?php
- /**/
- ',
- ];
- yield [
- '<?php
- echo 0;echo 1;
- ',
- '<?php
- echo 0;/**/echo 1;
- ',
- ];
- yield [
- '<?php
- echo 0;echo 1;
- ',
- '<?php
- echo 0;/**//**//**/echo 1/**/;
- ',
- ];
- yield [
- '<?php
- ',
- '<?php
- //',
- ];
- yield [
- '<?php
- ',
- '<?php
- /*
- */',
- ];
- yield [
- "<?php\n \n \n \n \n ",
- "<?php\n //\n //\n //\n /**///\n ",
- ];
- yield [
- "<?php\r \r \r \r \r ",
- "<?php\r //\r //\r //\r /**///\r ",
- ];
- yield [
- "<?php\r\n \r\n \r\n \r\n \r\n ",
- "<?php\r\n //\r\n //\r\n //\r\n /**///\r\n ",
- ];
- yield [
- "<?php\necho 1;\r\recho 2;",
- "<?php\necho 1;\r//\recho 2;",
- ];
- // do not fix cases
- yield [
- '<?php
- // a
- // /**/
- // #
- /* b */ // s
- # c',
- ];
- yield [
- '<?php
- // This comment could be nicely formatted.
- //
- //
- // For that, it could have some empty comment lines inside.
- //
- ## A 1
- ##
- ##
- ## A 2
- ##
- // B 1
- //
- // B 2
- ## C 1
- ##
- ## C 2
- $foo = 1;
- //
- // a
- //
- $bar = 2;
- ',
- ];
- yield [
- '<?php
- '.'
- ',
- '<?php
- /*
- *
- */
- ',
- ];
- yield [
- '<?php
- '.'
- ',
- '<?php
- /********
- *
- ********/
- ',
- ];
- yield [
- '<?php /* a */',
- '<?php /* *//* a *//* */',
- ];
- yield [
- '<?php
- '.'
- /* a */
- '.'
- ',
- '<?php
- //
- /* a */
- //
- ',
- ];
- }
- /**
- * @param string $source valid PHP source code
- * @param int $startIndex start index of the comment block
- * @param int $endIndex expected index of the last token of the block
- * @param bool $isEmpty expected value of empty flag returned
- *
- * @dataProvider provideGetCommentBlockCases
- */
- public function testGetCommentBlock(string $source, int $startIndex, int $endIndex, bool $isEmpty): void
- {
- Tokens::clearCache();
- $tokens = Tokens::fromCode($source);
- self::assertTrue($tokens[$startIndex]->isComment(), \sprintf('Misconfiguration of test, expected comment token at index "%d".', $startIndex));
- $method = new \ReflectionMethod($this->fixer, 'getCommentBlock');
- $method->setAccessible(true);
- $foundInfo = $method->invoke($this->fixer, $tokens, $startIndex);
- self::assertSame($startIndex, $foundInfo['blockStart'], 'Find start index of block failed.');
- self::assertSame($endIndex, $foundInfo['blockEnd'], 'Find end index of block failed.');
- self::assertSame($isEmpty, $foundInfo['isEmpty'], 'Is empty comment block detection failed.');
- }
- /**
- * @return iterable<array{string, int, int, bool}>
- */
- public static function provideGetCommentBlockCases(): iterable
- {
- yield [
- '<?php // a',
- 1,
- 1,
- false,
- ];
- yield [
- '<?php
- // This comment could be nicely formatted.
- //
- //
- // For that, it could have some empty comment lines inside.
- // ',
- 2,
- 11,
- false,
- ];
- yield [
- '<?php
- /**///',
- 1,
- 1,
- true,
- ];
- yield [
- '<?php
- //
- //
- #
- #
- ',
- 5,
- 8,
- true,
- ];
- yield [
- '<?php
- //
- //
- //
- //
- ',
- 5,
- 8,
- true,
- ];
- yield [
- '<?php
- //
- //
- //
- //
- ',
- 1,
- 3,
- true,
- ];
- yield [
- str_replace("\n", "\r", "<?php\n//\n//\n\n//\n//\n"),
- 1,
- 3,
- true,
- ];
- yield [
- str_replace("\n", "\r\n", "<?php\n//\n//\n\n//\n//\n"),
- 1,
- 3,
- true,
- ];
- yield [
- '<?php
- //
- //
- ',
- 1,
- 1,
- true,
- ];
- yield [
- '<?php
- //
- //
- $a; ',
- 1,
- 4,
- true,
- ];
- yield [
- '<?php
- //',
- 1,
- 1,
- true,
- ];
- $src = '<?php
- // a2
- // /*4*/
- // #6
- /* b8 */ // s10
- # c12';
- foreach ([2, 4, 6] as $i) {
- yield [$src, $i, 7, false];
- }
- yield [$src, 8, 8, false];
- yield [$src, 10, 11, false];
- yield [$src, 12, 12, false];
- }
- }
|