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

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Rails::ActionFilter

Extended by:

TargetRailsVersion

Includes:

ConfigurableEnforcedStyle

Defined in:

lib/rubocop/cop/rails/action_filter.rb

Overview

This cop enforces the consistent use of action filter methods.

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

If the TargetRailsVersion is set to less than 4.0, the cop will enforce the use of filter methods.

Examples:

EnforcedStyle: action (default)

# bad
after_filter :do_stuff
append_around_filter :do_stuff
skip_after_filter :do_stuff

# good
after_action :do_stuff
append_around_action :do_stuff
skip_after_action :do_stuff

EnforcedStyle: filter

# bad
after_action :do_stuff
append_around_action :do_stuff
skip_after_action :do_stuff

# good
after_filter :do_stuff
append_around_filter :do_stuff
skip_after_filter :do_stuff

Constant Summary

MSG =

'Prefer `%<prefer>s` over `%<current>s`.'.freeze

FILTER_METHODS =

%i[
  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
].freeze

ACTION_METHODS =

%i[
  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
].freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #autocorrect(node) ⇒ Object
• #on_block(node) ⇒ Object
• #on_send(node) ⇒ Object

Methods included from TargetRailsVersion

minimum_target_rails_version, support_target_rails_version?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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?, comment_line?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object

# File 'lib/rubocop/cop/rails/action_filter.rb', line 83

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

# File 'lib/rubocop/cop/rails/action_filter.rb', line 75

def on_block(node)
  check_method_node(node.send_node)
end

#on_send(node) ⇒ Object

# File 'lib/rubocop/cop/rails/action_filter.rb', line 79

def on_send(node)
  check_method_node(node) unless node.receiver
end