undercover 0.6.3 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6858f42ada692894674f818d7713d20e8239051d06547f72e721f6122dda53be
-  data.tar.gz: ef323b826f66d68a5ad0a5a7c14f5d37d3a85344f0efe82ac457181745000fb9
+  metadata.gz: 514293d0be75c8d741a434a7d01b338f4b7ea2cf1b8b91ada91ec698531252f4
+  data.tar.gz: 3c2b19dd909af9a37f5f5c1e3a1aba8f0cea06f91eb37a10df2d6646a2e6144b
 SHA512:
-  metadata.gz: 365149055a1553d4bc6dfde0475cd4b1bc6a3a82c7a0cb5c5fbcf7604c078e320bafcd85b783d495bc4667bff58c0ebffeb5ec76a982c61bcb366e8a9a8edc18
-  data.tar.gz: d5d7ec83fd50f1504f38bdd9961be84d365d5f3882045a1028f3daf45cd309a5ded497941e723cf3f3ce0eb335dfba34310f69b3d5efb91b0013fc5f69cc77a8
+  metadata.gz: a877a890d2992f62496dc64d5a93a04488fd8f7820a3ca4f673d71446bd53dc756117a50c4ae6504f891aebf4547472569bf8c9d7cd5b489eccc22d8affa0711
+  data.tar.gz: 2c1d6b90e6f4bad580581d85a928ff607728950c562a02aad160c2534ced6b68ed8c43e5f97b48a7dcd1618988b81c179676f36b4ceccbe8a83107bc42a85922

data/.github/workflows/ruby.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['3.3', '3.0']
+        ruby: ['3.4', '3.0']
     steps:
       - uses: actions/checkout@v4
         with:
@@ -33,7 +33,7 @@ jobs:
     steps:
       - uses: actions/download-artifact@v4
         with:
