undercover 0.8.4 → 0.9.0

data/lib/undercover.rb

@@ -2,25 +2,33 @@
 
 $LOAD_PATH << 'lib'
 require 'json'
-require 'imagen'
 require 'rainbow'
-require 'bigdecimal'
 require 'forwardable'
 require 'simplecov'
 
 require 'undercover/lcov_parser'
+require 'undercover/coverage_index'
 require 'undercover/result'
 require 'undercover/cli'
 require 'undercover/changeset'
 require 'undercover/formatter'
+require 'undercover/json_formatter'
 require 'undercover/options'
+require 'undercover/coverage_root'
 require 'undercover/filter_set'
 require 'undercover/simplecov_result_adapter'
 require 'undercover/version'
+require 'undercover/node'
+require 'undercover/node_visitor'
+require 'undercover/erb_node'
+require 'undercover/erb_visitor'
+require 'undercover/erb_extractor'
+require 'undercover/file_loader'
 
 module Undercover
   class Report
     extend Forwardable
+    include FileLoader
 
     def_delegators :changeset, :validate
 
@@ -29,6 +37,7 @@ module Undercover
                 :coverage_adapter,
                 :results,
                 :code_dir,
+                :coverage_root,
                 :filter_set,
                 :max_warnings_limit
 
@@ -39,41 +48,28 @@ module Undercover
     # @param coverage_adapter [Undercover::SimplecovResultAdapter|Undercover::LcovParser] pre-parsed coverage adapter
     def initialize(changeset, opts, coverage_adapter)
       @coverage_adapter = coverage_adapter
-
-      @code_dir = opts.path
       @changeset = changeset
-
-      ignored_files = coverage_adapter.ignored_files || []
-      @filter_set = FilterSet.new(opts.glob_allow_filters, opts.glob_reject_filters, ignored_files)
+      @code_dir = changeset.repo_workdir
+      @coverage_root = resolve_coverage_root
+      coverage_adapter.coverage_root = @coverage_root
+      @filter_set = build_filter_set(opts)
       changeset.filter_with(filter_set)
       @max_warnings_limit = opts.max_warnings_limit
       @loaded_files = {}
       @results = {}
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable-next Metrics/MethodLength, Metrics/AbcSize
     def build
       flag_count = 0
       changeset.each_changed_line do |filepath, line_no|
         break if max_warnings_limit && flag_count >= max_warnings_limit
 
-        dist_from_line_no = lambda do |res|
-          return BigDecimal::INFINITY if line_no < res.first_line
-
-          res_lines = res.first_line..res.last_line
-          return BigDecimal::INFINITY unless res_lines.cover?(line_no)
-
-          line_no - res.first_line
-        end
-        dist_from_line_no_sorter = lambda do |res1, res2|
-          dist_from_line_no[res1] <=> dist_from_line_no[res2]
-        end
-
         load_and_parse_file(filepath)
 
         next unless loaded_files[filepath]
 
-        res = loaded_files[filepath].min(&dist_from_line_no_sorter)
+        res = result_for_line(filepath, line_no)
         if res.uncovered?(line_no) && !res.flagged?
           res.flag
           flag_count += 1
