filter out files ignored by simplecov

Author: grodowski

lib/undercover.rb

@@ -25,7 +25,7 @@ class Report
 
     attr_reader :changeset,
                 :lcov,
-                :simplecov_resultset,
+                :coverage_adapter,
                 :results,
                 :code_dir,
                 :filter_set,
@@ -35,15 +35,16 @@ class Report
     #
     # @param changeset [Undercover::Changeset]
     # @param opts [Undercover::Options]
-    def initialize(changeset, opts)
-      if opts.simplecov_resultset
-        @simplecov_resultset = SimplecovResultAdapter.parse(File.open(opts.simplecov_resultset), opts)
-      end
-      @lcov = LcovParser.parse(File.open(opts.lcov), opts) if opts.lcov
+    # @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
-      @filter_set = FilterSet.new(opts.glob_allow_filters, opts.glob_reject_filters)
+
+      ignored_files = coverage_adapter.ignored_files || []
+      @filter_set = FilterSet.new(opts.glob_allow_filters, opts.glob_reject_filters, ignored_files)
+      changeset.filter_with(filter_set)
       @max_warnings_limit = opts.max_warnings_limit
       @loaded_files = {}
       @results = {}
@@ -106,29 +107,21 @@ def inspect
 
     attr_reader :loaded_files
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize
     def load_and_parse_file(filepath)
       key = filepath.gsub(/^\.\//, '')
       return if loaded_files[key]
-      return unless include_file?(filepath)
 
       root_ast = Imagen::Node::Root.new.build_from_file(
         File.join(code_dir, filepath)
       )
       return if root_ast.children.empty?
 
-      # lcov will be deprecated at some point and we'll be able to refactor harder
-      coverage = simplecov_resultset || lcov
-
       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, filepath)
+        loaded_files[key] << Result.new(imagen_node, coverage_adapter, filepath)
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-
-    def include_file?(filepath)
-      filter_set.include?(filepath)
-    end
+    # rubocop:enable Metrics/AbcSize
   end
 end

lib/undercover/changeset.rb

@@ -49,6 +49,10 @@ def validate(lcov_report_path)
       :stale_coverage if last_modified > File.mtime(lcov_report_path)
     end
 
+    def filter_with(filter_set)
+      @filter_set = filter_set
+    end
+
     private
 
     # Diffs `head` or `head` + `compare_base` (if exists),

lib/undercover/cli.rb

@@ -5,9 +5,6 @@
 
 module Undercover
   module CLI