-          name: undercover-3.3.lcov
+          name: undercover-3.4.lcov
       - name: Upload coverage
         run: |
           ruby -e "$(curl -s https://undercover-ci.com/uploader.rb)" -- \

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.3
+ruby 3.4.2

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+# [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
+- Fix more false positives due to source file / coverage locator issues ([#222](https://github.com/grodowski/undercover/issues/222))
+
 # [0.6.3] - 2024-12-23
 
 ### Fixed
@@ -143,9 +153,11 @@ 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.6.5...HEAD
+[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/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:
@@ -110,6 +109,7 @@ Usage: undercover [options]
     -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/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,18 +27,25 @@ 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
@@ -68,7 +56,7 @@ module Undercover
     # 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 +71,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

@@ -20,7 +20,6 @@ module Undercover
 
       run_report(opts)
     end
-    # rubocop:enable
 
     def self.run_report(opts)
       report = Undercover::Report.new(changeset(opts), opts).build
@@ -44,7 +43,8 @@ module Undercover
 
     def self.changeset(opts)
       git_dir = File.join(opts.path, opts.git_dir)
-      Undercover::Changeset.new(git_dir, opts.compare)
+      filter_set = Undercover::FilterSet.new(opts.glob_allow_filters, opts.glob_reject_filters)
+      Undercover::Changeset.new(git_dir, opts.compare, filter_set)
     end
   end
 end

data/lib/undercover/filter_set.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Undercover
+  class FilterSet
+    attr_reader :allow_filters, :reject_filters
+
+    def initialize(allow_filters, reject_filters)
+      @allow_filters = allow_filters || []
+      @reject_filters = reject_filters || []
+    end
+
+    def include?(filepath)
+      fnmatch = proc { |glob| File.fnmatch(glob, filepath) }
+      allow_filters.any?(fnmatch) && reject_filters.none?(fnmatch)
+    end
+  end
+end

data/lib/undercover/options.rb

@@ -5,16 +5,29 @@ require 'pathname'
 
 module Undercover
   class Options # rubocop:disable Metrics/ClassLength
-    RUN_MODE = [
-      RUN_MODE_DIFF_STRICT = :diff_strict, # warn for changed lines
-      # RUN_MODE_DIFF_FILES  = :diff_files, # warn for changed whole files
-      # RUN_MODE_ALL         = :diff_all, # warn for allthethings
-      # RUN_MODE_FILES       = :files # warn for specific files (cli option)
+    DIFF_TRIGGER_MODE = [
+      # Default, analyse all code blocks with changed lines. Untested lines and branches will trigger warnings if they
+      # strictly belong to the diff.
+      DIFF_TRIGGER_LINE = :diff_trigger_line,
+      #
+      # Doesn't exist yet
+      # Analyse all code blocks with changed lines. Untested lines and branches always trigger warnings for code block.
+      # DIFF_TRIGGER_BLOCK = :diff_trigger_block,
+      # Analyse all code blocks in each changed file.
+      # DIFF_TRIGGER_FILE = :diff_trigger_file,
+      # Analyse all code blocks in all files, ignores current diff (use --include-files and --exclude-files for control)
+      # ALL = :all,
     ].freeze
 
-    OUTPUT_FORMATTERS = [
-      OUTPUT_STDOUT = :stdout, # outputs warnings to stdout with exit 1
-      # OUTPUT_CIRCLEMATOR = :circlemator # posts warnings as review comments
+    FILE_SCOPE = [
+      # Extended scope helps identify Ruby files that are not required in the test suite.
+      # Warning: currently doesn't respect :nocov: syntax in files not traced by SimpleCov.
+      # (use --include-files and --exclude-files for control)
+      FILE_SCOPE_EXTENDED = :scope_extended,
+      #
+      # Doesn't exist yet
+      # Analyse file that appear in coverage reports. Historically, the default undercover mode.
+      # FILE_SCOPE_COVERAGE = :scope_coverage,
     ].freeze
 
     DEFAULT_FILE_INCLUDE_GLOBS = %w[*.rb *.rake *.ru Rakefile].freeze
@@ -25,19 +38,21 @@ module Undercover
                   :git_dir,
                   :compare,
                   :syntax_version,
+                  :run_mode,
+                  :file_scope,
                   :glob_allow_filters,
-                  :glob_reject_filters
+                  :glob_reject_filters,
+                  :max_warnings_limit
 
     def initialize
-      # TODO: use run modes
-      # TODO: use formatters
-      @run_mode = RUN_MODE_DIFF_STRICT
-      @enabled_formatters = [OUTPUT_STDOUT]
+      @run_mode = DIFF_TRIGGER_LINE
+      @file_scope = FILE_SCOPE_EXTENDED
       # set defaults
       self.path = '.'
       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
@@ -62,6 +77,7 @@ module Undercover
         git_dir_option(opts)
         compare_option(opts)
         ruby_syntax_option(opts)
+        max_warnings_limit_option(opts)
         file_filters(opts)
       end.parse(args)
 
@@ -124,6 +140,13 @@ 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_lcov_path
       cwd = Pathname.new(File.expand_path(path))
       self.lcov = File.join(cwd, 'coverage', 'lcov', "#{cwd.split.last}.lcov")

data/lib/undercover/result.rb

@@ -10,13 +10,13 @@ module Undercover
 
     def_delegators :node, :first_line, :last_line, :name
 
-    def initialize(node, file_cov, file_path) # rubocop:disable Metrics/MethodLength
+    def initialize(node, file_cov, file_path) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
       @node = node
       @coverage = file_cov.select do |ln, _|
         if first_line == last_line
           ln == first_line
-        elsif node.empty_def?
-          ln >= first_line
+        elsif node.empty_def? || node.is_a?(Imagen::Node::Block)
+          ln >= first_line && ln <= last_line # rubocop:disable Style/ComparableBetween
         else
           ln > first_line && ln < last_line
         end
@@ -98,11 +98,11 @@ module Undercover
             Rainbow(' hits: n/a').italic.darkgray.dark
         elsif covered.positive?
           Rainbow(formatted_line).green +
-            Rainbow(" hits: #{covered}").italic.darkgray.dark + \
+            Rainbow(" hits: #{covered}").italic.darkgray.dark +
             count_covered_branches(num)
         elsif covered.zero?
           Rainbow(formatted_line).red +
-            Rainbow(" hits: #{covered}").italic.darkgray.dark + \
+            Rainbow(" hits: #{covered}").italic.darkgray.dark +
             count_covered_branches(num)
         end
       end.join("\n")

data/lib/undercover/version.rb

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

data/lib/undercover.rb

@@ -12,6 +12,7 @@ require 'undercover/cli'
 require 'undercover/changeset'
 require 'undercover/formatter'
 require 'undercover/options'
+require 'undercover/filter_set'
 require 'undercover/version'
 
 module Undercover
@@ -23,7 +24,8 @@ module Undercover
                 :lcov,
                 :results,
                 :code_dir,
-                :glob_filters
+                :filter_set,
+                :max_warnings_limit
 
     # Initializes a new Undercover::Report
     #
@@ -32,18 +34,19 @@ module Undercover
     def initialize(changeset, opts)
       @lcov = LcovParser.parse(File.open(opts.lcov))
       @code_dir = opts.path
-      @changeset = changeset.update
-      @glob_filters = {
-        allow: opts.glob_allow_filters,
-        reject: opts.glob_reject_filters
-      }
+      @changeset = changeset
+      @filter_set = FilterSet.new(opts.glob_allow_filters, opts.glob_reject_filters)
+      @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 +64,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.flag
+          flag_count += 1
+        end
         results[filepath] ||= Set.new
         results[filepath] << res
       end
@@ -107,16 +113,14 @@ module Undercover
       return if root_ast.children.empty?
 
       loaded_files[key] = []
-      # TODO: children[0] ignores the lonely_method (see spec fixtures)!
-      root_ast.children[0].find_all(->(_) { true }).each do |imagen_node|
+      root_ast.find_all(->(node) { !node.is_a?(Imagen::Node::Root) }).each do |imagen_node|
         loaded_files[key] << Result.new(imagen_node, coverage, 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)
+      filter_set.include?(filepath)
     end
   end
 end

data/undercover.gemspec

@@ -27,8 +27,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 3.0.0'
 
+  spec.add_dependency 'base64'
   spec.add_dependency 'bigdecimal'
   spec.add_dependency 'imagen', '>= 0.2.0'
   spec.add_dependency 'rainbow', '>= 2.1', '< 4.0'
-  spec.add_dependency 'rugged', '>= 0.27', '< 1.8'
+  spec.add_dependency 'rugged', '>= 0.27', '< 1.10'
 end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.5
 platform: ruby
 authors:
 - Jan Grodowski
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-23 00:00:00.000000000 Z
+date: 2025-07-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: bigdecimal
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +80,7 @@ dependencies:
         version: '0.27'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,8 +90,7 @@ dependencies:
         version: '0.27'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.8'
-description:
+        version: '1.10'
 email:
 - jgrodowski@gmail.com
 executables:
@@ -110,6 +122,7 @@ files:
 - 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
@@ -121,7 +134,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,8 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Actionable code coverage - detects untested code blocks in recent changes
 test_files: []