class RSpec::Core::ExampleGroup
ExampleGroup and {Example} are the main structural elements of rspec-core. Consider this example:
describe Thing do it "does something" do end end
The object returned by `describe Thing` is a subclass of ExampleGroup. The object returned by `it “does something”` is an instance of Example, which serves as a wrapper for an instance of the ExampleGroup in which it is declared.
Attributes
@attr_reader Returns the {Example} object that wraps this instance of `ExampleGroup`
Public Class Methods
@private
# File lib/rspec/core/example_group.rb, line 419 def self.all_apply?(filters) metadata.all_apply?(filters) end
@private
# File lib/rspec/core/example_group.rb, line 414 def self.any_apply?(filters) metadata.any_apply?(filters) end
@private
# File lib/rspec/core/example_group.rb, line 320 def self.assign_before_all_ivars(ivars, example_group_instance) ivars.each { |ivar, val| example_group_instance.instance_variable_set(ivar, val) } end
@private
# File lib/rspec/core/example_group.rb, line 306 def self.before_all_ivars @before_all_ivars ||= {} end
@private
# File lib/rspec/core/example_group.rb, line 258 def self.children @children ||= [].extend(Extensions::Ordered::ExampleGroups) end
@private
# File lib/rspec/core/example_group.rb, line 424 def self.declaration_line_numbers @declaration_line_numbers ||= [metadata[:example_group][:line_number]] + examples.collect {|e| e.metadata[:line_number]} + children.inject([]) {|l,c| l + c.declaration_line_numbers} end
@private @macro [attach] ::define_example_method
@param [String] name @param [Hash] extra_options @param [Block] implementation
# File lib/rspec/core/example_group.rb, line 61 def self.define_example_method(name, extra_options={}) module_eval(" def #{name}(desc=nil, *args, &block) options = build_metadata_hash_from(args) options.update(:pending => RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block options.update(#{extra_options.inspect}) examples << RSpec::Core::Example.new(self, desc, options, block) examples.last end ", __FILE__, __LINE__) end
@private
# File lib/rspec/core/example_group.rb, line 38 def self.delegate_to_metadata(*names) names.each do |name| define_method name do metadata[:example_group][name] end end end
@private
# File lib/rspec/core/example_group.rb, line 186 def self.descendant_filtered_examples @descendant_filtered_examples ||= filtered_examples + children.inject([]){|l,c| l + c.descendant_filtered_examples} end
@private
# File lib/rspec/core/example_group.rb, line 263 def self.descendants @_descendants ||= [self] + children.inject([]) {|list, c| list + c.descendants} end
Generates a subclass of this example group which inherits everything except the examples themselves.
## Examples
describe "something" do # << This describe method is defined in # << RSpec::Core::DSL, included in the # << global namespace before do do_something_before end let(:thing) { Thing.new } describe "attribute (of something)" do # examples in the group get the before hook # declared above, and can access `thing` end end
@see RSpec::Core::DSL#describe
# File lib/rspec/core/example_group.rb, line 223 def self.describe(*args, &example_group_block) @_subclass_count ||= 0 @_subclass_count += 1 args << {} unless args.last.is_a?(Hash) args.last.update(:example_group_block => example_group_block) # TODO 2010-05-05: Because we don't know if const_set is thread-safe child = const_set( "Nested_#{@_subclass_count}", subclass(self, args, &example_group_block) ) children << child child end
@private
# File lib/rspec/core/example_group.rb, line 278 def self.ensure_example_groups_are_configured unless defined?(@@example_groups_configured) RSpec.configuration.configure_mock_framework RSpec.configuration.configure_expectation_framework @@example_groups_configured = true end end
@private
# File lib/rspec/core/example_group.rb, line 176 def self.examples @examples ||= [] end
@private
# File lib/rspec/core/example_group.rb, line 409 def self.fail_fast? RSpec.configuration.fail_fast? end
@private
# File lib/rspec/core/example_group.rb, line 397 def self.fail_filtered_examples(exception, reporter) filtered_examples.each { |example| example.fail_with_exception(reporter, exception) } children.each do |child| reporter.example_group_started(child) child.fail_filtered_examples(exception, reporter) reporter.example_group_finished(child) end false end
@private
# File lib/rspec/core/example_group.rb, line 181 def self.filtered_examples world.filtered_examples[self] end
Includes shared content mapped to `name` directly in the group in which it is declared, as opposed to `it_behaves_like`, which creates a nested group. If given a block, that block is also eval'd in the current context.
@see SharedExampleGroup
# File lib/rspec/core/example_group.rb, line 153 def self.include_context(name, *args, &block) find_and_eval_shared("context", name, *args, &block) end
Includes shared content mapped to `name` directly in the group in which it is declared, as opposed to `it_behaves_like`, which creates a nested group. If given a block, that block is also eval'd in the current context.
@see SharedExampleGroup
# File lib/rspec/core/example_group.rb, line 162 def self.include_examples(name, *args, &block) find_and_eval_shared("examples", name, *args, &block) end
The [Metadata](Metadata) object associated with this group. @see Metadata
# File lib/rspec/core/example_group.rb, line 192 def self.metadata @metadata if defined?(@metadata) end
@private
# File lib/rspec/core/example_group.rb, line 268 def self.parent_groups @parent_groups ||= ancestors.select {|a| a < RSpec::Core::ExampleGroup} end
@private
# File lib/rspec/core/example_group.rb, line 32 def self.register world.register(self) end
Runs all the examples in this group
# File lib/rspec/core/example_group.rb, line 362 def self.run(reporter) if RSpec.wants_to_quit RSpec.clear_remaining_example_groups if top_level? return end reporter.example_group_started(self) begin run_before_all_hooks(new) result_for_this_group = run_examples(reporter) results_for_descendants = children.ordered.map {|child| child.run(reporter)}.all? result_for_this_group && results_for_descendants rescue Exception => ex RSpec.wants_to_quit = true if fail_fast? fail_filtered_examples(ex, reporter) ensure run_after_all_hooks(new) before_all_ivars.clear reporter.example_group_finished(self) end end
@private
# File lib/rspec/core/example_group.rb, line 354 def self.run_after_all_hooks(example_group_instance) return if descendant_filtered_examples.empty? assign_before_all_ivars(before_all_ivars, example_group_instance) run_hook(:after, :all, example_group_instance) end
@private
# File lib/rspec/core/example_group.rb, line 349 def self.run_after_each_hooks(example) run_hook(:after, :each, example) end
@private
# File lib/rspec/core/example_group.rb, line 339 def self.run_around_each_hooks(example, initial_procsy) run_hook(:around, :each, example, initial_procsy) end
@private
# File lib/rspec/core/example_group.rb, line 325 def self.run_before_all_hooks(example_group_instance) return if descendant_filtered_examples.empty? begin assign_before_all_ivars(superclass.before_all_ivars, example_group_instance) BeforeAllMemoizedHash.isolate_for_before_all(example_group_instance) do run_hook(:before, :all, example_group_instance) end ensure store_before_all_ivars(example_group_instance) end end
@private
# File lib/rspec/core/example_group.rb, line 344 def self.run_before_each_hooks(example) run_hook(:before, :each, example) end
@private
# File lib/rspec/core/example_group.rb, line 385 def self.run_examples(reporter) filtered_examples.ordered.map do |example| next if RSpec.wants_to_quit instance = new set_ivars(instance, before_all_ivars) succeeded = example.run(instance, reporter) RSpec.wants_to_quit = true if fail_fast? && !succeeded succeeded end.all? end
@private
# File lib/rspec/core/example_group.rb, line 287 def self.set_it_up(*args) # Ruby 1.9 has a bug that can lead to infinite recursion and a # SystemStackError if you include a module in a superclass after # including it in a subclass: https://gist.github.com/845896 # To prevent this, we must include any modules in RSpec::Core::ExampleGroup # before users create example groups and have a chance to include # the same module in a subclass of RSpec::Core::ExampleGroup. # So we need to configure example groups here. ensure_example_groups_are_configured symbol_description = args.shift if args.first.is_a?(Symbol) args << build_metadata_hash_from(args) args.unshift(symbol_description) if symbol_description @metadata = RSpec::Core::Metadata.new(superclass_metadata).process(*args) hooks.register_globals(self, RSpec.configuration.hooks) world.configure_group(self) end
@private
# File lib/rspec/core/example_group.rb, line 436 def self.set_ivars(instance, ivars) ivars.each {|name, value| instance.instance_variable_set(name, value)} end
@private
# File lib/rspec/core/example_group.rb, line 311 def self.store_before_all_ivars(example_group_instance) return if example_group_instance.instance_variables.empty? example_group_instance.instance_variables.each { |ivar| before_all_ivars[ivar] = example_group_instance.instance_variable_get(ivar) } end
@private
# File lib/rspec/core/example_group.rb, line 243 def self.subclass(parent, args, &example_group_block) subclass = Class.new(parent) subclass.set_it_up(*args) subclass.module_eval(&example_group_block) if example_group_block # The LetDefinitions module must be included _after_ other modules # to ensure that it takes precendence when there are name collisions. # Thus, we delay including it until after the example group block # has been eval'd. MemoizedHelpers.define_helpers_on(subclass) subclass end
@private @return [Metadata] belonging to the parent of a nested {ExampleGroup}
# File lib/rspec/core/example_group.rb, line 198 def self.superclass_metadata @superclass_metadata ||= self.superclass.respond_to?(:metadata) ? self.superclass.metadata : nil end
@private
# File lib/rspec/core/example_group.rb, line 273 def self.top_level? @top_level ||= superclass == ExampleGroup end
@private
# File lib/rspec/core/example_group.rb, line 431 def self.top_level_description parent_groups.last.description end
@private
# File lib/rspec/core/example_group.rb, line 27 def self.world RSpec.world end
Public Instance Methods
Works like `alias_method :name, :example` with the added benefit of assigning default metadata to the generated example.
@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.
# File lib/rspec/core/example_group.rb, line 109 def alias_example_to name, extra={} (class << self; self; end).define_example_method name, extra end
Works like `alias_method :name, :it_behaves_like` with the added benefit of assigning default metadata to the generated example.
@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.
# File lib/rspec/core/example_group.rb, line 143 def alias_it_behaves_like_to name, *args, &block (class << self; self; end).define_nested_shared_group_method name, *args, &block end
Returns the class or module passed to the `describe` method (or alias). Returns nil if the subject is not a class or module. @example
describe Thing do it "does something" do described_class == Thing end end
# File lib/rspec/core/example_group.rb, line 462 def described_class self.class.described_class end
# File lib/rspec/core/example_group.rb, line 46 def description description = metadata[:example_group][:description] RSpec.configuration.format_docstrings_block.call(description) end
@private instance_evals the block, capturing and reporting an exception if raised
# File lib/rspec/core/example_group.rb, line 469 def instance_eval_with_rescue(context = nil, &hook) begin instance_eval(&hook) rescue Exception => e raise unless example example.set_exception(e, context) end end
@deprecated use {ExampleGroup#example}
# File lib/rspec/core/example_group.rb, line 446 def running_example RSpec.deprecate("running_example", :replacement => "example") example end