Method: RSpec::Core::ExampleGroup.example

Defined in:
lib/rspec/core/example_group.rb

.example ⇒ void .example(&example_implementation) ⇒ void .example(doc_string, *metadata_keys, metadata = {}) ⇒ void .example(doc_string, *metadata_keys, metadata = {}, &example_implementation) ⇒ void

Defines an example within a group.

Examples:

example do
end

example "does something" do
end

example "does something", :slow, :uses_js do
end

example "does something", :with => 'additional metadata' do
end

example "does something" do |ex|
  # ex is the Example object that contains metadata about the example
end

Overloads:

  • .example(&example_implementation) ⇒ void

    Parameters:

    • example_implementation (Block) —

      The implementation of the example.

  • .example(doc_string, *metadata_keys, metadata = {}) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Hash) (defaults to: {}) —

      Metadata for the example.

    • metadata_keys (Array<Symbol>) —

      Metadata tags for the example. Will be transformed into hash entries with true values.

  • .example(doc_string, *metadata_keys, metadata = {}, &example_implementation) ⇒ void

    Parameters:

    • doc_string (String) —

      The example's doc string.

    • metadata (Hash) (defaults to: {}) —

      Metadata for the example.

    • metadata_keys (Array<Symbol>) —

      Metadata tags for the example. Will be transformed into hash entries with true values.

    • example_implementation (Block) —

      The implementation of the example.

Yields:



155
 
# File 'lib/rspec/core/example_group.rb', line 155

define_example_method :example