Add new Rails/IncludeViewHelper cop#1609
Open
mathieugoedhart96 wants to merge 1 commit intorubocop:masterfrom
Open
Add new Rails/IncludeViewHelper cop#1609mathieugoedhart96 wants to merge 1 commit intorubocop:masterfrom
Rails/IncludeViewHelper cop#1609mathieugoedhart96 wants to merge 1 commit intorubocop:masterfrom
Conversation
…r modules (modules in the `ActionView::Helpers` namespace or following the `*Helper` naming convention) outside of view contexts.
cdcd018 to
55f79df
Compare
This file contains hidden or 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
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.
Summary
Add a new
Rails/IncludeViewHelpercop that disallows including view helper modules outside of view contexts.View helpers (modules in the
ActionView::Helpersnamespace or following the*Helpernaming convention) depend on the view context. Including them in controllers, models, jobs, etc. may cause methods to fail silently or raise errors because the view context is not present.Modules in
app/helpersare automatically included into all views by Rails. If shared behaviour is needed across multiple classes, it should be extracted into a concern underapp/concernsinstead. In controllers, thehelpersproxy can be used to call helper methods.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.