Class: Rubocop::Cop::Style::FinalNewline

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/final_newline.rb

Overview

This cop enforces the presence of a final newline in each source file.

Constant Summary collapse

MSG = 
'Source files should end with a newline (\n).'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, lint?, #message, non_rails, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



21
22
23
24
25
 
# File 'lib/rubocop/cop/style/final_newline.rb', line 21

def autocorrect(range)
  @corrections << lambda do |corrector|
    corrector.insert_after(range, "\n")
  end
end

#investigate(processed_source) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
 
# File 'lib/rubocop/cop/style/final_newline.rb', line 10

def investigate(processed_source)
  final_line = processed_source.raw_lines.to_a.last

  unless final_line.nil? || final_line.end_with?("\n")
    range = source_range(processed_source.buffer,
                         processed_source[0...-1],
                         final_line.length - 1, 1)
    add_offense(range, range)
  end
end