-
-
Notifications
You must be signed in to change notification settings - Fork 55
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
Squiz/ClosingDeclarationComment: fix a non-problematic bug plus some other small improvements #381
Merged
jrfnl
merged 4 commits into
PHPCSStandards:master
from
rodrigoprimo:closing-declaration-comment-improvements
Apr 9, 2024
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6b7bea2
Squiz/ClosingDeclarationComment: rename test case file
rodrigoprimo 7443644
Squiz/ClosingDeclarationComment: improve test coverage
rodrigoprimo 579f081
Squiz/ClosingDeclarationComment: remove unreachable condition
rodrigoprimo 5b597d8
Squiz/ClosingDeclarationCommentSniff: prevent non-problematic bug
rodrigoprimo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.2.inc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<?php | ||
|
||
// Intentional parse error (missing opening bracket). | ||
// This should be the only test in this file. | ||
// Testing that the sniff is triggered. | ||
|
||
class MissingOpeningBracket |
7 changes: 7 additions & 0 deletions
7
src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.3.inc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<?php | ||
|
||
// Intentional parse error (missing closing bracket). | ||
// This should be the only test in this file. | ||
// Testing that the sniff is triggered. | ||
|
||
class MissingClosingBracket { |
8 changes: 8 additions & 0 deletions
8
src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.4.inc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<?php | ||
|
||
// This should be the only test in this file. | ||
// Testing that the sniff is triggered when the closing bracket is | ||
// the last character in the file (no newline after it). | ||
|
||
function closingBraceAtEndOfFile() { | ||
} |
8 changes: 8 additions & 0 deletions
8
src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.4.inc.fixed
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<?php | ||
|
||
// This should be the only test in this file. | ||
// Testing that the sniff is triggered when the closing bracket is | ||
// the last character in the file (no newline after it). | ||
|
||
function closingBraceAtEndOfFile() { | ||
}//end closingBraceAtEndOfFile() |
11 changes: 11 additions & 0 deletions
11
src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.5.inc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
//end closingBraceAtEndOfFileMissingComment() | ||
|
||
<?php | ||
|
||
// This should be the only test in this file. | ||
// Testing that the sniff is triggered and the fixer works when the closing bracket is | ||
// the last character in the file (no newline after it) and the content of the first token | ||
// is a "//end closingBraceAtEndOfFileMissingComment()" comment. | ||
|
||
function closingBraceAtEndOfFileMissingComment() { | ||
} |
11 changes: 11 additions & 0 deletions
11
src/Standards/Squiz/Tests/Commenting/ClosingDeclarationCommentUnitTest.5.inc.fixed
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
//end closingBraceAtEndOfFileMissingComment() | ||
|
||
<?php | ||
|
||
// This should be the only test in this file. | ||
// Testing that the sniff is triggered and the fixer works when the closing bracket is | ||
// the last character in the file (no newline after it) and the content of the first token | ||
// is a "//end closingBraceAtEndOfFileMissingComment()" comment. | ||
|
||
function closingBraceAtEndOfFileMissingComment() { | ||
}//end closingBraceAtEndOfFileMissingComment() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this is a good test to have anyway, this test doesn't actually highlight the problem with the missing
$next !== false
condition.We looked at this during our call and the following additional test should be added to safeguard the fix:
This test will show that without that extra condition the wrong error is being thrown (though an error is still being thrown).
Note: as the test framework as-is doesn't safeguard that the correct error code is being thrown for each line, it's not a hard safeguard, but having the test in place will allow us to safeguard this properly if/when the test framework gets updates to check per error code/per line.