undercover 0.3.4 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 876068f41c32798bbc3e6d2e37980021c5afebf2d7316700671741b64e4959ae
-  data.tar.gz: 55fea89d18b7e6feeac2821f97a008999c2442aac83b53239c353fb05d6875f2
+  metadata.gz: f6cd3608abfe38ef691799586ac21e0818846ea2b67e7867af9c917762c28de7
+  data.tar.gz: 434a7428414fe21d31e5cf691255f39f5abdc9a0e370f39a362d7ac6f90ae7a4
 SHA512:
-  metadata.gz: 1210f2973aee4c7bea1484c9eef36dce6bf8582eec0f9f95a94585bdc03cce9df7e5f8d750f33d2838f0329fd466e636fba7f05d2080c998717048a09520172f
-  data.tar.gz: 0cc9be1fa5e3fe60009b71a9b2212c24f2f3c7f20a8df674821dcbd2c2ca5e1157dc04ece674b221d8bbbcaab3f4cfb6084846241474d664e98b644484e77e08
+  metadata.gz: 18574633620761accff515e582f79949c7bd4deaae9f5e44dfdba03cddfeed39c76d271214be0bbccf6c51da1c0231bd290693679cfd182753b14102bc4dac0b
+  data.tar.gz: 05f18a34ffa46f66a4cb73c9143c0851e295ad60129e7969d2e72a6350af5a874713201797f75ff8bbcaebfe27918a322b75e3b5eb9508eb20140ca5ad82d0bf

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: rubocop
+    versions:
+    - 1.10.0
+    - 1.12.0
+    - 1.12.1
+    - 1.8.1
+    - 1.9.0

data/.github/workflows/ruby.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['2.7.x', '2.6.x', '2.5.x']
+        ruby: ['3.0.x', '2.7.x', '2.6.x', '2.5.x']
     steps:
       - uses: actions/checkout@v1
       - name: Set up Ruby ${{ matrix.ruby }}

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.7.0
+  NewCops: enable
+  TargetRubyVersion: 2.5.0
   Exclude:
     - spec/fixtures/**/*
 

data/CHANGELOG.md

