Kettle::Soup::Cover

A Covered Kettle of SOUP (Software of Unknown Provenance)

The name is derived in part from the medical devices field, where this library is considered a package of SOUP.

It provides a one-line-configured, curated, opinionated, set of dependencies for Test Coverage.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add kettle-soup-cover

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install kettle-soup-cover

Usage

In your spec/spec_helper.rb, just prior to loading the library under test:

require "kettle/soup/cover" # or require "kettle-soup-cover"

In your .simplecov file:

require "kettle/soup/cover/config"
SimpleCov.start

See Advanced Usage below for more info, but the simplest thing is to run all the coverage things, which is configured by default on CI. To replicate that locally you could:

CI=true bundle exec rake test # or whatever command you run for tests.

That's it!

Advanced Usage

There are a number of ENV variables that control things within this gem. All of them can be found in lib/kettle/soup/cover.rb.

Additionally some of the included gems, like simplecov-console, have their own complete suite of ENV variables you can configure.

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 the created tag, and push the .gem file to rubygems.org.

Code of Conduct

Everyone interacting in this project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Contributing

See CONTRIBUTING.md.

Versioning

This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("kettle-soup-cover", "~> 0.1")

License

The gem is available as open source under the terms of the MIT License . See LICENSE for the official Copyright Notice.