-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathRSpec.html
486 lines (486 loc) · 27 KB
/
RSpec.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/3.13/rspec-core/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/3.13/rspec-core/js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (R)</a> »
<span class="title">RSpec</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: RSpec
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/core.rb<span class="defines">,<br />
lib/rspec/core/drb.rb,<br /> lib/rspec/core/dsl.rb,<br /> lib/rspec/core/set.rb,<br /> lib/rspec/core/hooks.rb,<br /> lib/rspec/core/world.rb,<br /> lib/rspec/core/runner.rb,<br /> lib/rspec/core/example.rb,<br /> lib/rspec/core/pending.rb,<br /> lib/rspec/core/sandbox.rb,<br /> lib/rspec/core/version.rb,<br /> lib/rspec/core/flat_map.rb,<br /> lib/rspec/core/metadata.rb,<br /> lib/rspec/core/ordering.rb,<br /> lib/rspec/core/profiler.rb,<br /> lib/rspec/core/warnings.rb,<br /> lib/rspec/core/rake_task.rb,<br /> lib/rspec/core/invocations.rb,<br /> lib/rspec/core/did_you_mean.rb,<br /> lib/rspec/core/ruby_project.rb,<br /> lib/rspec/core/shell_escape.rb,<br /> lib/rspec/core/bisect/server.rb,<br /> lib/rspec/core/configuration.rb,<br /> lib/rspec/core/example_group.rb,<br /> lib/rspec/core/filter_manager.rb,<br /> lib/rspec/core/output_wrapper.rb,<br /> lib/rspec/core/shared_context.rb,<br /> lib/rspec/core/metadata_filter.rb,<br /> lib/rspec/core/bisect/utilities.rb,<br /> lib/rspec/core/memoized_helpers.rb,<br /> lib/rspec/core/bisect/coordinator.rb,<br /> lib/rspec/core/bisect/fork_runner.rb,<br /> lib/rspec/core/formatters/helpers.rb,<br /> lib/rspec/core/backtrace_formatter.rb,<br /> lib/rspec/core/bisect/shell_runner.rb,<br /> lib/rspec/core/formatters/protocol.rb,<br /> lib/rspec/core/mocking_adapters/rr.rb,<br /> lib/rspec/core/project_initializer.rb,<br /> lib/rspec/core/bisect/shell_command.rb,<br /> lib/rspec/core/shared_example_group.rb,<br /> lib/rspec/core/configuration_options.rb,<br /> lib/rspec/core/mocking_adapters/null.rb,<br /> lib/rspec/core/mocking_adapters/mocha.rb,<br /> lib/rspec/core/mocking_adapters/rspec.rb,<br /> lib/rspec/core/formatters/html_printer.rb,<br /> lib/rspec/core/bisect/example_minimizer.rb,<br /> lib/rspec/core/example_status_persister.rb,<br /> lib/rspec/core/formatters/console_codes.rb,<br /> lib/rspec/core/formatters/base_formatter.rb,<br /> lib/rspec/core/formatters/html_formatter.rb,<br /> lib/rspec/core/formatters/json_formatter.rb,<br /> lib/rspec/core/mocking_adapters/flexmock.rb,<br /> lib/rspec/core/minitest_assertions_adapter.rb,<br /> lib/rspec/core/formatters/profile_formatter.rb,<br /> lib/rspec/core/formatters/snippet_extractor.rb,<br /> lib/rspec/core/test_unit_assertions_adapter.rb,<br /> lib/rspec/core/formatters/progress_formatter.rb,<br /> lib/rspec/core/formatters/syntax_highlighter.rb,<br /> lib/rspec/core/formatters/base_text_formatter.rb,<br /> lib/rspec/core/formatters/exception_presenter.rb,<br /> lib/rspec/core/formatters/bisect_drb_formatter.rb,<br /> lib/rspec/core/formatters/base_bisect_formatter.rb,<br /> lib/rspec/core/formatters/deprecation_formatter.rb,<br /> lib/rspec/core/formatters/failure_list_formatter.rb,<br /> lib/rspec/core/formatters/html_snippet_extractor.rb,<br /> lib/rspec/core/formatters/documentation_formatter.rb,<br /> lib/rspec/core/formatters/bisect_progress_formatter.rb,<br /> lib/rspec/core/formatters/fallback_message_formatter.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This is borrowed (slightly modified) from Scott Taylor's
project_path project:
<a href="http://github.com/smtlaissezfaire/project_path">http://github.com/smtlaissezfaire/project_path</a></p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="RSpec/Core.html" title="RSpec::Core (module)">Core</a></span>
</p>
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#configuration-class_method" title="configuration (class method)">.<strong>configuration</strong> ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the global <a href="RSpec/Core/Configuration">Configuration</a> object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#world=-class_method" title="world= (class method)">.<strong>world</strong> ⇒ void </a>
</span>
<span class="note title writeonly">writeonly</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Setters for shared global objects.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#clear_examples-class_method" title="clear_examples (class method)">.<strong>clear_examples</strong> ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'><p>Used to ensure examples get reloaded between multiple runs in the same process and ensures user configuration is persisted.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|Configuration| ... } ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'><p>Yields the global configuration to a block.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#current_example-class_method" title="current_example (class method)">.<strong>current_example</strong> ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'><p>The example being executed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#current_example=-class_method" title="current_example= (class method)">.<strong>current_example=</strong>(example) ⇒ void </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Set the current example being executed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#current_scope-class_method" title="current_scope (class method)">.<strong>current_scope</strong> ⇒ Symbol </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get the current RSpec execution scope.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#current_scope=-class_method" title="current_scope= (class method)">.<strong>current_scope=</strong>(scope) ⇒ void </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Set the current scope rspec is executing in.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reset-class_method" title="reset (class method)">.<strong>reset</strong> ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'><p>Used to ensure examples get reloaded and user configuration gets reset to defaults between multiple runs in the same process.</p>
</div></span>
</li>
</ul>
<div id="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id="configuration=-class_method"></span>
<div class="method_details first">
<h3 class="signature first" id="configuration-class_method">
.<strong>configuration</strong> ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the global <a href="RSpec/Core/Configuration">Configuration</a> object. While
you <em>can</em> use this method to access the configuration, the more common
convention is to use <a href="RSpec#configure-class_method">RSpec.configure</a>.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_drb_port'>drb_port</span> <span class='op'>=</span> <span class='int'>1234</span></code></pre>
</div>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#configure-class_method" title="RSpec.configure (method)">configure</a></span></li>
<li><span class='object_link'><a href="RSpec/Core/Configuration.html" title="RSpec::Core::Configuration (class)">RSpec::Core::Configuration</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
85
86
87</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 85</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span>
<span class='ivar'>@configuration</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="RSpec/Core.html" title="RSpec::Core (module)">Core</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="RSpec/Core/Configuration.html" title="RSpec::Core::Configuration (class)">Configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="RSpec/Core/Configuration.html#initialize-instance_method" title="RSpec::Core::Configuration#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="world-class_method"></span>
<div class="method_details ">
<h3 class="signature " id="world=-class_method">
.<strong>world=</strong>(value) ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Setters for shared global objects</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_world='>world=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='ivar'>@world</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="clear_examples-class_method">
.<strong>clear_examples</strong> ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Used to ensure examples get reloaded between multiple runs in the same
process and ensures user configuration is persisted.</p>
<p>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.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72
73
74
75</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 70</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_clear_examples'>clear_examples</span>
<span class='id identifier rubyid_world'>world</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span>
<span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_reset_reporter'>reset_reporter</span>
<span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_start_time'>start_time</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="RSpec/Core.html" title="RSpec::Core (module)">Core</a></span></span><span class='op'>::</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span>
<span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_reset_filters'>reset_filters</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="configure-class_method">
.<strong>configure</strong> {|Configuration| ... } ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Yields the global configuration to a block.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_add_formatter'>add_formatter</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>documentation</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></code></pre>
</div>
<p class="tag_title">Yields:</p>
<ul class="yield">
<li>
<span class='type'>(<tt>Configuration</tt>)</span>
—
<div class='inline'><p>global configuration</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="RSpec/Core/Configuration.html" title="RSpec::Core::Configuration (class)">RSpec::Core::Configuration</a></span></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 97</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span>
<span class='kw'>yield</span> <span class='id identifier rubyid_configuration'>configuration</span> <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="current_example-class_method">
.<strong>current_example</strong> ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The example being executed.</p>
<p>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.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code>
<span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="#configure-class_method" title="RSpec.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
<span class='comment'># context.example is deprecated, but RSpec.current_example is not
</span> <span class='comment'># available until RSpec 3.0.
</span> <span class='id identifier rubyid_fetch_current_example'>fetch_current_example</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:current_example</span><span class='rparen'>)</span> <span class='op'>?</span>
<span class='id identifier rubyid_proc'>proc</span> <span class='lbrace'>{</span> <span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_current_example'>current_example</span> <span class='rbrace'>}</span> <span class='op'>:</span> <span class='id identifier rubyid_proc'>proc</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_context'>context</span><span class='op'>|</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_example'>example</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_before'>before</span><span class='lparen'>(</span><span class='symbol'>:example</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='id identifier rubyid_example'>example</span> <span class='op'>=</span> <span class='id identifier rubyid_fetch_current_example'>fetch_current_example</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='comment'># ...
</span> <span class='kw'>end</span>
<span class='kw'>end</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
122
123
124</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 122</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_current_example'>current_example</span>
<span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'>Support</span><span class='period'>.</span><span class='id identifier rubyid_thread_local_data'>thread_local_data</span><span class='lbracket'>[</span><span class='symbol'>:current_example</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="current_example=-class_method">
.<strong>current_example=</strong>(example) ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Set the current example being executed.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
128
129
130</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 128</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_current_example='>current_example=</span><span class='lparen'>(</span><span class='id identifier rubyid_example'>example</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'>Support</span><span class='period'>.</span><span class='id identifier rubyid_thread_local_data'>thread_local_data</span><span class='lbracket'>[</span><span class='symbol'>:current_example</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_example'>example</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="current_scope-class_method">
.<strong>current_scope</strong> ⇒ <tt>Symbol</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the current RSpec execution scope</p>
<p>Returns (in order of lifecycle):</p>
<ul>
<li><code>:suite</code> as an initial value, this is outside of the test lifecycle.</li>
<li><code>:before_suite_hook</code> during <code>before(:suite)</code> hooks.</li>
<li><code>:before_context_hook</code> during <code>before(:context)</code> hooks.</li>
<li><code>:before_example_hook</code> during <code>before(:example)</code> hooks and <code>around(:example)</code> before <code>example.run</code>.</li>
<li><code>:example</code> within the example run.</li>
<li><code>:after_example_hook</code> during <code>after(:example)</code> hooks and <code>around(:example)</code> after <code>example.run</code>.</li>
<li><code>:after_context_hook</code> during <code>after(:context)</code> hooks.</li>
<li><code>:after_suite_hook</code> during <code>after(:suite)</code> hooks.</li>
<li><code>:suite</code> as a final value, again this is outside of the test lifecycle.</li>
</ul>
<p>Reminder, <code>:context</code> hooks have <code>:all</code> alias and <code>:example</code> hooks have <code>:each</code> alias.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
154
155
156</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 154</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_current_scope'>current_scope</span>
<span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'>Support</span><span class='period'>.</span><span class='id identifier rubyid_thread_local_data'>thread_local_data</span><span class='lbracket'>[</span><span class='symbol'>:current_scope</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="current_scope=-class_method">
.<strong>current_scope=</strong>(scope) ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This method is part of a private API.</strong>
You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Set the current scope rspec is executing in</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
134
135
136</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 134</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_current_scope='>current_scope=</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'>Support</span><span class='period'>.</span><span class='id identifier rubyid_thread_local_data'>thread_local_data</span><span class='lbracket'>[</span><span class='symbol'>:current_scope</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_scope'>scope</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reset-class_method">
.<strong>reset</strong> ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Used to ensure examples get reloaded and user configuration gets reset to
defaults between multiple runs in the same process.</p>
<p>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.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/core.rb', line 58</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reset'>reset</span>
<span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'>ExampleGroups</span><span class='period'>.</span><span class='id identifier rubyid_remove_all_constants'>remove_all_constants</span>
<span class='ivar'>@world</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@configuration</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Oct 1 21:13:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
</html>