class RuboCop::Cop::Layout::EmptyLineAfterMagicComment

Checks for a newline after the final magic comment.

@example

# good
# frozen_string_literal: true

# Some documentation for Person
class Person
  # Some code
end

# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

Constants

MSG

Public Instance Methods

autocorrect(token) click to toggle source
# File lib/rubocop/cop/layout/empty_line_after_magic_comment.rb, line 39
def autocorrect(token)
  lambda do |corrector|
    corrector.insert_before(token, "\n")
  end
end
investigate(source) click to toggle source
# File lib/rubocop/cop/layout/empty_line_after_magic_comment.rb, line 28
def investigate(source)
  return unless source.ast &&
                (last_magic_comment = last_magic_comment(source))
  return if source[last_magic_comment.loc.line].strip.empty?

  offending_range =
    source_range(source.buffer, last_magic_comment.loc.line + 1, 0)

  add_offense(offending_range, location: offending_range)
end

Private Instance Methods

last_magic_comment(source) click to toggle source

Find the last magic comment in the source file.

Take all comments that precede the first line of code, select the magic comments, and return the last magic comment in the file.

@return [Parser::Source::Comment] if magic comments exist before code @return [nil] otherwise

# File lib/rubocop/cop/layout/empty_line_after_magic_comment.rb, line 54
def last_magic_comment(source)
  source
    .comments
    .take_while { |comment| comment.loc.line < source.ast.loc.line }
    .select     { |comment| MagicComment.parse(comment.text).any?  }
    .last
end