Feature Request: Display Total Coverage Percentage in SimpleCov Index

Open
#540 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
ruby
Domain
tooling

Research direction

Locate the Coverage analyser and the SimpleCovIndex generator, then read how the analyser currently obtains coverage data and how the index header is assembled. Reuse the existing SimpleCov::Result covered_percent calculation so the generated index displays the overall percentage alongside the file coverage information.

Written by the indexing model from the issue text.

Description

Display total coverage percentage in SimpleCov index

Would be nice to show the overall project coverage percentage in the SimpleCov index page. Right now it only shows individual file coverage, but I often want to see the total coverage number (like "45.5%") at a glance.

I implemented this using SimpleCov's covered_percent method from the SimpleCov::Result object. The changes:

  • Added a method to expose the SimpleCov::Result from the Coverage analyser
  • Added total_coverage to the SimpleCovIndex generator that displays it in the header
  • Reused the existing Coverage analyser logic (no duplication)
  • The result is cached when the analyser runs, so there's no performance impact

The implementation uses SimpleCov's own calculation method, so it's accurate and consistent with SimpleCov's reporting.

Screenshot of example working locally.

Image
Dominant language
Ruby
Stars
3.5k
Forks
234
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from whitesmith/rubycritic

All issues in whitesmith/rubycritic

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.