Class: Rubocop::Cop::Style::TrailingBlankLines

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

Overview

This cop looks for trailing blank lines in the source code.

Constant Summary collapse

MSG = 
'%d trailing blank lines detected.'

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 



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rubocop/cop/style/trailing_blank_lines.rb', line 31

def autocorrect(range)
  # Bail out if there's also trailing whitespace, because
  # auto-correction in the two cops would result in clobbering.
  if range.source =~ / / &&
      config.for_cop('TrailingWhitespace')['Enabled']
    return
  end

  @corrections << ->(corrector) { corrector.remove(range) }
end

#investigate(processed_source) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/rubocop/cop/style/trailing_blank_lines.rb', line 10

def investigate(processed_source)
  blank_lines = 0

  processed_source.lines.reverse_each do |line|
    if line.blank?
      blank_lines += 1
    else
      break
    end
  end

  if blank_lines > 0
    range_size =
      processed_source.raw_lines.to_a[-blank_lines..-1].join.length
    range = source_range(processed_source.buffer,
                         processed_source[0...-blank_lines],
                         0, range_size)
    add_offense(range, range, format(MSG, blank_lines))
  end
end