Class: Rcov::RcovTask

Class | Rcov::RcovTask
In: | lib/rcov/rcovtask.rb
Parent: | Rake::TaskLib

Create a task that runs a set of tests through rcov, generating code coverage reports.

Example:

      require 'rcov/rcovtask'

      Rcov::RcovTask.new do |t|
        t.libs << "test"
        t.test_files = FileList['test/test*.rb']
        t.verbose = true
      end

If rake is invoked with a "TEST=filename" command line option, then the list of test files will be overridden to include only the filename specified on the command line. This provides an easy way to run just one test.

If rake is invoked with a "RCOVOPTS=options" command line option, then the given options are passed to rcov.

If rake is invoked with a "RCOVPATH=path/to/rcov" command line option, then the given rcov executable will be used; otherwise the one in your PATH will be used.

Examples:

      rake rcov                           # run tests normally
      rake rcov TEST=just_one_file.rb     # run just one test file.
      rake rcov RCOVOPTS="-p"             # run in profile mode
      rake rcov RCOVOPTS="-T"             # generate text report

### Methods

define new test_files=

### Attributes

libs | [RW] | List of directories to added to $LOAD_PATH before running the tests. (default is ‘lib’)
name | [RW] | Name of test task. (default is :rcov)
output_dir | [RW] | Output directory for the XHTML report.
pattern | [RW] | Glob pattern to match test files. (default is ‘test/test*.rb’)
rcov_opts | [RW] | Array of commandline options to pass to rcov. An explicit RCOVOPTS=opts on the command line will override this. (default is `["—text-report"]`)
ruby_opts | [RW] | Array of commandline options to pass to ruby when running the rcov loader.
verbose | [RW] | True if verbose test output desired. (default is false)
warning | [RW] | Request that the tests be run with the warning flag set. E.g. warning=true implies "ruby -w" used to run the tests.

### Public Class methods

new(name=:rcov) {|self if block_given?| ...}

Create a testing task.

### Public Instance methods

define()

Create the tasks defined by this task lib.

test_files=(list)

Explicitly define the list of test files to be included in a test. `list` is expected to be an array of file names (a FileList is acceptable). If both `pattern` and `test_files` are used, then the list of test files is the union of the two.

[Validate]