Generic/MultipleStatementAlignment: bug fix for closure params with defaults #3464
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
…efaults For use within the loop in the `checkAlignment()` method, closures are explicitly removed for the `$scopeOpeners` array as they can be (and often are) assigned to a variable. However, a closure which contained a parameter with a default value would take the equal sign for the default value as the start of a new block. The `process()` method already contained a safeguard against this, but it's the `checkAlignment()` method which is being called recursively, so this check was not executed for those recursive calls. Calling the `process()` method recursively would be troublesome as the returned stackPtr is incremented by one in the `process()` method, so moving the initial check from the `process()` method to the `checkAlignment()` method seemed a reasonable solution. There will probably be other ways in which this could be solved and I'm not 100% sure this is the best solution, but it is a solution which works without breaking any of the existing unit tests. Includes a few additional unit tests to further safeguard against this issue and make sure nothing new is broken.
jrfnl
force-pushed
the
feature/3460-generic-multiplestatement-closure-param-bug
branch
from
5616d5a to
1f39246
Compare
gsherwood
added a commit
that referenced
this pull request
Dec 6, 2021
|
Thanks for fixing this. Very happy to accept a straightforward fix that doesn't break anything :) |
jrfnl
deleted the
feature/3460-generic-multiplestatement-closure-param-bug
branch
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.
For use within the loop in the
checkAlignment()method, closures are explicitly removed for the$scopeOpenersarray as they can be (and often are) assigned to a variable.However, a closure which contained a parameter with a default value would take the equal sign for the default value as the start of a new block.
The
process()method already contained a safeguard against this, but it's thecheckAlignment()method which is being called recursively, so this check was not executed for those recursive calls.Calling the
process()method recursively would be troublesome as the returned stackPtr is incremented by one in theprocess()method, so moving the initial check from theprocess()method to thecheckAlignment()method seemed a reasonable solution.There will probably be other ways in which this could be solved and I'm not 100% sure this is the best solution, but it is a solution which works without breaking any of the existing unit tests.
Includes a few additional unit tests to further safeguard against this issue and make sure nothing new is broken.
Fixes #3460