Class: RSpec::Core::Configuration

Inherits:
Object
  • Object
show all
Includes:
Hooks
Defined in:
lib/rspec/core/configuration.rb

Overview

Stores runtime configuration information.

Configuration options are loaded from ~/.rspec, .rspec, .rspec-local, command line switches, and the SPEC_OPTS environment variable (listed in lowest to highest precedence; for example, an option in ~/.rspec can be overridden by an option in .rspec-local).

Examples:

Standard settings

RSpec.configure do |c|
  c.drb          = true
  c.drb_port     = 1234
  c.default_path = 'behavior'
end

Hooks

RSpec.configure do |c|
  c.before(:suite)   { establish_connection }
  c.before(:example) {  :authorized }
  c.around(:example) { |ex| Database.transaction(&ex) }
end

See Also:

Constant Summary

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from Hooks

#after, #append_after, #around, #before, #prepend_before

Constructor Details

- (Configuration) initialize

Returns a new instance of Configuration



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/rspec/core/configuration.rb', line 274

def initialize
  @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now
  @expectation_frameworks = []
  @include_or_extend_modules = []
  @mock_framework = nil
  @files_or_directories_to_run = []
  @color = false
  @pattern = '**/*_spec.rb'
  @failure_exit_code = 1
  @spec_files_loaded = false

  @backtrace_formatter = BacktraceFormatter.new

  @default_path = 'spec'
  @deprecation_stream = $stderr
  @output_stream = $stdout
  @reporter = nil
  @reporter_buffer = nil
  @filter_manager = FilterManager.new
  @ordering_manager = Ordering::ConfigurationManager.new
  @preferred_options = {}
  @failure_color = :red
  @success_color = :green
  @pending_color = :yellow
  @default_color = :white
  @fixed_color = :blue
  @detail_color = :cyan
  @profile_examples = false
  @requires = []
  @libs = []
  @derived_metadata_blocks = []
end

Instance Attribute Details

- (void) default_color

The default output color.

Parameters:

  • color (Symbol)

    defaults to :white but can be set to one of the following:[:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]



233
# File 'lib/rspec/core/configuration.rb', line 233

add_setting :default_color

- (void) default_path

Path to use if no path is provided to the rspec command (default: "spec"). Allows you to just type rspec instead of rspec spec to run all the examples in the spec directory.



92
# File 'lib/rspec/core/configuration.rb', line 92

add_setting :default_path

- (void) detail_color

Color used to print details.

Parameters:

  • color (Symbol)

    defaults to :cyan but can be set to one of the following: [:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]



247
# File 'lib/rspec/core/configuration.rb', line 247

add_setting :detail_color

- (void) drb

Run examples over DRb (default: false). RSpec doesn't supply the DRb server, but you can use tools like spork.



97
# File 'lib/rspec/core/configuration.rb', line 97

add_setting :drb

- (void) drb_port

The drb_port (default: nil).



101
# File 'lib/rspec/core/configuration.rb', line 101

add_setting :drb_port

- (void) dry_run

Prints the formatter output of your suite without running any examples or hooks.



153
# File 'lib/rspec/core/configuration.rb', line 153

add_setting :dry_run

- (void) error_stream

Default: $stderr.



105
# File 'lib/rspec/core/configuration.rb', line 105

add_setting :error_stream

- (void) fail_fast

Clean up and exit after the first failure (default: false).



148
# File 'lib/rspec/core/configuration.rb', line 148

add_setting :fail_fast

- (void) failure_color

Color to use to indicate failure.

Parameters:

  • color (Symbol)

    defaults to :red but can be set to one of the following: [:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]



226
# File 'lib/rspec/core/configuration.rb', line 226

add_setting :failure_color

- (void) failure_exit_code

The exit code to return if there are any failures (default: 1).



157
# File 'lib/rspec/core/configuration.rb', line 157

add_setting :failure_exit_code

- (Array) files_to_run

The spec files RSpec will run

Returns:

  • (Array)

    specified files about to run



719
720
721
# File 'lib/rspec/core/configuration.rb', line 719

def files_to_run
  @files_to_run ||= get_files_to_run(@files_or_directories_to_run)
end

- (void) fixed_color

Color used when a pending example is fixed.

