Class: RuboCop::Cop::Style::Semicolon

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

Overview

This cop checks for multiple expressions placed on the same line. It also checks for lines terminated with a semicolon.

This cop has `AllowAsExpressionSeparator` configuration option. It allows `;` to separate several expressions on the same line.

Examples:

# bad
foo = 1; bar = 2;
baz = 3;

# good
foo = 1
bar = 2
baz = 3

AllowAsExpressionSeparator: false (default)

# bad
foo = 1; bar = 2

AllowAsExpressionSeparator: true

# good
foo = 1; bar = 2

Constant Summary collapse

MSG =
'Do not use semicolons to terminate expressions.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object


69
70
71
72
73
# File 'lib/rubocop/cop/style/semicolon.rb', line 69

def autocorrect(range)
  return unless range

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

#investigate(processed_source) ⇒ Object


34
35
36
37
38
39
40
# File 'lib/rubocop/cop/style/semicolon.rb', line 34

def investigate(processed_source)
  return if processed_source.blank?

  @processed_source = processed_source

  check_for_line_terminator_or_opener
end

#on_begin(node) ⇒ Object


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/rubocop/cop/style/semicolon.rb', line 42

def on_begin(node)
  return if cop_config['AllowAsExpressionSeparator']

  exprs = node.children

  return if exprs.size < 2

  # create a map matching lines to the number of expressions on them
  exprs_lines = exprs.map(&:first_line)
  lines = exprs_lines.group_by(&:itself)

  lines.each do |line, expr_on_line|
    # Every line with more than one expression on it is a
    # potential offense
    next unless expr_on_line.size > 1

    # TODO: Find the correct position of the semicolon. We don't know
    # if the first semicolon on the line is a separator of
    # expressions. It's just a guess.
    column = @processed_source[line - 1].index(';')

    next unless column

    convention_on(line, column, false)
  end
end