guard-phpspec 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,325 @@
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::Inspector
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 (I)</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">Inspector</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::Inspector
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/inspector.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 inspector verifies that the changed paths are valid for
91
+ Guard::PHPSpec.</p>
92
+
93
+
94
+ </div>
95
+ </div>
96
+ <div class="tags">
97
+
98
+
99
+ </div>
100
+
101
+
102
+
103
+ <h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
104
+ <ul class="summary">
105
+
106
+ <li class="public ">
107
+ <span class="summary_signature">
108
+
109
+ <a href="#tests_path-class_method" title="tests_path (class method)">+ (Object) <strong>tests_path</strong> </a>
110
+
111
+
112
+
113
+ </span>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+ <span class="summary_desc"><div class='inline'>
127
+ <p>Returns the value of attribute tests_path.</p>
128
+ </div></span>
129
+
130
+ </li>
131
+
132
+
133
+ </ul>
134
+
135
+
136
+
137
+
138
+
139
+ <h2>
140
+ Class Method Summary
141
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
142
+ </h2>
143
+
144
+ <ul class="summary">
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#clean-class_method" title="clean (class method)">+ (Array&lt;String&gt;) <strong>clean</strong>(paths) </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <span class="summary_desc"><div class='inline'>
164
+ <p>Clean the changed paths and return only valid PHPSpec tests files.</p>
165
+ </div></span>
166
+
167
+ </li>
168
+
169
+
170
+ </ul>
171
+
172
+
173
+
174
+ <div id="class_attr_details" class="attr_details">
175
+ <h2>Class Attribute Details</h2>
176
+
177
+
178
+ <span id="tests_path=-class_method"></span>
179
+ <div class="method_details first">
180
+ <h3 class="signature first" id="tests_path-class_method">
181
+
182
+ + (<tt>Object</tt>) <strong>tests_path</strong>
183
+
184
+
185
+
186
+
187
+
188
+ </h3><div class="docstring">
189
+ <div class="discussion">
190
+
191
+ <p>Returns the value of attribute tests_path</p>
192
+
193
+
194
+ </div>
195
+ </div>
196
+ <div class="tags">
197
+
198
+
199
+ </div><table class="source_code">
200
+ <tr>
201
+ <td>
202
+ <pre class="lines">
203
+
204
+
205
+ 10
206
+ 11
207
+ 12</pre>
208
+ </td>
209
+ <td>
210
+ <pre class="code"><span class="info file"># File 'lib/guard/phpspec/inspector.rb', line 10</span>
211
+
212
+ <span class='kw'>def</span> <span class='id identifier rubyid_tests_path'>tests_path</span>
213
+ <span class='ivar'>@tests_path</span>
214
+ <span class='kw'>end</span></pre>
215
+ </td>
216
+ </tr>
217
+ </table>
218
+ </div>
219
+
220
+ </div>
221
+
222
+
223
+ <div id="class_method_details" class="method_details_list">
224
+ <h2>Class Method Details</h2>
225
+
226
+
227
+ <div class="method_details first">
228
+ <h3 class="signature first" id="clean-class_method">
229
+
230
+ + (<tt>Array&lt;String&gt;</tt>) <strong>clean</strong>(paths)
231
+
232
+
233
+
234
+
235
+
236
+ </h3><div class="docstring">
237
+ <div class="discussion">
238
+
239
+ <p>Clean the changed paths and return only valid PHPSpec tests files.</p>
240
+
241
+
242
+ </div>
243
+ </div>
244
+ <div class="tags">
245
+ <p class="tag_title">Parameters:</p>
246
+ <ul class="param">
247
+
248
+ <li>
249
+
250
+ <span class='name'>paths</span>
251
+
252
+
253
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
254
+
255
+
256
+
257
+ &mdash;
258
+ <div class='inline'>
259
+ <p>the changed paths</p>
260
+ </div>
261
+
262
+ </li>
263
+
264
+ </ul>
265
+
266
+ <p class="tag_title">Returns:</p>
267
+ <ul class="return">
268
+
269
+ <li>
270
+
271
+
272
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
273
+
274
+
275
+
276
+ &mdash;
277
+ <div class='inline'>
278
+ <p>the valid tests files</p>
279
+ </div>
280
+
281
+ </li>
282
+
283
+ </ul>
284
+
285
+ </div><table class="source_code">
286
+ <tr>
287
+ <td>
288
+ <pre class="lines">
289
+
290
+
291
+ 16
292
+ 17
293
+ 18
294
+ 19
295
+ 20
296
+ 21
297
+ 22</pre>
298
+ </td>
299
+ <td>
300
+ <pre class="code"><span class="info file"># File 'lib/guard/phpspec/inspector.rb', line 16</span>
301
+
302
+ <span class='kw'>def</span> <span class='id identifier rubyid_clean'>clean</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span>
303
+ <span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_uniq!'>uniq!</span>
304
+ <span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_compact!'>compact!</span>
305
+ <span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_test_file?'>test_file?</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
306
+ <span class='id identifier rubyid_clear_tests_files_list'>clear_tests_files_list</span>
307
+ <span class='id identifier rubyid_paths'>paths</span>
308
+ <span class='kw'>end</span></pre>
309
+ </td>
310
+ </tr>
311
+ </table>
312
+ </div>
313
+
314
+ </div>
315
+
316
+ </div>
317
+
318
+ <div id="footer">
319
+ Generated on Sat Aug 24 15:20:45 2013 by
320
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
321
+ 0.8.7 (ruby-2.0.0).
322
+ </div>
323
+
324
+ </body>
325
+ </html>
@@ -0,0 +1,400 @@
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::Notifier
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 (N)</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">Notifier</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::Notifier
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/notifier.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::PHPUnit notifier displays a notification pop-up with the tests
91
+ results.</p>
92
+
93
+
94
+ </div>
95
+ </div>
96
+ <div class="tags">
97
+
98
+
99
+ </div>
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+ <h2>
108
+ Class Method Summary
109
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
110
+ </h2>
111
+
112
+ <ul class="summary">
113
+
114
+ <li class="public ">
115
+ <span class="summary_signature">
116
+
117
+ <a href="#notify-class_method" title="notify (class method)">+ (Object) <strong>notify</strong>(message, options) </a>
118
+
119
+
120
+
121
+ </span>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <span class="summary_desc"><div class='inline'>
132
+ <p>Displays a system notification.</p>
133
+ </div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#notify_results-class_method" title="notify_results (class method)">+ (Object) <strong>notify_results</strong>(test_results) </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+ <span class="summary_desc"><div class='inline'>
156
+ <p>Displays a notification about the tests results.</p>
157
+ </div></span>
158
+
159
+ </li>
160
+
161
+
162
+ </ul>
163
+
164
+
165
+
166
+
167
+ <div id="class_method_details" class="method_details_list">
168
+ <h2>Class Method Details</h2>
169
+
170
+
171
+ <div class="method_details first">
172
+ <h3 class="signature first" id="notify-class_method">
173
+
174
+ + (<tt>Object</tt>) <strong>notify</strong>(message, options)
175
+
176
+
177
+
178
+
179
+
180
+ </h3><div class="docstring">
181
+ <div class="discussion">
182
+
183
+ <p>Displays a system notification.</p>
184
+
185
+
186
+ </div>
187
+ </div>
188
+ <div class="tags">
189
+ <p class="tag_title">Parameters:</p>
190
+ <ul class="param">
191
+
192
+ <li>
193
+
194
+ <span class='name'>message</span>
195
+
196
+
197
+ <span class='type'>(<tt>String</tt>)</span>
198
+
199
+
200
+
201
+ &mdash;
202
+ <div class='inline'>
203
+ <p>the message to show</p>
204
+ </div>
205
+
206
+ </li>
207
+
208
+ <li>
209
+
210
+ <span class='name'>options</span>
211
+
212
+
213
+ <span class='type'>(<tt>Hash</tt>)</span>
214
+
215
+
216
+
217
+ &mdash;
218
+ <div class='inline'>
219
+ <p>the notifier options</p>
220
+ </div>
221
+
222
+ </li>
223
+
224
+ </ul>
225
+
226
+
227
+ </div><table class="source_code">
228
+ <tr>
229
+ <td>
230
+ <pre class="lines">
231
+
232
+
233
+ 15
234
+ 16
235
+ 17</pre>
236
+ </td>
237
+ <td>
238
+ <pre class="code"><span class="info file"># File 'lib/guard/phpspec/notifier.rb', line 15</span>
239
+
240
+ <span class='kw'>def</span> <span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
241
+ <span class='op'>::</span><span class='const'>Guard</span><span class='op'>::</span><span class='const'>Notifier</span><span class='period'>.</span><span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
242
+ <span class='kw'>end</span></pre>
243
+ </td>
244
+ </tr>
245
+ </table>
246
+ </div>
247
+
248
+ <div class="method_details ">
249
+ <h3 class="signature " id="notify_results-class_method">
250
+
251
+ + (<tt>Object</tt>) <strong>notify_results</strong>(test_results)
252
+
253
+
254
+
255
+
256
+
257
+ </h3><div class="docstring">
258
+ <div class="discussion">
259
+
260
+ <p>Displays a notification about the tests results.</p>
261
+
262
+
263
+ </div>
264
+ </div>
265
+ <div class="tags">
266
+ <p class="tag_title">Parameters:</p>
267
+ <ul class="param">
268
+
269
+ <li>
270
+
271
+ <span class='name'>test_results</span>
272
+
273
+
274
+ <span class='type'>(<tt>Hash</tt>)</span>
275
+
276
+
277
+
278
+ &mdash;
279
+ <div class='inline'>
280
+ <p>the parsed tests results</p>
281
+ </div>
282
+
283
+ </li>
284
+
285
+ </ul>
286
+
287
+
288
+
289
+
290
+ <p class="tag_title">Options Hash (<tt>test_results</tt>):</p>
291
+ <ul class="option">
292
+
293
+ <li>
294
+ <span class="name">:tests</span>
295
+ <span class="type">(<tt>Integer</tt>)</span>
296
+ <span class="default">
297
+
298
+ </span>
299
+
300
+ &mdash; <div class='inline'>
301
+ <p>tests count</p>
302
+ </div>
303
+
304
+ </li>
305
+
306
+ <li>
307
+ <span class="name">:failures</span>
308
+ <span class="type">(<tt>Integer</tt>)</span>
309
+ <span class="default">
310
+
311
+ </span>
312
+
313
+ &mdash; <div class='inline'>
314
+ <p>failures count</p>
315
+ </div>
316
+
317
+ </li>
318
+
319
+ <li>
320
+ <span class="name">:errors</span>
321
+ <span class="type">(<tt>Integer</tt>)</span>
322
+ <span class="default">
323
+
324
+ </span>
325
+
326
+ &mdash; <div class='inline'>
327
+ <p>count count</p>
328
+ </div>
329
+
330
+ </li>
331
+
332
+ <li>
333
+ <span class="name">:pending</span>
334
+ <span class="type">(<tt>Integer</tt>)</span>
335
+ <span class="default">
336
+
337
+ </span>
338
+
339
+ &mdash; <div class='inline'>
340
+ <p>pending tests count</p>
341
+ </div>
342
+
343
+ </li>
344
+
345
+ <li>
346
+ <span class="name">:duration</span>
347
+ <span class="type">(<tt>Integer</tt>)</span>
348
+ <span class="default">
349
+
350
+ </span>
351
+
352
+ &mdash; <div class='inline'>
353
+ <p>tests duration</p>
354
+ </div>
355
+
356
+ </li>
357
+
358
+ </ul>
359
+
360
+
361
+
362
+ </div><table class="source_code">
363
+ <tr>
364
+ <td>
365
+ <pre class="lines">
366
+
367
+
368
+ 28
369
+ 29
370
+ 30
371
+ 31
372
+ 32
373
+ 33</pre>
374
+ </td>
375
+ <td>
376
+ <pre class="code"><span class="info file"># File 'lib/guard/phpspec/notifier.rb', line 28</span>
377
+
378
+ <span class='kw'>def</span> <span class='id identifier rubyid_notify_results'>notify_results</span><span class='lparen'>(</span><span class='id identifier rubyid_test_results'>test_results</span><span class='rparen'>)</span>
379
+ <span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='lparen'>(</span><span class='id identifier rubyid_test_results'>test_results</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='lbrace'>{</span>
380
+ <span class='symbol'>:title</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>PHPUnit results</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
381
+ <span class='symbol'>:image</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_image'>image</span><span class='lparen'>(</span><span class='id identifier rubyid_test_results'>test_results</span><span class='rparen'>)</span>
382
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
383
+ <span class='kw'>end</span></pre>
384
+ </td>
385
+ </tr>
386
+ </table>
387
+ </div>
388
+
389
+ </div>
390
+
391
+ </div>
392
+
393
+ <div id="footer">
394
+ Generated on Sat Aug 24 15:20:45 2013 by
395
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
396
+ 0.8.7 (ruby-2.0.0).
397
+ </div>
398
+
399
+ </body>
400
+ </html>