class RuboCop::Cop::Layout::EmptyLinesAroundAccessModifier

Access modifiers should be surrounded by blank lines.

@example

# bad
class Foo
  def bar; end
  private
  def baz; end
end

# good
class Foo
  def bar; end

  private

  def baz; end
end

Constants

MSG_AFTER
MSG_BEFORE_AND_AFTER

Public Instance Methods

autocorrect(node) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 37
def autocorrect(node)
  lambda do |corrector|
    send_line = node.loc.line
    previous_line = processed_source[send_line - 2]
    next_line = processed_source[send_line]
    line = range_by_whole_lines(node.source_range)

    unless previous_line_empty?(previous_line)
      corrector.insert_before(line, "\n")
    end

    unless next_line_empty?(next_line)
      corrector.insert_after(line, "\n")
    end
  end
end
on_send(node) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 29
def on_send(node)
  return unless node.access_modifier?

  return if empty_lines_around?(node)

  add_offense(node)
end

Private Instance Methods

block_start?(line) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 85
def block_start?(line)
  line.match(/ (do|{)( \|.*?\|)?\s?$/)
end
body_end?(line) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 89
def body_end?(line)
  line =~ /^\s*end/
end
class_def?(line) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 81
def class_def?(line)
  line =~ /^\s*(class|module)/
end
empty_lines_around?(node) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 72
def empty_lines_around?(node)
  send_line = node.loc.line
  previous_line = previous_line_ignoring_comments(processed_source,
                                                  send_line)
  next_line = processed_source[send_line]

  previous_line_empty?(previous_line) && next_line_empty?(next_line)
end
message(node) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 93
def message(node)
  previous_line = processed_source[node.loc.line - 2]

  if block_start?(previous_line) ||
     class_def?(previous_line)
    format(MSG_AFTER, node.loc.selector.source)
  else
    format(MSG_BEFORE_AND_AFTER, node.loc.selector.source)
  end
end
next_line_empty?(next_line) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 68
def next_line_empty?(next_line)
  body_end?(next_line) || next_line.blank?
end
previous_line_empty?(previous_line) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 62
def previous_line_empty?(previous_line)
  block_start?(previous_line) ||
    class_def?(previous_line) ||
    previous_line.blank?
end
previous_line_ignoring_comments(processed_source, send_line) click to toggle source
# File lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb, line 56
def previous_line_ignoring_comments(processed_source, send_line)
  processed_source[0..send_line - 2].reverse.find do |line|
    !comment_line?(line)
  end
end