Class: RuboCop::Cop::Rails::ActionFilter

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/rails/action_filter.rb

Overview

This cop enforces the consistent use of action filters methods.

The cop is configurable and the enforce the use of older something_filter methods or the newer something_action methods.

Constant Summary collapse

MSG =
'Prefer `%s` over `%s`.'
FILTER_METHODS =
[
  :after_filter,
  :append_after_filter,
  :append_around_filter,
  :append_before_filter,
  :around_filter,
  :before_filter,
  :prepend_after_filter,
  :prepend_around_filter,
  :prepend_before_filter,
  :skip_after_filter,
  :skip_around_filter,
  :skip_before_filter,
  :skip_filter
]
ACTION_METHODS =
[
  :after_action,
  :append_after_action,
  :append_around_action,
  :append_before_action,
  :around_action,
  :before_action,
  :prepend_after_action,
  :prepend_around_action,
  :prepend_before_action,
  :skip_after_action,
  :skip_around_action,
  :skip_before_action,
  :skip_action_callback
]

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object


59
60
61
62
63
64
# File 'lib/rubocop/cop/rails/action_filter.rb', line 59

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(node.loc.selector,
                      preferred_method(node.loc.selector.source).to_s)
  end
end

#on_block(node) ⇒ Object


47
48
49
50
51
# File 'lib/rubocop/cop/rails/action_filter.rb', line 47

def on_block(node)
  method, _args, _body = *node

  check_method_node(method)
end

#on_send(node) ⇒ Object


53
54
55
56
57
# File 'lib/rubocop/cop/rails/action_filter.rb', line 53

def on_send(node)
  receiver, _method_name, *_args = *node

  check_method_node(node) if receiver.nil?
end