reflection 0.4.0 → 0.4.1

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,385 @@
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 name="Content-Type" content="text/html; charset=UTF-8" />
6
+ <title>Class: Reflection::Command::Base</title>
7
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '../..';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <div id="header">
20
+ <div id="menu">
21
+
22
+ <a href="../../_index.html">Index (B)</a> &raquo;
23
+ <a title="Reflection" href="../../Reflection.html">Reflection</a> &raquo; <a title="Command" href="../Command.html">Command</a>
24
+ &raquo;
25
+ <span class="title">Base</span>
26
+
27
+ </div>
28
+
29
+ <div id="search">
30
+ <a id="class_list_link" href="#">Namespace List</a>
31
+ <a id="method_list_link" href="#">Method List</a>
32
+ <a id ="file_list_link" href="#">File List</a>
33
+ </div>
34
+
35
+ <div class="clear"></div>
36
+ </div>
37
+
38
+ <iframe id="search_frame"></iframe>
39
+
40
+ <div id="content"><h1>Class: Reflection::Command::Base
41
+
42
+
43
+ </h1>
44
+
45
+ <dl class="box">
46
+
47
+ <dt class="r1">Inherits:</dt>
48
+ <dd class="r1">
49
+ <span class="inheritName">Object</span>
50
+
51
+ </dd>
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+ <dt class="r2 last">Defined in:</dt>
61
+ <dd class="r2 last">lib/reflection/command/base.rb</dd>
62
+
63
+ </dl>
64
+ <div class="clear"></div>
65
+
66
+
67
+
68
+ <h2>Attribute Summary</h2>
69
+ <ul class="summary">
70
+
71
+ <li class="public ">
72
+ <span class="summary_signature"><a title="#config (instance method)" href="#config-instance_method">- (Object) <strong>config</strong> </a>
73
+
74
+ </span>
75
+
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+ <span class="summary_desc">
85
+ Returns the value of attribute <tt>config</tt>.
86
+
87
+ </span>
88
+
89
+ </li>
90
+
91
+
92
+ </ul>
93
+
94
+
95
+ <h2>Method Summary</h2>
96
+ <ul class="summary">
97
+
98
+ <li class="public ">
99
+ <span class="summary_signature"><a title="run! (class method)" href="#run%21-class_method">+ (Object) <strong>run!</strong>(config) </a>
100
+
101
+ </span>
102
+
103
+
104
+
105
+
106
+
107
+
108
+ <span class="summary_desc"></span>
109
+
110
+ </li>
111
+
112
+
113
+ <li class="public ">
114
+ <span class="summary_signature"><a title="#initialize (instance method)" href="#initialize-instance_method">- (Base) <strong>initialize</strong>(new_config) </a>
115
+
116
+ </span>
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <span class="summary_desc">
124
+ A new instance of <tt>Base</tt>.
125
+
126
+ </span>
127
+
128
+ </li>
129
+
130
+
131
+ <li class="public ">
132
+ <span class="summary_signature"><a title="#validate (instance method)" href="#validate-instance_method">- (Object) <strong>validate</strong> </a>
133
+
134
+ </span>
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"></span>
142
+
143
+ </li>
144
+
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature"><a title="#verify_that_target_is_not_a_repository (instance method)" href="#verify_that_target_is_not_a_repository-instance_method">- (Object) <strong>verify_that_target_is_not_a_repository</strong>(target_directory) </a>
148
+
149
+ </span>
150
+
151
+
152
+
153
+
154
+
155
+
156
+ <span class="summary_desc"></span>
157
+
158
+ </li>
159
+
160
+
161
+ </ul>
162
+
163
+ <div id="constructor_details">
164
+ <h2>Constructor Details</h2>
165
+
166
+ <div class="method_details first">
167
+ <p class="signature first" id="initialize-instance_method">
168
+
169
+ - (<tt><a title="Base" href="">Base</a></tt>) <strong>initialize</strong>(new_config)
170
+
171
+
172
+
173
+ </p><div class="docstring">
174
+ <div class="discussion">
175
+ <p>
176
+ A new instance of <tt>Base</tt>
177
+ </p>
178
+
179
+
180
+ </div>
181
+ </div>
182
+ <div class="tags">
183
+ <h3>Returns:</h3>
184
+ <ul class="return">
185
+
186
+ <li>
187
+
188
+ <span class='type'>(<tt><a title="Base" href="">Base</a></tt>)</span>
189
+
190
+
191
+
192
+
193
+ &mdash;
194
+
195
+ a new instance of <tt>Base</tt>
196
+
197
+
198
+
199
+ </li>
200
+
201
+ </ul>
202
+
203
+ </div><table class="source_code">
204
+ <tr>
205
+ <td>
206
+ <pre class="lines">
207
+
208
+
209
+ 12
210
+ 13
211
+ 14</pre>
212
+ </td>
213
+ <td>
214
+ <pre class="code"><span class="info file"># File 'lib/reflection/command/base.rb', line 12</span>
215
+
216
+ <span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='new_config identifier id'>new_config</span><span class='rparen token'>)</span>
217
+ <span class='self self kw'>self</span><span class='dot token'>.</span><span class='config identifier id'>config</span> <span class='assign token'>=</span> <span class='new_config identifier id'>new_config</span>
218
+ <span class='end end kw'>end</span>
219
+ </pre>
220
+ </td>
221
+ </tr>
222
+ </table>
223
+ </div>
224
+
225
+ </div>
226
+
227
+ <div id="attr_details">
228
+ <h2>Attribute Details</h2>
229
+
230
+
231
+ <span id="config=-instance_method"></span>
232
+ <span id="config-instance_method"></span>
233
+ <div class="method_details first">
234
+ <p class="signature first" id="config-instance_method">
235
+
236
+ - (<tt>Object</tt>) <strong>config</strong>
237
+
238
+
239
+
240
+ </p><div class="docstring">
241
+ <div class="discussion">
242
+ <p>
243
+ Returns the value of attribute <tt>config</tt>
244
+ </p>
245
+
246
+
247
+ </div>
248
+ </div>
249
+ <div class="tags">
250
+
251
+ </div><table class="source_code">
252
+ <tr>
253
+ <td>
254
+ <pre class="lines">
255
+
256
+
257
+ 4
258
+ 5
259
+ 6</pre>
260
+ </td>
261
+ <td>
262
+ <pre class="code"><span class="info file"># File 'lib/reflection/command/base.rb', line 4</span>
263
+
264
+ <span class='def def kw'>def</span> <span class='config identifier id'>config</span>
265
+ <span class='@config ivar id'>@config</span>
266
+ <span class='end end kw'>end</span>
267
+ </pre>
268
+ </td>
269
+ </tr>
270
+ </table>
271
+ </div>
272
+
273
+ </div>
274
+
275
+
276
+ <div id="method_details">
277
+ <h2>Method Details</h2>
278
+
279
+ <div class="method_details first">
280
+ <p class="signature first" id="run!-class_method">
281
+
282
+ + (<tt>Object</tt>) <strong>run!</strong>(config)
283
+
284
+
285
+
286
+ </p><table class="source_code">
287
+ <tr>
288
+ <td>
289
+ <pre class="lines">
290
+
291
+
292
+ 6
293
+ 7
294
+ 8
295
+ 9
296
+ 10</pre>
297
+ </td>
298
+ <td>
299
+ <pre class="code"><span class="info file"># File 'lib/reflection/command/base.rb', line 6</span>
300
+
301
+ <span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='run! fid id'>run!</span><span class='lparen token'>(</span><span class='config identifier id'>config</span><span class='rparen token'>)</span>
302
+ <span class='command identifier id'>command</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='config identifier id'>config</span><span class='rparen token'>)</span>
303
+ <span class='command identifier id'>command</span><span class='dot token'>.</span><span class='validate! fid id'>validate!</span> <span class='if if_mod kw'>if</span> <span class='command identifier id'>command</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:validate!</span><span class='rparen token'>)</span>
304
+ <span class='command identifier id'>command</span><span class='dot token'>.</span><span class='run! fid id'>run!</span>
305
+ <span class='end end kw'>end</span>
306
+ </pre>
307
+ </td>
308
+ </tr>
309
+ </table>
310
+ </div>
311
+
312
+ <div class="method_details ">
313
+ <p class="signature " id="validate-instance_method">
314
+
315
+ - (<tt>Object</tt>) <strong>validate</strong>
316
+
317
+
318
+
319
+ </p><table class="source_code">
320
+ <tr>
321
+ <td>
322
+ <pre class="lines">
323
+
324
+
325
+ 16
326
+ 17
327
+ 18</pre>
328
+ </td>
329
+ <td>
330
+ <pre class="code"><span class="info file"># File 'lib/reflection/command/base.rb', line 16</span>
331
+
332
+ <span class='def def kw'>def</span> <span class='validate identifier id'>validate</span>
333
+ <span class='Reflection constant id'>Reflection</span><span class='colon2 op'>::</span><span class='Validations constant id'>Validations</span>
334
+ <span class='end end kw'>end</span>
335
+ </pre>
336
+ </td>
337
+ </tr>
338
+ </table>
339
+ </div>
340
+
341
+ <div class="method_details ">
342
+ <p class="signature " id="verify_that_target_is_not_a_repository-instance_method">
343
+
344
+ - (<tt>Object</tt>) <strong>verify_that_target_is_not_a_repository</strong>(target_directory)
345
+
346
+
347
+
348
+ </p><table class="source_code">
349
+ <tr>
350
+ <td>
351
+ <pre class="lines">
352
+
353
+
354
+ 20
355
+ 21
356
+ 22
357
+ 23
358
+ 24</pre>
359
+ </td>
360
+ <td>
361
+ <pre class="code"><span class="info file"># File 'lib/reflection/command/base.rb', line 20</span>
362
+
363
+ <span class='def def kw'>def</span> <span class='verify_that_target_is_not_a_repository identifier id'>verify_that_target_is_not_a_repository</span><span class='lparen token'>(</span><span class='target_directory identifier id'>target_directory</span><span class='rparen token'>)</span>
364
+ <span class='if if kw'>if</span> <span class='Repository constant id'>Repository</span><span class='dot token'>.</span><span class='exists? fid id'>exists?</span><span class='lparen token'>(</span><span class='target_directory identifier id'>target_directory</span><span class='dot token'>.</span><span class='path identifier id'>path</span><span class='rparen token'>)</span>
365
+ <span class='Support constant id'>Support</span><span class='dot token'>.</span><span class='exit_with_error identifier id'>exit_with_error</span> <span class='string val'>&quot;The specified --directory is a repository. Reflection is afraid of breaking something, so it won't touch it. Pleace specify another one..&quot;</span>
366
+ <span class='end end kw'>end</span>
367
+ <span class='end end kw'>end</span>
368
+ </pre>
369
+ </td>
370
+ </tr>
371
+ </table>
372
+ </div>
373
+
374
+ </div>
375
+
376
+ </div>
377
+
378
+ <div id="footer">
379
+ Generated on Wed Nov 18 18:17:11 2009 by
380
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
381
+ 0.4.0 (ruby-1.8.7).
382
+ </div>
383
+
384
+ </body>
385
+ </html>