Preserve multiline semantics on Style/SymbolArray and Style/WordArray
#10784
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
koic
reviewed
Jul 4, 2022
| @@ -39,7 +39,7 @@ class SymbolArray < Base | |||
| minimum_target_ruby_version 2.0 | |||
|
|
|||
| PERCENT_MSG = 'Use `%i` or `%I` for an array of symbols.' | |||
| ARRAY_MSG = 'Use `%<prefer>s` for an array of symbols.' | |||
| ARRAY_MSG = 'Use `[...]` for an array of symbols.' | |||
There was a problem hiding this comment.
Can you tweak the message?
Suggested change
| ARRAY_MSG = 'Use `[...]` for an array of symbols.' | |
| ARRAY_MSG = 'Use array brackets `[...]` for an array of symbols.' |
There was a problem hiding this comment.
Sure, thank you for pointing that out. I too was afraid that this [...] might be a bit confusing.
koic
reviewed
Jul 4, 2022
lib/rubocop/cop/style/word_array.rb
Outdated
| @@ -44,7 +44,7 @@ class WordArray < Base | |||
| extend AutoCorrector | |||
|
|
|||
| PERCENT_MSG = 'Use `%w` or `%W` for an array of words.' | |||
| ARRAY_MSG = 'Use `%<prefer>s` for an array of words.' | |||
| ARRAY_MSG = 'Use `[...]` for an array of words.' | |||
There was a problem hiding this comment.
Ditto.
Suggested change
| ARRAY_MSG = 'Use `[...]` for an array of words.' | |
| ARRAY_MSG = 'Use array brackets`[...]` for an array of words.' |
r7kamura
force-pushed
the
feature/preserve-array-line-break
branch
from
022fa36
to
7758a4c
Compare
dvandersluis
reviewed
Jul 4, 2022
…ray` To fix rubocop#10455. Note that this commit also changes the offense message like this: ```ruby \# Before %w( ^^^ Use `[ 'foo', 'bar' ]` for an array of words. foo bar ) \# After %w( ^^^ Use `[...]` for an array of words. foo bar ) ``` This means that the auto-corrected code no longer appears in the offense message. I think this is a reasonable change because the message to enforce the percent styles (`'Use `%w` or `%W` for an array of words.'`) is already using this format.
r7kamura
force-pushed
the
feature/preserve-array-line-break
branch
from
a3d6672
to
074f294
Compare
|
Looks good. Thanks! |
ydah
added a commit
to ydah/rubocop-rails
that referenced
this pull request
Oct 19, 2022
Similar issue: rubocop/rubocop#10784 Before ```diff if a.present? +^^^^^^^^^^^^^ Use `a.presence || b.to_f * 12.0` instead of `if a.present? + a +else + b +end`. a else b end ``` After ```diff if a.present? +^^^^^^^^^^^^^ Use `a.presence || b` instead of `if a.present? ... end`. a else b.to_f + 12.0 end ```
7 tasks
ydah
added a commit
to ydah/rubocop-rails
that referenced
this pull request
Oct 19, 2022
Similar issue: rubocop/rubocop#10784 Before ```diff if a.present? +^^^^^^^^^^^^^ Use `a.presence || b.to_f * 12.0` instead of `if a.present? + a +else + b +end`. a else b end ``` After ```diff if a.present? +^^^^^^^^^^^^^ Use `a.presence || b` instead of `if a.present? ... end`. a else b end ```
ydah
added a commit
to ydah/rubocop-rails
that referenced
this pull request
Oct 20, 2022
Similar issue: rubocop/rubocop#10784 Before ```diff if a.present? +^^^^^^^^^^^^^ Use `a.presence || b.to_f * 12.0` instead of `if a.present? + a +else + b +end`. a else b end ``` After ```diff if a.present? +^^^^^^^^^^^^^ Use `a.presence || b` instead of `if a.present? ... end`. a else b end ```
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.
To fix #10455.
Example:
To mimic the original whitespace semantics, I decided to extract three types of whitespace and reuse them in autocorrection.
Note that this commit also changes the offense message like this (on multiline case):
This means that the auto-corrected code no longer appears in the offense message (on multiline case). I think this is a reasonable change because this format is already used for percent styles:
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 runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.