Tokenizers/Comment: add tests + fix two edge case bugs #494
Conversation
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
The `Tokenizers\Comment` class did not have any tests associated with it. This commit fixes that and documents the existing behaviour. Note: code coverage is as high as it can go, but not 100%. The reason for this, is the tokenizer debug statements, which are conditional on a verbosity flag, which is turned off for the tests. Loosely related to 484.
This commit fixes an edge case tokenizer bug, where a - completely empty, not even whitespace - _block comment_, would be tokenized as a docblock. Without this commit, the `/**/` code snippet was tokenized as: ``` 8 | L07 | C 1 | CC 0 | ( 0) | T_DOC_COMMENT_OPEN_TAG | [ 4]: /**/ 9 | L07 | C 5 | CC 0 | ( 0) | T_DOC_COMMENT_CLOSE_TAG | [ 0]: ``` With the fix applied, it will be tokenized as: ``` 8 | L07 | C 1 | CC 0 | ( 0) | T_COMMENT | [ 4]: /**/ ```
This commit fixes an edge case tokenizer bug, where a - completely empty, not even whitespace - _DocBlock_, would not be tokenized correctly. Without this commit, the `/***/` code snippet was tokenized as: ``` 13 | L10 | C 1 | CC 0 | ( 0) | T_DOC_COMMENT_OPEN_TAG | [ 5]: /***/ 14 | L10 | C 6 | CC 0 | ( 0) | T_DOC_COMMENT_CLOSE_TAG | [ 0]: ``` With the fix applied, it will be tokenized as: ``` 13 | L10 | C 1 | CC 0 | ( 0) | T_DOC_COMMENT_OPEN_TAG | [ 3]: /** 14 | L10 | C 4 | CC 0 | ( 0) | T_DOC_COMMENT_CLOSE_TAG | [ 2]: */ ```
Girlscouting. * Remove an unnecessary interim variable. * Add a comment clarifying certain code. * Specify the array format in the `@return` tags.
|
Rebased without changes. Merging once the build passes. |
jrfnl
force-pushed
the
feature/tokenizer-comments-add-tests
branch
from
3cecd91
to
bef6fff
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Tokenizers/Comment: add tests
The
Tokenizers\Commentclass did not have any tests associated with it. This commit fixes that and documents the existing behaviour.Note: code coverage is as high as it can go, but not 100%. The reason for this, is the tokenizer debug statements, which are conditional on a verbosity flag, which is turned off for the tests.
Loosely related to #484.
Tokenizers/PHP: bug fix - empty block comment
This commit fixes an edge case tokenizer bug, where a - completely empty, not even whitespace - block comment, would be tokenized as a docblock.
Without this commit, the
/**/code snippet was tokenized as:With the fix applied, it will be tokenized as:
Tokenizers/Comment: bug fix - empty docblock
This commit fixes an edge case tokenizer bug, where a - completely empty, not even whitespace - DocBlock, would not be tokenized correctly.
Without this commit, the
/***/code snippet was tokenized as:With the fix applied, it will be tokenized as:
Tokenizers/Comment: minor tweaks
Girlscouting.
@returntags.Suggested changelog entry
Related issues/external references
Preliminary work to allow for #484 later on.
Related #146
Types of changes