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.
Files changed (26) hide show
  1. data/CHANGELOG.rdoc +9 -0
  2. data/Rakefile +5 -1
  3. data/doc/DirTravel/DirEntry.html +286 -0
  4. data/doc/DirTravel/DirTravelError.html +123 -0
  5. data/doc/DirTravel/Entry.html +1246 -0
  6. data/doc/DirTravel/FileEntry.html +392 -0
  7. data/doc/DirTravel/Travel.html +716 -0
  8. data/doc/DirTravel.html +158 -0
  9. data/doc/_index.html +172 -0
  10. data/doc/class_list.html +53 -0
  11. data/doc/css/common.css +1 -0
  12. data/doc/css/full_list.css +57 -0
  13. data/doc/css/style.css +338 -0
  14. data/doc/file.CHANGELOG.html +86 -0
  15. data/doc/file.README.html +84 -0
  16. data/doc/file_list.html +58 -0
  17. data/doc/frames.html +28 -0
  18. data/doc/index.html +84 -0
  19. data/doc/js/app.js +214 -0
  20. data/doc/js/full_list.js +178 -0
  21. data/doc/js/jquery.js +4 -0
  22. data/doc/method_list.html +190 -0
  23. data/doc/top-level-namespace.html +112 -0
  24. data/lib/dirtravel.rb +113 -16
  25. data/test/test_dirtravel.rb +51 -4
  26. metadata +24 -2
data/CHANGELOG.rdoc ADDED
@@ -0,0 +1,9 @@
1
+ = Version history
2
+
3
+ [0.0.3] Entry#tip, Entry#relative?, Entry#rename methods added. New
4
+ option for Travel.filetree, :inclusive. It uses one-up
5
+ directory as root.
6
+
7
+ [0.0.2] Comment typo.
8
+
9
+ [0.0.1] Initial version.
data/Rakefile CHANGED
@@ -11,10 +11,14 @@ task :cleanup_test do
11
11
  sh "rm -rf test/test"
12
12
  end
13
13
 
14
- task :build do
14
+ task :build => :doc do
15
15
  sh "gem build dirtravel.gemspec"
16
16
  end
17
17
 
18
+ task :doc do
19
+ sh "yardoc lib/* - README.rdoc CHANGELOG.rdoc"
20
+ end
21
+
18
22
  task :publish do
19
23
  if Dir.glob('dirtravel-*gem').length == 1
20
24
  sh "gem push dirtravel*.gem"
