Class: RuboCop::Cop::Style::EmptyLines

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

Overview

This cops checks for two or more consecutive blank lines.

Constant Summary collapse

MSG =
'Extra blank line detected.'
LINE_OFFSET =
2

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_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, 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

#autocorrect(range) ⇒ Object


38
39
40
# File 'lib/rubocop/cop/style/empty_lines.rb', line 38

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

#investigate(processed_source) ⇒ Object


11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/rubocop/cop/style/empty_lines.rb', line 11

def investigate(processed_source)
  return if processed_source.tokens.empty?

  prev_line = 1

  processed_source.tokens.sort_by { |t| t.pos.line }.each do |token|
    cur_line = token.pos.line

    line_diff = cur_line - prev_line

    if line_diff > LINE_OFFSET
      # we need to be wary of comments since they
      # don't show up in the tokens
      ((prev_line + 1)...cur_line).each do |line|
        # we check if the prev and current lines are empty
        next unless processed_source[line - 2].empty? &&
                    processed_source[line - 1].empty?

        range = source_range(processed_source.buffer, line, 0)
        add_offense(range, range)
      end
    end

    prev_line = cur_line
  end
end