Parameters:

  • color (Symbol)

    defaults to :blue but can be set to one of the following: [:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]



240
# File 'lib/rspec/core/configuration.rb', line 240

add_setting :fixed_color

- (void) libs

Returns dirs that have been prepended to the load path by the -I command line option



165
# File 'lib/rspec/core/configuration.rb', line 165

define_reader :libs

- (void) output_stream

Determines where RSpec will send its output. Default: $stdout.



170
# File 'lib/rspec/core/configuration.rb', line 170

define_reader :output_stream

- (void) pattern

Load files matching this pattern (default: '**/*_spec.rb')



187
# File 'lib/rspec/core/configuration.rb', line 187

define_reader :pattern

- (void) pending_color

Color to use to print pending examples.

Parameters:

  • color (Symbol)

    defaults to :yellow but can be set to one of the following: [:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]



219
# File 'lib/rspec/core/configuration.rb', line 219

add_setting :pending_color

- (void) profile_examples

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Defaults profile_examples to 10 examples when @profile_examples is true.



201
# File 'lib/rspec/core/configuration.rb', line 201

add_setting :profile_examples

- (void) requires

Indicates files configured to be required



161
# File 'lib/rspec/core/configuration.rb', line 161

define_reader :requires

- (void) run_all_when_everything_filtered

Run all examples if none match the configured filters (default: false).



205
# File 'lib/rspec/core/configuration.rb', line 205

add_setting :run_all_when_everything_filtered

- (void) success_color

Color to use to indicate success.

Parameters:

  • color (Symbol)

    defaults to :green but can be set to one of the following: [:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]



212
# File 'lib/rspec/core/configuration.rb', line 212

add_setting :success_color

Instance Method Details

- (void) add_formatter(formatter) Also known as: formatter=

Adds a formatter to the formatters collection. formatter can be a string representing any of the built-in formatters (see built_in_formatter), or a custom formatter class.

Note

For internal purposes, add_formatter also accepts the name of a class and paths to use for output streams, but you should consider that a private api that may change at any time without notice.



622
623
624
625
# File 'lib/rspec/core/configuration.rb', line 622

def add_formatter(formatter_to_use, *paths)
  paths << output_stream if paths.empty?
  formatter_loader.add formatter_to_use, *paths
end

- (void) add_setting(name) - (void) add_setting(name, opts)

Adds a custom setting to the RSpec.configuration object.

RSpec.configuration.add_setting :foo

Used internally and by extension frameworks like rspec-rails, so they can add config settings that are domain specific. For example:

RSpec.configure do |c|
  c.add_setting :use_transactional_fixtures,
    :default => true,
    :alias_with => :use_transactional_examples
end

add_setting creates three methods on the configuration object, a setter, a getter, and a predicate:

RSpec.configuration.foo=(value)
RSpec.configuration.foo
RSpec.configuration.foo? # returns true if foo returns anything but nil or false

Parameters:

  • opts (Hash) (defaults to: {})

    a customizable set of options

Options Hash (opts):

  • :default (Symbol)

    set a default value for the generated getter and predicate methods:

    add_setting(:foo, :default => "default value")
    
  • :alias_with (Symbol)

    Use :alias_with to alias the setter, getter, and predicate to another name, or names:

    add_setting(:foo, :alias_with => :bar)
    add_setting(:foo, :alias_with => [:bar, :baz])
    


357
358
359
360
361
362
363
# File 'lib/rspec/core/configuration.rb', line 357

def add_setting(name, opts={})
  default = opts.delete(:default)
  (class << self; self; end).class_exec do
    add_setting(name, opts)
  end
  __send__("#{name}=", default) if default
end

- (void) alias_example_group_to(new_name, *args)

Note:

The defined aliased will also be added to the top level (e.g. main and from within modules) if expose_dsl_globally is set to true.

Creates a method that defines an example group with the provided metadata. Can be used to define example group/metadata shortcuts.

Examples:

RSpec.configure do |config|
  config.alias_example_group_to :describe_model, :type => :model
end

shared_context_for "model tests", :type => :model do
  # define common model test helper methods, `let` declarations, etc
end

# This lets you do this:

RSpec.describe_model User do
end

# ... which is the equivalent of

