Add Rails/ControllerTesting cop #638
Merged
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
gmcgibbon
force-pushed
the
controller_testing_cop
branch
3 times, most recently
from
b7046b9
to
8405f86
Compare
koic
reviewed
Feb 7, 2022
koic
reviewed
Feb 7, 2022
koic
reviewed
Feb 7, 2022
| expect_no_offenses(<<~RUBY) | ||
| class MyControllerTest < ActionDispatch::IntegrationTest; end | ||
| RUBY | ||
| end |
There was a problem hiding this comment.
Can you add a test case that does not have a superclass as a test?
There was a problem hiding this comment.
Added one that tests:
expect_no_offenses(<<~RUBY)
class MyControllerTest < SuperControllerTest
end
RUBY
for a custom superclass. Let me know if you meant that, or something else 😄
There was a problem hiding this comment.
I was worried about class Foo; end, but there was no problem :-)
koic
reviewed
Feb 7, 2022
koic
reviewed
Feb 7, 2022
koic
reviewed
Feb 7, 2022
koic
reviewed
Feb 7, 2022
gmcgibbon
force-pushed
the
controller_testing_cop
branch
2 times, most recently
from
f2ac26a
to
b33f717
Compare
koic
reviewed
Feb 8, 2022
gmcgibbon
force-pushed
the
controller_testing_cop
branch
from
b33f717
to
07869be
Compare
koic
reviewed
Feb 9, 2022
koic
reviewed
Feb 9, 2022
koic
reviewed
Feb 9, 2022
koic
reviewed
Feb 9, 2022
koic
reviewed
Feb 9, 2022
koic
reviewed
Feb 9, 2022
Add controller testing cop to discourage use of ActionController::TestCase. ActionDispatch::IntegrationTest should be used instead to test controllers.
gmcgibbon
force-pushed
the
controller_testing_cop
branch
from
07869be
to
4fd37fd
Compare
|
Thanks! |
|
Thank you both for the reviews, I learned a lot! ❤️ |
koic
added a commit
to koic/rubocop
that referenced
this pull request
Feb 12, 2022
Follow up of rubocop/rubocop-rails#638 (comment). This PR adds new `InternalAffairs/RedundantContextConfigParameter` cop that checks for redundant `:config` parameter in the `context` arguments. ```ruby # bad context 'foo', :config do end # good context 'foo' do end ```
8 tasks
bbatsov
pushed a commit
to rubocop/rubocop
that referenced
this pull request
Feb 13, 2022
Follow up of rubocop/rubocop-rails#638 (comment). This PR adds new `InternalAffairs/RedundantContextConfigParameter` cop that checks for redundant `:config` parameter in the `context` arguments. ```ruby # bad context 'foo', :config do end # good context 'foo' do 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.
👋 I wrote a cop recently to list usage of all old controller tests. Essentially, it replaces
ActionController::TestCasewithActionDispatch::IntegrationTest. The actual process of converting between the two test case types is a little more involved, but I think the cop is valuable just to keep track of this tech debt within a codebase. I thought that other developers could possibly benefit from this cop as well. Let me know what you think. Thanks!Add controller testing cop to discourage use of
ActionController::TestCase.ActionDispatch::IntegrationTestshould be used instead to test controllers. See https://api.rubyonrails.org/classes/ActionController/TestCase.htmlRelated issue for updating the style guide: rubocop/rails-style-guide#302.
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.and description in grammatically correct, complete sentences.