-    # TODO: Report calls >parser< for each file instead of
-    # traversing the whole project at first!
-
     WARNINGS_TO_S = {
       stale_coverage: Rainbow('🚨 WARNING: Coverage data is older than your ' \
                               'latest changes and results might be incomplete. ' \
@@ -21,12 +18,20 @@ def self.run(args)
       run_report(opts)
     end
 
-    def self.run_report(opts)
+    def self.run_report(opts) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       coverage_path = opts.simplecov_resultset || opts.lcov
       return handle_missing_coverage_path(opts) if coverage_path.nil?
       return handle_missing_file(coverage_path) unless File.exist?(coverage_path)
 
-      report = Undercover::Report.new(changeset(opts), opts).build
+      simplecov_adapter = if opts.simplecov_resultset
+                            SimplecovResultAdapter.parse(File.open(opts.simplecov_resultset), opts)
+                          else
+                            # TODO: lcov will be deprecated end of 2025 and we'll be able to refactor harder
+                            LcovParser.parse(File.open(opts.lcov), opts)
+                          end
+
+      changeset_obj = changeset(opts)
+      report = Undercover::Report.new(changeset_obj, opts, simplecov_adapter).build
       handle_report_validation(report, coverage_path)
     end
 
@@ -63,8 +68,7 @@ def self.syntax_version(version)
 
     def self.changeset(opts)
       git_dir = File.join(opts.path, opts.git_dir)
-      filter_set = Undercover::FilterSet.new(opts.glob_allow_filters, opts.glob_reject_filters)
-      Undercover::Changeset.new(git_dir, opts.compare, filter_set)
+      Undercover::Changeset.new(git_dir, opts.compare)
     end
   end
 end

lib/undercover/filter_set.rb

@@ -2,15 +2,21 @@
 
 module Undercover
   class FilterSet
-    attr_reader :allow_filters, :reject_filters
+    attr_reader :allow_filters, :reject_filters, :simplecov_ignored_files
 
-    def initialize(allow_filters, reject_filters)
+    def initialize(allow_filters, reject_filters, simplecov_ignored_files)
       @allow_filters = allow_filters || []
       @reject_filters = reject_filters || []
+      @simplecov_ignored_files = simplecov_ignored_files
     end
 
     def include?(filepath)
       fnmatch = proc { |glob| File.fnmatch(glob, filepath, File::FNM_EXTGLOB) }
+
+      # Check if file was ignored by SimpleCov filters
+      return false if simplecov_ignored_files.include?(filepath)
+
+      # Apply Undercover's own filters
       allow_filters.any?(fnmatch) && reject_filters.none?(fnmatch)
     end
   end

lib/undercover/lcov_parser.rb

@@ -57,6 +57,11 @@ def skipped?(_filepath, _line_no)
       false
     end
 
+    def ignored_files
+      # supported by SimplecovResultAdapter only
+      []
+    end
+
     private
 
     # rubocop:disable Metrics/MethodLength, Style/SpecialGlobalVars, Metrics/AbcSize

lib/undercover/simplecov_formatter.rb

@@ -13,12 +13,29 @@ def export_path
   end
 end
 
+module SimpleCov
+  class << self
+    attr_accessor :filtered_files
+
+    alias filtered_uncached filtered
+
+    def filtered(files)
+      @filtered_files ||= Set.new
+      original_files = files.dup
+      filtered_uncached(files).tap do |filtered_files|
+        @filtered_files += (original_files.map(&:filename) - filtered_files.map(&:filename))
+      end
+    end
+  end
+end
+
 module Undercover
   class ResultHashFormatterWithRoot < SimpleCovJSONFormatter::ResultHashFormatter
     def format
       formatted_result[:meta] = {timestamp: @result.created_at.to_i}
       format_files
       add_undercover_meta_fields
+      add_ignored_files
       formatted_result
     end
 
@@ -30,6 +47,14 @@ def add_undercover_meta_fields
       end
     end
 
+    def add_ignored_files
+      ignored_files = SimpleCov.filtered_files&.map do |file|
+        file.delete_prefix("#{SimpleCov.root}/")
+      end || []
+
+      formatted_result[:meta][:ignored_files] = ignored_files
+    end
+
     # format_files uses relative path as keys, as opposed to the superclass method
     def format_files
       formatted_result[:coverage] ||= {}

lib/undercover/simplecov_result_adapter.rb

@@ -56,6 +56,10 @@ def skipped?(filepath, line_no)
     def total_coverage; end
     def total_branch_coverage; end
 
+    def ignored_files
+      @ignored_files ||= simplecov_result.dig('meta', 'ignored_files') || []
+    end
+
     private
 
     def find_file(filepath)

spec/changeset_spec.rb

@@ -62,7 +62,7 @@
 
   describe 'filtering' do
     it 'filters files using FilterSet in each_changed_line' do
-      filter_set = Undercover::FilterSet.new(['*.rb'], ['*_spec.rb'])
+      filter_set = Undercover::FilterSet.new(['*.rb'], ['*_spec.rb'], [])
       changeset = Undercover::Changeset.new('spec/fixtures/test.git', 'master', filter_set)
 
       yielded_files = []
@@ -75,7 +75,7 @@
     end
 
     it 'filters files using FilterSet with brace expansion' do
-      filter_set = Undercover::FilterSet.new(['*.{rb,js}'], ['*_spec.rb'])
+      filter_set = Undercover::FilterSet.new(['*.{rb,js}'], ['*_spec.rb'], [])
       changeset = Undercover::Changeset.new('spec/fixtures/test.git', 'master', filter_set)
 
       yielded_files = []