RSpec.describe User, :type => :model do
end

See Also:



787
788
789
790
# File 'lib/rspec/core/configuration.rb', line 787

def alias_example_group_to(new_name, *args)
  extra_options = Metadata.build_hash_from(args)
  RSpec::Core::ExampleGroup.define_example_group_method(new_name, extra_options)
end

- (void) alias_example_to(name, *args)

Note:

The specific example alias below (pending) is already defined for you.

Note:

Use with caution. This extends the language used in your specs, but does not add any additional documentation. We use this in rspec to define methods like focus and xit, but we also add docs for those methods.

Creates a method that delegates to example including the submitted args. Used internally to add variants of example like pending:

Examples:

RSpec.configure do |config|
  config.alias_example_to :pending, :pending => true
end

# This lets you do this:

describe Thing do
  pending "does something" do
    thing = Thing.new
  end
end

# ... which is the equivalent of

describe Thing do
  it "does something", :pending => true do
    thing = Thing.new
  end
end

Parameters:

  • name (String)

    example name alias

  • args (Array<Symbol>, Hash)

    metadata for the generated example



755
756
757
758
# File 'lib/rspec/core/configuration.rb', line 755

def alias_example_to(name, *args)
  extra_options = Metadata.build_hash_from(args)
  RSpec::Core::ExampleGroup.define_example_method(name, extra_options)
end

- (void) alias_it_behaves_like_to(new_name, report_label = '') Also known as: alias_it_should_behave_like_to

Note:

Use with caution. This extends the language used in your specs, but does not add any additional documentation. We use this in rspec to define it_should_behave_like (for backward compatibility), but we also add docs for that method.

Define an alias for it_should_behave_like that allows different language (like "it_has_behavior" or "it_behaves_like") to be employed when including shared examples.

Examples:

RSpec.configure do |config|
  config.alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')
end

# allows the user to include a shared example group like:

describe Entity do
  it_has_behavior 'sortability' do
    let(:sortable) { Entity.new }
  end
end

# which is reported in the output as:
# Entity
#   has behavior: sortability
#     ...sortability examples here


818
819
820
# File 'lib/rspec/core/configuration.rb', line 818

def alias_it_behaves_like_to(new_name, report_label = '')
  RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)
end

- (void) backtrace_exclusion_patterns

Regexps used to exclude lines from backtraces.

Excludes lines from ruby (and jruby) source, installed gems, anything in any "bin" directory, and any of the rspec libs (outside gem installs) by default.

You can modify the list via the getter, or replace it with the setter.

To override this behaviour and display a full backtrace, use --backtraceon the command line, in a .rspec file, or in the rspec_options attribute of RSpec's rake task.



387
388
389
# File 'lib/rspec/core/configuration.rb', line 387

def backtrace_exclusion_patterns
  @backtrace_formatter.exclusion_patterns
end

- (void) backtrace_exclusion_patterns=(patterns)

Set regular expressions used to exclude lines in backtrace

Parameters:

  • patterns (Regexp)

    set the backtrace exlusion pattern



393
394
395
# File 'lib/rspec/core/configuration.rb', line 393

def backtrace_exclusion_patterns=(patterns)
  @backtrace_formatter.exclusion_patterns = patterns
end

- (void) backtrace_inclusion_patterns

Regexps used to include lines in backtraces.

Defaults to [Regexp.new Dir.getwd].

Lines that match an exclusion and an inclusion pattern will be included.

You can modify the list via the getter, or replace it with the setter.



405
406
407
# File 'lib/rspec/core/configuration.rb', line 405

def backtrace_inclusion_patterns
  @backtrace_formatter.inclusion_patterns
end

- (void) backtrace_inclusion_patterns=(patterns)

Set regular expressions used to include lines in backtrace



411
412
413
# File 'lib/rspec/core/configuration.rb', line 411

def backtrace_inclusion_patterns=(patterns)
  @backtrace_formatter.inclusion_patterns = patterns
end

- (Boolean) color

Returns the configuration option for color, but should not be used to check if color is supported.

Returns:

  • (Boolean)

See Also:

  • color_enabled?


567
568
569
# File 'lib/rspec/core/configuration.rb', line 567

def color
  value_for(:color, @color)
end

