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.'.freeze
LINE_OFFSET = 
2

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



44
45
46
 
# File 'lib/rubocop/cop/style/empty_lines.rb', line 44

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

#investigate(processed_source) ⇒ Object 



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

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

  lines = Set.new
  processed_source.tokens.each do |token|
    lines << token.pos.line
  end

  prev_line = 1

  lines.sort.each do |cur_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