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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: Spec::Runner</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">Spec::Runner</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/spec/runner/backtrace_tweaker_rb.html">
lib/spec/runner/backtrace_tweaker.rb
</a>
<br />
<a href="../../files/lib/spec/runner/behaviour_runner_rb.html">
lib/spec/runner/behaviour_runner.rb
</a>
<br />
<a href="../../files/lib/spec/runner/command_line_rb.html">
lib/spec/runner/command_line.rb
</a>
<br />
<a href="../../files/lib/spec/runner/drb_command_line_rb.html">
lib/spec/runner/drb_command_line.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/base_formatter_rb.html">
lib/spec/runner/formatter/base_formatter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/base_text_formatter_rb.html">
lib/spec/runner/formatter/base_text_formatter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/failing_behaviours_formatter_rb.html">
lib/spec/runner/formatter/failing_behaviours_formatter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/failing_examples_formatter_rb.html">
lib/spec/runner/formatter/failing_examples_formatter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/html_formatter_rb.html">
lib/spec/runner/formatter/html_formatter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/progress_bar_formatter_rb.html">
lib/spec/runner/formatter/progress_bar_formatter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/rdoc_formatter_rb.html">
lib/spec/runner/formatter/rdoc_formatter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/snippet_extractor_rb.html">
lib/spec/runner/formatter/snippet_extractor.rb
</a>
<br />
<a href="../../files/lib/spec/runner/formatter/specdoc_formatter_rb.html">
lib/spec/runner/formatter/specdoc_formatter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/heckle_runner_rb.html">
lib/spec/runner/heckle_runner.rb
</a>
<br />
<a href="../../files/lib/spec/runner/heckle_runner_unsupported_rb.html">
lib/spec/runner/heckle_runner_unsupported.rb
</a>
<br />
<a href="../../files/lib/spec/runner/option_parser_rb.html">
lib/spec/runner/option_parser.rb
</a>
<br />
<a href="../../files/lib/spec/runner/options_rb.html">
lib/spec/runner/options.rb
</a>
<br />
<a href="../../files/lib/spec/runner/reporter_rb.html">
lib/spec/runner/reporter.rb
</a>
<br />
<a href="../../files/lib/spec/runner/spec_parser_rb.html">
lib/spec/runner/spec_parser.rb
</a>
<br />
<a href="../../files/lib/spec/runner_rb.html">
lib/spec/runner.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<h2>Behaviours and Examples</h2>
<p>
Rather than expressing examples in classes, RSpec uses a custom domain
specific language to describe Behaviours and Examples of those behaviours.
</p>
<p>
A Behaviour is the equivalent of a fixture in xUnit-speak. It is a metaphor
for the context in which you will run your executable example - a set of
known objects in a known starting state. We begin be describing
</p>
<pre>
describe Account do
before do
@account = Account.new
end
it "should have a balance of $0" do
@account.balance.should == Money.new(0, :dollars)
end
end
</pre>
<p>
We use the before block to set up the Behaviour (given), and then the it
method to hold the example code that expresses the event (when) and the
expected outcome (then).
</p>
<h2>Helper Methods</h2>
<p>
A primary goal of RSpec is to keep the examples clear. We therefore prefer
less indirection than you might see in xUnit examples and in well factored,
DRY production code. We feel that duplication is OK if removing it makes it
harder to understand an example without having to look elsewhere to
understand its context.
</p>
<p>
That said, RSpec does support some level of encapsulating common code in
helper methods that can exist within a context or within an included
module.
</p>
<h2>Setup and Teardown</h2>
<p>
You can use before and after within a Behaviour. Both methods take an
optional scope argument so you can run the block before :each example or
before :all examples
</p>
<pre>
describe "..." do
before :all do
...
end
before :each do
...
end
it "should do something" do
...
end
it "should do something else" do
...
end
after :each do
...
end
after :all do
...
end
end
</pre>
<p>
The <tt>before :each</tt> block will run before each of the examples, once
for each example. Likewise, the <tt>after :each</tt> block will run after
each of the examples.
</p>
<p>
It is also possible to specify a <tt>before :all</tt> and <tt>after
:all</tt> block that will run only once for each behaviour, respectively
before the first <tt>before :each</tt> and after the last <tt>after
:each</tt>. The use of these is generally discouraged, because it
introduces dependencies between the examples. Still, it might prove useful
for very expensive operations if you know what you are doing.
</p>
<h2>Local helper methods</h2>
<p>
You can include local helper methods by simply expressing them within a
context:
</p>
<pre>
describe "..." do
it "..." do
helper_method
end
def helper_method
...
end
end
</pre>
<h2>Included helper methods</h2>
<p>
You can include helper methods in multiple contexts by expressing them
within a module, and then including that module in your context:
</p>
<pre>
module AccountExampleHelperMethods
def helper_method
...
end
end
describe "A new account" do
include AccountExampleHelperMethods
before do
@account = Account.new
end
it "should have a balance of $0" do
helper_method
@account.balance.should eql(Money.new(0, :dollars))
end
end
</pre>
<h2>Shared behaviour</h2>
<p>
You can define a shared behaviour, that may be used on other behaviours
</p>
<pre>
describe "All Editions", :shared => true do
it "all editions behaviour" ...
end
describe SmallEdition do
it_should_behave_like "All Editions"
it "should do small edition stuff" do
...
end
end
</pre>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000149">configure</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>
Module <a href="Runner/Formatter.html" class="link">Spec::Runner::Formatter</a><br />
Class <a href="Runner/BacktraceTweaker.html" class="link">Spec::Runner::BacktraceTweaker</a><br />
Class <a href="Runner/BehaviourRunner.html" class="link">Spec::Runner::BehaviourRunner</a><br />
Class <a href="Runner/CommandLine.html" class="link">Spec::Runner::CommandLine</a><br />
Class <a href="Runner/DrbCommandLine.html" class="link">Spec::Runner::DrbCommandLine</a><br />
Class <a href="Runner/HeckleRunner.html" class="link">Spec::Runner::HeckleRunner</a><br />
Class <a href="Runner/Heckler.html" class="link">Spec::Runner::Heckler</a><br />
Class <a href="Runner/NoisyBacktraceTweaker.html" class="link">Spec::Runner::NoisyBacktraceTweaker</a><br />
Class <a href="Runner/OptionParser.html" class="link">Spec::Runner::OptionParser</a><br />
Class <a href="Runner/Options.html" class="link">Spec::Runner::Options</a><br />
Class <a href="Runner/QuietBacktraceTweaker.html" class="link">Spec::Runner::QuietBacktraceTweaker</a><br />
Class <a href="Runner/Reporter.html" class="link">Spec::Runner::Reporter</a><br />
Class <a href="Runner/SpecParser.html" class="link">Spec::Runner::SpecParser</a><br />
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000149" class="method-detail">
<a name="M000149"></a>
<div class="method-heading">
<a href="#M000149" class="method-signature">
<span class="method-name">configure</span><span class="method-args">() {|configuration if @configuration.nil?| ...}</span>
</a>
</div>
<div class="method-description">
<p>
Use this to <a href="Runner.html#M000149">configure</a> various
configurable aspects of RSpec:
</p>
<pre>
Spec::Runner.configure do |configuration|
# Configure RSpec here
end
</pre>
<p>
The yielded <tt>configuration</tt> object is a <a
href="DSL/Configuration.html">Spec::DSL::Configuration</a> instance. See
its RDoc for details about what you can do with it.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000149-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000149-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/runner.rb, line 160</span>
160: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>
161: <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">configuration</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@configuration</span>.<span class="ruby-identifier">nil?</span>
162: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