- (void) color=(true_or_false)

Toggle output color



581
582
583
584
585
586
587
588
589
590
# File 'lib/rspec/core/configuration.rb', line 581

def color=(true_or_false)
  if true_or_false
    if RSpec.world.windows_os? and not ENV['ANSICON']
      RSpec.warning "You must use ANSICON 1.31 or later (http://adoxa.3eeweb.com/ansicon/) to use colour on Windows"
      @color = false
    else
      @color = true
    end
  end
end

- (Boolean) color_enabled?(output = output_stream)

Check if color is enabled for a particular output

Parameters:

  • output (IO) (defaults to: output_stream)

    an output stream to use, defaults to the current output_stream

Returns:

  • (Boolean)


575
576
577
# File 'lib/rspec/core/configuration.rb', line 575

def color_enabled?(output = output_stream)
  output_to_tty?(output) && color
end

- (void) default_formatter

The formatter that will be used if no formatter has been set. Defaults to 'progress'.



630
631
632
# File 'lib/rspec/core/configuration.rb', line 630

def default_formatter
  formatter_loader.default_formatter
end

- (void) default_formatter=(value)

Sets a fallback formatter to use if none other has been set.

Examples:


RSpec.configure do |rspec|
  rspec.default_formatter = 'doc'
end


641
642
643
# File 'lib/rspec/core/configuration.rb', line 641

def default_formatter=(value)
  formatter_loader.default_formatter = value
end

- (void) define_derived_metadata(*filters) {|metadata| ... }

Defines a callback that can assign derived metadata values.

Examples:

RSpec.configure do |config|
  # Tag all groups and examples in the spec/unit directory with :type => :unit
  config.(:file_path => %r{/spec/unit/}) do ||
    [:type] = :unit
  end
end

Parameters:

  • filters (Array<Symbol>, Hash)

    metadata filters that determine which example or group metadata hashes the callback will be triggered for. If none are given, the callback will be run against the metadata hashes of all groups and examples.

Yield Parameters:

  • metadata (Hash)

    original metadata hash from an example or group. Mutate this in your block as needed.



1263
1264
1265
1266
# File 'lib/rspec/core/configuration.rb', line 1263

def (*filters, &block)
  meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
  @derived_metadata_blocks << [meta, block]
end

- (IO, String) deprecation_stream

Determines where deprecation warnings are printed. Defaults to $stderr.

Returns:

  • (IO, String)

    IO to write to or filename to write to



130
# File 'lib/rspec/core/configuration.rb', line 130

define_reader :deprecation_stream

- (void) deprecation_stream=(value)

Determines where deprecation warnings are printed.

Parameters:

  • value (IO, String)

    IO to write to or filename to write to



134
135
136
137
138
139
140
141
142
143
144
# File 'lib/rspec/core/configuration.rb', line 134

def deprecation_stream=(value)
  if @reporter && !value.equal?(@deprecation_stream)
    warn "RSpec's reporter has already been initialized with " +
      "#{deprecation_stream.inspect} as the deprecation stream, so your change to "+
      "`deprecation_stream` will be ignored. You should configure it earlier for " +
      "it to take effect, or use the `--deprecation-out` CLI option. " +
      "(Called from #{CallerFilter.first_non_rspec_line})"
  else
    @deprecation_stream = value
  end
end

- (void) disable_monkey_patching!

Note:

It configures rspec-mocks and rspec-expectations only if the user is using those (either explicitly or implicitly by not setting mock_with or expect_with to anything else).

Note:

If the user uses this options with mock_with :mocha (or similiar) they will still have monkey patching active in their test environment from mocha.

Enables zero monkey patching mode for RSpec. It removes monkey patching of the top-level DSL methods (describe, shared_examples_for, etc) onto main and Module, instead requiring you to prefix these methods with RSpec.. It enables expect-only syntax for rspec-mocks and rspec-expectations. It simply disables monkey patching on whatever pieces of rspec the user is using.

Examples:


# It disables all monkey patching
RSpec.configure do |config|
  config.disable_monkey_patching!
end

# Is an equivalent to
RSpec.configure do |config|
  config.expose_dsl_globally = false

  config.mock_with :rspec do |mocks|
    mocks.syntax = :expect
    mocks.patch_marshal_to_support_partial_doubles = false
  end

  config.mock_with :rspec do |expectations|
    expectations.syntax = :expect
  end