@@ -6,6 +6,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+# [0.4.4] - 2021-11-29
+### Changed
+- Dependency updates
+
+# [0.4.3] - 2021-03-16
+### Fixed
+- Branch coverage without line coverage marked as uncovered - fix by @GCorbel
+
+# [0.4.1] - 2021-03-11
+### Fixed
+- Fix zero-division edge case resulting in NaN from Result#coverage_f
+
+# [0.4.0] - 2021-02-06
+### Added
+- [Minimal implementation of branch coverage in LCOV parser](https://github.com/grodowski/undercover/pull/112) by [@magneland](https://github.com/magneland)
+- Branch coverage output support in Undercover::Formatter
+### Changed
+- Min Ruby requirement bumped to 2.5.0
+- Dependency updates: Rubocop 1.0 and Rugged 1.1.0
+
+
 ## [0.3.4] - 2020-04-05
 ### Changed
 - Updated parsing performance by scoping `all_results` to git diff
@@ -86,7 +107,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.3.4...HEAD
+[Unreleased]: https://github.com/grodowski/undercover/compare/v0.4.4...HEAD
+[0.4.3]: https://github.com/grodowski/undercover/compare/v0.4.3...v0.4.4
+[0.4.3]: https://github.com/grodowski/undercover/compare/v0.4.1...v0.4.3
+[0.4.1]: https://github.com/grodowski/undercover/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/grodowski/undercover/compare/v0.3.4...v0.4.0
 [0.3.4]: https://github.com/grodowski/undercover/compare/v0.3.3...v0.3.4
 [0.3.3]: https://github.com/grodowski/undercover/compare/v0.3.2...v0.3.3
 [0.3.2]: https://github.com/grodowski/undercover/compare/v0.3.1...v0.3.2

data/README.md

@@ -1,8 +1,9 @@
 # undercover 👮‍♂️
 
-**Like RuboCop but for code coverage**
+**Like RuboCop but for code coverage**. Inspects files in a git diff and warns on changed methods, classes and blocks which need to be tested. Use it locally or as part of an automated build to shorten your code coverage feedback loop!
 
-**Inspects files in a git diff and warns on methods, classes and blocks which need test coverage.** Use it locally or as part of an automated build to shorten your code coverage feedback loop!
+- Visit **[https://undercover-ci.com](https://undercover-ci.com)** to set up actionable GitHub code review checks, or use one of the [integrations](#code-review-integrations)
+- Learn how to find untested code changes locally with the [CLI](#usage)
 
 A sample output of `undercover` ran before a commit may look like this:
 
@@ -14,7 +15,6 @@ And like this, given that specs were added:
 
 [![Build Status](https://action-badges.now.sh/grodowski/undercover)](https://github.com/grodowski/undercover/actions)
 [![Maintainability](https://api.codeclimate.com/v1/badges/b403feed68a18c072ec5/maintainability)](https://codeclimate.com/github/grodowski/undercover/maintainability)
-[![codebeat badge](https://codebeat.co/badges/be548247-2421-4448-bdab-896d13eb02e9)](https://codebeat.co/projects/github-com-grodowski-undercover-master)
 
 ## Installation
 
@@ -51,6 +51,7 @@ SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
 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'
@@ -83,6 +84,15 @@ Check out `docs/` for CI configuration examples:
 
 Merging coverage results ([sample gist](https://gist.github.com/grodowski/9744ff91034dce8df20c2a8210409fb0)) is required for parallel tests before processing with `undercover`.
 
+## Code review integrations
+
+A few options exist to provide automated comments from `undercover` in Pull Request reviews, which is the most streamlined way to add Undercover to your development workflow.
+
+- [UndercoverCI](https://undercover-ci.com) - `undercover` Pull Request feedback delivered natively with GitHub Checks
+- [pronto-undercover](https://github.com/grodowski/pronto-undercover)
+- [danger-undercover](https://github.com/nimblehq/danger-undercover)
+- [undercover-checkstyle](https://github.com/aki77/undercover-checkstyle)
+
 ## Configuration
 
 ### CLI Options

data/lib/undercover/changeset.rb

@@ -12,7 +12,8 @@ module Undercover
     include Enumerable
 
     attr_reader :files
-    def_delegators :files, :each, :'<=>'
+
+    def_delegators :files, :each, :<=>
 
     def initialize(dir, compare_base = nil)
       @dir = dir

data/lib/undercover/cli.rb

@@ -10,8 +10,8 @@ module Undercover
 
     WARNINGS_TO_S = {
       stale_coverage: Rainbow('🚨 WARNING: Coverage data is older than your ' \
-        'latest changes and results might be incomplete. ' \
-        'Re-run tests to update').yellow,
+                              'latest changes and results might be incomplete. ' \
+                              'Re-run tests to update').yellow,
       no_changes: Rainbow('✅ No reportable changes').green
     }.freeze
     def self.run(args)

data/lib/undercover/formatter.rb

@@ -18,20 +18,20 @@ module Undercover
       @results.map.with_index(1) do |res, idx|
         "🚨 #{idx}) node `#{res.node.name}` type: #{res.node.human_name},\n" +
           (' ' * pad_size) + "loc: #{res.file_path_with_lines}," \
-          " coverage: #{res.coverage_f * 100}%\n" +
+                             " coverage: #{res.coverage_f * 100}%\n" +
           res.pretty_print
       end
     end
 
     def success
       "#{Rainbow('undercover').bold.green}: ✅ No coverage" \
-      ' is missing in latest changes'
+        ' is missing in latest changes'
     end
 
     def warnings_header
       "#{Rainbow('undercover').bold.red}: " \
-      '👮‍♂️ some methods have no test coverage! Please add specs for' \
-      ' methods listed below'
+        '👮‍♂️ some methods have no test coverage! Please add specs for' \
+        ' methods listed below'
     end
 
     def pad_size

data/lib/undercover/lcov_parser.rb

@@ -31,7 +31,7 @@ module Undercover
 
     private
 
-    # rubocop:disable Metrics/MethodLength, Style/SpecialGlobalVars
+    # rubocop:disable Metrics/MethodLength, Style/SpecialGlobalVars, Metrics/AbcSize
     def parse_line(line)
       case line
       when /^SF:(.+)/
@@ -41,12 +41,20 @@ module Undercover
         line_no = $~[1]
         covered = $~[2]
         source_files[@current_filename] << [line_no.to_i, covered.to_i]
+      when /^(BRF|BRH):(\d+)/
+        # branches found/hit; no-op
+      when /^BRDA:(\d+),(\d+),(\d+),(-|\d+)/
+        line_no = $~[1]
+        block_no = $~[2]
+        branch_no = $~[3]
+        covered = ($~[4] == '-' ? '0' : $~[4])
+        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
       else
         raise LcovParseError, "could not recognise '#{line}' as valid LCOV"
       end
     end
-    # rubocop:enable Metrics/MethodLength, Style/SpecialGlobalVars
+    # rubocop:enable Metrics/MethodLength, Style/SpecialGlobalVars, Metrics/AbcSize
   end
 end

data/lib/undercover/options.rb

@@ -74,7 +74,7 @@ module Undercover
     def args_from_options_file(path)
       return [] unless File.exist?(path)
 
-      File.read(path).split('\n').flat_map { |line| line.split(' ') }
+      File.read(path).split('\n').flat_map(&:split)
     end
 
     def project_options_file

data/lib/undercover/result.rb

@@ -27,28 +27,38 @@ module Undercover
       @flagged
     end
 
-    # TODO: make DRY
-    def non_code?(line_no)
-      line_cov = coverage.find { |ln, _cov| ln == line_no }
-      !line_cov
-    end
-
-    def covered?(line_no)
-      line_cov = coverage.find { |ln, _cov| ln == line_no }
-      line_cov && line_cov[1].positive?
-    end
-
+    # rubocop:disable Metrics/CyclomaticComplexity
     def uncovered?(line_no)
-      line_cov = coverage.find { |ln, _cov| ln == line_no }
+      # check branch coverage for line_no
+      coverage.each do |ln, _block, _branch, cov|
+        return true if ln == line_no && cov && cov.zero?
+      end
+
+      # check line coverage for line_no
+      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
-      covered = coverage.reduce(0) do |sum, (_, cov)|
-        sum + [[0, cov].max, 1].min
+      lines = {}
+      coverage.each do |ln, block_or_line_cov, _, branch_cov|
+        lines[ln] = 1 unless lines.key?(ln)
+        if branch_cov
+          lines[ln] = 0 if branch_cov.zero?
+        elsif block_or_line_cov.zero?
+          lines[ln] = 0
+        end
       end
-      (covered.to_f / coverage.size).round(4)
+      return 1.0 if lines.keys.size.zero?
+
+      (lines.values.sum.to_f / lines.keys.size).round(4)
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     # TODO: create a formatter interface instead and add some tests.
     # TODO: re-enable rubocops
@@ -60,10 +70,10 @@ module Undercover
       cov_enum = coverage.each
       cov_source_lines = (node.first_line..node.last_line).map do |line_no|
         cov_line_no = begin
-                        cov_enum.peek[0]
-                      rescue StopIteration
-                        -1
-                      end
+          cov_enum.peek[0]
+        rescue StopIteration
+          -1
+        end
         cov_enum.next[1] if cov_line_no == line_no
       end
       cov_source_lines.zip(node.source_lines_with_numbers)
@@ -81,10 +91,12 @@ 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")
     end
@@ -99,5 +111,23 @@ module Undercover
         " name: #{node.name}, coverage: #{coverage_f}>"
     end
     alias to_s inspect
+
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def count_covered_branches(line_number)
+      branches = coverage.select { |cov| cov.size == 4 && cov[0] == line_number }
+      count_covered = branches.count { |cov| cov[3].positive? }
+
+      return '' if branches.size.zero?
+
+      if count_covered < branches.size
+        Rainbow(' branches: ').italic.darkgray.dark + \
+          Rainbow("#{count_covered}/#{branches.size}").italic.red
+      else
+        Rainbow(" branches: #{count_covered}/#{branches.size}").italic.darkgray.dark
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/undercover/version.rb

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

data/lib/undercover.rb

@@ -36,7 +36,7 @@ module Undercover
       @results = {}
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
     def build
       changeset.each_changed_line do |filepath, line_no|
         dist_from_line_no = lambda do |res|
@@ -61,7 +61,7 @@ module Undercover
       end
       self
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity
 
     def build_warnings
       warn('Undercover::Report#build_warnings is deprecated! ' \

data/undercover.gemspec

@@ -23,18 +23,20 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.5.0'
+
   spec.add_dependency 'imagen', '>= 0.1.8'
   spec.add_dependency 'rainbow', '>= 2.1', '< 4.0'
-  spec.add_dependency 'rugged', '>= 0.27', '< 1.1'
+  spec.add_dependency 'rugged', '>= 0.27', '< 1.3'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.81.0'
+  spec.add_development_dependency 'rubocop', '~> 1.22.1'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-html'
-  spec.add_development_dependency 'simplecov-lcov'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
   spec.add_development_dependency 'timecop'
 end
 # rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.4
 platform: ruby
 authors:
 - Jan Grodowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-05 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imagen
@@ -53,7 +53,7 @@ dependencies:
         version: '0.27'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: '0.27'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 1.22.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.81.0
+        version: 1.22.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -166,16 +166,16 @@ dependencies:
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +199,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codebeatsettings"
+- ".github/dependabot.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".overcommit.yml"
@@ -238,14 +239,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Actionable code coverage - detects untested code blocks in recent changes