Class: Shirobai::Cop::Style::Semicolon

Inherits:
RuboCop::Cop::Base
  • Object
show all
Extended by:
RuboCop::Cop::AutoCorrector
Includes:
RuboCop::Cop::RangeHelp, BundleEligible
Defined in:
lib/shirobai/cop/style/semicolon.rb

Overview

Drop-in Rust reimplementation of Style/Semicolon.

Stock has two detection paths. Path (a) (on_new_investigation) groups processed_source.tokens by line and flags a semicolon in six positional token-index patterns. shirobai builds no parser token stream, so path (a) runs in Rust: a masked byte scan (the same opaque regions as the punctuation cops) plus a few AST-collected opener positions reconstruct those index facts. Rust returns one [offset, last_token] pair per flagged ;.

Path (b) (on_begin, the token scan for expression separators) stays here, ported verbatim from stock: it walks processed_source.tokens for real ; tokens on lines that carry more than one expression, so a ; inside a string/regexp literal is skipped and it matches stock byte for byte. The AllowAsExpressionSeparator option only turns path (b) off, exactly as in stock.

Autocorrect is stock's, run at correction time on the real parser AST / tokens (only reached with -a): path (a)'s last-token pattern may wrap an endless range or a hash value omission in parentheses; path (b) replaces the ; with a newline unless a heredoc opened earlier on the line. Because both paths call add_offense in stock's order (path (a) first, then path (b) during the walk), RuboCop's own offense dedup and corrector-conflict resolution reproduce stock's result on the lines both paths touch.

Constant Summary collapse

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

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



45
46
47
 
# File 'lib/shirobai/cop/style/semicolon.rb', line 45

def self.autocorrect_incompatible_with
  [RuboCop::Cop::Style::SingleLineMethods]
end

.badge ⇒ Object 



39
 
# File 'lib/shirobai/cop/style/semicolon.rb', line 39

def self.badge = RuboCop::Cop::Badge.parse("Style/Semicolon")

.bundle_args(_config) ⇒ Object

Config-less on the bundle side: path (a) needs no config and path (b) reads AllowAsExpressionSeparator directly from cop_config.



43
 
# File 'lib/shirobai/cop/style/semicolon.rb', line 43

def self.bundle_args(_config) = []

.cop_name ⇒ Object 



38
 
# File 'lib/shirobai/cop/style/semicolon.rb', line 38

def self.cop_name = "Style/Semicolon"

Instance Method Details

#on_begin(node) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/shirobai/cop/style/semicolon.rb', line 55

def on_begin(node)
  return if cop_config["AllowAsExpressionSeparator"]
  return unless node.source.include?(";")

  exprs = node.children

  return if exprs.size < 2

  expressions_per_line(exprs).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

    find_semicolon_positions(line) { |pos| register_semicolon(line, pos, true) }
  end
end

#on_new_investigation ⇒ Object 



49
50
51
52
53
 
# File 'lib/shirobai/cop/style/semicolon.rb', line 49

def on_new_investigation
  return if processed_source.blank? || !processed_source.raw_source.include?(";")

  check_for_line_terminator_or_opener
end