README.md

Simplecov Material

NOTE: This repo is not maintained anymore -> Simplecov-Tailwindcss is the preferd and maintined Simplecov Formatter

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

Table of Contents

• Installing
• Usage
• Change Log
• Contributing
• Development
• License

Installing

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

Usage

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

require "simplecov-material"

Single Formatter Usage:

SimpleCov.formatter = SimpleCov::Formatter::MaterialFormatter

Multi Formatter Usage:

SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
  SimpleCov::Formatter::HTMLFormatter,
  SimpleCov::Formatter::MaterialFormatter
])

Change Log

Check out the Change Log for new breaking changes/features/bug fixes per release of a new version.

Contributing

Bug Reports, Feature Requests, and Pull Requests are welcome on GitHub at https://github.com/chiefpansancolt/simplecov-material. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

To see more about Contributing check out this document.

• Fork Repo and create new branch
• Once all is changed and committed create a pull request.

Ensure all merge conflicts are fixed and CI is passing.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run yarn test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

When working with SCSS or JS ensure to run yarn build to compile all SCSS and JS to the public folder. This will ensure you have the latest CSS and JS used when testing locally.

NOTE: Do not commit any changes made in public folder from compiling as this will be performed by the owner before building of a release.

To test locally run yarn test and a webpage will open after tests are complete and you will be able to see the page.

To install this gem onto your local machine, run yarn gem:build. Gems will be built/release by Owner.

License

Simplecov Material is available as open source under the terms of the MIT License.