Class: RuboCop::Cop::Layout::RescueEnsureAlignment

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/layout/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 = 
'`%<kw_loc>s` at %<kw_loc_line>d, %<kw_loc_column>d is not ' \
'aligned with `end` at %<end_loc_line>d, %<end_loc_column>d.'
.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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, 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?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::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?, comment_line?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

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



45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/layout/rescue_ensure_alignment.rb', line 45

def autocorrect(node)
  whitespace = whitespace_range(node)
  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 



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

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 



33
34
35
 
# File 'lib/rubocop/cop/layout/rescue_ensure_alignment.rb', line 33

def on_ensure(node)
  check(node)
end

#on_resbody(node) ⇒ Object 



29
30
31
 
# File 'lib/rubocop/cop/layout/rescue_ensure_alignment.rb', line 29

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