Appends a global after block to all example groups.
See append_before for scoping semantics.
# File lib/spec/runner/configuration.rb, line 123 def append_after(scope = :each, options={}, &proc) add_callback(:append_after, scope, options, &proc) end
Appends a global before block to all example groups. scope can be any of :each (default), :all, or :suite. When :each, the block is executed before each example. When :all, the block is executed once per example group, before any of its examples are run. When :suite the block is run once before the entire suite is run.
# File lib/spec/runner/configuration.rb, line 100 def append_before(scope = :each, options={}, &proc) add_callback(:append_before, scope, options, &proc) end
Works just like include, but extends the example groups with the modules rather than including them.
# File lib/spec/runner/configuration.rb, line 90 def extend(*modules_and_options) include_or_extend(:extend, *modules_and_options) end
Adds patterns to the list of patterns ignored in the backtrace when a failure is output by rspec. Example:
config.ignore_backtrace_patterns /spork/, /shoulda/, "/some/weird/path/"
When quiet backtraces are turned on (default), this will exclude any lines that match any of the Regexps and Strings passed.
# File lib/spec/runner/configuration.rb, line 149 def ignore_backtrace_patterns(*patterns) @ignored_backtrace_patterns ||= [] @ignored_backtrace_patterns += patterns end
Declares modules to be included in multiple example groups (describe blocks). With no :type, the modules listed will be included in all example groups.
Use :type to restrict the inclusion to a subset of example groups. The value assigned to :type should be a key that maps to a class that is either a subclass of Spec::Example::ExampleGroup or extends Spec::Example::ExampleGroupMethods and includes Spec::Example::ExampleMethods.
For example, the rspec-rails gem/plugin extends Test::Unit::TestCase with Spec::Example::ExampleGroupMethods and includes Spec::Example::ExampleMethods in it. So if you have a module of helper methods for controller examples, you could do this:
config.include(ControllerExampleHelpers, :type => :controller)
Only example groups that have that type will get the modules included:
describe Account, :type => :model do # Will *not* include ControllerExampleHelpers end describe AccountsController, :type => :controller do # *Will* include ControllerExampleHelpers end
# File lib/spec/runner/configuration.rb, line 79 def include(*modules_and_options) include_or_extend(:include, *modules_and_options) end
Chooses what mock framework to use. Example:
Spec::Runner.configure do |config| config.mock_with :rspec, :mocha, :flexmock, or :rr end
To use any other mock framework, you’ll have to provide your own adapter. This is simply a module that responds to the following methods:
setup_mocks_for_rspec verify_mocks_for_rspec teardown_mocks_for_rspec.
These are your hooks into the lifecycle of a given example. RSpec will call setup_mocks_for_rspec before running anything else in each Example. After executing the after methods, RSpec will then call verify_mocks_for_rspec and teardown_mocks_for_rspec (this is guaranteed to run even if there are failures in verify_mocks_for_rspec).
Once you’ve defined this module, you can pass that to mock_with:
Spec::Runner.configure do |config| config.mock_with MyMockFrameworkAdapter end
# File lib/spec/runner/configuration.rb, line 33 def mock_with(mock_framework) @mock_framework = case mock_framework when Symbol mock_framework_path(mock_framework.to_s) else mock_framework end end
DEPRECATED - use Spec::Matchers::DSL instead
Defines global predicate matchers. Example:
config.predicate_matchers[:swim] = :can_swim?
This makes it possible to say:
person.should swim # passes if person.can_swim? returns true
# File lib/spec/runner/configuration.rb, line 137 def predicate_matchers @predicate_matchers ||= Spec::HashWithDeprecationNotice.new("predicate_matchers", "the new Matcher DSL") end
Prepends a global after block to all example groups.
See append_before for scoping semantics.
# File lib/spec/runner/configuration.rb, line 115 def prepend_after(scope = :each, options={}, &proc) add_callback(:prepend_after, scope, options, &proc) end
Prepends a global before block to all example groups.
See append_before for scoping semantics.
# File lib/spec/runner/configuration.rb, line 108 def prepend_before(scope = :each, options={}, &proc) add_callback(:prepend_before, scope, options, &proc) end
Generated with the Darkfish Rdoc Generator 2.