Fix hidden-methods failure in Ruby 2.7
#3422
Merged
Conversation
This file contains hidden or 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
jez
reviewed
Sep 14, 2020
Resolves sorbet#2771 Due to the way argument forwarding is implemented in Ruby 2.7, at runtime Sorbet will see parameter names for the expanded method parameters that are invalid. This causes a failure in the hidden methods generation process since the output ends up being an invalid RBI file. The fix is to sanitize the parameter names to be valid unique names so that we still capture the runtime method signature but also have valid parameter names as well.
50a583a to
ff04946
Compare
jez
approved these changes
Sep 15, 2020
elliottt
pushed a commit
that referenced
this pull request
Sep 23, 2020
Resolves #2771 Due to the way argument forwarding is implemented in Ruby 2.7, at runtime Sorbet will see parameter names for the expanded method parameters that are invalid. This causes a failure in the hidden methods generation process since the output ends up being an invalid RBI file. The fix is to sanitize the parameter names to be valid unique names so that we still capture the runtime method signature but also have valid parameter names as well.
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.
Motivation
Resolve: #2771
Due to the way argument forwarding is implemented in Ruby 2.7, at runtime Sorbet will see parameter names for the expanded method parameters that are invalid. This causes a failure in the hidden methods generation process since the output ends up being an invalid RBI file.
The fix is to sanitize the parameter names to be valid unique names so that we still capture the runtime method signature but also have valid parameter names as well.
Test plan
No automated tests included since there is no framework to test
sorbetgem under 2.7. However, there are user reports of the fix working successfully in their codebase with this patch