Note: To learn more about SimpleCov, check out the main repo at https://github.com/colszowka/simplecov
Generates a HTML Material Design report generated from Simplecov using ruby 2.3 or greater.
Checkout this article on the approach to development https://dev.to/chiefpansancolt/using-a-clean-formatter-for-ruby-testing-2khe
- Now supports Branches
- added a space between to and path for coverage output (#13) - Thanks @YashdalfTheGray!
- Sort by value and not string usage (#8) Thanks @silent-e!
- Headers in Table overlap when screens are smaller (#10)
- Tile text breaks out of container at narrower widths (#11)
- Enabled Github Action usage
- Added Default Sort on Covered Percentage (#4)
- Added Column Sorting (#4)
- Upgraded to MDC Data Table Usage
- Updated Search Box UX
- Tabular view for Groupings
- File name searches
- Modal view of File Coverage from Click of Row
- Tile views for Stats in a group
- Clean Title of project
Add the below to your Gemfile to make Simplecov Material available as a formatter for your application
Ruby Gems Host
# ./Gemfile group :test do gem "simplecov" gem "simplecov-material" end
Github Rubygems Host
# ./Gemfile group :test do gem "simplecov" end source "https://rubygems.pkg.github.com/chiefpansancolt" group :test do gem "simplecov-material" end end
To use Simplecov Material you will need to ensure your Formatter is set to use Simplecov Material.
In your helper ensure your line about formatter usage is one of the following.
Ensure to add the require tag at the top of your helper class where Simplecov is configured
Single Formatter Usage:
SimpleCov.formatter = SimpleCov::Formatter::MaterialFormatter
Multi Formatter Usage:
SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([ SimpleCov::Formatter::HTMLFormatter, SimpleCov::Formatter::MaterialFormatter ])
First and for most thank you for taking the time to look to contribute to Simplecov Material, any help is apprciated to make Simplecov Material better and stronger!
Code of Conduct
This project and everyone participating in it is governed by the Simplecov Material Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to email@example.com.
How can I Contribute
Before submitting a bug report
This section guides you through submitting a bug report for Simplecov Material. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don’t need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template , the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you’re experiencing, open a new issue and include a link to the original issue in the body of your new one.
This section guides you through submitting an enhancement suggestion for Simplecov Material, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don’t need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template , including the steps that you imagine you would take if the feature you’re requesting existed.
Looking to contribute to Simplecov? You can look for any tickets tagged with help-wanted
- Help wanted issues
- issues which could use help form the community to help complete
The process described here has several goals:
- Maintain Simplecov Material’s quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Simplecov Material Interaction
- Enable a sustainable system for Simplecov Material’s maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
Issue and Pull Request Labels
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you’re interested in. For example, you might be interested in opening an Issue or perhaps opening a pull request. To help you find issues and pull requests, each label is listed with search links for finding open items with that label in Simplecov Material. We encourage you to read about other search filters which will help you write more focused queries.
Type of Issue and Issue State
|bug||Confirmed bugs or reports that are very likely to be bugs.|
|question||Questions more than bug reports or feature requests (e.g. how do I do X).|
|feedback||General feedback more than bug reports or feature requests.|
|help-wanted||The Simplecov Material team would appreciate help from the community in resolving these issues.|
|more-information-needed||More information needs to be collected about these problems or feature requests (e.g. steps to reproduce).|
|needs-reproduction||Likely bugs, but haven’t been reliably reproduced.|
|blocked||Issues blocked on other issues.|
|duplicate||Issues which are duplicates of other issues, i.e. they have been reported before.|
|wontfix||The Simplecov Material team has decided not to fix these issues for now, either because they’re working as intended or for some other reason.|
|invalid||Issues which aren’t valid (e.g. user errors).|
|new||Tagged on Issues that are new and have not been reviewed.|
|tech debt||Items to clean up / refactor / restructure|
Pull Request Labels
|work-in-progress||Pull Requests which are still being worked on, more changes will follow.|
|needs-review||Pull Requests which need code review, and approval from maintainers.|
|under-review||Pull Requests being reviewed by maintainers.|
|requires-changes||Pull Requests which need to be updated based on review comments and then reviewed again.|
|needs-testing||Pull Requests which need manual testing.|