SimpleCov::Formatter::Terminal

Note: This gem depends upon RSpec. If you aren't using RSpec to run your tests, it won't work!

Add the gem to your application's Gemfile.

group :test do
  gem 'simple_cov-formatter-terminal'
end

Then execute:

$ bundle install

Add something like the following to your spec/spec_helper.rb file:

require 'simplecov'
if RSpec.configuration.files_to_run.one?
  require 'simple_cov/formatter/terminal'
  SimpleCov.formatter = SimpleCov::Formatter::Terminal
end
SimpleCov.start

Note that this setup only uses SimpleCov::Formatter::Terminal when specs are run with a single spec file (e.g. bin/rspec spec/models/user_spec.rb) and not when multiple specs are executed (e.g. when simply running bin/rspec without any argument).

By default, only uncovered lines will be printed.

If you would like to print all lines, add this to your spec_helper.rb file:

SimpleCov::Formatter::Terminal.config.lines_to_print = :all

SimpleCov::Formatter::Terminal has a default hash that is used to map spec files to their corresponding application file.

For gems (determined from whether there is a .gemspec file at the top level of the project), the default mapping is very simple:

SimpleCov::Formatter::Terminal.config.spec_to_app_file_map = {
  %r{\Aspec/} => 'lib/',
}

This is the default used for non-gems; it is optimized for Rails applications using Active Admin:

SimpleCov::Formatter::Terminal.config.spec_to_app_file_map = {
  %r{\Aspec/lib/} => 'lib/',
  %r{\Aspec/controllers/admin/(.*)_controller_spec.rb} => 'app/admin/\1.rb',
  %r{
    \Aspec/
    (
    actions|
    channels|
    controllers|
    decorators|
    helpers|
    mailboxes|
    mailers|
    models|
    policies|
    serializers|
    views|
    workers
    )
    /
  }x => 'app/\1/',
}

If needed for your application, you can add to this hash in your spec/spec_helper.rb, e.g.:

SimpleCov::Formatter::Terminal.config.spec_to_app_file_map.merge!(
  %r{\Aspec/my_special/directory_structure/} => 'my_special/app_directory/',
)

Or you can override the default mapping completely:

SimpleCov::Formatter::Terminal.config.spec_to_app_file_map = {
  %r{\Aspec/my_special/directory_structure/} => 'my_special/app_directory/',
}

If you enable branch coverage for SimpleCov (via enable_coverage(:branch) within your SimpleCov.start block; read more here), then branch coverage info will be included in SimpleCov::Formatter::Terminal's output. Missed branches will be indicated with white text on a red background at the end of the line, and the line number will be printed in red text on a yellow background, as seen in the screenshot at the top of this README (where a then branch is not covered on line 18).

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

Bug reports and pull requests are welcome on GitHub at https://github.com/davidrunger/simple_cov-formatter-terminal.

The gem is available as open source under the terms of the MIT License.