undercover 0.6.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a3601cf9aa4d26cee9c04f12b44273f8a67e0e8584b020e4e9bb763e03bf24e
-  data.tar.gz: 8198c30de2bc16734a1575b7aa0213c25ccafe120848dad9c24257d688b7bca9
+  metadata.gz: 8c8f43820b6be7cbae834f152ed56778f8fb3540e878a012ce0bb5274be7b0e3
+  data.tar.gz: '0798f165b6deef05078311ff04822bc4c1dc708e3830b569b5575be2d1f8a3fe'
 SHA512:
-  metadata.gz: 6e6a60fad9a478c37895ae24035022a9acf86f789ce0d798194b6d13b82c7db52c9de6590a9a9d3b8a84d304f220a30ef2c8e5226bab6fa58cea96f09c3856ca
-  data.tar.gz: fd1ca272d59b29debe708bd2f8df2bf867dccc60484416002dbf004d21ea83370e408e7703098f8d6e2ff0345d2234a7e662f94254a7dcc339f7370bae9f9885
+  metadata.gz: 922c43acac57c8e57df9c902b9739c4f084a090e6afc9b838868e80ce8c39ea5d5e087952c40e7446fceaa97313ee686aacfef1e8a62af8dd01879d665e5abda
+  data.tar.gz: 3d538e5526d124c9ffba53c53de75dd2e6009b0abf1de4a333ccd3e013da195b15811217d0e1a8b1b12bd7c34d47cac47c42dd6e4838cd82e3a571602c0e5966

data/.github/workflows/ruby.yml

@@ -18,25 +18,25 @@ jobs:
         run: |
           gem install bundler undercover --no-doc
           bundle install --jobs 4 --retry 3
-          bundle exec rake
+          rake
       - name: undercover (local)
         run: |
           git fetch --update-head-ok origin master:master
-          undercover --compare master
+          undercover --simplecov coverage/undercover_coverage.json --compare master
       - uses: actions/upload-artifact@v4
         with:
-          name: undercover-${{ matrix.ruby }}.lcov
-          path: coverage/lcov/undercover.lcov
+          name: undercover-${{ matrix.ruby }}-coverage
+          path: coverage/undercover_coverage.json
   coverage:
     runs-on: ubuntu-latest
     needs: build
     steps:
       - uses: actions/download-artifact@v4
         with:
-          name: undercover-3.4.lcov
+          name: undercover-3.4-coverage
       - name: Upload coverage
         run: |
           ruby -e "$(curl -s https://undercover-ci.com/uploader.rb)" -- \
             --repo grodowski/undercover \
             --commit ${{ github.event.pull_request.head.sha || github.sha }} \
-            --lcov /home/runner/work/undercover/undercover/undercover.lcov
+            --simplecov /home/runner/work/undercover/undercover/undercover_coverage.json

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/.tool-versions

@@ -1 +1,2 @@
 ruby 3.4.2
+nodejs v24.4.0

data/CHANGELOG.md

