::Rake::TaskLib
A Rake task that runs a set of specs.
Example:
Spec::Rake::SpecTask.new do |t| t.warning = true t.rcov = true end
This will create a task that can be run with:
rake spec
If rake is invoked with a “SPEC=filename” command line option, then the list of spec files will be overridden to include only the filename specified on the command line. This provides an easy way to run just one spec.
If rake is invoked with a “SPEC_OPTS=options” command line option, then the given options will override the value of the spec_opts attribute.
If rake is invoked with a “RCOV_OPTS=options” command line option, then the given options will override the value of the rcov_opts attribute.
Examples:
rake spec # run specs normally rake spec SPEC=just_one_file.rb # run just one spec file. rake spec SPEC_OPTS="--diff" # enable diffing rake spec RCOV_OPTS="--aggregate myfile.txt" # see rcov --help for details
Each attribute of this task may be a proc. This allows for lazy evaluation, which is sometimes handy if you want to defer the evaluation of an attribute value until the task is run (as opposed to when it is defined).
This task can also be used to run existing Test::Unit tests and get RSpec output, for example like this:
require 'spec/rake/spectask' Spec::Rake::SpecTask.new do |t| t.ruby_opts = ['-rtest/unit'] t.spec_files = FileList['test/**/*_test.rb'] end
If true, requests that the specs be run with the warning flag set. E.g. warning=true implies “ruby -w” used to run the specs. Defaults to false.
Glob pattern to match spec files. (default is ‘spec/**/*_spec.rb’) Setting the SPEC environment variable overrides this.
Array of commandline options to pass to RSpec. Defaults to []. Setting the SPEC_OPTS environment variable overrides this.
Array of commandline options to pass to RCov. Defaults to [’—exclude’, ‘lib/spec,bin/spec’]. Ignored if rcov=false Setting the RCOV_OPTS environment variable overrides this.
Directory where the RCov report is written. Defaults to “coverage” Ignored if rcov=false
Whether or not to fail Rake when an error occurs (typically when specs fail). Defaults to true.
Where RSpec’s output is written. Defaults to $stdout. DEPRECATED. Use —format FORMAT:WHERE in spec_opts.
Explicitly define the list of spec files to be included in a spec. spec_files is expected to be an array of file names (a FileList is acceptable). If both pattern and spec_files are used, then the list of spec files is the union of the two. Setting the SPEC environment variable overrides this.
# File lib/spec/rake/spectask.rb, line 58 58: def self.attr_accessor(*names) 59: super(*names) 60: names.each do |name| 61: module_eval "def #{name}() evaluate(@#{name}) end" # Allows use of procs 62: end 63: end
Defines a new task, using the name name.
# File lib/spec/rake/spectask.rb, line 126 126: def initialize(name=:spec) 127: @name = name 128: @libs = ['lib'] 129: @pattern = nil 130: @spec_files = nil 131: @spec_opts = [] 132: @warning = false 133: @ruby_opts = [] 134: @fail_on_error = true 135: @rcov = false 136: @rcov_opts = ['--exclude', 'lib\/spec,bin\/spec,config\/boot.rb'] 137: @rcov_dir = "coverage" 138: 139: yield self if block_given? 140: @pattern = 'spec/**/*_spec.rb' if pattern.nil? && spec_files.nil? 141: define 142: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.