undercover 0.7.4 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb439eb426932d432434081cf9e17cce9b19b90a85c71b6a4c173d20cceb9392
-  data.tar.gz: a2703dd7d19a18f943dd3fdaebc34faf23cc995b1cc94b673756f1b5142cf046
+  metadata.gz: 522b27800c01ddd2ed70108b080f709d4c4ec12d338c4c8ba204b54cb4c464bc
+  data.tar.gz: 8208f484eb86247a02b0c58d5007ce6a80e29ce125a2a39516e5ee4b8acdd43b
 SHA512:
-  metadata.gz: 034ff6bd2826c4826b06780bd874e28c04c8fbcb0fcde85a5c0a1dd8901e4f5d2ebfe6c149b828c0fcf28fd4064f14ef122f69c763f59170b62d99941281d44b
-  data.tar.gz: 114c9a9873fb75c17a3bfe79612bfe8d2891cd2d2b2dd68f8253d49f3529def86bca607d4774d1f113ade2fd8eb2d6d5d55e53d4b47b4a5464c3a6075eb2da3b
+  metadata.gz: a65331bb82a3a31845fea782519a4254449264b914c26d8c54277a00a9ae4653bb183aa5bdc1f66982e991ccadea1b8a066553d616bbcc2c033bcc2c0550f0c0
+  data.tar.gz: d60a04cbd89cda50b486f850e68a0843aae0db0da5acc93acab565ba93e9eaf7090c14898140b0c120cd25ddd0164a3fbcd544f794859e3c466eccaa62a3afb7

data/.github/workflows/ruby.yml

@@ -7,7 +7,7 @@ jobs:
       matrix:
         ruby: ['3.4', '3.0']
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0 # fetch all since test fixtures depend on history
       - name: Set up Ruby ${{ matrix.ruby }}
@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     steps:
-      - uses: actions/download-artifact@v4
+      - uses: actions/download-artifact@v5
         with:
           name: undercover-3.4-coverage
       - name: Upload coverage

data/.gitignore

@@ -10,3 +10,6 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+
+# branch ignore fixture coverage metadata
+spec/fixtures/branch_ignored_coverage/.*

data/.rubocop.yml

@@ -25,10 +25,10 @@ Metrics/BlockLength:
     - spec/**/*
 
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 12
 
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 12
 
 Style/HashEachMethods:
   Enabled: true

data/CHANGELOG.md