@@ -6,6 +6,52 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+# [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
+- Fix `fnmatch` for `FilterSet` to support glob braces (sets) in `--include-files` and `--exclude-files`
+
+# [0.7.3] - 2025-07-13
+
+### Fixed
+- Improve Options#parse with glob braces support, strip quotes properly from .undercover config files
+- Fix Result#coverage_f to support ignored branches
+- Fix error parsing JSON coverage with branch coverage disabled ([#231](https://github.com/grodowski/undercover/issues/231))
+- Fixed NoMethodError and Errno::ENOENT that were occurring when coverage report doesn't exist ([#232](https://github.com/grodowski/undercover/issues/232))
+
+# [0.7.2] - 2025-07-07
+
+### Fixed
+- Resolved errors when .lcov files doesn't exist using `--lcov` CLI flag and `guess_lcov_path`
+
+# [0.7.0] - 2025-07-03
+
+### Added
+- New native SimpleCov formatter that generates coverage data directly without requiring LCOV conversion ([#223](https://github.com/grodowski/undercover/pull/223))
+- `--simplecov -s` CLI option to specify coverage JSON file path as an alternative to LCOV and future default ([#223](https://github.com/grodowski/undercover/pull/223))
+- Improved path handling for projects running in nested subdirectories or monorepo setups ([#223](https://github.com/grodowski/undercover/pull/223))
+
+### Fixed
+- `:nocov:` support to skip coverage analysis for specific code blocks works again after a regression in `0.6+` ([#223](https://github.com/grodowski/undercover/pull/223))
+
+# [0.6.6] - 2025-07-01
+
+- Bugfix in `max_warnings_limit` following ([#229](https://github.com/grodowski/undercover/pull/229))
+
+# [0.6.5] - 2025-07-01
+
+### Fixed
+- Improved performance for large PRs with lazy diff enumeration ([#229](https://github.com/grodowski/undercover/pull/229))
+
 # [0.6.4] - 2025-03-29
 
 ### Fixed
@@ -148,9 +194,18 @@ 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.6.3...HEAD
-[0.6.3]:https://github.com/grodowski/undercover/compare/v0.6.3...v0.6.0
-[0.6.0]: https://github.com/grodowski/undercover/compare/v0.6.0...v0.5.0
+[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
+[0.7.1]: https://github.com/grodowski/undercover/compare/v0.7.0...v0.7.1
+[0.7.0]: https://github.com/grodowski/undercover/compare/v0.6.6...v0.7.0
+[0.6.6]: https://github.com/grodowski/undercover/compare/v0.6.5...0.6.6
+[0.6.5]: https://github.com/grodowski/undercover/compare/v0.6.4...0.6.5
+[0.6.4]: https://github.com/grodowski/undercover/compare/v0.6.3...v0.6.4
+[0.6.3]: https://github.com/grodowski/undercover/compare/v0.6.0...v0.6.3
+[0.6.0]: https://github.com/grodowski/undercover/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/grodowski/undercover/compare/v0.4.7...v0.5.0
 [0.4.7]: https://github.com/grodowski/undercover/compare/v0.4.6...v0.4.7
 [0.4.6]: https://github.com/grodowski/undercover/compare/v0.4.5...v0.4.6

data/Gemfile

@@ -10,7 +10,8 @@ gem 'pry'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rubocop'
+gem 'ruby-lsp-rspec', require: false
 gem 'simplecov'
 gem 'simplecov-html'
-gem 'simplecov-lcov', '~> 0.8'
+gem 'simplecov_json_formatter'
 gem 'timecop'

data/README.md

@@ -9,7 +9,6 @@ Works with any Ruby CI pipeline as well as locally as a CLI.
 
 
 [![Build Status](https://github.com/grodowski/undercover/actions/workflows/ruby.yml/badge.svg)](https://github.com/grodowski/undercover/actions)
-[![Maintainability](https://api.codeclimate.com/v1/badges/b403feed68a18c072ec5/maintainability)](https://codeclimate.com/github/grodowski/undercover/maintainability)
 ![Downloads](https://img.shields.io/gem/dt/undercover)
 
 A sample output of `undercover` ran before a commit may look like this:
@@ -36,34 +35,56 @@ Or install it yourself as:
 
     $ gem install undercover
 
-## Setting up required LCOV reporting
+## Setting up coverage reporting
 
-To make your specs or tests compatible with `undercover` by providing an LCOV report, please add `simplecov` and `simplecov-lcov` to your test setup.
+To make your specs or tests compatible with `undercover`, please add `undercover` to your gemfile to use the undercover formatter the test helper.
 
 ```ruby
 # Gemfile
 group :test do
-  gem 'simplecov'
-  gem 'simplecov-lcov'
+  gem 'undercover'
 end
 
 # the very top of spec_helper.rb
 require 'simplecov'
-require 'simplecov-lcov'
-SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
-SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+require 'undercover/simplecov_formatter'
+
+# optional, the filename defaults to `coverage.json` and is automatically recognised by the gem
+# SimpleCov::Formatter::Undercover.output_filename = 'my_project_coverage.json'
+SimpleCov.formatter = SimpleCov::Formatter::Undercover
+
 SimpleCov.start do
   add_filter(/^\/spec\//) # For RSpec
   add_filter(/^\/test\//) # For Minitest
   enable_coverage(:branch) # Report branch coverage to trigger branch-level undercover warnings
 end
+# ...
+```
 
-require 'undercover'
+Then run your test suite once through to generate the initial coverage file before you can run the `undercover` command.
 
-# ...
+## Upgrading from pre-0.7.0
+
+If you're upgrading from an older version of undercover that used LCOV, you can migrate to the new SimpleCov formatter:
+
+1. Add `gem 'undercover'` to your test group
+2. Replace the LCOV formatter setup with the new SimpleCov formatter
+
+```ruby
+# Gemfile
+group :test do
+  gem 'undercover'
+end
+
+# spec_helper.rb
+require 'simplecov'
+require 'undercover/simplecov_formatter'
+SimpleCov.formatter = SimpleCov::Formatter::Undercover
 ```
 
-Then run your test suite once through to generate the initial `coverage/lcov/*.lcov` file before you can run the `undercover` command
+3. Update CLI usage: Use `--simplecov` flag instead of `--lcov`, or rely on auto-detection of `coverage/coverage.json`
+
+Note: LCOV support will be deprecated in a future release, but remains fully functional for existing projects.
 
 ## Usage
 
@@ -80,11 +101,10 @@ undercover --compare origin/master
 ```
 
 Check out `docs/` for CI configuration examples:
-- [Travis CI](docs/travis.yml)
+- [GitHub Actions](docs/actions.yml)
 - [CircleCI - simple](docs/circleci_config.yml)
 - [CircleCI - advanced](docs/circleci_advanced.yml)
 - [Semaphore](docs/semaphore.yml)
-- [Codeship](docs/codeship.md)
 
 Merging coverage results ([sample gist](https://gist.github.com/grodowski/9744ff91034dce8df20c2a8210409fb0)) is required for parallel tests before processing with `undercover`.
 
@@ -105,11 +125,13 @@ Options can be passed when running the command from the command line:
 
 ```sh
 Usage: undercover [options]
-    -l, --lcov path                  LCOV report file path
+    -s, --simplecov path             SimpleCov JSON report file
+    -l, --lcov path                  LCOV report file path (to be deprecated)
     -p, --path path                  Project directory
     -g, --git-dir dir                Override `.git` with a custom directory
     -c, --compare ref                Generate coverage warnings for all changes after `ref`
     -r, --ruby-syntax ver            Ruby syntax version, one of: current, ruby18, ruby19, ruby20, ruby21, ruby22, ruby23, ruby24, ruby25, ruby26, ruby30, ruby31, ruby32, ruby33
+    -w, --max-warnings limit         Maximum number of warnings to generate before stopping analysis. Useful as a performance improvement for large diffs.
     -f, --include-files globs        Include files matching specified glob patterns (comma separated). Defaults to '*.rb,*.rake,*.ru,Rakefile'
     -x, --exclude-files globs        Skip files matching specified glob patterns (comma separated). Empty by default.
     -h, --help                       Prints this help

data/docs/actions.yml

@@ -0,0 +1,19 @@
+name: Tests & Undercover
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 3.4
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+    - name: Build and test
+      env:
+        RAILS_ENV: test
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake test
+        undercover --simplecov coverage/coverage.json --compare origin/master

data/docs/circleci_advanced.yml

@@ -20,7 +20,7 @@ jobs:
             bundle exec rspec
       - run:
           name: Store coverage report
-          command: mv coverage/lcov/project.lcov /tmp/coverage/
+          command: mv coverage/coverage.json /tmp/coverage/
       - persist_to_workspace:
           root: /tmp/coverage
           paths: .
@@ -33,13 +33,13 @@ jobs:
     steps:
       - checkout
       - attach_workspace:
-          at: /tmp/coverage # gives access to project's LCOV report
+          at: /tmp/coverage # gives access to project's coverage report
       - run:
           name: Check coverage
           command: |
             sudo apt-get install cmake
             gem install undercover
-            undercover --lcov /tmp/coverage/project.lcov \
+            undercover --simplecov /tmp/coverage/coverage.json \
                        --compare origin/master
 
 workflows:

data/docs/circleci_config.yml

@@ -1,5 +1,5 @@
 # Simple CircleCI config.yml example.
-# See workflow_config.yml for a more advanced example,
+# See circleci_advanced.yml for a more advanced example,
 # that includes sharing data between containers.
 
 version: 2

data/lib/undercover/changeset.rb

@@ -8,31 +8,12 @@ module Undercover
   class Changeset
     T_ZERO = Time.strptime('0', '%s').freeze
 
-    extend Forwardable
-    include Enumerable
-
-    attr_reader :files
-
-    def_delegators :files, :each, :<=>
-
-    def initialize(dir, compare_base = nil)
+    def initialize(dir, compare_base = nil, filter_set = nil)
       @dir = dir
       @repo = Rugged::Repository.new(dir)
       @repo.workdir = Pathname.new(dir).dirname.to_s # TODO: can replace?
       @compare_base = compare_base
-      @files = {}
-    end
-
-    def update
-      full_diff.each_patch do |patch|
-        filepath = patch.delta.new_file[:path]
-        line_nums = patch.each_hunk.map do |hunk|
-          # TODO: optimise this to use line ranges!
-          hunk.lines.select(&:addition?).map(&:new_lineno)
-        end.flatten
-        @files[filepath] = line_nums if line_nums.any?
-      end
-      self
+      @filter_set = filter_set
     end
 
     def last_modified
@@ -46,29 +27,39 @@ module Undercover
     end
 
     def file_paths
-      files.keys.sort
+      full_diff.deltas.map { |d| d.new_file[:path] }.sort
     end
 
     def each_changed_line
-      files.each do |filepath, line_numbers|
-        line_numbers.each { |ln| yield filepath, ln }
+      full_diff.each_patch do |patch|
+        filepath = patch.delta.new_file[:path]
+        next if filter_set && !filter_set.include?(filepath)
+
+        patch.each_hunk do |hunk|
+          hunk.lines.select(&:addition?).each do |line|
+            yield filepath, line.new_lineno
+          end
+        end
       end
     end
 
-    # TODO: refactor to a standalone validator (depending on changeset AND lcov)
     def validate(lcov_report_path)
-      return :no_changes if files.empty?
+      return :no_changes if full_diff.deltas.empty?
 
       :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),
     # as it makes sense to run Undercover with the most recent file versions
     def full_diff
       base = compare_base_obj || head
-      base.diff(repo.index).merge!(repo.diff_workdir(head))
+      @full_diff ||= base.diff(repo.index).merge!(repo.diff_workdir(head))
     end
 
     def compare_base_obj
@@ -83,6 +74,6 @@ module Undercover
       repo.head.target
     end
 
-    attr_reader :repo, :compare_base
+    attr_reader :repo, :compare_base, :filter_set
   end
 end

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,10 +18,38 @@ module Undercover
       run_report(opts)
     end
 
-    def self.run_report(opts)
-      report = Undercover::Report.new(changeset(opts), opts).build
+    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)
+
+      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
+
+    def self.handle_missing_coverage_path(opts)
+      puts Rainbow('❌ ERROR: No coverage report found. Checked default paths:').red
+      puts Rainbow('  - ./coverage/coverage.json (SimpleCov)').red
+      puts Rainbow("  - ./coverage/lcov/#{Pathname.new(File.expand_path(opts.path)).split.last}.lcov (LCOV)").red
+      puts Rainbow('Set a custom path with --lcov or --simplecov option').red
+      1
+    end
+
+    def self.handle_missing_file(coverage_path)
+      puts Rainbow("❌ ERROR: Coverage report not found at: #{coverage_path}").red
+      1
+    end
 
-      error = report.validate(opts.lcov)
+    def self.handle_report_validation(report, coverage_path)
+      error = report.validate(coverage_path)
       if error
         puts(WARNINGS_TO_S[error])
         return 0 if error == :no_changes

data/lib/undercover/filter_set.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Undercover
+  class FilterSet
+    attr_reader :allow_filters, :reject_filters, :simplecov_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|
+        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

@@ -1,19 +1,24 @@
 # frozen_string_literal: true
 
+require 'undercover/root_to_relative_paths'
+
 module Undercover
   LcovParseError = Class.new(StandardError)
 
   class LcovParser
+    include RootToRelativePaths
+
     attr_reader :io, :source_files
 
-    def initialize(lcov_io)
+    def initialize(lcov_io, opts)
       @io = lcov_io
       @source_files = {}
+      @code_dir = opts&.path
     end
 
-    def self.parse(lcov_report_path)
+    def self.parse(lcov_report_path, opts = nil)
       lcov_io = File.open(lcov_report_path)
-      new(lcov_io).parse
+      new(lcov_io, opts).parse
     end
 
     def parse
@@ -24,7 +29,7 @@ module Undercover
 
     def coverage(filepath)
       _filename, coverage = source_files.find do |relative_path, _|
-        relative_path == filepath
+        relative_path == fix_relative_filepath(filepath)
       end
       coverage || []
     end
@@ -47,6 +52,16 @@ module Undercover
       total_f.round(3)
     end
 
+    def skipped?(_filepath, _line_no)
+      # this is why lcov parser will be deprecated
+      false
+    end
+
+    def ignored_files
+      # supported by SimplecovResultAdapter only
+      []
+    end
+
     private
 
     # rubocop:disable Metrics/MethodLength, Style/SpecialGlobalVars, Metrics/AbcSize
@@ -69,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/options.rb

@@ -2,6 +2,7 @@
 
 require 'optparse'
 require 'pathname'
+require 'shellwords'
 
 module Undercover
   class Options # rubocop:disable Metrics/ClassLength
@@ -34,6 +35,7 @@ module Undercover
     DEFAULT_FILE_EXCLUDE_GLOBS = %w[test/* spec/* db/* config/* *_test.rb *_spec.rb].freeze
 
     attr_accessor :lcov,
+                  :simplecov_resultset,
                   :path,
                   :git_dir,
                   :compare,
@@ -41,7 +43,8 @@ module Undercover
                   :run_mode,
                   :file_scope,
                   :glob_allow_filters,
-                  :glob_reject_filters
+                  :glob_reject_filters,
+                  :max_warnings_limit
 
     def initialize
       @run_mode = DIFF_TRIGGER_LINE
@@ -51,6 +54,7 @@ module Undercover
       self.git_dir = '.git'
       self.glob_allow_filters = DEFAULT_FILE_INCLUDE_GLOBS
       self.glob_reject_filters = DEFAULT_FILE_EXCLUDE_GLOBS
+      self.max_warnings_limit = nil
     end
 
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
@@ -66,18 +70,23 @@ module Undercover
         end
 
         opts.on_tail('--version', 'Show version') do
+          # :nocov:
           puts VERSION
           exit
+          # :nocov:
         end
 
         lcov_path_option(opts)
+        resultset_path_option(opts)
         project_path_option(opts)
         git_dir_option(opts)
         compare_option(opts)
         ruby_syntax_option(opts)
+        max_warnings_limit_option(opts)
         file_filters(opts)
       end.parse(args)
 
+      guess_resultset_path unless simplecov_resultset
       guess_lcov_path unless lcov
       self
     end
@@ -96,19 +105,39 @@ module Undercover
     def args_from_options_file(path)
       return [] unless File.exist?(path)
 
-      File.read(path).split('\n').flat_map(&:split)
+      File.read(path).split("\n").flat_map { parse_line(_1) }
     end
 
     def project_options_file
       './.undercover'
     end
 
+    def parse_line(line)
+      line = line.strip
+      return [] if line.empty? || line.start_with?('#')
+
+      Shellwords.split(line)
+    end
+
+    def split_comma_separated_with_braces(input)
+      return [] if input.empty?
+
+      input.split(/,(?![^{]*})/).map(&:strip) # split on commas that are not inside braces
+    end
+
     def lcov_path_option(parser)
       parser.on('-l', '--lcov path', 'LCOV report file path') do |path|
         self.lcov = path
       end
     end
 
+    def resultset_path_option(parser)
+      desc = 'SimpleCov::Formatter::Undercover output file path (alternative to LCOV that will become default)'
+      parser.on('-s', '--simplecov path', desc) do |path|
+        self.simplecov_resultset = path
+      end
+    end
+
     def project_path_option(parser)
       parser.on('-p', '--path path', 'Project directory') do |path|
         self.path = path
@@ -137,21 +166,35 @@ module Undercover
       end
     end
 
+    def max_warnings_limit_option(parser)
+      desc = 'Maximum number of warnings to generate before stopping analysis'
+      parser.on('-w', '--max-warnings limit', Integer, desc) do |limit|
+        self.max_warnings_limit = limit
+      end
+    end
+
+    def guess_resultset_path
+      cwd = Pathname.new(File.expand_path(path))
+      try_path = File.join(cwd, 'coverage', 'coverage.json')
+      self.simplecov_resultset = try_path if File.exist?(try_path)
+    end
+
     def guess_lcov_path
       cwd = Pathname.new(File.expand_path(path))
-      self.lcov = File.join(cwd, 'coverage', 'lcov', "#{cwd.split.last}.lcov")
+      try_path = File.join(cwd, 'coverage', 'lcov', "#{cwd.split.last}.lcov")
+      self.lcov = try_path if File.exist?(try_path)
     end
 
     def file_filters(parser)
       desc = 'Include files matching specified glob patterns (comma separated). ' \
              "Defaults to '#{DEFAULT_FILE_INCLUDE_GLOBS.join(',')}'"
       parser.on('-f', '--include-files globs', desc) do |comma_separated_globs|
-        self.glob_allow_filters = comma_separated_globs.strip.split(',')
+        self.glob_allow_filters = split_comma_separated_with_braces(comma_separated_globs)
       end
 
       desc = 'Skip files matching specified glob patterns (comma separated). Empty by default.'
       parser.on('-x', '--exclude-files globs', desc) do |comma_separated_globs|
-        self.glob_reject_filters = comma_separated_globs.strip.split(',')
+        self.glob_reject_filters = split_comma_separated_with_braces(comma_separated_globs)
       end
     end
   end

data/lib/undercover/result.rb

@@ -3,15 +3,18 @@
 require 'forwardable'
 
 module Undercover
-  class Result
+  class Result # rubocop:disable Metrics/ClassLength
     extend Forwardable
 
-    attr_reader :node, :coverage, :file_path
+    attr_reader :node, :coverage, :coverage_adapter, :file_path
 
     def_delegators :node, :first_line, :last_line, :name
+    def_delegators :coverage_adapter, :skipped?
 
-    def initialize(node, file_cov, file_path) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+    def initialize(node, coverage_adapter, file_path) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
       @node = node
+      @coverage_adapter = coverage_adapter
+      file_cov = coverage_adapter.coverage(file_path)
       @coverage = file_cov.select do |ln, _|
         if first_line == last_line
           ln == first_line
@@ -21,6 +24,7 @@ module Undercover
           ln > first_line && ln < last_line
         end
       end
+
       @file_path = file_path
       @flagged = false
     end
@@ -33,12 +37,13 @@ module Undercover
       @flagged
     end
 
-    def uncovered?(line_no)
+    def uncovered?(line_no) # rubocop:disable Metrics/AbcSize
+      return false if skipped?(file_path, line_no)
       return true if coverage.empty?
 
       # 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
@@ -55,9 +60,14 @@ module Undercover
 
       lines = {}
       coverage.each do |ln, block_or_line_cov, _, branch_cov|
+        if skipped?(file_path, ln)
+          lines[ln] = 1
+          next
+        end
+
         lines[ln] = 1 unless lines.key?(ln)
         if branch_cov
-          lines[ln] = 0 if branch_cov.zero?
+          lines[ln] = 0 if branch_cov != 'ignored' && branch_cov.zero?
         elsif block_or_line_cov.zero?
           lines[ln] = 0
         end
@@ -93,6 +103,9 @@ module Undercover
         formatted_line = "#{num.to_s.rjust(pad)}: #{line}"
         if line.strip.empty?
           Rainbow(formatted_line).darkgray.dark
+        elsif skipped?(file_path, num)
+          Rainbow(formatted_line).darkgray.dark +
+            Rainbow(' skipped with :nocov:').italic.darkgray.dark
         elsif covered.nil?
           Rainbow(formatted_line).darkgray.dark +
             Rainbow(' hits: n/a').italic.darkgray.dark

data/lib/undercover/root_to_relative_paths.rb

@@ -0,0 +1,24 @@
+# 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

data/lib/undercover/simplecov_formatter.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'simplecov_json_formatter'
+
+# Patch ResultExporter to allow setting a custom export_path
+module SimpleCovJSONFormatter
+  class ResultExporter
+    def export_path
+      # :nocov:
+      File.join(SimpleCov.coverage_path, SimpleCov::Formatter::Undercover.output_filename || FILENAME)
+      # :nocov:
+    end
+  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
+
+    private
+
+    def add_undercover_meta_fields
+      formatted_result.tap do |result|
+        result[:meta].merge!(simplecov_root: SimpleCov.root)
+      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] ||= {}
+      @result.files.each do |source_file|
+        path = source_file.project_filename.delete_prefix('/')
+        formatted_result[:coverage][path] = format_source_file(source_file)
+      end
+    end
+  end
+
+  class UndercoverSimplecovFormatter < SimpleCov::Formatter::JSONFormatter
+    class << self
+      attr_accessor :output_filename
+    end
+
+    def format_result(result)
+      result_hash_formater = ResultHashFormatterWithRoot.new(result)
+      result_hash_formater.format
+    end
+  end
+end
+
+module SimpleCov
+  module Formatter
+    Undercover = ::Undercover::UndercoverSimplecovFormatter
+  end
+end

data/lib/undercover/simplecov_result_adapter.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'undercover/root_to_relative_paths'
+
+module Undercover
+  class SimplecovResultAdapter
+    include RootToRelativePaths
+
+    attr_reader :simplecov_result
+
+    # @param file[File] JSON file supplied by SimpleCov::Formatter::Undercover
+    # @return SimplecovResultAdapter
+    def self.parse(file, opts = nil)
+      # :nocov:
+      result_h = JSON.parse(file.read)
+      raise ArgumentError, 'empty SimpleCov' if result_h.empty?
+
+      new(result_h, opts)
+      # :nocov:
+    end
+
+    # @param simplecov_result[SimpleCov::Result]
+    def initialize(simplecov_result, opts)
+      @simplecov_result = simplecov_result
+      @code_dir = opts&.path
+    end
+
+    # @param filepath[String]
+    # @return Array tuples (lines) and quadruples (branches) compatible with LcovParser
+    def coverage(filepath) # rubocop:disable Metrics/MethodLength
+      source_file = find_file(filepath)
+
+      return [] unless source_file
+
+      lines = source_file['lines'].map.with_index do |line_coverage, idx|
+        [idx + 1, line_coverage] if line_coverage
+      end.compact
+      return lines unless source_file['branches']
+
+      branch_idx = 0
+      branches = source_file['branches'].map do |branch|
+        branch_idx += 1
+        [branch['start_line'], 0, branch_idx, branch['coverage']]
+      end
+      lines + branches
+    end
+
+    def skipped?(filepath, line_no)
+      source_file = find_file(filepath)
+      return false unless source_file
+
+      source_file['lines'][line_no - 1] == 'ignored'
+    end
+
+    # unused for now
+    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)
+      simplecov_result['coverage'][fix_relative_filepath(filepath)]
+    end
+  end
+end

data/lib/undercover/version.rb

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

data/lib/undercover.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 $LOAD_PATH << 'lib'
+require 'json'
 require 'imagen'
 require 'rainbow'
 require 'bigdecimal'
 require 'forwardable'
+require 'simplecov'
 
 require 'undercover/lcov_parser'
 require 'undercover/result'
@@ -12,38 +14,49 @@ require 'undercover/cli'
 require 'undercover/changeset'
 require 'undercover/formatter'
 require 'undercover/options'
+require 'undercover/filter_set'
+require 'undercover/simplecov_result_adapter'
 require 'undercover/version'
 
 module Undercover
   class Report
     extend Forwardable
+
     def_delegators :changeset, :validate
 
     attr_reader :changeset,
                 :lcov,
+                :coverage_adapter,
                 :results,
                 :code_dir,
-                :glob_filters
+                :filter_set,
+                :max_warnings_limit
 
     # Initializes a new Undercover::Report
     #
     # @param changeset [Undercover::Changeset]
     # @param opts [Undercover::Options]
-    def initialize(changeset, opts)
-      @lcov = LcovParser.parse(File.open(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.update
-      @glob_filters = {
-        allow: opts.glob_allow_filters,
-        reject: opts.glob_reject_filters
-      }
+      @changeset = changeset
+
+      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 = {}
     end
 
     # rubocop:disable 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
 
@@ -61,7 +74,10 @@ module Undercover
         next unless loaded_files[filepath]
 
         res = loaded_files[filepath].min(&dist_from_line_no_sorter)
-        res.flag if res&.uncovered?(line_no)
+        if res.uncovered?(line_no) && !res.flagged?
+          res.flag
+          flag_count += 1
+        end
         results[filepath] ||= Set.new
         results[filepath] << res
       end
@@ -92,15 +108,11 @@ 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]
 
-      coverage = lcov.coverage(filepath)
-
-      return unless include_file?(filepath)
-
       root_ast = Imagen::Node::Root.new.build_from_file(
         File.join(code_dir, filepath)
       )
@@ -108,14 +120,9 @@ module Undercover
 
       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)
-      fnmatch = proc { |glob| File.fnmatch(glob, filepath) }
-      glob_filters[:allow].any?(fnmatch) && glob_filters[:reject].none?(fnmatch)
-    end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/undercover.gemspec

@@ -32,4 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'imagen', '>= 0.2.0'
   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'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Jan Grodowski
 bindir: bin
 cert_chain: []
-date: 2025-03-29 00:00:00.000000000 Z
+date: 2025-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -91,6 +91,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov_json_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 email:
 - jgrodowski@gmail.com
 executables:
@@ -112,20 +140,23 @@ files:
 - README.md
 - Rakefile
 - bin/undercover
+- docs/actions.yml
 - docs/circleci_advanced.yml
 - docs/circleci_config.yml
-- docs/codeship.md
 - docs/screenshot_success.png
 - docs/screenshot_warnings.png
 - docs/semaphore.yml
-- docs/travis.yml
 - lib/undercover.rb
 - lib/undercover/changeset.rb
 - lib/undercover/cli.rb
+- lib/undercover/filter_set.rb
 - lib/undercover/formatter.rb
 - lib/undercover/lcov_parser.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
 - undercover.gemspec
 homepage: https://github.com/grodowski/undercover

data/docs/codeship.md

@@ -1,19 +0,0 @@
-Sample configuration to run `undercover` in Codeship CI. Edit these fields in **Project Settings**.
-
-**Setup commands**
-
-```
-rvm use 2.5.3 --install
-bundle install
-gem install undercover
-```
-
-**Test pipeline**
-
-```
-bundle exec rspec --format documentation --color
-# fetch origin/master to have a ref to compare against
-git remote set-branches --add origin master
-git fetch
-undercover -c origin/master
-```

data/docs/travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.2
-  - 2.5.5
-  - 2.4.5
-  - 2.3.7
-before_install:
-  - gem install bundler undercover --no-doc
-  - gem update --system
-script:
-  - bundle exec rake
-  - git fetch origin master:master
-  - undercover --compare master