undercover 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba2a988ce8b2ef9451615675538b268f4d663cb141288a646b2604785ea92dc6
-  data.tar.gz: 6822d32d0b2000e711194c0d595b2f69dcaa3020740db9613be8f6fceea1e4e9
+  metadata.gz: c860e600589d92698fa5df94b1b8fe9283cbb00cdc595410b9c3a413d74b3095
+  data.tar.gz: e2c26b709c691201f473846e0cb6a7fa6844c5d1dc73169ca533d95482182f6c
 SHA512:
-  metadata.gz: 8ada6a585eee4ff30f9a520dde96f0b3b74bd11ab05a9e7857b356da7c00519e81d36dda12ddd4c7afde81b23cb73bc1c88a35f2f559f1cf9a638c42eab48052
-  data.tar.gz: 6c846695987c6126e7db5c7c363e44756f57aaf34374157bd35c0e723469f705a625244e90818a39b07e5626df8b34f248796405f95a5c9ed884e4760af304f3
+  metadata.gz: ace70eb4f75d2d57bda9d906925a7b5525c5a67520380ba0327a5344ed6718b79ea2587a5a0fb4d2a09d430d09b30eb2d1ac63c503be17197ff9c6455ab12b00
+  data.tar.gz: a2ec9a3b4d27cb9eaa7b4595f71ff9b12108e939864a6f5279aece22cd728e358dd50b16e63d0537780154e3ffd20e0712bce8322a8591e4f08f70d9d6818145

data/.github/dependabot.yml

@@ -14,3 +14,7 @@ updates:
     - 1.12.1
     - 1.8.1
     - 1.9.0
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "weekly"

data/.github/workflows/ruby.yml

@@ -7,7 +7,7 @@ jobs:
       matrix:
         ruby: ['3.3', '3.0']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0 # fetch all since test fixtures depend on history
       - name: Set up Ruby ${{ matrix.ruby }}
@@ -23,20 +23,20 @@ jobs:
         run: |
           git fetch --update-head-ok origin master:master
           undercover --compare master
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
-          name: undercover.lcov
+          name: undercover-${{ matrix.ruby }}.lcov
           path: coverage/lcov/undercover.lcov
   coverage:
     runs-on: ubuntu-latest
     needs: build
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
-          name: undercover.lcov
+          name: undercover-3.3.lcov
       - name: Upload coverage
         run: |
           ruby -e "$(curl -s https://undercover-ci.com/uploader.rb)" -- \
             --repo grodowski/undercover \
-            --commit $GITHUB_SHA \
+            --commit ${{ github.event.pull_request.head.sha || github.sha }} \
             --lcov /home/runner/work/undercover/undercover/undercover.lcov