@@ -6,6 +6,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+# [0.8.1] - 2025-09-27
+
+### Fixed
+- Fix missing require in the simplecov formatter causing potential load errors if SimpleCov wasn't required first
+- Fix SimpleCov filters ([#239](https://github.com/grodowski/undercover/pull/239) by [@loadkpi](https://github.com/loadkpi))
+
+# [0.8.0] - 2025-08-28
+
+### Added
+- Filter out files ignored by simplecov using `add_filter` ([#234](https://github.com/grodowski/undercover/pull/234))
+- Add LF and LH parsing to LcovParser for simplecov-lcov 0.9 compatibility
+
+### Fixed
+- Fix an `Undercover::Result` edge case causing errors with ignored branches on uningnored lines
+
 # [0.7.4] - 2025-07-13
 
 ### Fixed
@@ -185,7 +200,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - First release of `undercover` 🎉
 
-[Unreleased]: https://github.com/grodowski/undercover/compare/v0.7.4...HEAD
+[Unreleased]: https://github.com/grodowski/undercover/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/grodowski/undercover/compare/v0.7.4...v0.8.0
 [0.7.4]: https://github.com/grodowski/undercover/compare/v0.7.3...v0.7.4
 [0.7.3]: https://github.com/grodowski/undercover/compare/v0.7.2...v0.7.3
 [0.7.2]: https://github.com/grodowski/undercover/compare/v0.7.1...v0.7.2

data/lib/undercover/changeset.rb

@@ -49,6 +49,10 @@ module Undercover
       :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),

data/lib/undercover/cli.rb

@@ -5,9 +5,6 @@ require 'rainbow'
 
 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 @@ module Undercover
       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 @@ module Undercover
 
     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

data/lib/undercover/filter_set.rb

@@ -2,16 +2,37 @@
 
 module Undercover
   class FilterSet
-    attr_reader :allow_filters, :reject_filters
+    attr_reader :allow_filters, :reject_filters, :simplecov_filters
 
-    def initialize(allow_filters, reject_filters)
+    def initialize(allow_filters, reject_filters, simplecov_filters)
       @allow_filters = allow_filters || []
       @reject_filters = reject_filters || []
+      @simplecov_filters = simplecov_filters || []
     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 ignored_by_simplecov?(filepath)
+
+      # Apply Undercover's own filters
       allow_filters.any?(fnmatch) && reject_filters.none?(fnmatch)
     end
+
+    private
+
+    def ignored_by_simplecov?(filepath)
+      simplecov_filters.any? do |filter|
+        filter = filter.transform_keys(&:to_sym)
+        if filter[:string]
+          filepath.include?(filter[:string])
+        elsif filter[:regex]
+          filepath.match?(Regexp.new(filter[:regex]))
+        elsif filter[:file]
+          filepath == filter[:file]
+        end
+      end
+    end
   end
 end

data/lib/undercover/lcov_parser.rb

@@ -57,6 +57,11 @@ module Undercover
       false
     end
 
+    def ignored_files
+      # supported by SimplecovResultAdapter only
+      []
+    end
+
     private
 
     # rubocop:disable Metrics/MethodLength, Style/SpecialGlobalVars, Metrics/AbcSize
@@ -79,6 +84,7 @@ module Undercover
         source_files[@current_filename] << [line_no.to_i, block_no.to_i, branch_no.to_i, covered.to_i]
       when /^end_of_record$/, /^$/
         @current_filename = nil
+      when /^LF:(\d+)|LH:(\d+)/ # lines found, lines hit; no-op
       else
         raise LcovParseError, "could not recognise '#{line}' as valid LCOV"
       end

data/lib/undercover/result.rb

@@ -43,7 +43,7 @@ module Undercover
 
       # check branch coverage for line_no
       coverage.each do |ln, _block, _branch, cov|
-        return true if ln == line_no && cov && cov.zero?
+        return true if ln == line_no && cov && cov != 'ignored' && cov.zero?
       end
 
       # check line coverage for line_no

data/lib/undercover/simplecov_formatter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'simplecov'
 require 'simplecov_json_formatter'
 
 # Patch ResultExporter to allow setting a custom export_path
@@ -13,12 +14,60 @@ module SimpleCovJSONFormatter
   end
 end
 
+module SimpleCov
+  class << self
+    attr_accessor :filter_definitions
+
+    alias filtered_uncached filtered
+
+    def filtered(files)
+      @filter_definitions ||= extract_filter_definitions
+      original_files = files.dup
+      filtered_uncached(files).tap do |filtered_files|
+        filtered_file_paths = (original_files.map(&:filename) - filtered_files.map(&:filename))
+        filtered_file_paths.each do |file|
+          relative_path = file.delete_prefix("#{SimpleCov.root}/")
+          @filter_definitions << {file: relative_path} unless covered_by_serializable_filters?(relative_path)
+        end
+      end
+    end
+
+    private
+
+    def extract_filter_definitions
+      filter_array = []
+
+      filters.each do |filter|
+        case filter
+        when SimpleCov::StringFilter
+          filter_array << {string: filter.filter_argument}
+        when SimpleCov::RegexFilter
+          filter_array << {regex: filter.filter_argument.source}
+        end
+      end
+
+      filter_array
+    end
+
+    def covered_by_serializable_filters?(relative_path)
+      @filter_definitions.any? do |filter_def|
+        if filter_def[:string]
+          relative_path.include?(filter_def[:string])
+        elsif filter_def[:regex]
+          relative_path.match?(Regexp.new(filter_def[:regex]))
+        end
+      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 +79,10 @@ module Undercover
       end
     end
 
+    def add_ignored_files
+      formatted_result[:meta][:ignored_files] = SimpleCov.filter_definitions || []
+    end
+
     # format_files uses relative path as keys, as opposed to the superclass method
     def format_files
       formatted_result[:coverage] ||= {}

data/lib/undercover/simplecov_result_adapter.rb

@@ -56,6 +56,10 @@ module Undercover
     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)

data/lib/undercover/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Undercover
-  VERSION = '0.7.4'
+  VERSION = '0.8.1'
 end

data/lib/undercover.rb

@@ -21,11 +21,12 @@ require 'undercover/version'
 module Undercover
   class Report
     extend Forwardable
+
     def_delegators :changeset, :validate
 
     attr_reader :changeset,
                 :lcov,
-                :simplecov_resultset,
+                :coverage_adapter,
                 :results,
                 :code_dir,
                 :filter_set,
@@ -35,15 +36,16 @@ module Undercover
     #
     # @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 +108,21 @@ module Undercover
 
     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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.1
 platform: ruby
 authors:
 - Jan Grodowski
 bindir: bin
 cert_chain: []
-date: 2025-07-13 00:00:00.000000000 Z
+date: 2025-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64