Class: RuboCop::Cop::Style::TrailingBlankLines

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

Overview

This cop looks for trailing blank lines and a final newline in the source code.

Constant Summary

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 included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #parameter_name, #style, #unrecognized_style_detected

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

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

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#investigate(processed_source) ⇒ Object


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 11

def investigate(processed_source)
  sb = processed_source.buffer
  return if sb.source.empty?

  whitespace_at_end = sb.source[/\s*\Z/]
  blank_lines = whitespace_at_end.count("\n") - 1
  wanted_blank_lines = style == :final_newline ? 0 : 1

  return unless blank_lines != wanted_blank_lines

  begin_pos = sb.source.length - whitespace_at_end.length
  autocorrect_range = Parser::Source::Range.new(sb, begin_pos,
                                                sb.source.length)
  begin_pos += "\n".length unless whitespace_at_end.length == 0
  report_range = Parser::Source::Range.new(sb, begin_pos,
                                           sb.source.length)
  add_offense(autocorrect_range, report_range,
              message(wanted_blank_lines, blank_lines))
end