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.'.freeze

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, 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, #display_column, #indentation, #offset

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?, #duplicate_location?, #excluded_file?, #extra_details?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from 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?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



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 25

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

  indent = indentation(node)
  correction =
    "begin\n" \
    "#{operation.source.gsub(/^/, indent)}" \
    "\n#{offset(node)}rescue\n" \
    "#{rescue_args.source.gsub(/^/, indent)}" \
    "\n#{offset(node)}end"

  lambda do |corrector|
    corrector.replace(node.source_range, correction)
  end
end

#investigate(processed_source) ⇒ Object 



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

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

#on_resbody(node) ⇒ Object 



20
21
22
23
 
# File 'lib/rubocop/cop/style/rescue_modifier.rb', line 20

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