Fix an incorrect auto-correct for Style/MultilineTernaryOperator
#8661
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
bbatsov
reviewed
Sep 8, 2020
| @@ -5777,6 +5777,9 @@ a = if cond | |||
| else | |||
| c | |||
| end | |||
| return cond ? | |||
There was a problem hiding this comment.
I guess we shouldn't auto-correct this, but I think we should still flag this, as it looks quite weird.
There was a problem hiding this comment.
Ah, I get it and updated this PR!
koic
changed the title
Style/MultilineTernaryOperatorStyle/MultilineTernaryOperator
koic
force-pushed
the
fix_false_positive_for_style_multiline_ternary_operator
branch
from
c7ce426
to
838bb4e
Compare
bbatsov
approved these changes
Sep 9, 2020
bbatsov
reviewed
Sep 9, 2020
|
|
||
| add_offense(node) do |corrector| | ||
| next unless offense?(node) && !node.parent.return_type? |
There was a problem hiding this comment.
You can add a comment here explaining why this is needed for future reference.
koic
force-pushed
the
fix_false_positive_for_style_multiline_ternary_operator
branch
from
838bb4e
to
6794f3f
Compare
|
Thank you for your advice. I added a note to the doc. |
koic
force-pushed
the
fix_false_positive_for_style_multiline_ternary_operator
branch
2 times, most recently
from
9abfb7a
to
4c4c50e
Compare
This PR fixes the following incorrect auto-correct for
`Style/MultilineTernaryOperator` when returning
a multiline ternary operator expression.
```console
% cat example.rb
return distance_in_minutes == 0 ?
locale.t(:less_than_x_minutes, count: 1) :
locale.t(:x_minutes, count: distance_in_minutes)
% bundle exec rubocop -a --only Style/MultilineTernaryOperator
(snip)
Inspecting 2 files
C.
Offenses:
example.rb:1:8: C: [Corrected] Style/MultilineTernaryOperator: Avoid
multi-line ternary operators, use if or unless instead.
return distance_in_minutes == 0 ? ...
^^^^^^^^^^^^^^^^^^^^^^^^^^
2 files inspected, 1 offense detected, 1 offense corrected
% cat example.rb
return if distance_in_minutes == 0
locale.t(:less_than_x_minutes, count: 1)
else
locale.t(:x_minutes, count: distance_in_minutes)
end
% ruby -c example.rb
example.rb:3: syntax error, unexpected `else', expecting end-of-input
```
I found it with the following code.
https://github.com/rails/rails/blob/v6.0.3.2/actionview/lib/action_view/helpers/date_helper.rb#L109-L111
koic
force-pushed
the
fix_false_positive_for_style_multiline_ternary_operator
branch
from
4c4c50e
to
8a1776f
Compare
koic
deleted the
fix_false_positive_for_style_multiline_ternary_operator
branch
8 tasks
koic
added a commit
to koic/rubocop
that referenced
this pull request
Apr 15, 2022
Follow up rubocop#8661. This PR fixes an incorrect auto-correct for `Style/MultilineTernaryOperator` when returning a multiline ternary operator expression. Using `break`, `next`, or method call also causes the same syntax error as `return`. And this PR will change these auto-correct to single-line ternary operator as valid syntax.
bbatsov
pushed a commit
that referenced
this pull request
Apr 16, 2022
Follow up #8661. This PR fixes an incorrect auto-correct for `Style/MultilineTernaryOperator` when returning a multiline ternary operator expression. Using `break`, `next`, or method call also causes the same syntax error as `return`. And this PR will change these auto-correct to single-line ternary operator as valid syntax.
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.
This PR fixes the following incorrect auto-correct for
Style/MultilineTernaryOperatorwhen returning a multiline ternary operator expression.I found it with the following code.
https://github.com/rails/rails/blob/v6.0.3.2/actionview/lib/action_view/helpers/date_helper.rb#L109-L111
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.