Class: RuboCop::Cop::Naming::RescuedExceptionsVariableName

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb

Overview

This cop makes sure that rescued exceptions variables are named as expected.

The `PreferredName` config option takes a `String`. It represents the required name of the variable. Its default is `e`.

Examples:

PreferredName: e (default)

# bad
begin
  # do something
rescue MyException => exception
  # do something
end

# good
begin
  # do something
rescue MyException => e
  # do something
end

# good
begin
  # do something
rescue MyException => _e
  # do something
end

PreferredName: exception

# bad
begin
  # do something
rescue MyException => e
  # do something
end

# good
begin
  # do something
rescue MyException => exception
  # do something
end

# good
begin
  # do something
rescue MyException => _exception
  # do something
end

Constant Summary collapse

MSG =
'Use `%<preferred>s` instead of `%<bad>s`.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, 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


67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb', line 67

def autocorrect(node)
  lambda do |corrector|
    offending_name = variable_name(node)
    preferred_name = preferred_name(offending_name)
    corrector.replace(offense_range(node), preferred_name)

    node.body&.each_descendant(:lvar) do |var|
      next unless var.children.first == offending_name

      corrector.replace(var.loc.expression, preferred_name)
    end
  end
end

#on_resbody(node) ⇒ Object


59
60
61
62
63
64
65
# File 'lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb', line 59

def on_resbody(node)
  name = variable_name(node)
  return unless name
  return if preferred_name(name).to_sym == name

  add_offense(node, location: offense_range(node))
end