data/.rubocop.yml

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

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.0
+ruby 3.3.3

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+# [0.6.0] - 2024-12-12
+### Added
+- Add support for including and exluding files by glob patterns, supplied through CLI args and the configuration file (#146)
+
+### Fixed
+- Files that were changed but don't appear in the coverage report at all will now be reported as uncovered, as expected.
+- Fixed an issue where top-level methods were not being considered [#135](https://github.com/grodowski/undercover/issues/135). This was caused by a bug in the tree traversal logic.
+- Fixed a bug where `--compare` didn't work with grafted commits as there was no merge base available ([#175](https://github.com/grodowski/undercover/issues/175)). Now it's possible to pass a graft commit as `--compare` which enables `undercover` to work with shallow clones.
+
 # [0.5.0] - 2024-01-09
 ### Changed
 - Drop ruby 2.x support, require ruby 3.x in gemspec
@@ -128,7 +137,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.5.0...HEAD
+[Unreleased]: https://github.com/grodowski/undercover/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/grodowski/undercover/compare/v0.6.0...v0.5.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

@@ -1,6 +1,6 @@
 ![logo](https://github.com/grodowski/undercover/assets/4991698/c4bf038b-4472-4406-8f1f-5ddc812908d6)
 
-`undercover` warns about methods, classes and blocks that **were changed without tests**, to help you easily find untested code and reduce the number of bugs. It does so by analysing data from git diffs, code structure and SimpleCov coverage reports. 
+`undercover` warns about methods, classes and blocks that **were changed without tests**, to help you easily find untested code and reduce the number of bugs. It does so by analysing data from git diffs, code structure and SimpleCov coverage reports.
 
 Works with any Ruby CI pipeline as well as locally as a CLI.
 
@@ -104,12 +104,14 @@ A few options exist to provide automated comments from `undercover` in Pull Requ
 Options can be passed when running the command from the command line:
 
 ```sh
-undercover -h
 Usage: undercover [options]
     -l, --lcov path                  LCOV report file path
     -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
+    -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
         --version                    Show version
 ```

data/lib/undercover/changeset.rb

@@ -74,7 +74,9 @@ module Undercover
     def compare_base_obj
       return nil unless compare_base
 
-      repo.lookup(repo.merge_base(compare_base.to_s, head))
+      merge_base = repo.merge_base(compare_base.to_s, head)
+      # merge_base may be nil with --depth 1, compare two refs directly
+      merge_base ? repo.lookup(merge_base) : repo.rev_parse(compare_base)
     end
 
     def head

data/lib/undercover/options.rb

@@ -4,7 +4,7 @@ require 'optparse'
 require 'pathname'
 
 module Undercover
-  class Options
+  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
@@ -17,7 +17,15 @@ module Undercover
       # OUTPUT_CIRCLEMATOR = :circlemator # posts warnings as review comments
     ].freeze
 
-    attr_accessor :lcov, :path, :git_dir, :compare, :syntax_version
+    DEFAULT_FILE_INCLUDE_GLOBS = %w[*.rb *.rake *.ru Rakefile].freeze
+
+    attr_accessor :lcov,
+                  :path,
+                  :git_dir,
+                  :compare,
+                  :syntax_version,
+                  :glob_allow_filters,
+                  :glob_reject_filters
 
     def initialize
       # TODO: use run modes
@@ -27,6 +35,8 @@ module Undercover
       # set defaults
       self.path = '.'
       self.git_dir = '.git'
+      self.glob_allow_filters = DEFAULT_FILE_INCLUDE_GLOBS
+      self.glob_reject_filters = []
     end
 
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
@@ -51,9 +61,7 @@ module Undercover
         git_dir_option(opts)
         compare_option(opts)
         ruby_syntax_option(opts)
-        # TODO: parse dem other options and assign to self
-        # --quiet (skip progress bar)
-        # --exit-status (do not print report, just exit)
+        file_filters(opts)
       end.parse(args)
 
       guess_lcov_path unless lcov
@@ -119,5 +127,18 @@ module Undercover
       cwd = Pathname.new(File.expand_path(path))
       self.lcov = File.join(cwd, 'coverage', 'lcov', "#{cwd.split.last}.lcov")
     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(',')
+      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(',')
+      end
+    end
   end
 end

data/lib/undercover/result.rb

@@ -13,7 +13,7 @@ module Undercover
     def initialize(node, file_cov, file_path)
       @node = node
       @coverage = file_cov.select do |ln, _|
-        first_line == last_line ? ln == first_line : ln > first_line && ln < last_line
+        (node.empty_def? ? ln >= first_line : ln > first_line) && ln < last_line
       end
       @file_path = file_path
       @flagged = false
@@ -27,8 +27,9 @@ module Undercover
       @flagged
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def uncovered?(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?
@@ -38,13 +39,14 @@ module Undercover
       line_cov = coverage.select { |cov| cov.size == 2 }.find { |ln, _cov| ln == line_no }
       line_cov && line_cov[1].zero?
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     # Method `coverage_f` returns the total coverage of this Undercover::Result
     # as a % value, taking into account missing branches. Line coverage will be counted
     # as 0 if any branch is untested.
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def coverage_f
+      return 0.0 if coverage.empty?
+
       lines = {}
       coverage.each do |ln, block_or_line_cov, _, branch_cov|
         lines[ln] = 1 unless lines.key?(ln)
@@ -54,7 +56,6 @@ module Undercover
           lines[ln] = 0
         end
       end
-      return 1.0 if lines.keys.empty?
 
       (lines.values.sum.to_f / lines.keys.size).round(4)
     end
@@ -87,14 +88,14 @@ module Undercover
         if line.strip.empty?
           Rainbow(formatted_line).darkgray.dark
         elsif covered.nil?
-          Rainbow(formatted_line).darkgray.dark + \
+          Rainbow(formatted_line).darkgray.dark +
             Rainbow(' hits: n/a').italic.darkgray.dark
         elsif covered.positive?
-          Rainbow(formatted_line).green + \
+          Rainbow(formatted_line).green +
             Rainbow(" hits: #{covered}").italic.darkgray.dark + \
             count_covered_branches(num)
         elsif covered.zero?
-          Rainbow(formatted_line).red + \
+          Rainbow(formatted_line).red +
             Rainbow(" hits: #{covered}").italic.darkgray.dark + \
             count_covered_branches(num)
         end
@@ -122,7 +123,7 @@ module Undercover
       return '' if branches.empty?
 
       if count_covered < branches.size
-        Rainbow(' branches: ').italic.darkgray.dark + \
+        Rainbow(' branches: ').italic.darkgray.dark +
           Rainbow("#{count_covered}/#{branches.size}").italic.red
       else
         Rainbow(" branches: #{count_covered}/#{branches.size}").italic.darkgray.dark

data/lib/undercover/version.rb

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

data/lib/undercover.rb

@@ -22,7 +22,8 @@ module Undercover
     attr_reader :changeset,
                 :lcov,
                 :results,
-                :code_dir
+                :code_dir,
+                :glob_filters
 
     # Initializes a new Undercover::Report
     #
@@ -32,11 +33,15 @@ module Undercover
       @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
+      }
       @loaded_files = {}
       @results = {}
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def build
       changeset.each_changed_line do |filepath, line_no|
         dist_from_line_no = lambda do |res|
@@ -50,6 +55,7 @@ module Undercover
         dist_from_line_no_sorter = lambda do |res1, res2|
           dist_from_line_no[res1] <=> dist_from_line_no[res2]
         end
+
         load_and_parse_file(filepath)
 
         next unless loaded_files[filepath]
@@ -61,7 +67,7 @@ module Undercover
       end
       self
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
     def build_warnings
       warn('Undercover::Report#build_warnings is deprecated! ' \
@@ -92,7 +98,8 @@ module Undercover
       return if loaded_files[key]
 
       coverage = lcov.coverage(filepath)
-      return if coverage.empty?
+
+      return unless include_file?(filepath)
 
       root_ast = Imagen::Node::Root.new.build_from_file(
         File.join(code_dir, filepath)
@@ -106,5 +113,10 @@ module Undercover
       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
   end
 end

data/undercover.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_dependency 'bigdecimal'
-  spec.add_dependency 'imagen', '>= 0.1.8'
+  spec.add_dependency 'imagen', '>= 0.2.0'
   spec.add_dependency 'rainbow', '>= 2.1', '< 4.0'
   spec.add_dependency 'rugged', '>= 0.27', '< 1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jan Grodowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Actionable code coverage - detects untested code blocks in recent changes