Fix incorrect shorthand autocorrections in calls inside parentheses #11643
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
gsamokovarov
force-pushed
the
shorthand-syntax-in-kwargs
branch
from
03274ac
to
294fae9
Compare
If you happen to have a method call without parentheses that is inside outer parentheses like the following example: ```ruby (create :integration_shop, account: account) ``` We would have still thought that we need to parentheses the `create` call during `Style/HashSyntax` autocorrection like so: ```ruby (create(:integration_shop, account:)) ``` While this is not a problem in isolation, it can lead to problems with `Style/RedundantParentheses` and `Style/MethodCallWithArgsParentheses` with the following config: ```yaml AllCops: TargetRubyVersion: 3.1 Style/HashSyntax: EnforcedShorthandSyntax: always Style/RedundantParentheses: Enabled: true Style/MethodCallWithArgsParentheses: Enabled: true EnforcedStyle: omit_parentheses ``` I have two problematic examples: **1.** ```ruby receipt = create :receipt, account: account, integration_shop: (create :integration_shop, account: account) pass ``` Autocorrects to broken Ruby like so: ```ruby receipt = create :receipt, account:, integration_shop: create :integration_shop, account: pass ``` This happens because `Style/HashSyntax` puts parentheses in `(create(:integration_shop, account:))`, which then gets autocorrected by `Style/MethodCallWithArgsParentheses` to `(create :integration_shop, account:)` that finally gets picked up by `Style/RedundantParentheses` to `create :integration_shop, account:`. **2.** ```ruby bank_transaction_ids = (MatchBankTransactionsToCosts.execute object, bank_account: bank_account).keys pass ``` Gets autocorrected to: ```ruby bank_transaction_ids = MatchBankTransactionsToCosts.execute object, bank_account:.keys pass ``` The reason is the same, the unforunate play between `Style/HashSyntax`, `Style/MethodsAcceptingSymbol` with `EnforcedStyle: omit_parentheses` and `Style/RedundantParentheses`. An fix is not to parenthesize the calls with value omission if they are inside parentheses. That's one of the drawbacks of omitting parentheses, sometimes folks decide to put them in funny places like around a method call.
gsamokovarov
force-pushed
the
shorthand-syntax-in-kwargs
branch
from
294fae9
to
3d19dd4
Compare
|
Thanks! |
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.
If you happen to have a method call without parentheses that is inside outer parentheses like the following example:
We would have still thought that we need to add parentheses to the
createcall duringStyle/HashSyntaxautocorrection like so:While this is not a problem in isolation, it can lead to invalid Ruby autocorrections when
Style/HashSyntaxis used in combination withStyle/RedundantParentheses(enabled by default) andStyle/MethodCallWithArgsParentheses(disabled by default) withEnforcedStyle: omit_parentheses:I have two problematic examples:
1.
Autocorrects to broken Ruby like so:
This happens because
Style/HashSyntaxputs parentheses in(create(:integration_shop, account:)), which then gets autocorrected byStyle/MethodCallWithArgsParenthesesto(create :integration_shop, account:)that finally gets processed byStyle/RedundantParenthesestocreate :integration_shop, account:.2.
Gets autocorrected to:
The reason is the same, the unforunate play between
Style/HashSyntax,Style/MethodsAcceptingSymbolwithEnforcedStyle: omit_parenthesesandStyle/RedundantParentheses.An fix is not to parenthesize the calls with value omission if they are inside parentheses. That's one of the drawbacks of omitting parentheses, sometimes folks decide to put them in funny places like around a method call.