Files

Class/Module Index [+]

Quicksearch

RSpec

Constants

SharedContext

Public Class Methods

clear_remaining_example_groups() click to toggle source

@private Used internally to clear remaining groups when fail_fast is set

# File lib/rspec/core.rb, line 98
def self.clear_remaining_example_groups
  world.example_groups.clear
end
configuration() click to toggle source

Returns the global [Configuration](RSpec/Core/Configuration) object. While you can use this method to access the configuration, the more common convention is to use [RSpec.configure](RSpec#configure-class_method).

@example

RSpec.configuration.drb_port = 1234

@see RSpec.configure @see Core::Configuration

# File lib/rspec/core.rb, line 80
def self.configuration
  @configuration ||= RSpec::Core::Configuration.new
end
configure() click to toggle source

Yields the global configuration to a block. @yield [Configuration] global configuration

@example

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

@see Core::Configuration

# File lib/rspec/core.rb, line 92
def self.configure
  yield configuration if block_given?
end
deprecate(method, alternate_method=nil, version=nil) click to toggle source

@private

Used internally to print deprecation warnings

# File lib/rspec/core/deprecation.rb, line 6
def deprecate(method, alternate_method=nil, version=nil)
  version_string = version ? "rspec-#{version}" : "a future version of RSpec"

  message = *****************************************************************DEPRECATION WARNING: you are using deprecated behaviour that willbe removed from #{version_string}.#{caller(0)[2]}* #{method} is deprecated.
  if alternate_method
    message << * please use #{alternate_method} instead.
  end

  message << "*****************************************************************"
  warn_deprecation(message)
end
reset() click to toggle source

@private Used internally to ensure examples get reloaded between multiple runs in the same process.

# File lib/rspec/core.rb, line 67
def self.reset
  world.reset
  configuration.reset
end
wants_to_quit() click to toggle source

@private

# File lib/rspec/core.rb, line 47
def self.wants_to_quit
# Used internally to determine what to do when a SIGINT is received
  world.wants_to_quit
end
wants_to_quit=(maybe) click to toggle source

@private Used internally to determine what to do when a SIGINT is received

# File lib/rspec/core.rb, line 54
def self.wants_to_quit=(maybe)
  world.wants_to_quit=(maybe)
end
warn_deprecation(message) click to toggle source

@private

Used internally to print deprecation warnings

# File lib/rspec/core/deprecation.rb, line 32
def warn_deprecation(message)
  send :warn, message
end
world() click to toggle source

@private Internal container for global non-configuration data

# File lib/rspec/core.rb, line 60
def self.world
  @world ||= RSpec::Core::World.new
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.