end


1238
1239
1240
1241
1242
1243
# File 'lib/rspec/core/configuration.rb', line 1238

def disable_monkey_patching!
  self.expose_dsl_globally = false
  self.disable_monkey_patching = true
  conditionally_disable_mocks_monkey_patching
  conditionally_disable_expectations_monkey_patching
end

- (void) exclusion_filter

Returns the exclusion_filter. If none has been set, returns an empty hash.



929
930
931
# File 'lib/rspec/core/configuration.rb', line 929

def exclusion_filter
  filter_manager.exclusions
end

- (void) exclusion_filter=(filter)

Clears and reassigns the exclusion_filter. Set to nil if you don't want any exclusion filter at all.

Warning

This overrides any exclusion filters/tags set on the command line or in configuration files.



922
923
924
925
# File 'lib/rspec/core/configuration.rb', line 922

def exclusion_filter=(filter)
  meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)
  filter_manager.exclude_only meta
end

- (void) expect_with(*frameworks)

Sets the expectation framework module(s) to be included in each example group.

frameworks can be :rspec, :test_unit, :minitest, a custom module, or any combination thereof:

config.expect_with :rspec
config.expect_with :test_unit
config.expect_with :minitest
config.expect_with :rspec, :minitest
config.expect_with OtherExpectationFramework

RSpec will translate :rspec, :minitest, and :test_unit into the appropriate modules.

Configuration

If the module responds to configuration, expect_with will yield the configuration object if given a block:

config.expect_with OtherExpectationFramework do |custom_config|
  custom_config.custom_setting = true
end


517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'lib/rspec/core/configuration.rb', line 517

def expect_with(*frameworks)
  modules = frameworks.map do |framework|
    case framework
    when Module
      framework
    when :rspec
      require 'rspec/expectations'
      self.expecting_with_rspec = true
      ::RSpec::Matchers
    when :test_unit
      require 'rspec/core/test_unit_assertions_adapter'
      ::RSpec::Core::TestUnitAssertionsAdapter
    when :minitest
      require 'rspec/core/minitest_assertions_adapter'
      ::RSpec::Core::MinitestAssertionsAdapter
    else
      raise ArgumentError, "#{framework.inspect} is not supported"
    end
  end

  if (modules - @expectation_frameworks).any?
    assert_no_example_groups_defined(:expect_with)
  end

  if block_given?
    raise "expect_with only accepts a block with a single argument. Call expect_with #{modules.length} times, once with each argument, instead." if modules.length > 1
    raise "#{modules.first} must respond to `configuration` so that expect_with can yield it." unless modules.first.respond_to?(:configuration)
    yield modules.first.configuration
  end

  @expectation_frameworks.push(*modules)
end

- (void) expectation_framework=(framework)

Delegates to expect_with(framework)



490
491
492
# File 'lib/rspec/core/configuration.rb', line 490

def expectation_framework=(framework)
  expect_with(framework)
end

- (void) expectation_frameworks

Returns the configured expectation framework adapter module(s)



484
485
486
487
# File 'lib/rspec/core/configuration.rb', line 484

def expectation_frameworks
  expect_with :rspec if @expectation_frameworks.empty?
  @expectation_frameworks
end

- (void) expose_current_running_example_as(method_name)

Exposes the current running example via the named helper method. RSpec 2.x exposed this via example, but in RSpec 3.0, the example is instead exposed via an arg yielded to it, before, let, etc. However, some extension gems (such as Capybara) depend on the RSpec 2.x's example method, so this config option can be used to maintain compatibility.

Examples:


RSpec.configure do |rspec|
  rspec.expose_current_running_example_as :example
end

describe MyClass do
  before do
    # `example` can be used here because of the above config.
    do_something if example.[:type] == "foo"
  end
end

Parameters:

  • method_name (Symbol)

    the name of the helper method



1176
1177
1178
1179
1180
1181
1182
1183
# File 'lib/rspec/core/configuration.rb', line 1176

def expose_current_running_example_as(method_name)
  ExposeCurrentExample.module_exec do
    extend RSpec::SharedContext
    let(method_name) { |ex| ex }
  end

  include ExposeCurrentExample
