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

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, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

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?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, 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_body

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?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, 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 



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/rubocop/cop/style/rescue_ensure_alignment.rb', line 44

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 



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

def investigate(processed_source)
  @modifier_locations =
    processed_source.tokens.each_with_object([]) do |token, locations|
      next unless token.type == :kRESCUE_MOD
      locations << token.pos
    end
end

#on_ensure(node) ⇒ Object 



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

def on_ensure(node)
  check(node)
end

#on_resbody(node) ⇒ Object 



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

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