readme.md in covered-0.22.1 vs readme.md in covered-0.23.0
- old
+ new
@@ -1,88 +1,42 @@
# Covered
-[](https://github.com/ioquatix/covered/actions?workflow=Test)
+
-Covered uses modern Ruby features to generate comprehensive coverage, including support for templates which are compiled into Ruby.
+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 RSpec, Minitest, Travis & Coveralls - no need to configure anything - out of the box support for these platforms.
+ - 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.
-
+[](https://github.com/ioquatix/covered/actions?workflow=Test)
## Motivation
-Existing Ruby coverage tools are 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 allows us to do our own source code analysis to compute executable lines, thus making it possible to compute coverage for "templates".
+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".
-It's still tricky to do it correctly, but it is feasible now to compute coverage of web application "views" by using this technique. This gem is an exploration to see what is possible.
+After this concept prooved useful, [it was integrated directly into Ruby](https://bugs.ruby-lang.org/issues/19008).
-## Installation
-
-Add this line to your application's `Gemfile`:
-
-``` ruby
-gem 'covered'
-```
-
-### RSpec Integration
-
-In your `spec/spec_helper.rb` add the following before loading any other code:
-
-``` ruby
-require 'covered/rspec'
-```
-
-Ensure that you have a `.rspec` file with `--require spec_helper`:
-
- --require spec_helper
- --format documentation
- --warnings
-
-### Minitest Integration
-
-In your `test/test_helper.rb` add the following before loading any other code:
-
-``` ruby
-require 'covered/minitest'
-require 'minitest/autorun'
-```
-
-In your test files, e.g. `test/dummy_test.rb` add the following at the top:
-
-``` ruby
-require_relative 'test_helper'
-```
-
## Usage
-When running `rspec`, you can specify the kind of coverage analysis you would like:
+Please see the [project documentation](https://github.com/ioquatix/covered) for more details.
- COVERAGE=Summary rspec
+ - [Getting Started](https://github.com/ioquatix/coveredguides/getting-started/index) - This guide explains how to get
+ started with `covered` and integrate it with your test suite.
-If no `COVERAGE` is specified, coverage tracking will be finishd.
-
-### Template Coverage
-
-Covered supports coverage of templates which are compiled into Ruby code. This is only supported on Ruby 3.2+ due to enhancements in the coverage interface.
-
-### Partial Summary
-
- COVERAGE=PartialSummary rspec
-
-This report only shows snippets of source code with incomplete coverage.
-
-### Brief Summary
-
- COVERAGE=BriefSummary rspec
-
-This report lists several files in order of least coverage.l
-
## See Also
- - [coveralls-ruby](https://github.com/lemurheavy/coveralls-ruby) – the official Coveralls implementation for Ruby.
- - [simplecov](https://github.com/colszowka/simplecov) – one of the original coverage implementations for Ruby, uses the built-in `coverage` library.
+ - [simplecov](https://github.com/colszowka/simplecov) – one of the original coverage implementations for Ruby, uses
+ the built-in `coverage` library.
+ - [sus](https://github.com/ioquatix/sus) - a test framework which uses `covered` to generate coverage reports.
## Contributing
We welcome contributions to this project.
@@ -92,10 +46,12 @@
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.
+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 [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and
+participants agree to abide by its terms.