Class: RuboCop::Cop::Naming::RescuedExceptionsVariableName
- 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`.
Constant Summary collapse
- MSG =
'Use `%<preferred>s` instead of `%<bad>s`.'
Constants included from Util
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, #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
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?, 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
70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb', line 70 def autocorrect(node) lambda do |corrector| offending_name = node.exception_variable.children.first corrector.replace(offense_range(node), preferred_name) return unless node.body 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 66 67 68 |
# File 'lib/rubocop/cop/naming/rescued_exceptions_variable_name.rb', line 59 def on_resbody(node) exception_type, @exception_name = *node return unless exception_type || @exception_name @exception_name ||= exception_type.children.first return if @exception_name.const_type? || variable_name == preferred_name add_offense(node, location: offense_range(node)) end |