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.

Sign up for GitHub

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

Jump to bottom

SyntaxError::getNormalizedMessage(): improve tests + 2 bug fixes #118

Merged
merged 5 commits into from
Apr 19, 2022
Merged

SyntaxError::getNormalizedMessage(): improve tests + 2 bug fixes #118

merged 5 commits into from
Apr 19, 2022

Commits on Apr 8, 2022

  1. SyntaxErrorGetNormalizeMessageTest: refactor to dataprovider 

    Refactor the tests in the `SyntaxErrorGetNormalizeMessageTest` class to use data providers, which allow for adding more tests in a straight forward manner.

Note: this is a 1-on-1 refactor of the test with all existing test cases still being tested but no other changes.
    @jrfnl
    jrfnl committed Apr 8, 2022
    Configuration menu
    Copy the full SHA
    e222caf View commit details
    Browse the repository at this point in the history

  2. SyntaxError::getNormalizedMessage(): bug fix - file name containing r… 

    …egex delimiter

If a file name would contain the delimiter used in the replacement regex, it would cause a PHP error like `preg_replace(): Unknown modifier 'f'`.

Fixed by telling `preg_quote()` explicitly which delimiter is being used.

Includes unit test.

Ref: https://www.php.net/manual/en/function.preg-quote.php
    @jrfnl
    jrfnl committed Apr 8, 2022
    Configuration menu
    Copy the full SHA
    273d379 View commit details
    Browse the repository at this point in the history

  3. SyntaxError::getNormalizedMessage(): bug fix - "in file on line" does… 

    …n't always get stripped

In certain cases, PHP puts the full file name in the error message. In those cases the "in filename.php on line .." trailing part of the error message did not get stripped off.

Also, in some cases, when Windows slashes are used in the file path, the "in filename.php on line .." trailing part of the error message may not get stripped off.
This last case will be exceedingly rare as on Windows, those file paths are handled correctly and the chances of a non-Windows user passing a path using Windows slashes will be minuscule.

Even so, I've fixed both cases by making the path handling in the function more robust.
* When the initial stripping of the trailing part of the error message fails, it will be retried up to two times.
* The first time, if Windows slashes would be found in the file path _after_ the `basename()` function has been applied, a "manual" basename extraction is done and the stripping of the trailing part is retried.
* The second time, the full file path is used in a last attempt to strip the trailing part of the error message.

Includes unit tests.

Fixes 94
    @jrfnl
    jrfnl committed Apr 8, 2022
    Configuration menu
    Copy the full SHA
    e55c918 View commit details
    Browse the repository at this point in the history

  4. SyntaxErrorGetNormalizeMessageTest: add some additional test cases 

    Including documenting that a `Deprecated:` prefix will not be removed.
    @jrfnl
    jrfnl committed Apr 8, 2022
    Configuration menu
    Copy the full SHA
    bdd5a89 View commit details
    Browse the repository at this point in the history

  5. SyntaxError::getNormalizedMessage(): minor regex tweak 

    By using `?:` at the start of a parenthesis group, the group will not be "remembered"/saved to memory.

As this regex does not use the subgroups anyway, we don't need to remember them.
    @jrfnl
    jrfnl committed Apr 8, 2022
    Configuration menu
    Copy the full SHA
    0da93c9 View commit details
    Browse the repository at this point in the history