end

- (void) expose_dsl_globally=(value)

Use this to expose the core RSpec DSL via Module and the main object. It will be set automatically but you can override it to remove the DSL. Default: true



117
118
119
120
121
122
123
124
125
# File 'lib/rspec/core/configuration.rb', line 117

def expose_dsl_globally=(value)
  if value
    Core::DSL.expose_globally!
    Core::SharedExampleGroup::TopLevelDSL.expose_globally!
  else
    Core::DSL.remove_globally!
    Core::SharedExampleGroup::TopLevelDSL.remove_globally!
  end
end

- (Boolean) expose_dsl_globally?

Indicates if the DSL has been exposed off of modules and main. Default: true

Returns:

  • (Boolean)


109
110
111
# File 'lib/rspec/core/configuration.rb', line 109

def expose_dsl_globally?
  Core::DSL.exposed_globally?
end

- (void) extend(mod, *filters)

Tells RSpec to extend example groups with mod. Methods defined in mod are exposed to example groups (not examples). Use filters to constrain the groups to extend.

Similar to include, but behavior is added to example groups, which are classes, rather than the examples, which are instances of those classes.

Examples:


module UiHelpers
  def run_in_browser
    # ...
  end
end

RSpec.configure do |config|
  config.extend(UiHelpers, :type => :request)
end

describe "edit profile", :type => :request do
  run_in_browser

  it "does stuff in the client" do
    # ...
  end
end

See Also:



999
1000
1001
1002
# File 'lib/rspec/core/configuration.rb', line 999

def extend(mod, *filters)
  meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
  include_or_extend_modules << [:extend, mod, meta]
end

- (void) filter_run_excluding(*args)

Adds key/value pairs to the exclusion_filter. If args includes any symbols that are not part of the hash, each symbol is treated as a key in the hash with the value true.

Note

Filters set using this method can be overridden from the command line or config files (e.g. .rspec).

Examples:

# given this declaration
describe "something", :foo => 'bar' do
  # ...
end

# any of the following will exclude that group
config.filter_run_excluding :foo => 'bar'
config.filter_run_excluding :foo => /^ba/
config.filter_run_excluding :foo => lambda {|v| v == 'bar'}
config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}

# given a proc with an arity of 1, the lambda is passed the value related to the key, e.g.
config.filter_run_excluding :foo => lambda {|v| v == 'bar'}

# given a proc with an arity of 2, the lambda is passed the value related to the key,
# and the metadata itself e.g.
config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'}

filter_run_excluding :foo # same as filter_run_excluding :foo => true


910
911
912
913
# File 'lib/rspec/core/configuration.rb', line 910

def filter_run_excluding(*args)
  meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)
  filter_manager.exclude_with_low_priority meta
end

- (void) filter_run_including(*args) Also known as: filter_run

Adds key/value pairs to the inclusion_filter. If args includes any symbols that are not part of the hash, each symbol is treated as a key in the hash with the value true.

Note

Filters set using this method can be overridden from the command line or config files (e.g. .rspec).

Examples:

# given this declaration
describe "something", :foo => 'bar' do
  # ...
end

# any of the following will include that group
config.filter_run_including :foo => 'bar'
config.filter_run_including :foo => /^ba/
config.filter_run_including :foo => lambda {|v| v == 'bar'}
config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}

# given a proc with an arity of 1, the lambda is passed the value related to the key, e.g.
config.filter_run_including :foo => lambda {|v| v == 'bar'}

# given a proc with an arity of 2, the lambda is passed the value related to the key,
# and the metadata itself e.g.
config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'}

filter_run_including :foo # same as filter_run_including :foo => true


852
853
854
855
# File 'lib/rspec/core/configuration.rb', line 852

def filter_run_including(*args)
  meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)
  filter_manager.include_with_low_priority meta
end

- (void) format_docstrings(&block)

Formats the docstring output using the block provided.

Examples:

# This will strip the descriptions of both examples and example groups.
RSpec.configure do |config|
  config.format_docstrings { |s| s.strip }
end


1071
1072
1073
# File 'lib/rspec/core/configuration.rb', line 1071

def format_docstrings(&block)
  @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER
