[Fix #7900] Fix Style/FormatStringToken
false positive with formatted input and template
style enforced, and add autocorrection
#10160
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.
Fixes #7900.
Types of format strings:
annotated
:'%<name>s'
(wheres
is the format type)template
:'%{name}'
unannotated
:'%s'
The format string
'%{name}'
is only equivalent to'%<name>s'
, so when enforcing thetemplate
style, no offenses should be reported if the format type is nots
(for example,'%<name>f'
).The autocorrection from
template
style%[flags][width][.precision]{name}
toannotated
style is%<name>[flags][width][.precision]s
, and vice versa.Because
unannotated
has no names, it can't be autocorrected toannotated
ortemplate
.Autocorrecting from either
annotated
ortemplate
tounannotated
is possible, but I haven't attempted adding this yet. The method arguments must be updated too, sodef on_send
would need to be added (maybe as a new cop). For example: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}.md
if the new code introduces user-observable changes. See changelog entry format for details.