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

Inherits:
Cop
  • Object
show all
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.

Constant Summary collapse

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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

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 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?, compatible_external_encoding_for?, directions, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, scrub_string, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_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
 
# File 'lib/rubocop/cop/style/semicolon.rb', line 11

def investigate(processed_source)
  return unless processed_source.ast
  @processed_source = processed_source

  check_for_line_terminator_or_opener
end

#on_begin(node) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/rubocop/cop/style/semicolon.rb', line 18

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 { |e| e.source_range.line }
  lines = exprs_lines.group_by { |i| i }

  # every line with more than 1 expression on it is an offense
  lines.each do |line, expr_on_line|
    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(';')
    convention_on(line, column, false)
  end
end