undercover 0.6.4 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a3601cf9aa4d26cee9c04f12b44273f8a67e0e8584b020e4e9bb763e03bf24e
-  data.tar.gz: 8198c30de2bc16734a1575b7aa0213c25ccafe120848dad9c24257d688b7bca9
+  metadata.gz: 6d4fbea540abf1922afa393179a770aa7468bb030085495c4be1daad89bafaaa
+  data.tar.gz: a815eb262c6b848fe21420d1626ba4e1b43dadf025e095380acb7b0fb6fe5e07
 SHA512:
-  metadata.gz: 6e6a60fad9a478c37895ae24035022a9acf86f789ce0d798194b6d13b82c7db52c9de6590a9a9d3b8a84d304f220a30ef2c8e5226bab6fa58cea96f09c3856ca
-  data.tar.gz: fd1ca272d59b29debe708bd2f8df2bf867dccc60484416002dbf004d21ea83370e408e7703098f8d6e2ff0345d2234a7e662f94254a7dcc339f7370bae9f9885
+  metadata.gz: 625346ca6e5b042b1658e58e82be45e4c5a5528843f4a7112b079fd244b99282965e96f47f67ff54cd341e2ce7e8d2d16c559bfbbda9d5483ed44a6ed847c814
+  data.tar.gz: 307d626ae101ae1d7136f2fa6247f317b9a3bd072c7f0da936f32dc0d7910ada7b9c9f8b04fe66ae2cc79fe0387cc0575f303af06bf67e729fd6e9174f3aacd4

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+# [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 +157,12 @@ 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.6...HEAD
+[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/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

@@ -43,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

@@ -41,7 +41,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 +52,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
@@ -75,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)
 
@@ -137,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Undercover
-  VERSION = '0.6.4'
+  VERSION = '0.6.6'
 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.flagged?
+          res.flag
+          flag_count += 1
+        end
         results[filepath] ||= Set.new
         results[filepath] << res
       end
@@ -114,8 +120,7 @@ module Undercover
     # 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.6
 platform: ruby
 authors:
 - Jan Grodowski
 bindir: bin
 cert_chain: []
-date: 2025-03-29 00:00:00.000000000 Z
+date: 2025-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -122,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