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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
EndKeywordAlignment, RangeHelp
Defined in:
lib/rubocop/cop/layout/rescue_ensure_alignment.rb

Overview

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 block numblock].freeze
ANCESTOR_TYPES_WITH_ACCESS_MODIFIERS = 
%i[def defs].freeze
ALTERNATIVE_ACCESS_MODIFIERS = 
%i[public_class_method private_class_method].freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#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_new_investigation ⇒ Object 



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

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

      locations << token.pos
    end
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