@@ -83,7 +79,6 @@ module Undercover
       end
       self
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def build_warnings
       warn('Undercover::Report#build_warnings is deprecated! ' \
@@ -99,6 +94,29 @@ module Undercover
       all_results.select(&:flagged?)
     end
 
+    # Changed files undercover would have reported on, had --include-files /
+    # --exclude-files not rejected them. Everything rejected and nothing reported usually
+    # means the globs are written against the wrong root.
+    def globbed_out_files
+      @globbed_out_files ||= changeset.file_paths.select { |path| filter_set.rejected_by_globs?(path) }
+    end
+
+    # Changed ERB templates left unchecked because the coverage report has no ERB coverage
+    # at all, meaning SimpleCov ran without enable_coverage(:eval). Checking them anyway
+    # would flag every block at 0%.
+    def erb_files_without_coverage
+      return [] if coverage_adapter.erb_coverage?
+
+      @erb_files_without_coverage ||= changeset.file_paths.select do |path|
+        path.end_with?(FileLoader::ERB_EXTENSION) && filter_set.include?(path)
+      end
+    end
+
+    # Changed ERB templates left unchecked because they could not be parsed
+    def erb_parse_failures
+      @erb_parse_failures ||= []
+    end
+
     def inspect
       "#<Undercover::Report:#{object_id} results: #{results.size}>"
     end
@@ -108,21 +126,41 @@ module Undercover
 
     attr_reader :loaded_files
 
-    # rubocop:disable Metrics/AbcSize
-    def load_and_parse_file(filepath)
-      key = filepath.gsub(/^\.\//, '')
-      return if loaded_files[key]
-
-      root_ast = Imagen::Node::Root.new.build_from_file(
-        File.join(code_dir, filepath)
-      )
-      return if root_ast.children.empty?
+    # The innermost result whose lines cover line_no: the one starting closest above it,
+    # the first one listed on a tie. Lines outside every result fall back to the first.
+    def result_for_line(filepath, line_no)
+      @line_results ||= {}
+      by_line = @line_results[filepath] ||= index_results_by_line(loaded_files[filepath])
+      by_line[line_no] || loaded_files[filepath].first
+    end
 
-      loaded_files[key] = []
-      root_ast.find_all(->(node) { !node.is_a?(Imagen::Node::Root) }).each do |imagen_node|
-        loaded_files[key] << Result.new(imagen_node, coverage_adapter, filepath)
+    def index_results_by_line(file_results)
+      by_line = {}
+      file_results.each do |res|
+        (res.first_line..res.last_line).each do |line_no|
+          current = by_line[line_no]
+          by_line[line_no] = res if current.nil? || res.first_line > current.first_line
+        end
       end
+      by_line
+    end
+
+    def build_filter_set(opts)
+      FilterSet.new(opts.glob_allow_filters, opts.glob_reject_filters, coverage_adapter.ignored_files || [],
+                    coverage_root: coverage_root)
+    end
+
+    # LCOV reports carry no SimpleCov.root, so fall back to where undercover runs, which
+    # is where SimpleCov ran for anyone invoking the CLI by hand. A wrong guess is caught
+    # by the covered-file check in CoverageRoot.
+    def resolve_coverage_root
+      simplecov_root = coverage_adapter.simplecov_root || Dir.pwd
+      CoverageRoot.derive(code_dir, simplecov_root, coverage_adapter.coverage_keys, exists: method(:repository_path?))
+    end
+
+    # On disk, or committed at HEAD for files a sparse checkout left out
+    def repository_path?(path)
+      File.exist?(File.join(code_dir, path)) || changeset.head_path?(path)
     end
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/undercover.gemspec

@@ -4,7 +4,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'undercover/version'
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = 'undercover'
   spec.version       = Undercover::VERSION
   spec.authors       = ['Jan Grodowski']
@@ -25,13 +25,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.add_dependency 'base64'
-  spec.add_dependency 'bigdecimal'
-  spec.add_dependency 'imagen', '>= 0.2.0'
+  spec.add_dependency 'benchmark'
+  spec.add_dependency 'erubi', '>= 1.13'
+  spec.add_dependency 'prism', '>= 1.8', '< 3'
   spec.add_dependency 'rainbow', '>= 2.1', '< 4.0'
   spec.add_dependency 'rugged', '>= 0.27', '< 1.10'
-  spec.add_dependency 'simplecov'
-  spec.add_dependency 'simplecov_json_formatter'
+  spec.add_dependency 'simplecov', '>= 1.0'
+  # Pinned: undercover requires its internal files by path and subclasses
+  # ResultHashFormatter, so a file reorganisation would break loading.
+  spec.add_dependency 'simplecov_json_formatter', '~> 0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Jan Grodowski
@@ -24,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bigdecimal
+  name: benchmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,19 +38,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: imagen
+  name: erubi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -97,28 +117,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov_json_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 email:
 - jgrodowski@gmail.com
 executables:
@@ -127,6 +147,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codebeatsettings"
+- ".github/FUNDING.yml"
 - ".github/dependabot.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -147,14 +168,23 @@ files:
 - docs/screenshot_warnings.png
 - docs/semaphore.yml
 - lib/undercover.rb
+- lib/undercover/ast_branch_annotator.rb
 - lib/undercover/changeset.rb
 - lib/undercover/cli.rb
+- lib/undercover/coverage_index.rb
+- lib/undercover/coverage_root.rb
+- lib/undercover/erb_extractor.rb
+- lib/undercover/erb_node.rb
+- lib/undercover/erb_visitor.rb
+- lib/undercover/file_loader.rb
 - lib/undercover/filter_set.rb
 - lib/undercover/formatter.rb
+- lib/undercover/json_formatter.rb
 - lib/undercover/lcov_parser.rb
+- lib/undercover/node.rb
+- lib/undercover/node_visitor.rb
 - lib/undercover/options.rb
 - lib/undercover/result.rb
-- lib/undercover/root_to_relative_paths.rb
 - lib/undercover/simplecov_formatter.rb
 - lib/undercover/simplecov_result_adapter.rb
 - lib/undercover/version.rb
@@ -171,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/undercover/root_to_relative_paths.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Undercover
-  module RootToRelativePaths
-    # Needed if undercover is running inside nested subdirectories (e.g. in a monorepo app), where
-    # the git paths are rooted deeper than the paths in the coverage report.
-    # If that is the case, trim the git filepath to match the local relative path, assumming undercover is
-    # running in the correct directory (has to be equal to SimpleCov.root for paths to match)
-    # @param filepath[String]
-    # @return String
-    def fix_relative_filepath(filepath)
-      return filepath unless @code_dir
-
-      code_dir_abs = File.expand_path(@code_dir)
-
-      if Pathname.new(Dir.pwd).ascend.any? { |p| p.to_s == code_dir_abs }
-        prefix_to_skip = Pathname.new(Dir.pwd).relative_path_from(code_dir_abs).to_s
-        return filepath.delete_prefix(prefix_to_skip).gsub(/\A\//, '')
-      end
-
-      filepath
-    end
-  end
-end