Class: RSpec::Core::Configuration

Inherits:
Object
  • Object
show all
Includes:
Module.new, 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)

Constructor Details

- (Configuration) initialize

rubocop:disable Metrics/AbcSize rubocop:disable Metrics/MethodLength

409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/rspec/core/configuration.rb', line 409
def initialize
  # rubocop:disable Style/GlobalVars
  @start_time = $_rspec_core_load_started_at || ::RSpec::Core::Time.now
  # rubocop:enable Style/GlobalVars
  @expectation_frameworks = []
  @include_modules = FilterableItemRepository::QueryOptimized.new(:any?)
  @extend_modules  = FilterableItemRepository::QueryOptimized.new(:any?)
  @prepend_modules = FilterableItemRepository::QueryOptimized.new(:any?)
  @before_suite_hooks = []
  @after_suite_hooks  = []
  @mock_framework = nil
  @files_or_directories_to_run = []
  @loaded_spec_files = Set.new
  @color = false
  @pattern = '**{,/*/**}/*_spec.rb'
  @exclude_pattern = ''
  @failure_exit_code = 1
  @spec_files_loaded = false
  @backtrace_formatter = BacktraceFormatter.new
  @default_path = 'spec'
  @project_source_dirs = %w[ spec lib app ]
  @deprecation_stream = $stderr
  @output_stream = $stdout
  @reporter = nil
  @reporter_buffer = nil
  @filter_manager = FilterManager.new
  @static_config_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 = FilterableItemRepository::QueryOptimized.new(:any?)
  @threadsafe = true
  @max_displayed_failure_line_count = 10
  @world = World::Null
  @shared_context_metadata_behavior = :trigger_inclusion
  define_built_in_hooks
end

Instance Attribute Details

- (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?
781
782
783
 
# File 'lib/rspec/core/configuration.rb', line 781
def color
  value_for(:color) { @color }
end

- (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]

297
 
# File 'lib/rspec/core/configuration.rb', line 297
add_setting :default_color

- (void) default_path

Note:

Other scripts invoking rspec indirectly will ignore this setting.

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.

103
 
# File 'lib/rspec/core/configuration.rb', line 103
add_read_only_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]

311
 
# File 'lib/rspec/core/configuration.rb', line 311
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.

112
 
# File 'lib/rspec/core/configuration.rb', line 112
add_setting :drb

- (void) drb_port

The drb_port (default: nil).

116
 
# File 'lib/rspec/core/configuration.rb', line 116
add_setting :drb_port

- (void) dry_run

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

196
 
# File 'lib/rspec/core/configuration.rb', line 196
add_setting :dry_run

- (void) error_stream

Default: $stderr.

120
 
# File 'lib/rspec/core/configuration.rb', line 120
add_setting :error_stream

- (String) example_status_persistence_file_path - (void) example_status_persistence_file_path=(value)

The file path to use for persisting example statuses. Necessary for the --only-failures and --next-failures CLI options.

Overloads:

  • - (String) example_status_persistence_file_path

    Returns the file path

    Returns:

    • (String) —

      the file path

  • - (void) example_status_persistence_file_path=(value)

    Parameters:

    • value (String) —

      the file path

169
 
# File 'lib/rspec/core/configuration.rb', line 169
define_reader :example_status_persistence_file_path

- (void) exclude_pattern

Exclude files matching this pattern.

241
 
# File 'lib/rspec/core/configuration.rb', line 241
define_reader :exclude_pattern

- (void) fail_fast

If specified, indicates the number of failures required before cleaning up and exit (default: nil).

191
 
# File 'lib/rspec/core/configuration.rb', line 191
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]

290
 
# File 'lib/rspec/core/configuration.rb', line 290
add_setting :failure_color

- (void) failure_exit_code

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

200
 
# File 'lib/rspec/core/configuration.rb', line 200
add_setting :failure_exit_code

- (Array) files_to_run

The spec files RSpec will run.

Returns:

  • (Array) —

    specified files about to run

927
928
929
 
# File 'lib/rspec/core/configuration.rb', line 927
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]

304
 
# File 'lib/rspec/core/configuration.rb', line 304
add_setting :fixed_color

- (void) libs

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

209
 
# File 'lib/rspec/core/configuration.rb', line 209
define_reader :libs

- (void) max_displayed_failure_line_count

Maximum count of failed source lines to display in the failure reports. (default 10).

394
 
