Class: RuboCop::Cop::Layout::EmptyLinesAroundExceptionHandlingKeywords

Inherits:
Cop
  • Object
show all
Includes:
EmptyLinesAroundBody
Defined in:
lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb

Overview

This cops checks if empty lines exist around the bodies of ‘begin` sections. This cop doesn’t check empty lines at ‘begin` body beginning/end and around method definition body. `Style/EmptyLinesAroundBeginBody` or `Style/EmptyLinesAroundMethodBody` can be used for this purpose.

Examples:


# good

begin
  do_something
rescue
  do_something2
else
  do_something3
ensure
  do_something4
end

# good

def foo
  do_something
rescue
  do_something2
end

# bad

begin
  do_something

rescue

  do_something2

else

  do_something3

ensure

  do_something4
end

# bad

def foo
  do_something

rescue

  do_something2
end

Constant Summary collapse

MSG = 
'Extra empty line detected %<location>s the `%<keyword>s`.'.freeze

Constants included from EmptyLinesAroundBody

RuboCop::Cop::Layout::EmptyLinesAroundBody::MSG_DEFERRED, RuboCop::Cop::Layout::EmptyLinesAroundBody::MSG_EXTRA, RuboCop::Cop::Layout::EmptyLinesAroundBody::MSG_MISSING

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 included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

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?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

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 



76
77
78
 
# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 76

def autocorrect(node)
  EmptyLineCorrector.correct(node)
end

#on_def(node) ⇒ Object Also known as: on_defs 



66
67
68
 
# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 66

def on_def(node)
  check_body(node.body)
end

#on_kwbegin(node) ⇒ Object 



71
72
73
74
 
# File 'lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb', line 71

def on_kwbegin(node)
  body, = *node
  check_body(body)
end