simplecov 0.22.0 → 1.3.0

data/lib/simplecov/source_file/branch.rb

@@ -2,53 +2,33 @@
 
 module SimpleCov
   class SourceFile
-    #
-    # Representing single branch that has been detected in coverage report.
-    # Give us support methods that handle needed calculations.
     class Branch
       attr_reader :start_line, :end_line, :coverage, :type
 
-      # rubocop:disable Metrics/ParameterLists
       def initialize(start_line:, end_line:, coverage:, inline:, type:)
         @start_line = start_line
-        @end_line   = end_line
-        @coverage   = coverage
-        @inline     = inline
-        @type       = type
-        @skipped    = false
+        @end_line = end_line
+        @coverage = coverage
+        @inline = inline
+        @type = type
+        @skipped = false
       end
-      # rubocop:enable Metrics/ParameterLists
 
       def inline?
         @inline
       end
 
-      #
-      # Return true if there is relevant count defined > 0
-      #
-      # @return [Boolean]
-      #
       def covered?
         !skipped? && coverage.positive?
       end
 
-      #
-      # Check if branche missed or not
-      #
-      # @return [Boolean]
-      #
       def missed?
         !skipped? && coverage.zero?
       end
 
-      # The line on which we want to report the coverage
-      #
-      # Usually we choose the line above the start of the branch (so that it shows up
-      # at if/else) because that
-      # * highlights the condition
-      # * makes it distinguishable if the first line of the branch is an inline branch
-      #   (see the nested_branches fixture)
-      #
+      # Usually the line above the start of the branch, so that it shows up at the
+      # if/else. That highlights the condition, and makes it distinguishable when
+      # the first line of the branch is itself an inline branch.
       def report_line
         if inline?
           start_line
@@ -57,12 +37,10 @@ module SimpleCov
         end
       end
 
-      # Flags the branch as skipped
       def skipped!
         @skipped = true
       end
 
-      # Returns true if the branch was marked skipped by virtue of nocov comments.
       def skipped?
         @skipped
       end
@@ -71,11 +49,6 @@ module SimpleCov
         start_line <= line_range.end && end_line >= line_range.begin
       end
 
-      #
-      # Return array with coverage count and badge
-      #
-      # @return [Array]
-      #
       def report
         [type, coverage]
       end

