Class: SimpleCov::LinesClassifier

Inherits:
Object
  • Object
show all
Defined in:
lib/simplecov/lines_classifier.rb

Overview

Classifies whether lines are relevant for code coverage analysis. Comments & whitespace lines, and :nocov: token blocks, are considered not relevant.

Constant Summary collapse

RELEVANT = 
0
NOT_RELEVANT = 
nil
WHITESPACE_LINE = 
/^\s*$/.freeze
COMMENT_LINE = 
/^\s*#/.freeze
WHITESPACE_OR_COMMENT_LINE = 
Regexp.union(WHITESPACE_LINE, COMMENT_LINE)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.no_cov_line ⇒ Object 



15
16
17
 
# File 'lib/simplecov/lines_classifier.rb', line 15

def self.no_cov_line
  /^(\s*)#(\s*)(:#{SimpleCov.nocov_token}:)/o
end

.no_cov_line?(line) ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
22
23
24
 
# File 'lib/simplecov/lines_classifier.rb', line 19

def self.no_cov_line?(line)
  no_cov_line.match?(line)
rescue ArgumentError
  # E.g., line contains an invalid byte sequence in UTF-8
  false
end

.whitespace_line?(line) ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
29
30
31
 
# File 'lib/simplecov/lines_classifier.rb', line 26

def self.whitespace_line?(line)
  WHITESPACE_OR_COMMENT_LINE.match?(line)
rescue ArgumentError
  # E.g., line contains an invalid byte sequence in UTF-8
  false
end

Instance Method Details

#classify(lines) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/simplecov/lines_classifier.rb', line 33

def classify(lines)
  skipping = false

  lines.map do |line|
    if self.class.no_cov_line?(line)
      skipping = !skipping
      NOT_RELEVANT
    elsif skipping || self.class.whitespace_line?(line)
      NOT_RELEVANT
    else
      RELEVANT
    end
  end
end