PHPCSStandards / PHP_CodeSniffer / 13467033366

79%

push

github

Squiz/MemberVarSpacing: bug fix / improve parse error handling

The `Squiz.WhiteSpace.MemberVarSpacing` sniff checks the number of blank lines before a property declaration.

To determine the number of blank lines before a property, it tries to find the start of the statement by:
* First finding the first modifier keyword before the variable (to skip over a potential type declaration);
* And then walking over the other modifiers until it finds the first one for the statement;
* After that, it checks for potential docblocks and attributes and skips over those.

Only after all that it checks the number of blank lines.

The first step however leads to problems when, during live coding, a property would be declared without a modifier keyword.
In that case, the sniff could walk back much further than it should, potentially misidentifying a modifier keyword for a function for the modifier keyword for the property.

While this is an edge-case as it is not customary for properties to be declared _after_ functions, the sniff should still handle this situation correctly.

Fixed by changing the logic of the sniff to stop searching earlier.

Includes new test case files, both of which demonstrate the bug.
Additionally, the test in the `1` file safeguards that the current behaviour of the sniff for multi-property declarations is not aversely affected by the fix.

8 of 8 new or added lines in 1 file covered. (100.0%)

24728 of 31473 relevant lines covered (78.57%)

66.34 hits per line