Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
Rails/ActionControllerFlashBeforeRender
cop
- Loading branch information
1 parent
bceaa02
commit b697f90
Showing
5 changed files
with
196 additions
and
0 deletions.
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 @@ | ||
* [#759](https://github.com/rubocop/rubocop-rails/pull/759): Add new `Rails/ActionControllerFlashBeforeRender` cop. ([@americodls][]) |
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
85 changes: 85 additions & 0 deletions
85
lib/rubocop/cop/rails/action_controller_flash_before_render.rb
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,85 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Rails | ||
# Using `flash` assignment before `render` will persist the message for too long. | ||
# Check https://guides.rubyonrails.org/action_controller_overview.html#flash-now | ||
# | ||
# @safety | ||
# This cop's autocorrection is unsafe because it replaces `flash` by `flash.now`. | ||
# Even though it is usually a mistake, it might be used intentionally. | ||
# | ||
# @example | ||
# # bad | ||
# flash[:alert] = "Warning!" | ||
# render :index | ||
# | ||
# # good | ||
# flash.now[:alert] = "Warning!" | ||
# render :index | ||
# | ||
class ActionControllerFlashBeforeRender < Base | ||
extend AutoCorrector | ||
|
||
MSG = 'Use `flash.now` before `render`.' | ||
|
||
def_node_search :flash_assignment?, <<~PATTERN | ||
^(send (send nil? :flash) :[]= ...) | ||
PATTERN | ||
|
||
def_node_search :render?, <<~PATTERN | ||
(send nil? :render ...) | ||
PATTERN | ||
|
||
def_node_search :action_controller?, <<~PATTERN | ||
{ | ||
(const nil? :ApplicationController) | ||
(const (const nil? :ActionController) :Base) | ||
} | ||
PATTERN | ||
|
||
RESTRICT_ON_SEND = [:flash].freeze | ||
|
||
def on_send(node) | ||
expression = flash_assignment?(node) | ||
return unless expression | ||
|
||
context = find_ancestor(node, type: :begin) | ||
return unless context | ||
|
||
siblings = context.descendants | ||
return unless siblings.any? { |sibling| render?(sibling) } | ||
|
||
return unless instance_method_or_block?(node) | ||
|
||
return unless inherit_action_controller_base?(node) | ||
|
||
add_offense(node) do |corrector| | ||
corrector.replace(node, 'flash.now') | ||
end | ||
end | ||
|
||
private | ||
|
||
def inherit_action_controller_base?(node) | ||
class_node = find_ancestor(node, type: :class) | ||
return unless class_node | ||
|
||
action_controller?(class_node) | ||
end | ||
|
||
def instance_method_or_block?(node) | ||
def_node = find_ancestor(node, type: :def) | ||
block_node = find_ancestor(node, type: :block) | ||
|
||
def_node || block_node | ||
end | ||
|
||
def find_ancestor(node, type:) | ||
node.each_ancestor(type).first | ||
end | ||
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
101 changes: 101 additions & 0 deletions
101
spec/rubocop/cop/rails/action_controller_flash_before_render_spec.rb
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,101 @@ | ||
# frozen_string_literal: true | ||
|
||
RSpec.describe RuboCop::Cop::Rails::ActionControllerFlashBeforeRender, :config do | ||
context 'within a rails controller class' do | ||
context 'within an instance method' do | ||
context 'when using `flash` before `render`' do | ||
it 'registers an offense and corrects' do | ||
expect_offense(<<~RUBY) | ||
class HomeController < ApplicationController | ||
def create | ||
flash[:alert] = "msg" | ||
^^^^^ Use `flash.now` before `render`. | ||
render :index | ||
end | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
class HomeController < ApplicationController | ||
def create | ||
flash.now[:alert] = "msg" | ||
render :index | ||
end | ||
end | ||
RUBY | ||
end | ||
end | ||
|
||
context 'when using `flash` before `redirect_to`' do | ||
it 'does not register an offense' do | ||
expect_no_offenses(<<~RUBY) | ||
class HomeController < ApplicationController | ||
def create | ||
flash[:alert] = "msg" | ||
redirect_to "https://www.google.com/" | ||
end | ||
end | ||
RUBY | ||
end | ||
end | ||
end | ||
|
||
context 'within a class method' do | ||
it 'does not register an offense' do | ||
expect_no_offenses(<<~RUBY) | ||
class HomeController < ApplicationController | ||
def self.create | ||
flash[:alert] = "msg" | ||
render :index | ||
end | ||
end | ||
RUBY | ||
end | ||
end | ||
|
||
context 'within a block' do | ||
it 'registers an offense and corrects' do | ||
expect_offense(<<~RUBY) | ||
class HomeController < ApplicationController | ||
before_action do | ||
flash[:alert] = "msg" | ||
^^^^^ Use `flash.now` before `render`. | ||
render :index | ||
end | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
class HomeController < ApplicationController | ||
before_action do | ||
flash.now[:alert] = "msg" | ||
render :index | ||
end | ||
end | ||
RUBY | ||
end | ||
end | ||
|
||
it 'does not register an offense' do | ||
expect_no_offenses(<<~RUBY) | ||
class HomeController < ApplicationController | ||
flash[:alert] = "msg" | ||
render :index | ||
end | ||
RUBY | ||
end | ||
end | ||
|
||
context 'within a non rails controller class' do | ||
it 'does not register an offense' do | ||
expect_no_offenses(<<~RUBY) | ||
class NonController < ApplicationRecord | ||
def create | ||
flash[:alert] = "msg" | ||
render :index | ||
end | ||
end | ||
RUBY | ||
end | ||
end | ||
end |