data/lib/simplecov/source_file/branch_builder.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  class SourceFile
+    # Builds the `SourceFile::Branch` objects for a source file from the raw
+    # branch data Ruby's Coverage library reports, applying the
+    # `ignore_branches` filters and marking branches inside disabled chunks as
+    # skipped.
+    class BranchBuilder
+      def initialize(source_file)
+        @source_file = source_file
+      end
+
+      def call
+        coverage_branch_data = @source_file.coverage_data["branches"] || {}
+        branches = coverage_branch_data.flat_map do |condition, coverage_branches|
+          next [] if eval_generated_condition_to_ignore?(condition)
+
+          build_branches_from(condition, coverage_branches)
+        end
+
+        process_skipped(branches)
+      end
+
+      private
+
+      # Coverage attributes an eval'd branch to the caller's `__FILE__` /
+      # `__LINE__`, so a Rails `delegate :foo, to: :bar` call surfaces inside the
+      # source file as if there were branches at the `delegate` line. Prism never
+      # sees those branches in the static source, so a condition whose start_line
+      # isn't in the real-source branch set must be eval-generated (#1046).
+      def eval_generated_condition_to_ignore?(condition)
+        return false unless SimpleCov.ignored_branch?(:eval_generated)
+
+        positions = @source_file.real_source_positions
+        # simplecov:disable branch — nil branch fires only when Prism is unavailable
+        return false unless positions
+
+        # simplecov:enable branch
+
+        _type, _id, start_line, * = RubyDataParser.call(condition)
+        !positions.fetch(:branches).include?(start_line)
+      end
+
+      def build_branches_from(condition, branches)
+        _condition_type, _condition_id, *condition_range = RubyDataParser.call(condition)
+
+        branches.filter_map do |branch_data, hit_count|
+          build_branch(RubyDataParser.call(branch_data), hit_count, condition_range)
+        end
+      end
+
+      # The coverage data hands in `[:then, 4, 6, 6, 6, 10]`, which is
+      # [type, id, start_line, start_col, end_line, end_col].
+      def build_branch(branch_data, hit_count, condition_range)
+        type, _id, start_line, start_col, end_line, end_col = branch_data
+        return nil if implicit_else_to_ignore?(type, [start_line, start_col, end_line, end_col], condition_range)
+
+        Branch.new(
+          start_line: start_line,
+          end_line: end_line,
+          coverage: hit_count,
+          inline: start_line.eql?(condition_range.first),
+          type: type
+        )
+      end
+
+      # Ruby's Coverage reports a synthetic `:else` for constructs with no literal
+      # `else` keyword. The signal is structural: a synthetic else reuses its
+      # parent condition's full source range, while an explicit `else` arm carries
+      # a narrower one. Comparing the full range rather than just `start_line` is
+      # what distinguishes a ternary's explicit else on the condition's own line
+      # from a postfix `return if cond` (#1033).
+      def implicit_else_to_ignore?(type, branch_range, condition_range)
+        return false unless type.equal?(:else)
+        return false unless SimpleCov.ignored_branch?(:implicit_else)
+
+        branch_range.eql?(condition_range)
+      end
+
+      # A non-inline branch's source range starts on its arm body, but
+      # `report_line` is the condition line above it, which is where the user sees
+      # the branch and would naturally place an inline disable directive. Honour
+      # both.
+      def process_skipped(branches)
+        chunks = @source_file.skip_chunks_for(:branch)
+
+        # `# simplecov:disable branch` directive. Honour both.
+        branches.each do |branch|
+          branch.skipped! if chunks.any? { |chunk| branch.overlaps_with?(chunk) || chunk.include?(branch.report_line) }
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/source_file/builder_context.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  class SourceFile
+    module BuilderContext
+      def skip_chunks_for(criterion)
+        (@skip_chunks ||= SkipChunks.new(filename, src)).chunks_for(criterion)
+      end
+
+      # Memoized set of real source positions extracted via Prism. Nil when Prism is
+      # unavailable or parsing fails, signaling callers to keep every Coverage entry
+      # rather than risk false drops. The `defined?` guard preserves a nil
+      # memoization across calls.
+      #
+      # Nil for a template too, without parsing: every entry a template reports
+      # is eval-generated by construction, so the filter has nothing to
+      # distinguish there, and a template whose text happens to parse as Ruby
+      # (a Haml `#id` tag reads as a comment) would otherwise lose its real
+      # branches to a confident wrong parse.
+      def real_source_positions
+        return @real_source_positions if instance_variable_defined?(:@real_source_positions)
+        return @real_source_positions = nil if Directive::Template.template?(filename)
+
+        @real_source_positions = StaticCoverageExtractor.real_source_positions(src.join)
+      end
+    end
+  end
+end

data/lib/simplecov/source_file/line.rb

@@ -2,70 +2,55 @@
 
 module SimpleCov
   class SourceFile
-    # Representation of a single line in a source file including
-    # this specific line's source code, line_number and code coverage,
-    # with the coverage being either nil (coverage not applicable, e.g. comment
-    # line), 0 (line not covered) or >1 (the amount of times the line was
-    # executed)
     class Line
-      # The source code for this line. Aliased as :source
-      attr_reader :src
-      # The line number in the source file. Aliased as :line, :number
-      attr_reader :line_number
-      # The coverage data for this line: either nil (never), 0 (missed) or >=1 (times covered)
-      attr_reader :coverage
-      # Whether this line was skipped
-      attr_reader :skipped
+      attr_reader :src, :line_number, :coverage, :skipped
 
-      # Lets grab some fancy aliases, shall we?
-      alias source src
-      alias line line_number
-      alias number line_number
+      alias_method :source, :src
+      alias_method :line, :line_number
+      alias_method :number, :line_number
 
       def initialize(src, line_number, coverage)
         raise ArgumentError, "Only String accepted for source" unless src.is_a?(String)
         raise ArgumentError, "Only Integer accepted for line_number" unless line_number.is_a?(Integer)
-        raise ArgumentError, "Only Integer and nil accepted for coverage" unless coverage.is_a?(Integer) || coverage.nil?
+        unless coverage.is_a?(Integer) || coverage.nil?
+          raise ArgumentError, "Only Integer and nil accepted for coverage"
+        end
 
-        @src         = src
+        @src = src
         @line_number = line_number
-        @coverage    = coverage
-        @skipped     = false
+        @coverage = coverage
+        @skipped = false
       end
 
