https://github.com/codecov/ruby-standard-2
Codecov coverage standard for Ruby using Codecov's Bash uploader
https://github.com/codecov/ruby-standard-2
codecov coverage-reports rails ruby
Last synced: about 1 year ago
JSON representation
Codecov coverage standard for Ruby using Codecov's Bash uploader
- Host: GitHub
- URL: https://github.com/codecov/ruby-standard-2
- Owner: codecov
- License: mit
- Created: 2019-07-22T09:06:36.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T15:03:20.000Z (over 1 year ago)
- Last Synced: 2025-04-11T15:10:25.701Z (about 1 year ago)
- Topics: codecov, coverage-reports, rails, ruby
- Language: Ruby
- Homepage:
- Size: 450 KB
- Stars: 3
- Watchers: 9
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Ruby-Standard-2 (CLI Edition)
[](https://github.com/codecov/ruby-standard-2/actions/workflows/ruby-standard-2.yml) [](https://codecov.io/gh/codecov/Ruby-Standard-2)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fruby-standard-2?ref=badge_shield)
### Last Updated: 09/14/23 00:12:46
## What is this?
This is a **Ruby on Rails** application, with basic unit tests, for which coverage is uploaded to Codecov on a daily basis via the Codecov CLI. It can also serve as an example for how to integrate Codecov into your Ruby project. If the build is passing for this project, then Codecov's Ruby report processing is functional and correct on codecov.io.
## What's the difference between `Ruby-Standard-1` and `Ruby-Standard-2`?
[Ruby-Standard-1](https://github.com/codecov/Ruby-Standard-1) uses the Codecov gem to process coverage reports, while this repository, Ruby-Standard-2, uses Codecov's CLI to process reports. Otherwise, everything is the same between these two repos.
## Configuration
This project is written in `Ruby 2.6.3` using `Rails 5.2.3`. Unit tests are written in the [RSpec Rails](https://github.com/rspec/rspec-rails) framework. Coverage reports are generated through the [SimpleCov](https://github.com/colszowka/simplecov) gem and formatted via the [SimpleCov-Cobertura](https://github.com/dashingrocket/simplecov-cobertura) gem which converts the SimpleCov report into a `coverage.xml` file that is easily consumed by Codecov.
Unit tests: `spec/index_spec.rb` which tests `lib/index.rb`
Gemfile configuration:
```ruby
gem 'simplecov', require: false
gem 'simplecov-cobertura'
```
RSpec configuration (top of `spec/spec_helper.rb`):
```ruby
require 'simplecov'
require 'simplecov-cobertura'
if ENV['CI']
SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
end
SimpleCov.start
```
> `spec_helper.rb` is a file that contains settings specific to RSpec. If you're using another testing framework, you'll need to put this information in some other helper Ruby file. For example, if you're using Minitest, which is prepackaged with all Rails applications, you'll need to put the above lines of code inside `test/test_helper.rb`
## Reporting Issues
If you've discovered an issue with this repository or with Ruby processing in general, it is recommended to email support@codecov.io rather than post an issue here. This repository will not be checked regularly for open issues.
## Contributing
Contributions are welcome! If you'd like to contribute to this repository, feel free to open a pull request or flag an issue. If you would like to contribute a new lanaguage standard, [you can get more information here](https://github.com/codecov/standards-scripts/blob/master/README.md#contributing).
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fruby-standard-2?ref=badge_large)