# File 'lib/rspec/core/configuration.rb', line 394
add_setting :max_displayed_failure_line_count

- (void) only_failures (readonly) Also known as: only_failures?

Indicates if the --only-failures (or --next-failure) flag is being used.

180
 
# File 'lib/rspec/core/configuration.rb', line 180
define_reader :only_failures

- (void) output_stream

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

214
 
# File 'lib/rspec/core/configuration.rb', line 214
define_reader :output_stream

- (void) pattern

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

231
 
# File 'lib/rspec/core/configuration.rb', line 231
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]

283
 
# File 'lib/rspec/core/configuration.rb', line 283
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.

262
 
# File 'lib/rspec/core/configuration.rb', line 262
add_setting :profile_examples

- (Array<String>) project_source_dirs

Specifies which directories contain the source code for your project. When a failure occurs, RSpec looks through the backtrace to find a a line of source to print. It first looks for a line coming from one of the project source directories so that, for example, it prints the expectation or assertion call rather than the source code from the expectation or assertion framework.

Returns:

  • (Array<String>) 
257
 
# File 'lib/rspec/core/configuration.rb', line 257
add_setting :project_source_dirs

- (void) requires

Indicates files configured to be required.

204
 
# File 'lib/rspec/core/configuration.rb', line 204
define_reader :requires

- (void) run_all_when_everything_filtered

Deprecated.

Use #filter_run_when_matching instead for the specific filters that you want to be ignored if none match.

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

269
 
# File 'lib/rspec/core/configuration.rb', line 269
add_setting :run_all_when_everything_filtered

- (:trigger_inclusion, :apply_to_host_groups) shared_context_metadata_behavior - (void) shared_context_metadata_behavior=(value)

Configures how RSpec treats metadata passed as part of a shared example group definition. For example, given this shared example group definition:

RSpec.shared_context "uses DB", :db => true do
  around(:example) do |ex|
    MyORM.transaction(:rollback => true, &ex)
  end
end

...there are two ways RSpec can treat the :db => true metadata, each of which has a corresponding config option:

  1. :trigger_inclusion: this shared context will be implicitly included in any groups (or examples) that have :db => true metadata.
  2. :apply_to_host_groups: the metadata will be inherited by the metadata hash of all host groups and examples.

:trigger_inclusion is the legacy behavior from before RSpec 3.5 but should be considered deprecated. Instead, you can explicitly include a group with include_context:

RSpec.describe "My model" do
  include_context "uses DB"
end

...or you can configure RSpec to include the context based on matching metadata using an API that mirrors configured module inclusion:

RSpec.configure do |rspec|
  rspec.include_context "uses DB", :db => true
end

:apply_to_host_groups is a new feature of RSpec 3.5 and will be the only supported behavior in RSpec 4.

Overloads:

  • - (:trigger_inclusion, :apply_to_host_groups) shared_context_metadata_behavior

    Returns the configured behavior

    Returns:

    • (:trigger_inclusion, :apply_to_host_groups) —

      the configured behavior

  • - (void) shared_context_metadata_behavior=(value)

    Parameters:

    • value (:trigger_inclusion, :apply_to_host_groups) —

      sets the configured behavior

370
 
# File 'lib/rspec/core/configuration.rb', line 370
define_reader :shared_context_metadata_behavior

- (void) silence_filter_announcements

Don't print filter info i.e. "Run options: include :focus=>true" (default false).

316
 
# File 'lib/rspec/core/configuration.rb', line 316
add_setting :silence_filter_announcements

- (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]

276
 
# File 'lib/rspec/core/configuration.rb', line 276
add_setting :success_color

- (void) threadsafe

Use threadsafe options where available. Currently this will place a mutex around memoized values such as let blocks.

389
 
# File 'lib/rspec/core/configuration.rb', line 389
add_setting :threadsafe

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.

826
827
828
829
 
# File 'lib/rspec/core/configuration.rb', line 826
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])

526
527
528
529
530
531
532
 
# File 'lib/rspec/core/configuration.rb', line 526
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) after(scope = nil, *meta, &block) Also known as: prepend_after

Defines a after hook. See Hooks#after for full docs.

This method differs from Hooks#after in only one way: it supports the :suite scope. Hooks with the :suite scope will be run once after the last example of the entire suite is executed.

See Also:

