Class: RSpec::Core::ExampleGroup
Constant Summary
Constants included
from Pending
Pending::DEFAULT_MESSAGE
Instance Attribute Summary collapse
#explicit_subject_block
Class Method Summary
collapse
-
.ancestors ⇒ Object
-
.apply?(predicate, filters) ⇒ Boolean
-
.around_hooks_for(example) ⇒ Object
-
.assign_before_all_ivars(ivars, example_group_instance) ⇒ Object
-
.before_all_ivars ⇒ Object
-
.children ⇒ Object
-
.declaration_line_numbers ⇒ Object
-
.define_example_method(name, extra_options = {}) ⇒ Object
(also: alias_example_to)
-
.define_nested_shared_group_method(new_name, report_label = nil) ⇒ Object
(also: alias_it_should_behave_like_to)
-
.delegate_to_metadata(*names) ⇒ Object
-
.descendant_filtered_examples ⇒ Object
-
.descendants ⇒ Object
-
.describe(*args, &example_group_block) ⇒ Object
(also: context)
-
.ensure_example_groups_are_configured ⇒ Object
-
.eval_after_alls(example_group_instance) ⇒ Object
-
.eval_after_eachs(example) ⇒ Object
-
.eval_around_eachs(example, initial_procsy) ⇒ Object
-
.eval_before_alls(example_group_instance) ⇒ Object
-
.eval_before_eachs(example) ⇒ Object
-
.examples ⇒ Object
-
.fail_fast? ⇒ Boolean
-
.fail_filtered_examples(exception, reporter) ⇒ Object
-
.filtered_examples ⇒ Object
-
.include_context(name) ⇒ Object
(also: include_examples)
-
.metadata ⇒ Object
-
.register ⇒ Object
-
.run(reporter) ⇒ Object
-
.run_examples(reporter) ⇒ Object
-
.set_it_up(*args) ⇒ Object
-
.set_ivars(instance, ivars) ⇒ Object
-
.store_before_all_ivars(example_group_instance) ⇒ Object
-
.subclass(parent, args, &example_group_block) ⇒ Object
-
.superclass_metadata ⇒ Object
-
.top_level? ⇒ Boolean
-
.top_level_description ⇒ Object
-
.world ⇒ Object
Instance Method Summary
collapse
#build_metadata_hash_from
module_eval_with_args
#instance_eval_with_args
its, subject
Methods included from Hooks
after, around, before, find_hook, hooks, run_hook, run_hook!, run_hook_filtered
Methods included from Let
included
Methods included from Pending
#pending
#subject
Instance Attribute Details
#example ⇒ Object
Returns the value of attribute example.
14
15
16
|
# File 'lib/rspec/core/example_group.rb', line 14
def example
@example
end
|
Class Method Details
.ancestors ⇒ Object
154
155
156
|
# File 'lib/rspec/core/example_group.rb', line 154
def self.ancestors
@_ancestors ||= super().select {|a| a < RSpec::Core::ExampleGroup}
end
|
.apply?(predicate, filters) ⇒ Boolean
300
301
302
|
# File 'lib/rspec/core/example_group.rb', line 300
def self.apply?(predicate, filters)
metadata.apply?(predicate, filters)
end
|
.around_hooks_for(example) ⇒ Object
249
250
251
|
# File 'lib/rspec/core/example_group.rb', line 249
def self.around_hooks_for(example)
world.find_hook(:around, :each, self, example) + ancestors.reverse.inject([]){|l,a| l + a.find_hook(:around, :each, self, example)}
end
|
.assign_before_all_ivars(ivars, example_group_instance) ⇒ Object
198
199
200
201
|
# File 'lib/rspec/core/example_group.rb', line 198
def self.assign_before_all_ivars(ivars, example_group_instance)
return if ivars.empty?
ivars.each { |ivar, val| example_group_instance.instance_variable_set(ivar, val) }
end
|
.before_all_ivars ⇒ Object
187
188
189
|
# File 'lib/rspec/core/example_group.rb', line 187
def self.before_all_ivars
@before_all_ivars ||= {}
end
|
.children ⇒ Object
146
147
148
|
# File 'lib/rspec/core/example_group.rb', line 146
def self.children
@children ||= []
end
|
.declaration_line_numbers ⇒ Object
304
305
306
307
308
|
# File 'lib/rspec/core/example_group.rb', line 304
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
|
.define_example_method(name, extra_options = {}) ⇒ Object
Also known as:
alias_example_to
43
44
45
46
47
48
49
50
51
52
53
|
# File 'lib/rspec/core/example_group.rb', line 43
def self.define_example_method(name, ={})
module_eval(<<-END_RUBY, __FILE__, __LINE__)
def self.#{name}(desc=nil, *args, &block)
options = build_metadata_hash_from(args)
options.update(:pending => true) unless block
options.update(#{.inspect})
examples << RSpec::Core::Example.new(self, desc, options, block)
examples.last
end
END_RUBY
end
|
.define_nested_shared_group_method(new_name, report_label = nil) ⇒ Object
Also known as:
alias_it_should_behave_like_to
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
# File 'lib/rspec/core/example_group.rb', line 68
def self.define_nested_shared_group_method(new_name, report_label=nil)
module_eval(<<-END_RUBY, __FILE__, __LINE__)
def self.#{new_name}(name, *args, &customization_block)
shared_block = world.shared_example_groups[name]
raise "Could not find shared example group named \#{name.inspect}" unless shared_block
group = describe("#{report_label || "it should behave like"} \#{name}") do
module_eval_with_args(*args, &shared_block)
module_eval(&customization_block) if customization_block
end
group.metadata[:shared_group_name] = name
group
end
END_RUBY
end
|
30
31
32
33
34
35
36
|
# File 'lib/rspec/core/example_group.rb', line 30
def self.delegate_to_metadata(*names)
names.each do |name|
define_method name do
metadata[:example_group][name]
end
end
end
|
.descendant_filtered_examples ⇒ Object
108
109
110
|
# File 'lib/rspec/core/example_group.rb', line 108
def self.descendant_filtered_examples
@descendant_filtered_examples ||= filtered_examples + children.inject([]){|l,c| l + c.descendant_filtered_examples}
end
|
.descendants ⇒ Object
150
151
152
|
# File 'lib/rspec/core/example_group.rb', line 150
def self.descendants
@_descendants ||= [self] + children.inject([]) {|list, c| list + c.descendants}
end
|
.describe(*args, &example_group_block) ⇒ Object
Also known as:
context
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
# File 'lib/rspec/core/example_group.rb', line 120
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)
child = const_set(
"Nested_#{@_subclass_count}",
subclass(self, args, &example_group_block)
)
children << child
child
end
|
162
163
164
165
166
167
168
|
# File 'lib/rspec/core/example_group.rb', line 162
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
|
.eval_after_alls(example_group_instance) ⇒ Object
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
# File 'lib/rspec/core/example_group.rb', line 229
def self.eval_after_alls(example_group_instance)
return if descendant_filtered_examples.empty?
assign_before_all_ivars(before_all_ivars, example_group_instance)
begin
run_hook!(:after, :all, example_group_instance)
rescue => e
RSpec.configuration.reporter.message <<-EOS
An error occurred in an after(:all) hook.
#{e.class}: #{e.message}
occurred at #{e.backtrace.first}
EOS
end
world.run_hook_filtered(:after, :all, self, example_group_instance)
end
|
.eval_after_eachs(example) ⇒ Object
224
225
226
227
|
# File 'lib/rspec/core/example_group.rb', line 224
def self.eval_after_eachs(example)
ancestors.each { |ancestor| ancestor.run_hook(:after, :each, example.example_group_instance) }
world.run_hook_filtered(:after, :each, self, example.example_group_instance, example)
end
|
.eval_around_eachs(example, initial_procsy) ⇒ Object
211
212
213
214
215
216
217
|
# File 'lib/rspec/core/example_group.rb', line 211
def self.eval_around_eachs(example, initial_procsy)
example.around_hooks.reverse.inject(initial_procsy) do |procsy, around_hook|
Example.procsy(procsy.metadata) do
example.example_group_instance.instance_eval_with_args(procsy, &around_hook)
end
end
end
|
.eval_before_alls(example_group_instance) ⇒ Object
203
204
205
206
207
208
209
|
# File 'lib/rspec/core/example_group.rb', line 203
def self.eval_before_alls(example_group_instance)
return if descendant_filtered_examples.empty?
assign_before_all_ivars(superclass.before_all_ivars, example_group_instance)
world.run_hook_filtered(:before, :all, self, example_group_instance)
run_hook!(:before, :all, example_group_instance)
store_before_all_ivars(example_group_instance)
end
|
.eval_before_eachs(example) ⇒ Object
219
220
221
222
|
# File 'lib/rspec/core/example_group.rb', line 219
def self.eval_before_eachs(example)
world.run_hook_filtered(:before, :each, self, example.example_group_instance, example)
ancestors.reverse.each { |ancestor| ancestor.run_hook(:before, :each, example.example_group_instance) }
end
|
.examples ⇒ Object
100
101
102
|
# File 'lib/rspec/core/example_group.rb', line 100
def self.examples
@examples ||= []
end
|
.fail_fast? ⇒ Boolean
285
286
287
|
# File 'lib/rspec/core/example_group.rb', line 285
def self.fail_fast?
RSpec.configuration.fail_fast?
end
|
.fail_filtered_examples(exception, reporter) ⇒ Object
274
275
276
277
278
279
280
281
282
283
|
# File 'lib/rspec/core/example_group.rb', line 274
def self.fail_filtered_examples(exception, reporter)
filtered_examples.each { |example| example.fail_fast(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
|
.filtered_examples ⇒ Object
104
105
106
|
# File 'lib/rspec/core/example_group.rb', line 104
def self.filtered_examples
world.filtered_examples[self]
end
|
.include_context(name) ⇒ Object
Also known as:
include_examples
92
93
94
|
# File 'lib/rspec/core/example_group.rb', line 92
def self.include_context(name)
module_eval(&world.shared_example_groups[name])
end
|
112
113
114
|
# File 'lib/rspec/core/example_group.rb', line 112
def self.metadata
@metadata if defined?(@metadata)
end
|
.register ⇒ Object
25
26
27
|
# File 'lib/rspec/core/example_group.rb', line 25
def self.register
world.register(self)
end
|
.run(reporter) ⇒ Object
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
# File 'lib/rspec/core/example_group.rb', line 253
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
eval_before_alls(new)
result_for_this_group = run_examples(reporter)
results_for_descendants = children.map {|child| child.run(reporter)}.all?
result_for_this_group && results_for_descendants
rescue Exception => ex
fail_filtered_examples(ex, reporter)
ensure
eval_after_alls(new)
before_all_ivars.clear
reporter.example_group_finished(self)
end
end
|
.run_examples(reporter) ⇒ Object
289
290
291
292
293
294
295
296
297
298
|
# File 'lib/rspec/core/example_group.rb', line 289
def self.run_examples(reporter)
filtered_examples.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
|
.set_it_up(*args) ⇒ Object
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
# File 'lib/rspec/core/example_group.rb', line 170
def self.set_it_up(*args)
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)
world.configure_group(self)
end
|
.set_ivars(instance, ivars) ⇒ Object
314
315
316
|
# File 'lib/rspec/core/example_group.rb', line 314
def self.set_ivars(instance, ivars)
ivars.each {|name, value| instance.instance_variable_set(name, value)}
end
|
.store_before_all_ivars(example_group_instance) ⇒ Object
191
192
193
194
195
196
|
# File 'lib/rspec/core/example_group.rb', line 191
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
|
.subclass(parent, args, &example_group_block) ⇒ Object
139
140
141
142
143
144
|
# File 'lib/rspec/core/example_group.rb', line 139
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
subclass
end
|
116
117
118
|
# File 'lib/rspec/core/example_group.rb', line 116
def self.superclass_metadata
@superclass_metadata ||= self.superclass.respond_to?(:metadata) ? self.superclass.metadata : nil
end
|
.top_level? ⇒ Boolean
158
159
160
|
# File 'lib/rspec/core/example_group.rb', line 158
def self.top_level?
@top_level ||= superclass == ExampleGroup
end
|
.top_level_description ⇒ Object
310
311
312
|
# File 'lib/rspec/core/example_group.rb', line 310
def self.top_level_description
ancestors.last.description
end
|
.world ⇒ Object
21
22
23
|
# File 'lib/rspec/core/example_group.rb', line 21
def self.world
RSpec.world
end
|
Instance Method Details
#described_class ⇒ Object
318
319
320
|
# File 'lib/rspec/core/example_group.rb', line 318
def described_class
self.class.described_class
end
|
#instance_eval_with_rescue(&hook) ⇒ Object
322
323
324
325
326
327
328
329
|
# File 'lib/rspec/core/example_group.rb', line 322
def instance_eval_with_rescue(&hook)
begin
instance_eval(&hook)
rescue Exception => e
raise unless example
example.set_exception(e)
end
end
|
#running_example ⇒ Object
16
17
18
19
|
# File 'lib/rspec/core/example_group.rb', line 16
def running_example
RSpec.deprecate("running_example", "example")
example
end
|