end

- (Array) formatters

Returns a duplicate of the formatters currently loaded in the FormatterLoader for introspection.

Note as this is a duplicate, any mutations will be disregarded.

Returns:

  • (Array)

    the formatters currently loaded



651
652
653
# File 'lib/rspec/core/configuration.rb', line 651

def formatters
  formatter_loader.formatters.dup
end

- (void) full_backtrace=(true_or_false)

Toggle full backtrace



558
559
560
# File 'lib/rspec/core/configuration.rb', line 558

def full_backtrace=(true_or_false)
  @backtrace_formatter.full_backtrace = true_or_false
end

- (Boolean) full_backtrace?

Check if full backtrace is enabled

Returns:

  • (Boolean)

    is full backtrace enabled



552
553
554
# File 'lib/rspec/core/configuration.rb', line 552

def full_backtrace?
  @backtrace_formatter.full_backtrace?
end

- (Array) full_description

Returns full description filter

Returns:

  • (Array)

    full description filter



607
608
609
# File 'lib/rspec/core/configuration.rb', line 607

def full_description
  filter.fetch :full_description, nil
end

- (void) full_description=(description)

Run examples matching on description in all files to run.

Parameters:

  • description (String, Regexp)

    the pattern to filter on



602
603
604
# File 'lib/rspec/core/configuration.rb', line 602

def full_description=(description)
  filter_run :full_description => Regexp.union(*Array(description).map {|d| Regexp.new(d) })
end

- (void) include(mod, *filters)

Tells RSpec to include mod in example groups. Methods defined in mod are exposed to examples (not example groups). Use filters to constrain the groups in which to include the module.

Examples:


module AuthenticationHelpers
  def (user)
    # ...
  end
end

module UserHelpers
  def users(username)
    # ...
  end
end

RSpec.configure do |config|
  config.include(UserHelpers) # included in all modules
  config.include(AuthenticationHelpers, :type => :request)
end

describe "edit profile", :type => :request do
  it "can be viewed by owning user" do
     users(:jdoe)
    get "/profiles/jdoe"
    assert_select ".username", :text => 'jdoe'
  end
end

See Also:



965
966
967
968
# File 'lib/rspec/core/configuration.rb', line 965

def include(mod, *filters)
  meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
  include_or_extend_modules << [:include, mod, meta]
end

- (void) inclusion_filter Also known as: filter

Returns the inclusion_filter. If none has been set, returns an empty hash.



875
876
877
# File 'lib/rspec/core/configuration.rb', line 875

def inclusion_filter
  filter_manager.inclusions
end

- (void) inclusion_filter=(filter) Also known as: filter=

Clears and reassigns the inclusion_filter. Set to nil if you don't want any inclusion filter at all.

Warning

This overrides any inclusion filters/tags set on the command line or in configuration files.



866
867
868
869
# File 'lib/rspec/core/configuration.rb', line 866

def inclusion_filter=(filter)
  meta = Metadata.build_hash_from([filter], :warn_about_example_group_filtering)
  filter_manager.include_only meta
end

- (void) mock_framework

Returns the configured mock framework adapter module



366
367
368
369
# File 'lib/rspec/core/configuration.rb', line 366

def mock_framework
  mock_with :rspec unless @mock_framework
  @mock_framework
end

- (void) mock_framework=(framework)

Delegates to mock_framework=(framework)



372
373
374
# File 'lib/rspec/core/configuration.rb', line 372

def mock_framework=(framework)
  mock_with framework
end

- (void) mock_with(framework)

Sets the mock framework adapter module.

framework can be a Symbol or a Module.

Given any of :rspec, :mocha, :flexmock, or :rr, configures the named framework.

Given :nothing, configures no framework. Use this if you don't use any mocking framework to save a little bit of overhead.

Given a Module, includes that module in every example group. The module should adhere to RSpec's mock framework adapter API:

setup_mocks_for_rspec
  - called before each example

verify_mocks_for_rspec
  - called after each example if the example hasn't yet failed.
    Framework should raise an exception when expectations fail

teardown_mocks_for_rspec
  - called after verify_mocks_for_rspec (even if there are errors)

If the module responds to configuration and mock_with receives a block, it will yield the configuration object to the block e.g.

