guard-phpspec 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,328 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Guard::PHPSpec::Runner
8
+
9
+ &mdash; Documentation by YARD 0.8.7
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (R)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Guard.html" title="Guard (module)">Guard</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../PHPSpec.html" title="Guard::PHPSpec (class)">PHPSpec</a></span></span>
36
+ &raquo;
37
+ <span class="title">Runner</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Guard::PHPSpec::Runner
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dt class="r1 last">Defined in:</dt>
82
+ <dd class="r1 last">lib/guard/phpspec/runner.rb</dd>
83
+
84
+ </dl>
85
+ <div class="clear"></div>
86
+
87
+ <h2>Overview</h2><div class="docstring">
88
+ <div class="discussion">
89
+
90
+ <p>The Guard::PHPSpec runner handles running the tests, displaying their
91
+ output and notifying the user about the results.</p>
92
+
93
+
94
+ </div>
95
+ </div>
96
+ <div class="tags">
97
+
98
+
99
+ </div>
100
+ <h2>Constant Summary</h2>
101
+
102
+ <dl class="constants">
103
+
104
+ <dt id="PHPUNIT_FAILURES_EXITCODE-constant" class="">PHPUNIT_FAILURES_EXITCODE =
105
+ <div class="docstring">
106
+ <div class="discussion">
107
+
108
+ <p>The exit code phpspec returns when the tests contain failures</p>
109
+
110
+
111
+ </div>
112
+ </div>
113
+ <div class="tags">
114
+
115
+
116
+ </div>
117
+ </dt>
118
+ <dd><pre class="code"><span class='int'>1</span></pre></dd>
119
+
120
+ <dt id="PHPUNIT_ERRORS_EXITCODE-constant" class="">PHPUNIT_ERRORS_EXITCODE =
121
+ <div class="docstring">
122
+ <div class="discussion">
123
+
124
+ <p>The exit code phpspec returns when the tests contain errors</p>
125
+
126
+
127
+ </div>
128
+ </div>
129
+ <div class="tags">
130
+
131
+
132
+ </div>
133
+ </dt>
134
+ <dd><pre class="code"><span class='int'>2</span></pre></dd>
135
+
136
+ </dl>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+ <h2>
147
+ Class Method Summary
148
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
149
+ </h2>
150
+
151
+ <ul class="summary">
152
+
153
+ <li class="public ">
154
+ <span class="summary_signature">
155
+
156
+ <a href="#run-class_method" title="run (class method)">+ (Boolean) <strong>run</strong>(paths, options = {}) </a>
157
+
158
+
159
+
160
+ </span>
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+ <span class="summary_desc"><div class='inline'>
171
+ <p>Runs the PHPSpec tests and displays notifications about the results.</p>
172
+ </div></span>
173
+
174
+ </li>
175
+
176
+
177
+ </ul>
178
+
179
+
180
+
181
+
182
+ <div id="class_method_details" class="method_details_list">
183
+ <h2>Class Method Details</h2>
184
+
185
+
186
+ <div class="method_details first">
187
+ <h3 class="signature first" id="run-class_method">
188
+
189
+ + (<tt>Boolean</tt>) <strong>run</strong>(paths, options = {})
190
+
191
+
192
+
193
+
194
+
195
+ </h3><div class="docstring">
196
+ <div class="discussion">
197
+
198
+ <p>Runs the PHPSpec tests and displays notifications about the results.</p>
199
+
200
+
201
+ </div>
202
+ </div>
203
+ <div class="tags">
204
+ <p class="tag_title">Parameters:</p>
205
+ <ul class="param">
206
+
207
+ <li>
208
+
209
+ <span class='name'>path</span>
210
+
211
+
212
+ <span class='type'>(<tt>Array&lt;Strings&gt;</tt>)</span>
213
+
214
+
215
+
216
+ &mdash;
217
+ <div class='inline'>
218
+ <p>to the tests files.</p>
219
+ </div>
220
+
221
+ </li>
222
+
223
+ <li>
224
+
225
+ <span class='name'>watchers</span>
226
+
227
+
228
+ <span class='type'>(<tt>Array&lt;Guard::Watcher&gt;</tt>)</span>
229
+
230
+
231
+
232
+ &mdash;
233
+ <div class='inline'>
234
+ <p>the watchers in the Guard block</p>
235
+ </div>
236
+
237
+ </li>
238
+
239
+ <li>
240
+
241
+ <span class='name'>options</span>
242
+
243
+
244
+ <span class='type'>(<tt>Hash</tt>)</span>
245
+
246
+
247
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
248
+
249
+
250
+ &mdash;
251
+ <div class='inline'>
252
+ <p>the options for the Guard</p>
253
+ </div>
254
+
255
+ </li>
256
+
257
+ </ul>
258
+
259
+ <p class="tag_title">Returns:</p>
260
+ <ul class="return">
261
+
262
+ <li>
263
+
264
+
265
+ <span class='type'>(<tt>Boolean</tt>)</span>
266
+
267
+
268
+
269
+ &mdash;
270
+ <div class='inline'>
271
+ <p>whether the tests were run successfully</p>
272
+ </div>
273
+
274
+ </li>
275
+
276
+ </ul>
277
+
278
+ </div><table class="source_code">
279
+ <tr>
280
+ <td>
281
+ <pre class="lines">
282
+
283
+
284
+ 23
285
+ 24
286
+ 25
287
+ 26
288
+ 27
289
+ 28
290
+ 29
291
+ 30
292
+ 31
293
+ 32
294
+ 33
295
+ 34</pre>
296
+ </td>
297
+ <td>
298
+ <pre class="code"><span class="info file"># File 'lib/guard/phpspec/runner.rb', line 23</span>
299
+
300
+ <span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
301
+ <span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='const'>Array</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span>
302
+
303
+ <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
304
+
305
+ <span class='kw'>unless</span> <span class='id identifier rubyid_phpspec_exists?'>phpspec_exists?</span>
306
+ <span class='const'>UI</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>phpspec not installed or not in env PATH</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='symbol'>:reset</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='rparen'>)</span>
307
+ <span class='kw'>return</span> <span class='kw'>false</span>
308
+ <span class='kw'>end</span>
309
+
310
+ <span class='id identifier rubyid_run_tests'>run_tests</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
311
+ <span class='kw'>end</span></pre>
312
+ </td>
313
+ </tr>
314
+ </table>
315
+ </div>
316
+
317
+ </div>
318
+
319
+ </div>
320
+
321
+ <div id="footer">
322
+ Generated on Sat Aug 24 15:20:45 2013 by
323
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
324
+ 0.8.7 (ruby-2.0.0).
325
+ </div>
326
+
327
+ </body>
328
+ </html>
@@ -0,0 +1,185 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Documentation by YARD 0.8.7
8
+
9
+ </title>
10
+
11
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
12
+
13
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
14
+
15
+ <script type="text/javascript" charset="utf-8">
16
+ hasFrames = window.top.frames.main ? true : false;
17
+ relpath = '';
18
+ framesUrl = "frames.html#!" + escape(window.location.href);
19
+ </script>
20
+
21
+
22
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <div id="header">
30
+ <div id="menu">
31
+
32
+
33
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
34
+ </div>
35
+
36
+ <div id="search">
37
+
38
+ <a class="full_list_link" id="class_list_link"
39
+ href="class_list.html">
40
+ Class List
41
+ </a>
42
+
43
+ <a class="full_list_link" id="method_list_link"
44
+ href="method_list.html">
45
+ Method List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="file_list_link"
49
+ href="file_list.html">
50
+ File List
51
+ </a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.8.7</h1>
60
+ <div id="listing">
61
+ <h1 class="alphaindex">Alphabetic Index</h1>
62
+
63
+ <h2>File Listing</h2>
64
+ <ul id="files" class="index_inline_list">
65
+
66
+
67
+ <li class="r1"><a href="index.html" title="README">README</a></li>
68
+
69
+
70
+ </ul>
71
+
72
+ <div class="clear"></div>
73
+ <h2>Namespace Listing A-Z</h2>
74
+
75
+
76
+
77
+
78
+ <table>
79
+ <tr>
80
+ <td valign='top' width="33%">
81
+
82
+
83
+ <ul id="alpha_F" class="alpha">
84
+ <li class="letter">F</li>
85
+ <ul>
86
+
87
+ <li>
88
+ <span class='object_link'><a href="Guard/PHPSpec/Formatter.html" title="Guard::PHPSpec::Formatter (module)">Formatter</a></span>
89
+
90
+ <small>(Guard::PHPSpec)</small>
91
+
92
+ </li>
93
+
94
+ </ul>
95
+ </ul>
96
+
97
+
98
+ <ul id="alpha_G" class="alpha">
99
+ <li class="letter">G</li>
100
+ <ul>
101
+
102
+ <li>
103
+ <span class='object_link'><a href="Guard.html" title="Guard (module)">Guard</a></span>
104
+
105
+ </li>
106
+
107
+ </ul>
108
+ </ul>
109
+
110
+
111
+ <ul id="alpha_I" class="alpha">
112
+ <li class="letter">I</li>
113
+ <ul>
114
+
115
+ <li>
116
+ <span class='object_link'><a href="Guard/PHPSpec/Inspector.html" title="Guard::PHPSpec::Inspector (module)">Inspector</a></span>
117
+
118
+ <small>(Guard::PHPSpec)</small>
119
+
120
+ </li>
121
+
122
+ </ul>
123
+ </ul>
124
+
125
+
126
+ <ul id="alpha_N" class="alpha">
127
+ <li class="letter">N</li>
128
+ <ul>
129
+
130
+ <li>
131
+ <span class='object_link'><a href="Guard/PHPSpec/Notifier.html" title="Guard::PHPSpec::Notifier (module)">Notifier</a></span>
132
+
133
+ <small>(Guard::PHPSpec)</small>
134
+
135
+ </li>
136
+
137
+ </ul>
138
+ </ul>
139
+
140
+
141
+ <ul id="alpha_P" class="alpha">
142
+ <li class="letter">P</li>
143
+ <ul>
144
+
145
+ <li>
146
+ <span class='object_link'><a href="Guard/PHPSpec.html" title="Guard::PHPSpec (class)">PHPSpec</a></span>
147
+
148
+ <small>(Guard)</small>
149
+
150
+ </li>
151
+
152
+ </ul>
153
+ </ul>
154
+
155
+
156
+ <ul id="alpha_R" class="alpha">
157
+ <li class="letter">R</li>
158
+ <ul>
159
+
160
+ <li>
161
+ <span class='object_link'><a href="Guard/PHPSpec/Runner.html" title="Guard::PHPSpec::Runner (module)">Runner</a></span>
162
+
163
+ <small>(Guard::PHPSpec)</small>
164
+
165
+ </li>
166
+
167
+ </ul>
168
+ </ul>
169
+
170
+ </td>
171
+ </tr>
172
+ </table>
173
+
174
+ </div>
175
+
176
+ </div>
177
+
178
+ <div id="footer">
179
+ Generated on Sat Aug 24 15:20:44 2013 by
180
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
181
+ 0.8.7 (ruby-2.0.0).
182
+ </div>
183
+
184
+ </body>
185
+ </html>