1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: String</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">String</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/rake_rb.html">
lib/rake.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
User defined methods to be added to <a href="String.html">String</a>.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000391">ext</a>
<a href="#M000395">pathmap</a>
<a href="#M000392">pathmap_explode</a>
<a href="#M000393">pathmap_partial</a>
<a href="#M000394">pathmap_replace</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000391" class="method-detail">
<a name="M000391"></a>
<div class="method-heading">
<a href="#M000391" class="method-signature">
<span class="method-name">ext</span><span class="method-args">(newext='')</span>
</a>
</div>
<div class="method-description">
<p>
Replace the file extension with <tt>newext</tt>. If there is no extenson on
the string, append the new extension to the end. If the new extension is
not given, or is the empty string, remove any existing extension.
</p>
<p>
<tt><a href="String.html#M000391">ext</a></tt> is a user added method for
the <a href="String.html">String</a> class.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000391-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000391-source">
<pre>
<span class="ruby-comment cmt"># File lib/rake.rb, line 82</span>
82: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ext</span>(<span class="ruby-identifier">newext</span>=<span class="ruby-value str">''</span>)
83: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">dup</span> <span class="ruby-keyword kw">if</span> [<span class="ruby-value str">'.'</span>, <span class="ruby-value str">'..'</span>].<span class="ruby-identifier">include?</span> <span class="ruby-keyword kw">self</span>
84: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">newext</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">''</span>
85: <span class="ruby-identifier">newext</span> = (<span class="ruby-identifier">newext</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^\./</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">newext</span> <span class="ruby-operator">:</span> (<span class="ruby-value str">"."</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">newext</span>)
86: <span class="ruby-keyword kw">end</span>
87: <span class="ruby-identifier">dup</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp re">%r(([^/\\])\.[^./\\]*$)</span>) { <span class="ruby-identifier">$1</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">newext</span> } <span class="ruby-operator">||</span> <span class="ruby-keyword kw">self</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">newext</span>
88: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000395" class="method-detail">
<a name="M000395"></a>
<div class="method-heading">
<a href="#M000395" class="method-signature">
<span class="method-name">pathmap</span><span class="method-args">(spec=nil, &block)</span>
</a>
</div>
<div class="method-description">
<p>
Map the path according to the given specification. The specification
controls the details of the mapping. The following special patterns are
recognized:
</p>
<ul>
<li><b>%p</b> — The complete path.
</li>
<li><b>%f</b> — The base file name of the path, with its file extension,
but without any directories.
</li>
<li><b>%n</b> — The file name of the path without its file extension.
</li>
<li><b>%d</b> — The directory list of the path.
</li>
<li><b>%x</b> — The file extension of the path. An empty string if there
is no extension.
</li>
<li><b>%X</b> — Everything <b>but</b> the file extension.
</li>
<li><b>%s</b> — The alternate file separater if defined, otherwise use
the standard file separator.
</li>
<li><b>%%</b> — A percent sign.
</li>
</ul>
<p>
The %d specifier can also have a numeric prefix (e.g. ’%2d’).
If the number is positive, only return (up to) <tt>n</tt> directories in
the path, starting from the left hand side. If <tt>n</tt> is negative,
return (up to) |<tt>n</tt>| directories from the right hand side of the
path.
</p>
<p>
Examples:
</p>
<pre>
'a/b/c/d/file.txt'.pathmap("%2d") => 'a/b'
'a/b/c/d/file.txt'.pathmap("%-2d") => 'c/d'
</pre>
<p>
Also the %d, %p, $f, $n, %x, and %X operators can take a
pattern/replacement argument to perform simple string substititions on a
particular part of the path. The pattern and replacement are speparated by
a comma and are enclosed by curly braces. The replacement spec comes after
the % character but before the operator letter. (e.g.
"%{old,new}d"). Muliple replacement specs should be separated by
semi-colons (e.g. "%{old,new;src,bin}d").
</p>
<p>
Regular expressions may be used for the pattern, and back refs may be used
in the replacement text. Curly braces, commas and semi-colons are excluded
from both the pattern and replacement text (let‘s keep parsing
reasonable).
</p>
<p>
For example:
</p>
<pre>
"src/org/onestepback/proj/A.java".pathmap("%{^src,bin}X.class")
</pre>
<p>
returns:
</p>
<pre>
"bin/org/onestepback/proj/A.class"
</pre>
<p>
If the replacement text is ’*’, then a block may be provided to
perform some arbitrary calculation for the replacement.
</p>
<p>
For example:
</p>
<pre>
"/path/to/file.TXT".pathmap("%X%{.*,*}x") { |ext|
ext.downcase
}
</pre>
<p>
Returns:
</p>
<pre>
"/path/to/file.txt"
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000395-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000395-source">
<pre>
<span class="ruby-comment cmt"># File lib/rake.rb, line 202</span>
202: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pathmap</span>(<span class="ruby-identifier">spec</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
203: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">self</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">nil?</span>
204: <span class="ruby-identifier">result</span> = <span class="ruby-value str">''</span>
205: <span class="ruby-identifier">spec</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp re">/%\{[^}]*\}-?\d*[sdpfnxX%]|%-?\d+d|%.|[^%]+/</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">frag</span><span class="ruby-operator">|</span>
206: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">frag</span>
207: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%f'</span>
208: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-keyword kw">self</span>)
209: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%n'</span>
210: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-keyword kw">self</span>).<span class="ruby-identifier">ext</span>
211: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%d'</span>
212: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">self</span>)
213: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%x'</span>
214: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">$1</span> <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/[^\/](\.[^.]+)$/</span>
215: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%X'</span>
216: <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^(.+[^\/])(\.[^.]+)$/</span>
217: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">$1</span>
218: <span class="ruby-keyword kw">else</span>
219: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">self</span>
220: <span class="ruby-keyword kw">end</span>
221: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%p'</span>
222: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">self</span>
223: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%s'</span>
224: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> (<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">ALT_SEPARATOR</span> <span class="ruby-operator">||</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
225: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%-'</span>
226: <span class="ruby-comment cmt"># do nothing</span>
227: <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'%%'</span>
228: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"%"</span>
229: <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/%(-?\d+)d/</span>
230: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">pathmap_partial</span>(<span class="ruby-identifier">$1</span>.<span class="ruby-identifier">to_i</span>)
231: <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/^%\{([^}]*)\}(\d*[dpfnxX])/</span>
232: <span class="ruby-identifier">patterns</span>, <span class="ruby-identifier">operator</span> = <span class="ruby-identifier">$1</span>, <span class="ruby-identifier">$2</span>
233: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">pathmap</span>(<span class="ruby-value str">'%'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">operator</span>).<span class="ruby-identifier">pathmap_replace</span>(<span class="ruby-identifier">patterns</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
234: <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/^%/</span>
235: <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Unknown pathmap specifier #{frag} in '#{spec}'"</span>
236: <span class="ruby-keyword kw">else</span>
237: <span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">frag</span>
238: <span class="ruby-keyword kw">end</span>
239: <span class="ruby-keyword kw">end</span>
240: <span class="ruby-identifier">result</span>
241: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000392" class="method-detail">
<a name="M000392"></a>
<div class="method-heading">
<a href="#M000392" class="method-signature">
<span class="method-name">pathmap_explode</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Explode a path into individual components. Used by <tt><a
href="String.html#M000395">pathmap</a></tt>.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000392-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000392-source">
<pre>
<span class="ruby-comment cmt"># File lib/rake.rb, line 93</span>
93: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pathmap_explode</span>
94: <span class="ruby-identifier">head</span>, <span class="ruby-identifier">tail</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">split</span>(<span class="ruby-keyword kw">self</span>)
95: <span class="ruby-keyword kw">return</span> [<span class="ruby-keyword kw">self</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">head</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">self</span>
96: <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">tail</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">head</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'.'</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">tail</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'/'</span>
97: <span class="ruby-keyword kw">return</span> [<span class="ruby-identifier">head</span>, <span class="ruby-identifier">tail</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">head</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'/'</span>
98: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">head</span>.<span class="ruby-identifier">pathmap_explode</span> <span class="ruby-operator">+</span> [<span class="ruby-identifier">tail</span>]
99: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000393" class="method-detail">
<a name="M000393"></a>
<div class="method-heading">
<a href="#M000393" class="method-signature">
<span class="method-name">pathmap_partial</span><span class="method-args">(n)</span>
</a>
</div>
<div class="method-description">
<p>
Extract a partial path from the path. Include <tt>n</tt> directories from
the front end (left hand side) if <tt>n</tt> is positive. Include
|<tt>n</tt>| directories from the back end (right hand side) if <tt>n</tt>
is negative.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000393-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000393-source">
<pre>
<span class="ruby-comment cmt"># File lib/rake.rb, line 105</span>
105: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pathmap_partial</span>(<span class="ruby-identifier">n</span>)
106: <span class="ruby-identifier">target</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">self</span>)
107: <span class="ruby-identifier">dirs</span> = <span class="ruby-identifier">target</span>.<span class="ruby-identifier">pathmap_explode</span>
108: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
109: <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">dirs</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span>])
110: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">n</span> <span class="ruby-operator"><</span> <span class="ruby-value">0</span>
111: <span class="ruby-identifier">partial</span> = <span class="ruby-identifier">dirs</span>[<span class="ruby-identifier">n</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
112: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">partial</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">partial</span>.<span class="ruby-identifier">empty?</span>
113: <span class="ruby-identifier">target</span>
114: <span class="ruby-keyword kw">else</span>
115: <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">partial</span>)
116: <span class="ruby-keyword kw">end</span>
117: <span class="ruby-keyword kw">else</span>
118: <span class="ruby-value str">"."</span>
119: <span class="ruby-keyword kw">end</span>
120: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000394" class="method-detail">
<a name="M000394"></a>
<div class="method-heading">
<a href="#M000394" class="method-signature">
<span class="method-name">pathmap_replace</span><span class="method-args">(patterns, &block)</span>
</a>
</div>
<div class="method-description">
<p>
Preform the <a href="String.html#M000395">pathmap</a> replacement
operations on the given path. The patterns take the form
‘pat1,rep1;pat2,rep2…’.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000394-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000394-source">
<pre>
<span class="ruby-comment cmt"># File lib/rake.rb, line 125</span>
125: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pathmap_replace</span>(<span class="ruby-identifier">patterns</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
126: <span class="ruby-identifier">result</span> = <span class="ruby-keyword kw">self</span>
127: <span class="ruby-identifier">patterns</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">';'</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pair</span><span class="ruby-operator">|</span>
128: <span class="ruby-identifier">pattern</span>, <span class="ruby-identifier">replacement</span> = <span class="ruby-identifier">pair</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">','</span>)
129: <span class="ruby-identifier">pattern</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pattern</span>)
130: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">replacement</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'*'</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">block_given?</span>
131: <span class="ruby-identifier">result</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-identifier">pattern</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
132: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">replacement</span>
133: <span class="ruby-identifier">result</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-identifier">pattern</span>, <span class="ruby-identifier">replacement</span>)
134: <span class="ruby-keyword kw">else</span>
135: <span class="ruby-identifier">result</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-identifier">pattern</span>, <span class="ruby-value str">''</span>)
136: <span class="ruby-keyword kw">end</span>
137: <span class="ruby-keyword kw">end</span>
138: <span class="ruby-identifier">result</span>
139: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
