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
|
<?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>File: README</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="fileHeader">
<h1>README</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>README
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Thu Nov 01 10:35:26 CDT 2007</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<h2>RSpec</h2>
<p>
RSpec is a Behaviour Definition Framework intended for use in Behaviour
Driven Development. RSpec plays the same role that a unit testing framework
would play in a <a href="../classes/Test.html">Test</a> Driven Development
environment, but does so using words and structures that better support
BDD.
</p>
<p>
RSpec ships with four modules:
</p>
<p>
<a href="../classes/Spec/Matchers.html">Spec::Matchers</a> provides
Expression Matchers for use with <a
href="../classes/Spec/Expectations.html">Spec::Expectations</a> and <a
href="../classes/Spec/Mocks.html">Spec::Mocks</a>.
</p>
<p>
<a href="../classes/Spec/Expectations.html">Spec::Expectations</a> supports
setting expectations on your objects so you can do things like:
</p>
<pre>
result.should equal(expected_result)
</pre>
<p>
<a href="../classes/Spec/Mocks.html">Spec::Mocks</a> supports creating Mock
Objects, Stubs, and adding Mock/Stub behaviour to your existing objects.
</p>
<p>
<a href="../classes/Spec/Runner.html">Spec::Runner</a> provides a very
small but powerful DSL for writing executable examples of how your code
should work.
</p>
<h2>Installation</h2>
<p>
The simplest approach is to install the gem:
</p>
<pre>
gem install -r rspec #mac users must sudo
</pre>
<h2>Building the RSpec gem</h2>
<p>
If you prefer to build the gem locally, check out source from
svn://rubyforge.org/var/svn/rspec/trunk. Then do the following:
</p>
<pre>
rake gem
gem install pkg/rspec-0.x.x.gem (you may have to sudo)
</pre>
<h2>Running RSpec‘s specs</h2>
<p>
In order to run RSpec‘s full suite of specs (rake pre_commit) you
must install the following gems:
</p>
<ul>
<li>rake # Runs the build script
</li>
<li>rcov # Verifies that the code is 100% covered by specs
</li>
<li>webgen # Generates the static HTML website
</li>
<li>RedCloth # Required by webgen
</li>
<li>syntax # Required by our own custom webgen extension to highlight ruby code
</li>
<li>diff-lcs # Required if you use the —diff switch
</li>
<li>win32console # Required by the —colour switch if you‘re on
Windows
</li>
<li>meta_project # Required in order to make releases at RubyForge
</li>
<li>heckle # Required if you use the —heckle switch
</li>
<li>hpricot # Used for parsing HTML from the HTML output formatter in
RSpec‘s own specs
</li>
</ul>
<p>
Once those are all installed, you should be able to run the suite with the
following steps:
</p>
<ul>
<li>svn co svn://rubyforge.org/var/svn/rspec/trunk rspec
</li>
<li>cd rspec
</li>
<li>rake install_dependencies
</li>
<li>cd example_rails_app
</li>
<li>export RSPEC_RAILS_VERSION=1.2.3
</li>
<li>rake rspec:generate_mysql_config
</li>
<li>mysql -u root < db/mysql_setup.sql
</li>
<li>cd ..
</li>
<li>rake pre_commit
</li>
</ul>
<p>
Note that RSpec itself - once built - doesn‘t have any dependencies
outside the Ruby core and stdlib - with a few exceptions:
</p>
<ul>
<li>The spec command line uses diff-lcs when —diff is specified.
</li>
<li>The spec command line uses heckle when —heckle is specified.
</li>
<li>The <a href="../classes/Spec/Rake/SpecTask.html">Spec::Rake::SpecTask</a>
needs <a href="../classes/RCov.html">RCov</a> if <a
href="../classes/RCov.html">RCov</a> is enabled in the task.
</li>
</ul>
<p>
See <a href="http://rspec.rubyforge.org">rspec.rubyforge.org</a> for
further documentation.
</p>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
