dirtravel 0.0.2 → 0.0.3
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.
- data/CHANGELOG.rdoc +9 -0
- data/Rakefile +5 -1
- data/doc/DirTravel/DirEntry.html +286 -0
- data/doc/DirTravel/DirTravelError.html +123 -0
- data/doc/DirTravel/Entry.html +1246 -0
- data/doc/DirTravel/FileEntry.html +392 -0
- data/doc/DirTravel/Travel.html +716 -0
- data/doc/DirTravel.html +158 -0
- data/doc/_index.html +172 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +338 -0
- data/doc/file.CHANGELOG.html +86 -0
- data/doc/file.README.html +84 -0
- data/doc/file_list.html +58 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +84 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +178 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +190 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/dirtravel.rb +113 -16
- data/test/test_dirtravel.rb +51 -4
- metadata +24 -2
|
@@ -0,0 +1,392 @@
|
|
|
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
|
+
Class: DirTravel::FileEntry
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.6.1
|
|
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 (F)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../DirTravel.html" title="DirTravel (module)">DirTravel</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">FileEntry</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>Class: DirTravel::FileEntry
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName"><span class='object_link'><a href="Entry.html" title="DirTravel::Entry (class)">Entry</a></span></span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">Tree::TreeNode</li>
|
|
82
|
+
|
|
83
|
+
<li class="next"><span class='object_link'><a href="Entry.html" title="DirTravel::Entry (class)">Entry</a></span></li>
|
|
84
|
+
|
|
85
|
+
<li class="next">DirTravel::FileEntry</li>
|
|
86
|
+
|
|
87
|
+
</ul>
|
|
88
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
89
|
+
|
|
90
|
+
</dd>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dt class="r2 last">Defined in:</dt>
|
|
101
|
+
<dd class="r2 last">lib/dirtravel.rb</dd>
|
|
102
|
+
|
|
103
|
+
</dl>
|
|
104
|
+
<div class="clear"></div>
|
|
105
|
+
|
|
106
|
+
<h2>Overview</h2><div class="docstring">
|
|
107
|
+
<div class="discussion">
|
|
108
|
+
|
|
109
|
+
<p>File type entry.</p>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
</div>
|
|
113
|
+
</div>
|
|
114
|
+
<div class="tags">
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</div>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
122
|
+
<ul class="summary">
|
|
123
|
+
|
|
124
|
+
<li class="public ">
|
|
125
|
+
<span class="summary_signature">
|
|
126
|
+
|
|
127
|
+
<a href="#basename-instance_method" title="#basename (instance method)">- (Object) <strong>basename</strong> </a>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</span>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class="note title readonly">readonly</span>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<span class="summary_desc"><div class='inline'>
|
|
147
|
+
<p>Returns the value of attribute basename.</p>
|
|
148
|
+
</div></span>
|
|
149
|
+
|
|
150
|
+
</li>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<li class="public ">
|
|
154
|
+
<span class="summary_signature">
|
|
155
|
+
|
|
156
|
+
<a href="#suffix-instance_method" title="#suffix (instance method)">- (Object) <strong>suffix</strong> </a>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
</span>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<span class="note title readonly">readonly</span>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="summary_desc"><div class='inline'>
|
|
176
|
+
<p>Returns the value of attribute suffix.</p>
|
|
177
|
+
</div></span>
|
|
178
|
+
|
|
179
|
+
</li>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
</ul>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Entry.html" title="DirTravel::Entry (class)">Entry</a></span></h3>
|
|
189
|
+
<p class="inherited"><span class='object_link'><a href="Entry.html#name-instance_method" title="DirTravel::Entry#name (method)">#name</a></span></p>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<h2>
|
|
194
|
+
Instance Method Summary
|
|
195
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
196
|
+
</h2>
|
|
197
|
+
|
|
198
|
+
<ul class="summary">
|
|
199
|
+
|
|
200
|
+
<li class="public ">
|
|
201
|
+
<span class="summary_signature">
|
|
202
|
+
|
|
203
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (FileEntry) <strong>initialize</strong>(name) </a>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
</span>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<span class="note title constructor">constructor</span>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<span class="summary_desc"><div class='inline'>
|
|
220
|
+
<p>A new instance of FileEntry.</p>
|
|
221
|
+
</div></span>
|
|
222
|
+
|
|
223
|
+
</li>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
</ul>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Entry.html" title="DirTravel::Entry (class)">Entry</a></span></h3>
|
|
239
|
+
<p class="inherited"><span class='object_link'><a href="Entry.html#abspath-instance_method" title="DirTravel::Entry#abspath (method)">#abspath</a></span>, <span class='object_link'><a href="Entry.html#dir-instance_method" title="DirTravel::Entry#dir (method)">#dir</a></span>, <span class='object_link'><a href="Entry.html#files-instance_method" title="DirTravel::Entry#files (method)">#files</a></span>, <span class='object_link'><a href="Entry.html#parts-instance_method" title="DirTravel::Entry#parts (method)">#parts</a></span>, <span class='object_link'><a href="Entry.html#path-instance_method" title="DirTravel::Entry#path (method)">#path</a></span>, <span class='object_link'><a href="Entry.html#relative%3F-instance_method" title="DirTravel::Entry#relative? (method)">#relative?</a></span>, <span class='object_link'><a href="Entry.html#rename-instance_method" title="DirTravel::Entry#rename (method)">#rename</a></span>, <span class='object_link'><a href="Entry.html#select_level-instance_method" title="DirTravel::Entry#select_level (method)">#select_level</a></span>, <span class='object_link'><a href="Entry.html#stat-instance_method" title="DirTravel::Entry#stat (method)">#stat</a></span>, <span class='object_link'><a href="Entry.html#subpath-instance_method" title="DirTravel::Entry#subpath (method)">#subpath</a></span>, <span class='object_link'><a href="Entry.html#tip-instance_method" title="DirTravel::Entry#tip (method)">#tip</a></span></p>
|
|
240
|
+
|
|
241
|
+
<div id="constructor_details" class="method_details_list">
|
|
242
|
+
<h2>Constructor Details</h2>
|
|
243
|
+
|
|
244
|
+
<div class="method_details first">
|
|
245
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
246
|
+
|
|
247
|
+
- (<tt><span class='object_link'><a href="" title="DirTravel::FileEntry (class)">FileEntry</a></span></tt>) <strong>initialize</strong>(name)
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
</h3><div class="docstring">
|
|
254
|
+
<div class="discussion">
|
|
255
|
+
|
|
256
|
+
<p>A new instance of FileEntry</p>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
</div>
|
|
260
|
+
</div>
|
|
261
|
+
<div class="tags">
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
</div><table class="source_code">
|
|
265
|
+
<tr>
|
|
266
|
+
<td>
|
|
267
|
+
<pre class="lines">
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
185
|
|
271
|
+
186
|
|
272
|
+
187
|
|
273
|
+
188
|
|
274
|
+
189</pre>
|
|
275
|
+
</td>
|
|
276
|
+
<td>
|
|
277
|
+
<pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 185</span>
|
|
278
|
+
|
|
279
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
|
|
280
|
+
<span class='kw'>super</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
|
|
281
|
+
<span class='ivar'>@suffix</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_extname'>extname</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
|
|
282
|
+
<span class='ivar'>@basename</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='ivar'>@suffix</span> <span class='rparen'>)</span>
|
|
283
|
+
<span class='kw'>end</span></pre>
|
|
284
|
+
</td>
|
|
285
|
+
</tr>
|
|
286
|
+
</table>
|
|
287
|
+
</div>
|
|
288
|
+
|
|
289
|
+
</div>
|
|
290
|
+
|
|
291
|
+
<div id="instance_attr_details" class="attr_details">
|
|
292
|
+
<h2>Instance Attribute Details</h2>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
<span id=""></span>
|
|
296
|
+
<div class="method_details first">
|
|
297
|
+
<h3 class="signature first" id="basename-instance_method">
|
|
298
|
+
|
|
299
|
+
- (<tt>Object</tt>) <strong>basename</strong> <span class="extras">(readonly)</span>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
</h3><div class="docstring">
|
|
306
|
+
<div class="discussion">
|
|
307
|
+
|
|
308
|
+
<p>Returns the value of attribute basename</p>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
</div>
|
|
312
|
+
</div>
|
|
313
|
+
<div class="tags">
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
</div><table class="source_code">
|
|
317
|
+
<tr>
|
|
318
|
+
<td>
|
|
319
|
+
<pre class="lines">
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
183
|
|
323
|
+
184
|
|
324
|
+
185</pre>
|
|
325
|
+
</td>
|
|
326
|
+
<td>
|
|
327
|
+
<pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 183</span>
|
|
328
|
+
|
|
329
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_basename'>basename</span>
|
|
330
|
+
<span class='ivar'>@basename</span>
|
|
331
|
+
<span class='kw'>end</span></pre>
|
|
332
|
+
</td>
|
|
333
|
+
</tr>
|
|
334
|
+
</table>
|
|
335
|
+
</div>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<span id=""></span>
|
|
339
|
+
<div class="method_details ">
|
|
340
|
+
<h3 class="signature " id="suffix-instance_method">
|
|
341
|
+
|
|
342
|
+
- (<tt>Object</tt>) <strong>suffix</strong> <span class="extras">(readonly)</span>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
</h3><div class="docstring">
|
|
349
|
+
<div class="discussion">
|
|
350
|
+
|
|
351
|
+
<p>Returns the value of attribute suffix</p>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
</div>
|
|
355
|
+
</div>
|
|
356
|
+
<div class="tags">
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
</div><table class="source_code">
|
|
360
|
+
<tr>
|
|
361
|
+
<td>
|
|
362
|
+
<pre class="lines">
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
183
|
|
366
|
+
184
|
|
367
|
+
185</pre>
|
|
368
|
+
</td>
|
|
369
|
+
<td>
|
|
370
|
+
<pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 183</span>
|
|
371
|
+
|
|
372
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_suffix'>suffix</span>
|
|
373
|
+
<span class='ivar'>@suffix</span>
|
|
374
|
+
<span class='kw'>end</span></pre>
|
|
375
|
+
</td>
|
|
376
|
+
</tr>
|
|
377
|
+
</table>
|
|
378
|
+
</div>
|
|
379
|
+
|
|
380
|
+
</div>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
</div>
|
|
384
|
+
|
|
385
|
+
<div id="footer">
|
|
386
|
+
Generated on Sat Jan 18 17:51:32 2014 by
|
|
387
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
388
|
+
0.8.6.1 (ruby-1.9.3).
|
|
389
|
+
</div>
|
|
390
|
+
|
|
391
|
+
</body>
|
|
392
|
+
</html>
|