undercover 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff312e0fdc1d61bc1ac46a49812fe490bc57d095f660ba38df00686b1d08a28
-  data.tar.gz: b8df1a289dd957868632ecb1aea06033b6945e75357163f1007136ccae94d9b3
+  metadata.gz: ba2a988ce8b2ef9451615675538b268f4d663cb141288a646b2604785ea92dc6
+  data.tar.gz: 6822d32d0b2000e711194c0d595b2f69dcaa3020740db9613be8f6fceea1e4e9
 SHA512:
-  metadata.gz: b4fee8956df8fd10483e7c6af403859c1e93775fe8d322b3709f22d38b14cbcd4139aea072692eb5bb754f1d581ebf7123352b63d5641c0f7810ee9ba3a577a2
-  data.tar.gz: 1dfced71df7fb571add736bb31877ae5c3116796c3c3a888db9e3e1d6f8c7ad92809f47dce700ead01064299706a6edf0347d8333ba8218ec8696512de5ca854
+  metadata.gz: 8ada6a585eee4ff30f9a520dde96f0b3b74bd11ab05a9e7857b356da7c00519e81d36dda12ddd4c7afde81b23cb73bc1c88a35f2f559f1cf9a638c42eab48052
+  data.tar.gz: 6c846695987c6126e7db5c7c363e44756f57aaf34374157bd35c0e723469f705a625244e90818a39b07e5626df8b34f248796405f95a5c9ed884e4760af304f3

data/.github/workflows/ruby.yml

@@ -5,9 +5,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['3.2', '3.0', '2.7']
+        ruby: ['3.3', '3.0']
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # fetch all since test fixtures depend on history
       - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
@@ -19,9 +21,9 @@ jobs:
           bundle exec rake
       - name: undercover (local)
         run: |
-          git fetch origin master:master
+          git fetch --update-head-ok origin master:master
           undercover --compare master
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         with:
           name: undercover.lcov
           path: coverage/lcov/undercover.lcov
@@ -29,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v3
         with:
           name: undercover.lcov
       - name: Upload coverage

data/.rubocop.yml

@@ -1,8 +1,9 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7.0
+  TargetRubyVersion: 3.0
   Exclude:
     - spec/fixtures/**/*
+  SuggestExtensions: false
 
 Style/RegexpLiteral:
   EnforcedStyle: slashes

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.0

data/CHANGELOG.md

