Module: RSpec

Defined in:
lib/rspec/core.rb,
lib/rspec/core/dsl.rb,
lib/rspec/core/drb.rb,
lib/rspec/core/hooks.rb,
lib/rspec/core/world.rb,
lib/rspec/core/runner.rb,
lib/rspec/core/sandbox.rb,
lib/rspec/core/pending.rb,
lib/rspec/core/example.rb,
lib/rspec/core/version.rb,
lib/rspec/core/metadata.rb,
lib/rspec/core/flat_map.rb,
lib/rspec/core/ordering.rb,
lib/rspec/core/warnings.rb,
lib/rspec/core/rake_task.rb,
lib/rspec/core/ruby_project.rb,
lib/rspec/core/configuration.rb,
lib/rspec/core/example_group.rb,
lib/rspec/core/shared_context.rb,
lib/rspec/core/filter_manager.rb,
lib/rspec/core/metadata_filter.rb,
lib/rspec/core/backport_random.rb,
lib/rspec/core/memoized_helpers.rb,
lib/rspec/core/formatters/helpers.rb,
lib/rspec/core/mocking_adapters/rr.rb,
lib/rspec/core/backtrace_formatter.rb,
lib/rspec/core/formatters/protocol.rb,
lib/rspec/core/project_initializer.rb,
lib/rspec/core/shared_example_group.rb,
lib/rspec/core/configuration_options.rb,
lib/rspec/core/mocking_adapters/null.rb,
lib/rspec/core/mocking_adapters/rspec.rb,
lib/rspec/core/mocking_adapters/mocha.rb,
lib/rspec/core/formatters/html_printer.rb,
lib/rspec/core/formatters/console_codes.rb,
lib/rspec/core/mocking_adapters/flexmock.rb,
lib/rspec/core/formatters/base_formatter.rb,
lib/rspec/core/formatters/html_formatter.rb,
lib/rspec/core/formatters/json_formatter.rb,
lib/rspec/core/minitest_assertions_adapter.rb,
lib/rspec/core/formatters/snippet_extractor.rb,
lib/rspec/core/test_unit_assertions_adapter.rb,
lib/rspec/core/formatters/profile_formatter.rb,
lib/rspec/core/formatters/progress_formatter.rb,
lib/rspec/core/formatters/base_text_formatter.rb,
lib/rspec/core/formatters/deprecation_formatter.rb,
lib/rspec/core/formatters/documentation_formatter.rb

Overview

This is borrowed (slightly modified) from Scott Taylor's project_path project: http://github.com/smtlaissezfaire/project_path

Defined Under Namespace

Modules: Core

Constant Summary

Class Attribute Summary (collapse)

Class Method Summary (collapse)

Class Attribute Details

+ (void) configuration

Returns the global Configuration object. While you can use this method to access the configuration, the more common convention is to use RSpec.configure.

Examples:

RSpec.configuration.drb_port = 1234

See Also:

84
85
86
87
88
89
90
 
# File 'lib/rspec/core.rb', line 84
def self.configuration
  @configuration ||= begin
                       config = RSpec::Core::Configuration.new
                       config.expose_dsl_globally = true
                       config
                     end
end

+ (void) world=(value)

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.

Setters for shared global objects

49
50
51
 
# File 'lib/rspec/core.rb', line 49
def world=(value)
  @world = value
end

Class Method Details

+ (void) clear_examples

Used to ensure examples get reloaded between multiple runs in the same process and ensures user configuration is persisted.

Users must invoke this if they want to clear all examples but preserve current configuration when they use the runner multiple times within the same process.

69
70
71
72
73
74
 
# File 'lib/rspec/core.rb', line 69
def self.clear_examples
  world.reset
  configuration.reporter.reset
  configuration.start_time = ::RSpec::Core::Time.now
  configuration.reset_filters
end

+ (void) configure {|Configuration| ... }

Yields the global configuration to a block.

Examples:

RSpec.configure do |config|
  config.add_formatter 'documentation'
end

Yields:

  • (Configuration) —

    global configuration

See Also:

100
101
102
 
# File 'lib/rspec/core.rb', line 100
def self.configure
  yield configuration if block_given?
end

+ (void) current_example

The example being executed.

The primary audience for this method is library authors who need access to the example currently being executed and also want to support all versions of RSpec 2 and 3.

Examples:


RSpec.configure do |c|
  # context.example is deprecated, but RSpec.current_example is not
  # available until RSpec 3.0.
  fetch_current_example = RSpec.respond_to?(:current_example) ?
    proc { RSpec.current_example } : proc { |context| context.example }
  c.before(:example) do
    example = fetch_current_example.call(self)
    # ...
  end
end
125
126
127
 
# File 'lib/rspec/core.rb', line 125
def self.current_example
  thread_local_metadata[:current_example]
end

+ (void) current_example=(example)

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.

Set the current example being executed.

131
132
133
 
# File 'lib/rspec/core.rb', line 131
def self.current_example=(example)
  thread_local_metadata[:current_example] = example
end

+ (void) reset

Used to ensure examples get reloaded and user configuration gets reset to defaults between multiple runs in the same process.

Users must invoke this if they want to have the configuration reset when they use the runner multiple times within the same process. Users must deal themselves with re-configuration of RSpec before run.

58
59
60
61
 
# File 'lib/rspec/core.rb', line 58
def self.reset
  @world = nil
  @configuration = nil
end