Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 3.21 KB

README.md

File metadata and controls

100 lines (63 loc) · 3.21 KB

Slather Logo

Gem Version Build Status

Generate test coverage reports for Xcode projects & hook it into CI.

Projects that use Slather

Project Coverage
Parsimmon Parsimmon Coverage
VENCore VENCore Coverage
CGFloatType CGFloatType Coverage

Installation

Add this line to your application's Gemfile:

gem 'slather'

And then execute:

$ bundle

Usage

Setup your project for test coverage:

$ slather setup path/to/project.xcodeproj

This will enable the Generate Test Coverage and Instrument Program Flow flags for your project.

To test if you're ready to generate test coverage, run your test suite on your project, and then run:

$ slather coverage -s path/to/project.xcodeproj

Coveralls

Login to https://coveralls.io/ and enable your repository. Right now, slather only supports coveralls via Travis CI.

Make a .slather.yml file:

# .slather.yml

coverage_service: coveralls
xcodeproj: path/to/project.xcodeproj
ignore:
  - ExamplePodCode/*
  - ProjectTestsGroup/*

And then in your .travis.yml, call slather after a successful_build

# .travis.yml

before_install: rvm use $RVM_RUBY_VERSION
install: bundle install --without=documentation --path ../travis_bundle_dir
after_success: slather

Coverage for code included via CocoaPods

If you're trying to compute the coverage of code that has been included via CocoaPods, you will need to tell slather where to find the source files for your Pod.

# .slather.yml

source_directory: Pods/AFNetworking

Custom Build Directory

Slather will look for the test coverage files in DerivedData by default. If you send build output to a custom location, like this, then you should also set the build_directory property in .slather.yml

Contributing

We'd love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We'll do our best to respond to your patch as soon as possible. You can also submit a new Github issue if you find bugs or have questions. :octocat:

Please make sure to follow our general coding style and add test coverage for new features!

Contributors