1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'lib/rspec/core/configuration.rb', line 1789
def after(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @after_suite_hooks.unshift Hooks::AfterHook.new(block, {})
  end || begin
    on_existing_matching_groups({}) { |g| g.after(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
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:

1029
1030
1031
1032
 
# File 'lib/rspec/core/configuration.rb', line 1029
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

997
998
999
1000
 
# File 'lib/rspec/core/configuration.rb', line 997
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
1060
1061
1062
 
# File 'lib/rspec/core/configuration.rb', line 1060
def alias_it_behaves_like_to(new_name, report_label='')
  RSpec::Core::ExampleGroup.define_nested_shared_group_method(new_name, report_label)
end

- (void) append_after(scope = nil, *meta, &block)

Adds block to the end of the list of after blocks in the same scope (:example, :context, or :suite), in contrast to #after, which adds the hook to the start of the list.

See Hooks#after for full after hook docs.

This method differs from Hooks#append_after in only one way: it supports the :suite scope. Hooks with the :suite scope will be run once after the last example of the entire suite is executed.

See Also:

1812
1813
1814
1815
1816
1817
1818
1819
 
# File 'lib/rspec/core/configuration.rb', line 1812
def append_after(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @after_suite_hooks << Hooks::AfterHook.new(block, {})
  end || begin
    on_existing_matching_groups({}) { |g| g.append_after(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

- (void) around(scope = nil, *meta, &block)

Registers block as an around hook.

See Hooks#around for full around hook docs.

1824
1825
1826
1827
1828
 
# File 'lib/rspec/core/configuration.rb', line 1824
def around(scope=nil, *meta, &block)
  on_existing_matching_groups({}) { |g| g.around(scope, *meta, &block) }
  super(scope, *meta, &block)
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 --backtrace on the command line, in a .rspec file, or in the rspec_options attribute of RSpec's rake task.

562
563
564
 
# File 'lib/rspec/core/configuration.rb', line 562
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

568
569
570
 
# File 'lib/rspec/core/configuration.rb', line 568
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.

580
581
582
 
# File 'lib/rspec/core/configuration.rb', line 580
def backtrace_inclusion_patterns
  @backtrace_formatter.inclusion_patterns
end

- (void) backtrace_inclusion_patterns=(patterns)

Set regular expressions used to include lines in backtrace.

586
587
588
 
# File 'lib/rspec/core/configuration.rb', line 586
def backtrace_inclusion_patterns=(patterns)
  @backtrace_formatter.inclusion_patterns = patterns
end

- (void) before(scope = nil, *meta, &block) Also known as: append_before

Defines a before hook. See Hooks#before for full docs.

This method differs from Hooks#before in only one way: it supports the :suite scope. Hooks with the :suite scope will be run once before the first example of the entire suite is executed.

See Also:

1748
1749
1750
1751
1752
1753
1754
1755
 
# File 'lib/rspec/core/configuration.rb', line 1748
def before(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @before_suite_hooks << Hooks::BeforeHook.new(block, {})
  end || begin
    on_existing_matching_groups({}) { |g| g.before(scope, *meta, &block) }
    super(scope, *meta, &block)
  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) 
789
790
791
 
# File 'lib/rspec/core/configuration.rb', line 789
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'.

834
835
836
 
# File 'lib/rspec/core/configuration.rb', line 834
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
845
846
847
 
# File 'lib/rspec/core/configuration.rb', line 845
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.define_derived_metadata(:file_path => %r{/spec/unit/}) do |metadata|
    metadata[: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.

1692
1693
1694
1695
 
# File 'lib/rspec/core/configuration.rb', line 1692
def define_derived_metadata(*filters, &block)
  meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
  @derived_metadata_blocks.append(block, meta)
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

145
 
# File 'lib/rspec/core/configuration.rb', line 145
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

149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/rspec/core/configuration.rb', line 149
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
1665
1666
1667
1668
1669
1670
 
# File 'lib/rspec/core/configuration.rb', line 1665
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.

1189
1190
1191
 
# File 'lib/rspec/core/configuration.rb', line 1189
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.

1182
1183
1184
1185
 
# File 'lib/rspec/core/configuration.rb', line 1182
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

722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/rspec/core/configuration.rb', line 722
def expect_with(*frameworks)
  modules = frameworks.map do |framework|
    case framework
    when Module
      framework
    when :rspec
      require 'rspec/expectations'
      # Tag this exception class so our exception formatting logic knows
      # that it satisfies the `MultipleExceptionError` interface.
      ::RSpec::Expectations::MultipleExpectationsNotMetError.__send__(
        :include, MultipleExceptionError::InterfaceTag
      )
      ::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).

695
696
697
 
# File 'lib/rspec/core/configuration.rb', line 695
def expectation_framework=(framework)
  expect_with(framework)
end

- (void) expectation_frameworks

Returns the configured expectation framework adapter module(s)

683
684
685
686
687
688
689
690
691
692
 
# File 'lib/rspec/core/configuration.rb', line 683
def expectation_frameworks
  if @expectation_frameworks.empty?
    begin
      expect_with :rspec
    rescue LoadError
      expect_with Module.new
    end
  end
  @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.metadata[:type] == "foo"
  end
end

Parameters:

  • method_name (Symbol) —

    the name of the helper method

1603
1604
1605
1606
1607
1608
1609
1610
 
# File 'lib/rspec/core/configuration.rb', line 1603
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

132
133
134
135
136
137
138
139
140
 
# File 'lib/rspec/core/configuration.rb', line 132
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) 
124
125
126
 
# File 'lib/rspec/core/configuration.rb', line 124
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:

1312
1313
1314
1315
1316
 
# File 'lib/rspec/core/configuration.rb', line 1312
def extend(mod, *filters)
  define_mixed_in_module(mod, filters, @extend_modules, :extend) do |group|
    safe_extend(mod, group)
  end
end

- (void) filter_gems_from_backtrace(*gem_names)

Note:

The patterns this adds will match the named gems in their common locations (e.g. system gems, vendored with bundler, installed as a :git dependency with bundler, etc) but is not guaranteed to work for all possible gem locations. For example, if you have the gem source in a directory with a completely unrelated name, and use bundler's :path option, this will not filter it.

Adds #backtrace_exclusion_patterns that will filter lines from the named gems from backtraces.

Examples:

RSpec.configure do |config|
  config.filter_gems_from_backtrace "rack", "rake"
end

Parameters:

  • gem_names (Array<String>) —

    Names of the gems to filter

606
607
608
609
610
 
# File 'lib/rspec/core/configuration.rb', line 606
def filter_gems_from_backtrace(*gem_names)
  gem_names.each do |name|
    @backtrace_formatter.filter_gem(name)
  end
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
1169
1170
1171
1172
1173
 
# File 'lib/rspec/core/configuration.rb', line 1169
def filter_run_excluding(*args)
  meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)
  filter_manager.exclude_with_low_priority meta
  static_config_filter_manager.exclude_with_low_priority Metadata.deep_hash_dup(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
1095
1096
1097
1098
1099
 
# File 'lib/rspec/core/configuration.rb', line 1095
def filter_run_including(*args)
  meta = Metadata.build_hash_from(args, :warn_about_example_group_filtering)
  filter_manager.include_with_low_priority meta
  static_config_filter_manager.include_with_low_priority Metadata.deep_hash_dup(meta)
end

- (void) filter_run_when_matching(*args)

Applies the provided filter only if any of examples match, in constrast to #filter_run, which always applies even if no examples match, in which case no examples will be run. This allows you to leave configured filters in place that are intended only for temporary use. The most common example is focus filtering: config.filter_run_when_matching :focus. With that configured, you can temporarily focus an example or group by tagging it with :focus metadata, or prefixing it with an f (as in fdescribe, fcontext and fit) since those are aliases for describe/context/it with :focus metadata.

1111
1112
1113
1114
1115
 
# File 'lib/rspec/core/configuration.rb', line 1111
def filter_run_when_matching(*args)
  when_first_matching_example_defined(*args) do
    filter_run(*args)
  end
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
1453
1454
1455
 
# File 'lib/rspec/core/configuration.rb', line 1453
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

855
856
857
 
# File 'lib/rspec/core/configuration.rb', line 855
def formatters
  formatter_loader.formatters.dup
end

- (void) full_backtrace=(true_or_false)

Toggle full backtrace.

772
773
774
 
# File 'lib/rspec/core/configuration.rb', line 772
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

766
767
768
 
# File 'lib/rspec/core/configuration.rb', line 766
def full_backtrace?
  @backtrace_formatter.full_backtrace?
end

- (Array) full_description

Returns full description filter

Returns:

  • (Array) —

    full description filter

811
812
813
 
# File 'lib/rspec/core/configuration.rb', line 811
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

806
807
808
 
# File 'lib/rspec/core/configuration.rb', line 806
def full_description=(description)
  filter_run :full_description => Regexp.union(*Array(description).map { |d| Regexp.new(d) })
end

- (void) include(mod, *filters)

Note:

Filtered module inclusions can also be applied to individual examples that have matching metadata. Just like Ruby's object model is that every object has a singleton class which has only a single instance, RSpec's model is that every example has a singleton example group containing just the one example.

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 or examples 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 groups
  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:

1234
1235
1236
1237
1238
 
# File 'lib/rspec/core/configuration.rb', line 1234
def include(mod, *filters)
  define_mixed_in_module(mod, filters, @include_modules, :include) do |group|
    safe_include(mod, group)
  end
end

- (void) include_context(shared_group_name, *filters)

Note:

Filtered context inclusions can also be applied to individual examples that have matching metadata. Just like Ruby's object model is that every object has a singleton class which has only a single instance, RSpec's model is that every example has a singleton example group containing just the one example.

Tells RSpec to include the named shared example group in example groups. Use filters to constrain the groups or examples in which to include the example group.

Examples:


RSpec.shared_context "example users" do
  let(:admin_user) { create_user(:admin) }
  let(:guest_user) { create_user(:guest) }
end
RSpec.configure do |config|
  config.include_context "example users", :type => :request
end
RSpec.describe "The admin page", :type => :request do
  it "can be viewed by admins" do
     admin_user
    get "/admin"
    expect(response).to be_ok
  end
  it "cannot be viewed by guests" do
     guest_user
    get "/admin"
    expect(response).to be_forbidden
  end
end

See Also:

1277
1278
1279
1280
 
# File 'lib/rspec/core/configuration.rb', line 1277
def include_context(shared_group_name, *filters)
  shared_module = world.shared_example_group_registry.find([:main], shared_group_name)
  include shared_module, *filters
end

- (void) inclusion_filter Also known as: filter

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

1133
1134
1135
 
# File 'lib/rspec/core/configuration.rb', line 1133
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.

1124
1125
1126
1127
 
# File 'lib/rspec/core/configuration.rb', line 1124
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.

535
536
537
538
539
540
541
542
543
544
 
# File 'lib/rspec/core/configuration.rb', line 535
def mock_framework
  if @mock_framework.nil?
    begin
      mock_with :rspec
    rescue LoadError
      mock_with :nothing
    end
  end
  @mock_framework
end

- (void) mock_framework=(framework)

Delegates to mock_framework=(framework).

547
548
549
 
# File 'lib/rspec/core/configuration.rb', line 547
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

650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/rspec/core/configuration.rb', line 650
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) on_example_group_definition(&block)

Invokes block before defining an example group

1852
1853
1854
 
# File 'lib/rspec/core/configuration.rb', line 1852
def on_example_group_definition(&block)
  on_example_group_definition_callbacks << block
end

- (void) on_example_group_definition_callbacks

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.

Returns an array of blocks to call before defining an example group

1858
1859
1860
 
# File 'lib/rspec/core/configuration.rb', line 1858
def on_example_group_definition_callbacks
  @on_example_group_definition_callbacks ||= []
end

- (void) order=

Sets the default global ordering strategy. By default this can be one of :defined, :random, but is customizable through the register_ordering API. If order is set to 'rand:<seed>', the seed will also be set.

See Also:

1500
 
# File 'lib/rspec/core/configuration.rb', line 1500
delegate_to_ordering_manager :order=

- (void) prepend(mod, *filters)

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

Similar to include, but module is included before the example group's class in the ancestor chain.

Examples:


module OverrideMod
  def override_me
    "overridden"
  end
end
RSpec.configure do |config|
  config.prepend(OverrideMod, :method => :prepend)
end
describe "overriding example's class", :method => :prepend do
  it "finds the user" do
    self.class.class_eval do
      def override_me
      end
    end
    override_me # => "overridden"
    # ...
  end
end

See Also:

1351
1352
1353
1354
1355
 
# File 'lib/rspec/core/configuration.rb', line 1351
def prepend(mod, *filters)
  define_mixed_in_module(mod, filters, @prepend_modules, :prepend) do |group|
    safe_prepend(mod, group)
  end
end

- (void) prepend_before(scope = nil, *meta, &block)

Adds block to the start of the list of before blocks in the same scope (:example, :context, or :suite), in contrast to #before, which adds the hook to the end of the list.

See Hooks#before for full before hook docs.

This method differs from Hooks#prepend_before in only one way: it supports the :suite scope. Hooks with the :suite scope will be run once before the first example of the entire suite is executed.

See Also:

1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/rspec/core/configuration.rb', line 1771
def prepend_before(scope=nil, *meta, &block)
  handle_suite_hook(scope, meta) do
    @before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})
  end || begin
    on_existing_matching_groups({}) { |g| g.prepend_before(scope, *meta, &block) }
    super(scope, *meta, &block)
  end
end

- (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
1625
1626
1627
 
# File 'lib/rspec/core/configuration.rb', line 1625
def raise_errors_for_deprecations!
  self.deprecation_stream = Formatters::DeprecationFormatter::RaiseErrorStream.new
end

- (void) raise_on_warning=(value)

Turns warnings into errors. This can be useful when you want RSpec to run in a 'strict' no warning situation.

Examples:


RSpec.configure do |rspec|
  rspec.raise_on_warning = true
end
1573
1574
1575
1576
1577
1578
1579
 
# File 'lib/rspec/core/configuration.rb', line 1573
def raise_on_warning=(value)
  if value
    RSpec::Support.warning_notifier = RAISE_ERROR_WARNING_NOTIFIER
  else
    RSpec::Support.warning_notifier = RSpec::Support::DEFAULT_WARNING_NOTIFIER
  end
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
RSpec.describe 'MyClass', :order => :reverse do
  # ...
end
RSpec.configure do |rspec|
  rspec.register_ordering :global do |examples|
    acceptance, other = examples.partition do |example|
      example.metadata[:type] == :acceptance
    end
    other + acceptance
  end
end
RSpec.describe 'MyClass', :type => :acceptance do
  # will run last
end
RSpec.describe 'MyClass' do
  # will run first
end

Parameters:

  • name (Symbol) —

    The name of the ordering.

Yields:

  • Block that will order the given examples or example groups

Yield Parameters:

Yield Returns:

1547
 
# File 'lib/rspec/core/configuration.rb', line 1547
delegate_to_ordering_manager :register_ordering

- (RSpec::Core::Reporter) reporter

Returns the currently configured reporter

Returns:

887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'lib/rspec/core/configuration.rb', line 887
def reporter
  # @reporter_buffer should only ever be set in this method to cover
  # initialization of @reporter.
  @reporter_buffer || @reporter ||=
    begin
      @reporter_buffer = DeprecationReporterBuffer.new
      formatter_loader.setup_default output_stream, deprecation_stream
      @reporter_buffer.play_onto(formatter_loader.reporter)
      @reporter_buffer = nil
      formatter_loader.reporter
    end
end

- (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.

1490
 
# File 'lib/rspec/core/configuration.rb', line 1490
delegate_to_ordering_manager :seed

- (void) seed=

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

1476
 
# File 'lib/rspec/core/configuration.rb', line 1476
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.

321
322
323
324
325
326
327
328
 
# File 'lib/rspec/core/configuration.rb', line 321
def treat_symbols_as_metadata_keys_with_true_values=(_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.

1553
1554
1555
 
# File 'lib/rspec/core/configuration.rb', line 1553
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.

1558
1559
1560
 
# File 'lib/rspec/core/configuration.rb', line 1558
def warnings?
  $VERBOSE
end

- (void) when_first_matching_example_defined(*filters, &block)

Defines a callback that runs after the first example with matching metadata is defined. If no examples are defined with matching metadata, it will not get called at all.

This can be used to ensure some setup is performed (such as bootstrapping a DB or loading a specific file that adds significantly to the boot time) if needed (as indicated by the presence of an example with matching metadata) but avoided otherwise.

Examples:

RSpec.configure do |config|
  config.when_first_matching_example_defined(:db) do
    # Load a support file that does some heavyweight setup,
    # including bootstrapping the DB, but only if we have loaded
    # any examples tagged with `:db`.
    require 'support/db'
  end
end
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
 
# File 'lib/rspec/core/configuration.rb', line 1715
def when_first_matching_example_defined(*filters, &block)
  specified_meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
  callback = lambda do |example_or_group_meta|
    # Example groups do not have `:example_group` metadata
    # (instead they have `:parent_example_group` metadata).
    return unless example_or_group_meta.key?(:example_group)
    # Ensure the callback only fires once.
    @derived_metadata_blocks.items_for(specified_meta).delete(callback)
    block.call
  end
  @derived_metadata_blocks.append(callback, specified_meta)
end