-      # Returns true if this is a line that should have been covered, but was not
+      # Asking `covered?` rather than reading the count a second time keeps the two
+      # answers from ever disagreeing, and `never?` ahead of it is what keeps a
+      # line with no coverage at all out of the missed column.
       def missed?
-        !never? && !skipped? && coverage.zero?
+        !never? && !skipped? && !covered?
       end
 
-      # Returns true if this is a line that has been covered
       def covered?
-        !never? && !skipped? && coverage.positive?
+        !skipped? && coverage.to_i.positive?
       end
 
-      # Returns true if this line is not relevant for coverage
       def never?
         !skipped? && coverage.nil?
       end
 
-      # Flags this line as skipped
       def skipped!
         @skipped = true
       end
 
-      # Returns true if this line was skipped, false otherwise. Lines are skipped if they are wrapped with
-      # # :nocov: comment lines.
       def skipped?
         skipped
       end
 
-      # The status of this line - either covered, missed, skipped or never. Useful i.e. for direct use
-      # as a css class in report generation
       def status
         return "skipped" if skipped?
         return "never" if never?
         return "missed" if missed?
-        return "covered" if covered?
+
+        "covered"
       end
     end
   end

data/lib/simplecov/source_file/line_builder.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  class SourceFile
+    # Builds the `SourceFile::Line` objects for a source file from the raw
+    # line-coverage array, applying the disabled block ranges via `skipped!`.
+    class LineBuilder
+      def initialize(source_file)
+        @source_file = source_file
+      end
+
+      def call
+        lines = build_lines
+        mark_skipped(lines, @source_file.skip_chunks_for(:line))
+        lines
+      end
+
+      private
+
+      # When `:line` coverage is disabled the Coverage module emits no "lines" data,
+      # so every position looks up nil. The source rows are still useful for the
+      # HTML report's source view even without per-line hits.
+      def build_lines
+        line_coverage = @source_file.coverage_data["lines"] || []
+        @source_file.src.map.with_index(1) do |src, i|
+          Line.new(src, i, line_coverage.at(i - 1))
+        end
+      end
+
+      # The lines array is 0-based while the chunks' line numbers are 1-based, so
+      # each range is shifted down by one to slice into it.
+      def mark_skipped(lines, chunks)
+        chunks.each { |chunk| lines[(chunk.begin - 1)..(chunk.end - 1)].each(&:skipped!) }
+      end
+    end
+  end
+end

data/lib/simplecov/source_file/method.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  class SourceFile
+    class Method
+      attr_reader :source_file, :coverage, :class_name, :method_name,
+        :start_line, :start_col, :end_line, :end_col
+
+      def initialize(source_file, info, coverage)
+        @source_file = source_file
+        @class_name, @method_name, @start_line, @start_col, @end_line, @end_col = info
+        @coverage = coverage
+      end
+
+      def covered?
+        !skipped? && coverage.positive?
+      end
+
+      # Criterion-level skips (nocov chunks, `# simplecov:disable` /
+      # `# simplecov:disable method` regions) arrive via `skipped!` from
+      # MethodBuilder. Deliberately NOT derived from the lines' skip
+      # state: a line-only directive around a def must not remove the
+      # method from method totals. Without line info there is nothing to
+      # report against, so such a method stays skipped.
+      def skipped?
+        return @skipped if instance_variable_defined?(:@skipped)
+
+        @skipped = lines.empty?
+      end
+
+      def skipped!
+        @skipped = true
+      end
+
+      def missed?
+        !skipped? && coverage.zero?
+      end
+
+      def lines
+        @lines ||= (start_line && end_line) ? source_file.lines[(start_line - 1)..(end_line - 1)] || [] : []
+      end
+
+      def overlaps_with?(line_range)
+        return false unless start_line && end_line
+
+        start_line <= line_range.end && end_line >= line_range.begin
+      end
+
+      def to_s
+        "#{class_name}##{method_name}"
+      end
+    end
+  end
+end