data/doc/DirTravel/DirEntry.html ADDED
@@ -0,0 +1,286 @@
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::DirEntry
8
+
9
+ &mdash; 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 (D)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../DirTravel.html" title="DirTravel (module)">DirTravel</a></span></span>
36
+ &raquo;
37
+ <span class="title">DirEntry</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::DirEntry
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::DirEntry</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>Directory type entry.</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+
122
+
123
+ <h2>Instance Attribute Summary</h2>
124
+
125
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Entry.html" title="DirTravel::Entry (class)">Entry</a></span></h3>
126
+ <p class="inherited"><span class='object_link'><a href="Entry.html#name-instance_method" title="DirTravel::Entry#name (method)">#name</a></span></p>
127
+
128
+
129
+
130
+ <h2>
131
+ Instance Method Summary
132
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
133
+ </h2>
134
+
135
+ <ul class="summary">
136
+
137
+ <li class="public ">
138
+ <span class="summary_signature">
139
+
140
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (DirEntry) <strong>initialize</strong>(name, root = false) </a>
141
+
142
+
143
+
144
+ </span>
145
+
146
+
147
+ <span class="note title constructor">constructor</span>
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+ <span class="summary_desc"><div class='inline'>
157
+ <p>Instantiate.</p>
158
+ </div></span>
159
+
160
+ </li>
161
+
162
+
163
+ </ul>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Entry.html" title="DirTravel::Entry (class)">Entry</a></span></h3>
176
+ <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>
177
+
178
+ <div id="constructor_details" class="method_details_list">
179
+ <h2>Constructor Details</h2>
180
+
181
+ <div class="method_details first">
182
+ <h3 class="signature first" id="initialize-instance_method">
183
+
184
+ - (<tt><span class='object_link'><a href="" title="DirTravel::DirEntry (class)">DirEntry</a></span></tt>) <strong>initialize</strong>(name, root = false)
185
+
186
+
187
+
188
+
189
+
190
+ </h3><div class="docstring">
191
+ <div class="discussion">
192
+
193
+ <p>Instantiate.</p>
194
+
195
+
196
+ </div>
197
+ </div>
198
+ <div class="tags">
199
+ <p class="tag_title">Parameters:</p>
200
+ <ul class="param">
201
+
202
+ <li>
203
+
204
+ <span class='name'>name</span>
205
+
206
+
207
+ <span class='type'>(<tt>String</tt>)</span>
208
+
209
+
210
+
211
+ &mdash;
212
+ <div class='inline'>
213
+ <p>Directory name.</p>
214
+ </div>
215
+
216
+ </li>
217
+
218
+ <li>
219
+
220
+ <span class='name'>root</span>
221
+
222
+
223
+ <span class='type'>(<tt>Boolean</tt>)</span>
224
+
225
+
226
+ <em class="default">(defaults to: <tt>false</tt>)</em>
227
+
228
+
229
+ &mdash;
230
+ <div class='inline'>
231
+ <p>If root, abspath is set now.</p>
232
+ </div>
233
+
234
+ </li>
235
+
236
+ </ul>
237
+
238
+
239
+ </div><table class="source_code">
240
+ <tr>
241
+ <td>
242
+ <pre class="lines">
243
+
244
+
245
+ 167
246
+ 168
247
+ 169
248
+ 170
249
+ 171
250
+ 172
251
+ 173
252
+ 174
253
+ 175
254
+ 176</pre>
255
+ </td>
256
+ <td>
257
+ <pre class="code"><span class="info file"># File 'lib/dirtravel.rb', line 167</span>
258
+
259
+ <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='comma'>,</span> <span class='id identifier rubyid_root'>root</span> <span class='op'>=</span> <span class='kw'>false</span> <span class='rparen'>)</span>
260
+ <span class='kw'>super</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
261
+ <span class='kw'>if</span> <span class='id identifier rubyid_root'>root</span>
262
+ <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span>
263
+ <span class='ivar'>@abspath</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
264
+ <span class='kw'>else</span>
265
+ <span class='ivar'>@abspath</span> <span class='op'>=</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_pwd'>pwd</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/</span><span class='tstring_end'>'</span></span> <span class='op'>+</span> <span class='id identifier rubyid_name'>name</span>
266
+ <span class='kw'>end</span>
267
+ <span class='kw'>end</span>
268
+ <span class='kw'>end</span></pre>
269
+ </td>
270
+ </tr>
271
+ </table>
272
+ </div>
273
+
274
+ </div>
275
+
276
+
277
+ </div>
278
+
279
+ <div id="footer">
280
+ Generated on Sat Jan 18 17:51:32 2014 by
281
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
282
+ 0.8.6.1 (ruby-1.9.3).
283
+ </div>
284
+
285
+ </body>
286
+ </html>
data/doc/DirTravel/DirTravelError.html ADDED
@@ -0,0 +1,123 @@
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
+ Exception: DirTravel::DirTravelError
8
+
9
+ &mdash; 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 (D)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../DirTravel.html" title="DirTravel (module)">DirTravel</a></span></span>
36
+ &raquo;
37
+ <span class="title">DirTravelError</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>Exception: DirTravel::DirTravelError
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">RuntimeError</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">RuntimeError</li>
82
+
83
+ <li class="next">DirTravel::DirTravelError</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/dirtravel.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+ </div>
115
+
116
+ <div id="footer">
117
+ Generated on Sat Jan 18 17:51:32 2014 by
118
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
119
+ 0.8.6.1 (ruby-1.9.3).
120
+ </div>
121
+
122
+ </body>
123
+ </html>