@@ -6,8 +6,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+# [0.5.0] - 2024-01-09
+### Changed
+- Drop ruby 2.x support, require ruby 3.x in gemspec
+- Dev dependency updates
+
+# [0.4.7] - 2024-01-08
+### Fixed
+- [Update of one-line block is ignored](https://github.com/grodowski/undercover/pull/207) by [@lizhangyuh](https://github.com/lizhangyuh)
+
+# [0.4.6] - 2023-04-21
+### Added
+- #total_coverage and #total_branch_coverage in the LcovParser
+
 ### Changed
 - Drop support for ruby < 2.7
+- Test coverage with both local `undercover` and Undercover GitHub App for demo purposes
 
 # [0.4.5] - 2022-07-28
 ### Changed
@@ -114,7 +128,10 @@ 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.4.4...HEAD
+[Unreleased]: https://github.com/grodowski/undercover/compare/v0.5.0...HEAD
+[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
 [0.4.5]: https://github.com/grodowski/undercover/compare/v0.4.4...v0.4.5
 [0.4.4]: 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

data/Gemfile

@@ -3,3 +3,14 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'base64'
+gem 'bundler'
+gem 'pry'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'simplecov'
+gem 'simplecov-html'
+gem 'simplecov-lcov', '~> 0.8'
+gem 'timecop'

data/README.md

@@ -1,16 +1,17 @@
-# undercover 👮‍♂️
+![logo](https://github.com/grodowski/undercover/assets/4991698/c4bf038b-4472-4406-8f1f-5ddc812908d6)
 
-[![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)
+`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` examines git diffs and warns about Ruby methods, classes and blocks that **were changed without sufficient test coverage**. 
-
-Works with CI/CD and automated pull request review, as well as locally using the CLI to help you reduce the number of defects caused by untested code changes.
+Works with any Ruby CI pipeline as well as locally as a CLI.
 
 - Visit **[https://undercover-ci.com](https://undercover-ci.com)** to set up code review checks with the GitHub App, or use one of the [CI integrations](#code-review-integrations)
 - Learn how to find untested code changes locally with the [CLI](#usage)
 
+
+[![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:
 
 ![screenshot warning](docs/screenshot_warnings.png)

data/lib/undercover/changeset.rb

@@ -56,10 +56,10 @@ module Undercover
     end
 
     # TODO: refactor to a standalone validator (depending on changeset AND lcov)
-    # TODO: add specs
     def validate(lcov_report_path)
       return :no_changes if files.empty?
-      return :stale_coverage if last_modified > File.mtime(lcov_report_path)
+
+      :stale_coverage if last_modified > File.mtime(lcov_report_path)
     end
 
     private

data/lib/undercover/formatter.rb

@@ -17,21 +17,21 @@ module Undercover
     def formatted_warnings
       @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" +
+          (' ' * pad_size) + "loc: #{res.file_path_with_lines}, " \
+                             "coverage: #{res.coverage_f * 100}%\n" +
           res.pretty_print
       end
     end
 
     def success
-      "#{Rainbow('undercover').bold.green}: ✅ No coverage" \
-        ' is missing in latest changes'
+      "#{Rainbow('undercover').bold.green}: ✅ No coverage " \
+        '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/result.rb

@@ -13,7 +13,7 @@ module Undercover
     def initialize(node, file_cov, file_path)
       @node = node
       @coverage = file_cov.select do |ln, _|
-        ln > first_line && ln < last_line
+        first_line == last_line ? ln == first_line : ln > first_line && ln < last_line
       end
       @file_path = file_path
       @flagged = false
@@ -54,7 +54,7 @@ module Undercover
           lines[ln] = 0
         end
       end
-      return 1.0 if lines.keys.size.zero?
+      return 1.0 if lines.keys.empty?
 
       (lines.values.sum.to_f / lines.keys.size).round(4)
     end
@@ -84,7 +84,7 @@ module Undercover
       pad = node.last_line.to_s.length
       pretty_print_lines.map do |covered, (num, line)|
         formatted_line = "#{num.to_s.rjust(pad)}: #{line}"
-        if line.strip.length.zero?
+        if line.strip.empty?
           Rainbow(formatted_line).darkgray.dark
         elsif covered.nil?
           Rainbow(formatted_line).darkgray.dark + \
@@ -107,8 +107,8 @@ module Undercover
     end
 
     def inspect
-      "#<Undercover::Report::Result:#{object_id}" \
-        " name: #{node.name}, coverage: #{coverage_f}>"
+      "#<Undercover::Report::Result:#{object_id} " \
+        "name: #{node.name}, coverage: #{coverage_f}>"
     end
     alias to_s inspect
 
@@ -119,7 +119,7 @@ module Undercover
       branches = coverage.select { |cov| cov.size == 4 && cov[0] == line_number }
       count_covered = branches.count { |cov| cov[3].positive? }
 
-      return '' if branches.size.zero?
+      return '' if branches.empty?
 
       if count_covered < branches.size
         Rainbow(' branches: ').italic.darkgray.dark + \

data/lib/undercover/version.rb

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

data/undercover.gemspec

@@ -4,15 +4,14 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'undercover/version'
 
-# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'undercover'
   spec.version       = Undercover::VERSION
   spec.authors       = ['Jan Grodowski']
   spec.email         = ['jgrodowski@gmail.com']
 
-  spec.summary       = 'Actionable code coverage - detects untested' \
-                       ' code blocks in recent changes'
+  spec.summary       = 'Actionable code coverage - detects untested ' \
+                       'code blocks in recent changes'
   spec.homepage      = 'https://github.com/grodowski/undercover'
   spec.license       = 'MIT'
   spec.metadata      = {
@@ -26,20 +25,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.0.0'
 
+  spec.add_dependency 'bigdecimal'
   spec.add_dependency 'imagen', '>= 0.1.8'
   spec.add_dependency 'rainbow', '>= 2.1', '< 4.0'
-  spec.add_dependency 'rugged', '>= 0.27', '< 1.7'
-
-  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', '~> 1.28.2'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'simplecov-html'
-  spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
-  spec.add_development_dependency 'timecop'
+  spec.add_dependency 'rugged', '>= 0.27', '< 1.8'
 end
-# rubocop:enable Metrics/BlockLength

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: undercover
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Jan Grodowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-12 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  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: imagen
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ dependencies:
         version: '0.27'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,133 +77,7 @@ dependencies:
         version: '0.27'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.28.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.28.2
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov-html
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 description:
 email:
 - jgrodowski@gmail.com
@@ -205,6 +93,7 @@ files:
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -240,14 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Actionable code coverage - detects untested code blocks in recent changes