data/lib/simplecov/source_file/method_builder.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  class SourceFile
+    # `# simplecov:disable` / `# :nocov:` chunks as skipped.
+    class MethodBuilder
+      def initialize(source_file)
+        @source_file = source_file
+      end
+
+      def call
+        none = {} #: Hash[untyped, Integer]
+        raw_methods = @source_file.coverage_data.fetch("methods", none)
+        methods = raw_methods.filter_map do |info, hit_count|
+          info = RubyDataParser.call(info)
+          next if eval_generated_to_ignore?(info)
+
+          Method.new(@source_file, info, hit_count)
+        end
+
+        process_skipped(methods)
+      end
+
+      private
+
+      # Coverage reports an eval'd `def` at the eval caller's line and name, so a
+      # method whose `(name, start_line)` is absent from the real-source `def` set
+      # is eval-generated (#1046).
+      def eval_generated_to_ignore?(info)
+        return false unless SimpleCov.ignored_method?(:eval_generated)
+
+        positions = @source_file.real_source_positions
+        # simplecov:disable branch — nil branch fires only when Prism is unavailable
+        return false unless positions
+
+        # simplecov:enable branch
+
+        _class_name, name, start_line, * = info
+        !positions.fetch(:methods).include?([name, start_line])
+      end
+
+      def process_skipped(methods)
+        chunks = @source_file.skip_chunks_for(:method)
+
+        methods.each do |method|
+          method.skipped! if chunks.any? { |chunk| method.overlaps_with?(chunk) }
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/source_file/ruby_data_parser.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "ripper"
+
+module SimpleCov
+  class SourceFile
+    # `Coverage.result` reports condition and method keys as Ruby arrays. When
+    # the resultset is round-tripped through JSON those array keys become their
+    # stringified inspect form, so this parser walks the literal back into a
+    # real Array without using `eval` (#801). The grammar covers symbols,
+    # strings, integers, unary minus, and constant paths: every shape Coverage
+    # ever emits.
+    module RubyDataParser
+      extend self
+
+      # String parses are memoized: `Combine::BranchesCombiner` and
+      # `Combine::MethodsCombiner` derive a merge identity from every key of
+      # both sides on every pairwise merge, so collating N resultsets parses
+      # each key string N-1 times, and Ripper dominates the wall time of a
+      # large collate. The set of unique keys is bounded by the project's
+      # branch and method count, so a permanent cache stays small.
+      #
+      # Cached arrays are frozen element-wise, String class names included:
+      # every caller destructures without mutating, and sharing one array
+      # across callers must stay that way. The cache key needs no such care,
+      # since `Hash#[]=` dups and freezes String keys on its own.
+      def call(structure)
+        return structure if structure.is_a?(Array)
+
+        parse_cache[structure] ||= parse_array_string(structure).each(&:freeze).freeze
+      end
+
+      def parse_cache
+        @parse_cache ||= {} #: Hash[String, untyped]
+      end
+
+      # Parses a string like '[:if, 0, 3, 4, 3, 21]' or
+      # '["ClassName", :method1, 2, 2, 5, 5]' back into a Ruby array.
+      def parse_array_string(str)
+        # Plain Ripper first: pre-quoting `#<...>` inspect segments would corrupt
+        # `"#<Class:Foo>"` strings that are valid Ruby literals, exactly the
+        # shape simplecov-on-simplecov method-coverage keys take.
+        sexp = Ripper.sexp(str) || Ripper.sexp(quote_inspected_class_segments(str))
+        # Ripper wraps what it parsed in a `:program` node holding the
+        # statements, and this input is supposed to be one array literal and
+        # nothing else. Both passes answer nil for input Ruby can't parse at
+        # all, so there may be no statement to unwrap.
+        _program, statements = sexp
+        first_statement, *extra = statements
+        array_node = Array(first_statement)
+        unless extra.empty? && array_node.first.equal?(:array)
+          raise ArgumentError, "expected array literal: #{str.inspect}"
+        end
+
+        Array(array_node.fetch(1)).map { |element| parse_element(element) }
+      end
+
+      # Each `when` already knows the node's shape, so the elements read straight
+      # out of it rather than through a second dispatch. A symbol's text sits
+      # where a string's does, one node deeper.
+      def parse_element(node)
+        case node.fetch(0)
+        when :@int then Integer(node.fetch(1))
+        when :unary then -Integer(node.fetch(2).fetch(1)) # `-2`
+        when :symbol_literal, :dyna_symbol then literal_text(node).to_sym
+        when :string_literal then literal_text(node)
+        when :var_ref then node.fetch(1).fetch(1) # `Foo`
+        when :const_path_ref then const_path(node) # `Foo::Bar`
+        else
+          raise ArgumentError, "unexpected element: #{node}"
+        end
+      end
+
+      # A constant path's namespace is an element in its own right, so
+      # `Foo::Bar::Baz` comes back together one segment at a time.
+      def const_path(node)
+        "#{parse_element(node.fetch(1))}::#{node.fetch(2).fetch(1)}"
+      end
+
+      # Ripper may emit zero, one, or many fragments under a literal depending
+      # on its form, and the escapes it leaves in the source text come back out.
+      def literal_text(node)
+        unescape_ruby(node.fetch(1)[1..].map { |fragment| fragment.fetch(1) }.join)
+      end
+
+      # Undoes the same backslash-prefix escapes the previous hand-rolled parser
+      # undid: `\X` -> `X` for any X.
+      def unescape_ruby(raw)
+        raw.gsub(/\\(.)/) { Regexp.last_match(1) }
+      end
+
+      # Method coverage keys can contain inspect-format class references like
+      # `#<Class:Foo>`, which aren't valid Ruby syntax. Wrapping them in quotes
+      # lets Ripper parse the surrounding array literal. The pattern recurses
+      # because singleton methods on instances nest one inspect segment inside
+      # another (`#<Class:#<Object:0x...>>`), and stopping at the first `>`
+      # leaves a dangling `>` that fails both Ripper passes.
+      def quote_inspected_class_segments(str)
+        str.gsub(/#<(?:[^<>]|\g<0>)+>/) { |segment| %("#{segment.gsub('"', '\\"')}") }
+      end
+    end
+  end
+end

data/lib/simplecov/source_file/skip_chunks.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module SimpleCov
+  class SourceFile
+    # The line ranges excluded from a SourceFile's coverage per criterion. Two
+    # sources contribute: the deprecated nocov block toggle, and the
+    # `SimpleCov::Directive` block directives, which can be scoped per criterion.
+    class SkipChunks
+      @nocov_warned = Set.new
+      class << self
+        attr_reader :nocov_warned
+      end
+
+      def initialize(filename, src)
+        @filename = filename
+        @src = src
+      end
+
+      # Every criterion honors the deprecated all-criteria nocov chunks plus its
+      # own per-criterion directive ranges, methods included: they carry a
+      # source range, and nocov has always meant "exclude everything here". The
+      # ranges are 1-based line numbers, so consumers subtract 1 to index into
+      # the zero-based lines array.
+      def chunks_for(criterion)
+        nocov_chunks + directive_chunks.fetch(criterion)
+      end
+
+      def nocov_chunks
+        @nocov_chunks ||= build_nocov_chunks
+      end
+
+      def directive_chunks
+        @directive_chunks ||= Directive.disabled_ranges(ruby_lines)
+      end
+
+      private
+
+      # The Ruby the file holds, which for a template means the Ruby inside its
+      # tags or script lines with its own comments turned into Ruby comments.
+      # Both kinds of marker are found there, so a toggle in a template's
+      # comment syntax gets the same treatment, and the same deprecation
+      # warning, as one in a Ruby file.
+      def ruby_lines
+        @ruby_lines ||= Directive::Template.ruby_lines(@filename, @src)
+      end
+
+      # An uneven number of nocovs is assumed to run to the end of the file. It
+      # cannot be handled inside the each_slice because JRuby behaves differently
+      # there (jruby/jruby#6048).
+      def build_nocov_chunks
+        no_cov_lines = ruby_lines.filter_map.with_index(1) do |line_src, index|
+          index if LinesClassifier.no_cov_line?(line_src)
+        end
+
+        warn_nocov_deprecation(no_cov_lines.first) if no_cov_lines.any?
+
+        no_cov_lines << @src.size if no_cov_lines.size.odd?
+
+        no_cov_lines.each_slice(2).map { |chunk_start, chunk_end| chunk_start..chunk_end }
+      end
+
+      # at the `# simplecov:disable` / `# simplecov:enable` replacement.
+      def warn_nocov_deprecation(first_line_number)
+        return unless self.class.nocov_warned.add?(@filename)
+
+        token = SimpleCov.current_nocov_token
+        warn "#{@filename}:#{first_line_number}: [DEPRECATION] `# :#{token}:` is deprecated and will be removed " \
+             "in a future release. Replace with `# simplecov:disable` / `# simplecov:enable` block comments."
+      end
+    end
+  end
+end