Class: RuboCop::Cop::Layout::EmptyLineAfterMagicComment

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

Overview

Checks for a newline after the final magic comment.

Examples:

# 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

Constant Summary collapse

MSG = 
'Add an empty line after magic comments.'.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, 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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(token) ⇒ Object 



39
40
41
42
43
 
# 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) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
 
# 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