config.mock_with OtherMockFrameworkAdapter do |mod_config|
  mod_config.custom_setting = true
end


453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
# File 'lib/rspec/core/configuration.rb', line 453

def mock_with(framework)
  framework_module = if framework.is_a?(Module)
     framework
  else
    const_name = MOCKING_ADAPTERS.fetch(framework) do
      raise ArgumentError,
        "Unknown mocking framework: #{framework.inspect}. " +
        "Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}"
    end

    RSpec::Support.require_rspec_core "mocking_adapters/#{const_name.to_s.downcase}"
    RSpec::Core::MockingAdapters.const_get(const_name)
  end

  new_name, old_name = [framework_module, @mock_framework].map do |mod|
    mod.respond_to?(:framework_name) ?  mod.framework_name : :unnamed
  end

  unless new_name == old_name
    assert_no_example_groups_defined(:mock_framework)
  end

  if block_given?
    raise "#{framework_module} must respond to `configuration` so that mock_with can yield it." unless framework_module.respond_to?(:configuration)
    yield framework_module.configuration
  end

  @mock_framework = framework_module
end

- (void) order=

Sets the default global order and, if order is 'rand:<seed>', also sets the seed.



1113
# File 'lib/rspec/core/configuration.rb', line 1113

delegate_to_ordering_manager :order=

- (void) raise_errors_for_deprecations!

Turns deprecation warnings into errors, in order to surface the full backtrace of the call site. This can be useful when you need more context to address a deprecation than the single-line call site normally provided.

Examples:


RSpec.configure do |rspec|
  rspec.raise_errors_for_deprecations!
end


1198
1199
1200
# File 'lib/rspec/core/configuration.rb', line 1198

def raise_errors_for_deprecations!
  self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new
end

- (void) register_ordering {|list| ... }

Note:

Pass the symbol :global to set the ordering strategy that will be used to order the top-level example groups and any example groups that do not have declared :order metadata.

Registers a named ordering strategy that can later be used to order an example group's subgroups by adding :order => <name> metadata to the example group.

Examples:

RSpec.configure do |rspec|
  rspec.register_ordering :reverse do |list|
    list.reverse
  end
end

describe MyClass, :order => :reverse do
  # ...
end

Parameters:

  • name (Symbol)

    The name of the ordering.

Yields:

  • Block that will order the given examples or example groups

Yield Parameters:

Yield Returns:



1139
# File 'lib/rspec/core/configuration.rb', line 1139

delegate_to_ordering_manager :register_ordering

- (void) seed

Seed for random ordering (default: generated randomly each run).

When you run specs with --order random, RSpec generates a random seed for the randomization and prints it to the output_stream (assuming you're using RSpec's built-in formatters). If you discover an ordering dependency (i.e. examples fail intermittently depending on order), set this (on Configuration or on the command line with --seed) to run using the same seed while you debug the issue.

We recommend, actually, that you use the command line approach so you don't accidentally leave the seed encoded.



1108
# File 'lib/rspec/core/configuration.rb', line 1108

delegate_to_ordering_manager :seed

- (void) seed=

Sets the seed value and sets the default global ordering to random.



1094
# File 'lib/rspec/core/configuration.rb', line 1094

delegate_to_ordering_manager :seed=

- (void) treat_symbols_as_metadata_keys_with_true_values=(value)

Deprecated. This config option was added in RSpec 2 to pave the way for this being the default behavior in RSpec 3. Now this option is a no-op.



252
253
254
255
256
# File 'lib/rspec/core/configuration.rb', line 252

def (value)
  RSpec.deprecate("RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=",
                  :message => "RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values= " +
                              "is deprecated, it is now set to true as default and setting it to false has no effect.")
end

- (void) warnings=(value)

Set Ruby warnings on or off



1145
1146
1147
# File 'lib/rspec/core/configuration.rb', line 1145

def warnings=(value)
  $VERBOSE = !!value
end

- (Boolean) warnings?

Returns Whether or not ruby warnings are enabled.

Returns:

  • (Boolean)

    Whether or not ruby warnings are enabled.



1150
1151
1152
# File 'lib/rspec/core/configuration.rb', line 1150

def warnings?
  $VERBOSE
end