Class: RSpec::Core::RakeTask

Inherits:
Rake::TaskLib
  • Object
show all
Includes:
Rake::DSL
Defined in:
lib/rspec/core/rake_task.rb

Overview

RSpec rake task

See Also:

  • Rakefile

Constant Summary collapse

DEFAULT_RSPEC_PATH =

Default path to the RSpec executable.

File.expand_path('../../../../exe/rspec', __FILE__)
DEFAULT_PATTERN =

Default pattern for spec files.

'spec/**{,/*/**}/*_spec.rb'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args, &task_block) ⇒ RakeTask

Returns a new instance of RakeTask.

77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/rspec/core/rake_task.rb', line 77
def initialize(*args, &task_block)
  @name          = args.shift || :spec
  @ruby_opts     = nil
  @rspec_opts    = nil
  @verbose       = true
  @fail_on_error = true
  @rspec_path    = DEFAULT_RSPEC_PATH
  @pattern       = DEFAULT_PATTERN
  define(args, &task_block)
end

Instance Attribute Details

#exclude_pattern ⇒ void

Files matching this pattern will be excluded. Defaults to nil.

39
40
41
 
# File 'lib/rspec/core/rake_task.rb', line 39
def exclude_pattern
  @exclude_pattern
end

#fail_on_error ⇒ void

Whether or not to fail Rake when an error occurs (typically when examples fail). Defaults to true.

43
44
45
 
# File 'lib/rspec/core/rake_task.rb', line 43
def fail_on_error
  @fail_on_error
end

#failure_message ⇒ void

A message to print to stderr when there are failures.

46
47
48
 
# File 'lib/rspec/core/rake_task.rb', line 46
def failure_message
  @failure_message
end

#name ⇒ void

Name of task. Defaults to :spec.

31
32
33
 
# File 'lib/rspec/core/rake_task.rb', line 31
def name
  @name
end

#pattern ⇒ void

Files matching this pattern will be loaded. Defaults to 'spec/**{,/*/**}/*_spec.rb'.

35
36
37
 
# File 'lib/rspec/core/rake_task.rb', line 35
def pattern
  @pattern
end

#rspec_opts ⇒ void

Command line options to pass to RSpec. Defaults to nil.

75
76
77
 
# File 'lib/rspec/core/rake_task.rb', line 75
def rspec_opts
  @rspec_opts
end

#rspec_path ⇒ void

Path to RSpec. Defaults to the absolute path to the rspec binary from the loaded rspec-core gem.

72
73
74
 
# File 'lib/rspec/core/rake_task.rb', line 72
def rspec_path
  @rspec_path
end

#ruby_opts ⇒ void

Command line options to pass to ruby. Defaults to nil.

68
69
70
 
# File 'lib/rspec/core/rake_task.rb', line 68
def ruby_opts
  @ruby_opts
end

#verbose ⇒ void

Use verbose output. If this is set to true, the task will print the executed spec command to stdout. Defaults to true.

65
66
67
 
# File 'lib/rspec/core/rake_task.rb', line 65
def verbose
  @verbose
end

#with_clean_environment ⇒ void

Run RSpec with a clean (empty) environment.

55
56
57
 
# File 'lib/rspec/core/rake_task.rb', line 55
def with_clean_environment
  false
end