Class: RuboCop::Cop::Style::RescueModifier

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment
Defined in:
lib/rubocop/cop/style/rescue_modifier.rb

Overview

This cop checks for uses of rescue in its modifier form.

Constant Summary collapse

MSG = 
'Avoid using `rescue` in its modifier form.'

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

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 AutocorrectAlignment

#check_alignment, #configured_indentation_width, #indentation, #offset, #start_of_line?

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 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rubocop/cop/style/rescue_modifier.rb', line 23

def autocorrect(node)
  operation, rescue_modifier, = *node
  *_, rescue_args = *rescue_modifier

  correction =
    "begin\n" <<
    indentation(node) << operation.loc.expression.source <<
    "\n#{offset(node)}rescue\n" <<
    indentation(node) << rescue_args.loc.expression.source <<
    "\n#{offset(node)}end"
  range = Parser::Source::Range.new(node.loc.expression.source_buffer,
                                    node.loc.expression.begin_pos,
                                    node.loc.expression.end_pos)

  lambda do |corrector|
    corrector.replace(range, correction)
  end
end

#investigate(processed_source) ⇒ Object 



12
13
14
15
16
 
# File 'lib/rubocop/cop/style/rescue_modifier.rb', line 12

def investigate(processed_source)
  @modifier_locations = processed_source.tokens
                        .select { |t| t.type == :kRESCUE_MOD }
                        .map(&:pos)
end

#on_resbody(node) ⇒ Object 



18
19
20
21
 
# File 'lib/rubocop/cop/style/rescue_modifier.rb', line 18

def on_resbody(node)
  return unless modifier?(node)
  add_offense(node.parent, :expression)
end