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

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
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 `%<beginning>s` at ' \
'%<begin_loc_line>d, %<begin_loc_column>d.'
ANCESTOR_TYPES = 
%i[kwbegin def defs class module].freeze
RUBY_2_5_ANCESTOR_TYPES = 
(ANCESTOR_TYPES + %i[block]).freeze
ANCESTOR_TYPES_WITH_ACCESS_MODIFIERS = 
%i[def defs].freeze
ALTERNATIVE_ACCESS_MODIFIERS = 
%i[public_class_method
private_class_method].freeze

Constants included from Util

Util::LITERAL_REGEX

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, 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 


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

def autocorrect(node)
  whitespace = whitespace_range(node)
  # Some inline node is sitting before current node.
  return nil unless whitespace.source.strip.empty?

  alignment_node = alignment_node(node)
  return false if alignment_node.nil?

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

#investigate(processed_source) ⇒ Object 


56
57
58
59
60
61
62
63
 
# File 'lib/rubocop/cop/layout/rescue_ensure_alignment.rb', line 56

def investigate(processed_source)
  @modifier_locations =
    processed_source.tokens.each_with_object([]) do |token, locations|
      next unless token.rescue_modifier?

      locations << token.pos
    end
end

#on_ensure(node) ⇒ Object 


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

def on_ensure(node)
  check(node)
end

#on_resbody(node) ⇒ Object 


36
37
38
 
# File 'lib/rubocop/cop/layout/rescue_ensure_alignment.rb', line 36

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