Class: RuboCop::Cop::Layout::EmptyLineBetweenDefs

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

Overview

This cop checks whether method definitions are separated by one empty line.

‘NumberOfEmptyLines` can be and integer (e.g. 1 by default) or an array (e.g. [1, 2]) to specificy a minimum and a maximum of empty lines.

‘AllowAdjacentOneLineDefs` can be used to configure is adjacent one line methods definitions are an offense

Examples:


# bad
def a
end
def b
end

# good
def a
end

def b
end

Constant Summary collapse

MSG = 
'Use empty lines between method definitions.'.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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, 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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



35
36
37
 
# File 'lib/rubocop/cop/layout/empty_line_between_defs.rb', line 35

def self.autocorrect_incompatible_with
  [Layout::EmptyLines]
end

Instance Method Details

#autocorrect(node) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/rubocop/cop/layout/empty_line_between_defs.rb', line 60

def autocorrect(node)
  prev_def = prev_node(node)

  # finds position of first newline
  end_pos = prev_def.loc.end.end_pos
  source_buffer = prev_def.loc.end.source_buffer
  newline_pos = source_buffer.source.index("\n", end_pos)

  count = blank_lines_count_between(prev_def, node)

  if count > maximum_empty_lines
    autocorrect_remove_lines(newline_pos, count)
  else
    autocorrect_insert_lines(newline_pos, count)
  end
end

#check_defs(nodes) ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/rubocop/cop/layout/empty_line_between_defs.rb', line 51

def check_defs(nodes)
  return if blank_lines_between?(*nodes)
  return if multiple_blank_lines_groups?(*nodes)
  return if nodes.all?(&:single_line?) &&
            cop_config['AllowAdjacentOneLineDefs']

  add_offense(nodes.last, location: :keyword)
end

#on_begin(node) ⇒ Object

We operate on ‘begin` nodes, instead of using `OnMethodDef`, so that we can walk over pairs of consecutive nodes and efficiently access a node’s predecessor; #prev_node ends up doing a linear scan over siblings, so we don’t want to call it on each def.



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

def on_begin(node)
  node.children.each_cons(2) do |prev, n|
    nodes = [prev, n]
    check_defs(nodes) if nodes.all?(&method(:def_node?))
  end
end