Class: RuboCop::Cop::Style::EmptyLineBetweenDefs

Inherits:
Cop
  • Object
show all
Includes:
OnMethodDef
Defined in:
lib/rubocop/cop/style/empty_line_between_defs.rb

Overview

This cop checks whether method definitions are separated by empty lines.

Constant Summary collapse

MSG =
'Use empty lines between method definitions.'

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from OnMethodDef

#on_def, #on_defs

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, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_method_def(node, _method_name, _args, _body) ⇒ Object


12
13
14
15
16
17
18
19
20
21
22
23
# File 'lib/rubocop/cop/style/empty_line_between_defs.rb', line 12

def on_method_def(node, _method_name, _args, _body)
  return unless node.parent && node.parent.begin_type?

  nodes = [prev_node(node), node]

  return unless nodes.all?(&method(:def_node?))
  return if blank_lines_between?(*nodes)
  return if nodes.all?(&:single_line?) &&
            cop_config['AllowAdjacentOneLineDefs']

  add_offense(node, :keyword)
end