-
-
Notifications
You must be signed in to change notification settings - Fork 263
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Rails/ToSWithArgument
cop
#747
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* [#747](https://github.com/rubocop/rubocop-rails/pull/747): Add `Rails/ToSWithArgument` cop. ([@r7kamura][]) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Rails | ||
# Identifies passing any argument to `#to_s`. | ||
# | ||
# @safety | ||
# This cop is marked as unsafe because it may detect `#to_s` calls | ||
# that are not related to Active Support implementation. | ||
# | ||
# @example | ||
# | ||
# # bad | ||
# obj.to_s(:delimited) | ||
# | ||
# # good | ||
# obj.to_formatted_s(:delimited) | ||
# | ||
class ToSWithArgument < Base | ||
extend AutoCorrector | ||
extend TargetRailsVersion | ||
|
||
MSG = 'Use `to_formatted_s` instead.' | ||
|
||
RESTRICT_ON_SEND = %i[to_s].freeze | ||
|
||
minimum_target_rails_version 7.0 | ||
|
||
def on_send(node) | ||
return if node.arguments.empty? | ||
|
||
add_offense(node.loc.selector) do |corrector| | ||
corrector.replace(node.loc.selector, 'to_formatted_s') | ||
end | ||
end | ||
alias on_csend on_send | ||
end | ||
end | ||
end | ||
end |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# frozen_string_literal: true | ||
|
||
RSpec.describe RuboCop::Cop::Rails::ToSWithArgument, :config, :rails70 do | ||
context 'without argument' do | ||
it 'does not register an offense' do | ||
expect_no_offenses(<<~RUBY) | ||
to_s | ||
RUBY | ||
end | ||
end | ||
|
||
context 'with argument' do | ||
it 'registers an offense' do | ||
expect_offense(<<~RUBY) | ||
to_s(:delimited) | ||
^^^^ Use `to_formatted_s` instead. | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
to_formatted_s(:delimited) | ||
RUBY | ||
end | ||
end | ||
|
||
context 'with argument and receiver' do | ||
it 'registers an offense' do | ||
expect_offense(<<~RUBY) | ||
1.to_s(:delimited) | ||
^^^^ Use `to_formatted_s` instead. | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
1.to_formatted_s(:delimited) | ||
RUBY | ||
end | ||
end | ||
|
||
context 'with argument and safe navigation operator' do | ||
it 'registers an offense' do | ||
expect_offense(<<~RUBY) | ||
1&.to_s(:delimited) | ||
^^^^ Use `to_formatted_s` instead. | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
1&.to_formatted_s(:delimited) | ||
RUBY | ||
end | ||
end | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add tests for |
||
|
||
context 'with argument on Rails 6.1', :rails61 do | ||
it 'does not register an offense' do | ||
expect_no_offenses(<<~RUBY) | ||
to_s | ||
RUBY | ||
end | ||
end | ||
end |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add
@safety
to explain why this cop is unsafe? e.g. #575