Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generic/EmptyPHPStatement: improve code coverage #699

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,6 @@ public function process(File $phpcsFile, $stackPtr)
case 'T_SEMICOLON':
$prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), null, true);

if ($prevNonEmpty === false) {
jrfnl marked this conversation as resolved.
Show resolved Hide resolved
return;
}

if ($tokens[$prevNonEmpty]['code'] !== T_SEMICOLON
&& $tokens[$prevNonEmpty]['code'] !== T_OPEN_TAG
&& $tokens[$prevNonEmpty]['code'] !== T_OPEN_TAG_WITH_ECHO
Expand Down Expand Up @@ -128,9 +124,8 @@ public function process(File $phpcsFile, $stackPtr)
case 'T_CLOSE_TAG':
$prevNonEmpty = $phpcsFile->findPrevious(T_WHITESPACE, ($stackPtr - 1), null, true);

if ($prevNonEmpty === false
|| ($tokens[$prevNonEmpty]['code'] !== T_OPEN_TAG
&& $tokens[$prevNonEmpty]['code'] !== T_OPEN_TAG_WITH_ECHO)
if ($tokens[$prevNonEmpty]['code'] !== T_OPEN_TAG
&& $tokens[$prevNonEmpty]['code'] !== T_OPEN_TAG_WITH_ECHO
) {
return;
}
Expand All @@ -150,10 +145,6 @@ public function process(File $phpcsFile, $stackPtr)
$phpcsFile->fixer->endChangeset();
}
break;

default:
// Deliberately left empty.
break;
}//end switch

}//end process()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function_call();

?>
<input name="<?php ; something_else(); ?>" />
<input name="<?php something_else(); ; ?>" />
<input name="<?php something_else(); ; ; ?>" />

/*
* Test empty statement: no code between PHP open and close tag.
Expand All @@ -42,7 +42,7 @@ function_call();
-->
<?php ; ?>

<input name="<?php ; ?>" /> <!-- Bad. -->
<input name="<?php ;; ?>" /> <!-- Bad. -->

<!-- Tests with short open echo tag. -->
<input name="<?= 'some text' ?>" /> <!-- OK. -->
Expand All @@ -53,7 +53,7 @@ function_call();
// Guard against false positives for two consecutive semicolons in a for statement.
for ( $i = 0; ; $i++ ) {}

// Test for useless semicolons
// Test for useless semicolons.
for ( $i = 0; ; $i++ ) {};

if (true) {};
Expand All @@ -80,7 +80,7 @@ if ($foo) {
;
}

// Do not remove semicolon after match
// Do not remove semicolon after match.
$c = match ($a) {
1 => true,
};
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ function_call();
// Guard against false positives for two consecutive semicolons in a for statement.
for ( $i = 0; ; $i++ ) {}

// Test for useless semicolons
// Test for useless semicolons.
for ( $i = 0; ; $i++ ) {}

if (true) {}
Expand All @@ -74,7 +74,7 @@ echo $a{0};
if ($foo) {
}

// Do not remove semicolon after match
// Do not remove semicolon after match.
$c = match ($a) {
1 => true,
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- Tests with short open tag. -->

<input name="<? ; something_else(); ?>" />
<input name="<? something_else(); ; ?>" />

/*
* Test empty statement: no code between PHP open and close tag.
*/
<input name="<? something_else() ?>" /> <!-- OK. -->
<input name="<? something_else(); ?>" /> <!-- OK. -->
<input name="<? /* comment */ ?>" /> <!-- OK. -->

<input name="<? ?>" /> <!-- Bad. -->

<input name="<?


?>" /> <!-- Bad. -->

<!--
/*
* Test detecting & fixing a combination of the two checks.
*/
-->
<? ; ?>

<input name="<? ; ?>" /> <!-- Bad. -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Tests with short open tag. -->

<input name="<?something_else(); ?>" />
<input name="<? something_else(); ?>" />

/*
* Test empty statement: no code between PHP open and close tag.
*/
<input name="<? something_else() ?>" /> <!-- OK. -->
<input name="<? something_else(); ?>" /> <!-- OK. -->
<input name="<? /* comment */ ?>" /> <!-- OK. -->

<input name="" /> <!-- Bad. -->

<input name="" /> <!-- Bad. -->

<!--
/*
* Test detecting & fixing a combination of the two checks.
*/
-->

<input name="" /> <!-- Bad. -->
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,27 @@ final class EmptyPHPStatementUnitTest extends AbstractSniffUnitTest
{


/**
* Get a list of all test files to check.
*
* @param string $testFileBase The base path that the unit tests files will have.
*
* @return string[]
*/
protected function getTestFiles($testFileBase)
{
$testFiles = [$testFileBase.'1.inc'];

$option = (bool) ini_get('short_open_tag');
if ($option === true) {
$testFiles[] = $testFileBase.'2.inc';
}

return $testFiles;

}//end getTestFiles()


/**
* Returns the lines where errors should occur.
*
Expand All @@ -41,31 +62,47 @@ public function getErrorList()
* The key of the array should represent the line number and the value
* should represent the number of warnings that should occur on that line.
*
* @param string $testFile The name of the file being tested.
*
* @return array<int, int>
*/
public function getWarningList()
public function getWarningList($testFile='')
{
return [
9 => 1,
12 => 1,
15 => 1,
18 => 1,
21 => 1,
22 => 1,
31 => 1,
33 => 1,
43 => 1,
45 => 1,
49 => 1,
50 => 1,
57 => 1,
59 => 1,
61 => 1,
63 => 2,
71 => 1,
72 => 1,
80 => 1,
];
switch ($testFile) {
case 'EmptyPHPStatementUnitTest.1.inc':
return [
9 => 1,
12 => 1,
15 => 1,
18 => 1,
21 => 1,
22 => 2,
31 => 1,
33 => 1,
43 => 1,
45 => 2,
49 => 1,
50 => 1,
57 => 1,
59 => 1,
61 => 1,
63 => 2,
71 => 1,
72 => 1,
80 => 1,
];
case 'EmptyPHPStatementUnitTest.2.inc':
return [
3 => 1,
4 => 1,
13 => 1,
15 => 1,
25 => 1,
27 => 1,
];
default:
return [];
}//end switch

}//end getWarningList()

Expand Down