class RuboCop::Cop::Layout::EmptyLineBetweenDefs

class ErrorC < BaseError; end
class ErrorB < BaseError; end
class ErrorA < BaseError; end
# good
@example AllowAdjacentOneLineDefs: true
end
def b
end
module B
end
module A
# good
@example
end
def b
end
module B
end
module A
# bad
# checks for empty lines between module definitions.
@example EmptyLineBetweenModuleDefs: true (default)
end
def b
end
class B
end
class A
# good
@example
end
def b
end
class B
end
class A
# bad
# checks for empty lines between class definitions.
@example EmptyLineBetweenClassDefs: true (default)
end
def b
end
def a
# good
@example
end
def b
end
def a
# bad
# checks for empty lines between method definitions.
@example EmptyLineBetweenMethodDefs: true (default)
one-line definitions are considered an offense.
‘AllowAdjacentOneLineDefs` configures whether adjacent
number of empty lines permitted.
an array (e.g. [1, 2]) to specify a minimum and maximum
`NumberOfEmptyLines` can be an integer (default is 1) or
separated by one or more empty lines.
This cop checks whether class/module/method definitions are

def self.autocorrect_incompatible_with

def self.autocorrect_incompatible_with
  [Layout::EmptyLines]
end

def allowance_range?

def allowance_range?
  minimum_empty_lines != maximum_empty_lines
end

def autocorrect(corrector, prev_def, node, count)

def autocorrect(corrector, prev_def, node, count)
  # finds position of first newline
  end_pos = end_loc(prev_def).end_pos
  source_buffer = end_loc(prev_def).source_buffer
  newline_pos = source_buffer.source.index("\n", end_pos)
  # Handle the case when multiple one-liners are on the same line.
  newline_pos = end_pos + 1 if newline_pos > node.source_range.begin_pos
  if count > maximum_empty_lines
    autocorrect_remove_lines(corrector, newline_pos, count)
  else
    autocorrect_insert_lines(corrector, newline_pos, count)
  end
end

def autocorrect_insert_lines(corrector, newline_pos, count)

def autocorrect_insert_lines(corrector, newline_pos, count)
  difference = minimum_empty_lines - count
  where_to_insert = range_between(newline_pos, newline_pos + 1)
  corrector.insert_after(where_to_insert, "\n" * difference)
end

def autocorrect_remove_lines(corrector, newline_pos, count)

def autocorrect_remove_lines(corrector, newline_pos, count)
  difference = count - maximum_empty_lines
  range_to_remove = range_between(newline_pos, newline_pos + difference)
  corrector.remove(range_to_remove)
end

def blank_lines_count_between(first_def_node, second_def_node)

def blank_lines_count_between(first_def_node, second_def_node)
  lines_between_defs(first_def_node, second_def_node).count(&:blank?)
end

def candidate?(node)

def candidate?(node)
  return unless node
  method_candidate?(node) || class_candidate?(node) || module_candidate?(node)
end

def check_defs(nodes)

def check_defs(nodes)
  count = blank_lines_count_between(*nodes)
  return if line_count_allowed?(count)
  return if multiple_blank_lines_groups?(*nodes)
  return if nodes.all?(&:single_line?) &&
            cop_config['AllowAdjacentOneLineDefs']
  correction_node = nodes.last
  location = correction_node.loc.keyword.join(correction_node.loc.name)
  add_offense(location, message: message(correction_node, count: count)) do |corrector|
    autocorrect(corrector, *nodes, count)
  end
end

def class_candidate?(node)

def class_candidate?(node)
  cop_config['EmptyLineBetweenClassDefs'] && node.class_type?
end

def def_end(node)

def def_end(node)
  end_loc(node).line
end

def def_start(node)

def def_start(node)
  node.loc.keyword.line
end

def end_loc(node)

def end_loc(node)
  if (node.def_type? || node.defs_type?) && node.endless?
    node.loc.expression.end
  else
    node.loc.end
  end
end

def expected_lines

def expected_lines
  if allowance_range?
    "#{minimum_empty_lines..maximum_empty_lines} empty lines"
  else
    lines = maximum_empty_lines == 1 ? 'line' : 'lines'
    "#{maximum_empty_lines} empty #{lines}"
  end
end

def line_count_allowed?(count)

def line_count_allowed?(count)
  (minimum_empty_lines..maximum_empty_lines).cover?(count)
end

def lines_between_defs(first_def_node, second_def_node)

def lines_between_defs(first_def_node, second_def_node)
  begin_line_num = def_end(first_def_node)
  end_line_num = def_start(second_def_node) - 2
  return [] if end_line_num.negative?
  processed_source.lines[begin_line_num..end_line_num]
end

def maximum_empty_lines

def maximum_empty_lines
  Array(cop_config['NumberOfEmptyLines']).last
end

def message(node, count: nil)

def message(node, count: nil)
  type = node_type(node)
  format(MSG,
         type: type,
         expected: expected_lines,
         actual: count)
end

def method_candidate?(node)

def method_candidate?(node)
  cop_config['EmptyLineBetweenMethodDefs'] && (node.def_type? || node.defs_type?)
end

def minimum_empty_lines

def minimum_empty_lines
  Array(cop_config['NumberOfEmptyLines']).first
end

def module_candidate?(node)

def module_candidate?(node)
  cop_config['EmptyLineBetweenModuleDefs'] && node.module_type?
end

def multiple_blank_lines_groups?(first_def_node, second_def_node)

def multiple_blank_lines_groups?(first_def_node, second_def_node)
  lines = lines_between_defs(first_def_node, second_def_node)
  blank_start = lines.each_index.select { |i| lines[i].blank? }.max
  non_blank_end = lines.each_index.reject { |i| lines[i].blank? }.min
  return false if blank_start.nil? || non_blank_end.nil?
  blank_start > non_blank_end
end

def node_type(node)

def node_type(node)
  case node.type
  when :def, :defs
    :method
  else
    node.type
  end
end

def on_begin(node)

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

def on_begin(node)
  node.children.each_cons(2) do |prev, n|
    nodes = [prev, n]
    check_defs(nodes) if nodes.all? { |def_candidate| candidate?(def_candidate) }
  end
end

Modules

Classes