https://github.com/socketry/covered

https://github.com/socketry/covered

coverage ruby testing

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/socketry/covered
• Owner: socketry
• License: mit
• Created: 2018-07-01T01:40:01.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-07-22T11:56:13.000Z (6 months ago)
• Last Synced: 2025-01-11T19:43:06.707Z (10 days ago)
• Topics: coverage, ruby, testing
• Language: Ruby
• Homepage:
• Size: 758 KB
• Stars: 202
• Watchers: 6
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# Covered

![Screenshot](media/example.png)

Covered uses modern Ruby features to generate comprehensive coverage, including support for templates which are compiled

into Ruby.

  - Incremental coverage - if you run your full test suite, and the run a subset, it will still report the correct

    coverage - so you can incrementally work on improving coverage.

  - Integration with Sus, Git, RSpec and Minitest- no need to configure anything - out of the box support for these

    platforms.

  - Supports coverage of views - templates compiled to Ruby code can be tracked for coverage reporting.

[![Development Status](https://github.com/socketry/covered/workflows/Test/badge.svg)](https://github.com/socketry/covered/actions?workflow=Test)

## Motivation

Originally, Ruby coverage tools were unable to handle `eval`ed code. This is because the `coverage` module built into

Ruby doesn't expose the necessary hooks to capture it. Using the [parser](https://github.com/whitequark/parser) gem and

trace points allows us to do our own source code analysis to compute executable lines, thus making it possible to

compute coverage for "templates".

After this concept prooved useful, [it was integrated directly into Ruby](https://bugs.ruby-lang.org/issues/19008).

## Usage

Please see the [project documentation](https://socketry.github.io/covered/) for more details.

  - [Getting Started](https://socketry.github.io/covered/guides/getting-started/index) - This guide explains how to get started with `covered` and integrate it with your test suite.

  - [Configuration](https://socketry.github.io/covered/guides/configuration/index) - This guide will help you to configure covered for your project's specific requirements.

## See Also

  - [simplecov](https://github.com/colszowka/simplecov) – one of the original coverage implementations for Ruby, uses

    the built-in `coverage` library.

  - [sus](https://github.com/socketry/sus) - a test framework which uses `covered` to generate coverage reports.

## Contributing

We welcome contributions to this project.

1.  Fork it.

2.  Create your feature branch (`git checkout -b my-new-feature`).

3.  Commit your changes (`git commit -am 'Add some feature'`).

4.  Push to the branch (`git push origin my-new-feature`).

5.  Create new Pull Request.

### Developer Certificate of Origin

This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.

### Contributor Covenant

This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.