Coverage::Badge

Generate a SVG badge for code coverage in your project

Installation

Add this line to your application's Gemfile:

gem 'coverage-badge', '~> 0.1.0	'

And then execute:

$ bundle

Or install it yourself as:

$ gem install coverage-badge

Usage

if ENV['CI'] == 'true'
  require 'simplecov'

  SimpleCov.start 'rails' do
    require 'coverage-badge'

    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
      [
        SimpleCov::Formatter::HTMLFormatter,
        Coverage::Badge::Formatter
      ]
    )
  end
end

Development

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

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/andreyors/coverage-badge.