Hexx::RSpec Documentation Status

Gem Version Build Status Dependency Status Code Climate Coverage Inline docs

The module adds RSpec, Coveralls and Simplecov dependencies with their default settings.

Installation

Add this line to your application's Gemfile:

group :test, :development do
  gem "hexx-rspec"
end

Then execute:

bundle

And run the task from the application root:

hexx-rspec install

Require the gem in the spec_helper.rb before loading application:

# spec/spec_helper.rb
require "hexx-rspec"

# Loads coveralls runtime metric in the application's scope.
Hexx::RSpec.load_metrics_for(self)

# Loads the application under the test.
require "my_app"

Review the config/metrics/simplecov.yml for coverage report settings.

Usage

Use rake test of rake test:coverage respectively.

Or run rake test:coverage:run and rake test:coverage:display separately.

Compatibility

Tested under rubies with API 1.9.3+.

Uses RSpec 3.0+ for testing

Contributing

  • Read the STYLEGUIDE
  • Fork the project
  • Create your feature branch (git checkout -b my-new-feature)
  • Add tests for it
  • Commit your changes (git commit -am '[UPDATE] Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create a new Pull Request

License

See [MIT LICENSE](file: LICENSE).