Class: RuboCop::Cop::Style::RescueEnsureAlignment

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

Overview

This cop checks whether the rescue and ensure keywords are aligned properly.

Examples:


# bad
begin
  something
  rescue
  puts 'error'
end

# good
begin
  something
rescue
  puts 'error'
end

Constant Summary collapse

MSG =
'`%s` at %d, %d is not aligned with `end` at %d, %d.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, 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 inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, #excluded_file?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

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



41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/rubocop/cop/style/rescue_ensure_alignment.rb', line 41

def autocorrect(node)
  source_buffer = node.loc.keyword.source_buffer
  begin_pos = node.loc.keyword.begin_pos
  current_column = node.loc.keyword.column
  whitespace = Parser::Source::Range.new(source_buffer,
                                         begin_pos - current_column,
                                         begin_pos)
  return false unless whitespace.source.strip.empty?

  new_column = ancestor_node(node).loc.end.column
  ->(corrector) { corrector.replace(whitespace, ' ' * new_column) }
end

#investigate(processed_source) ⇒ Object



35
36
37
38
39
# File 'lib/rubocop/cop/style/rescue_ensure_alignment.rb', line 35

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

#on_ensure(node) ⇒ Object



31
32
33
# File 'lib/rubocop/cop/style/rescue_ensure_alignment.rb', line 31

def on_ensure(node)
  check(node)
end

#on_resbody(node) ⇒ Object



27
28
29
# File 'lib/rubocop/cop/style/rescue_ensure_alignment.rb', line 27

def on_resbody(node)
  check(node) unless modifier?(node)
end