rupat 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.rdoc +3 -0
  3. data/LICENSE +20 -0
  4. data/README.rdoc +17 -0
  5. data/bin/rupat +183 -0
  6. data/doc/Rupat.html +973 -0
  7. data/doc/RupatAlias.html +191 -0
  8. data/doc/RupatMod/RupatError.html +138 -0
  9. data/doc/RupatMod/RupatInvalidLineError.html +142 -0
  10. data/doc/RupatMod/RupatPasteError.html +142 -0
  11. data/doc/RupatMod/RupatSearchError.html +142 -0
  12. data/doc/RupatMod/RupatTypeError.html +142 -0
  13. data/doc/RupatMod.html +5150 -0
  14. data/doc/_index.html +158 -0
  15. data/doc/class_list.html +58 -0
  16. data/doc/css/common.css +1 -0
  17. data/doc/css/full_list.css +57 -0
  18. data/doc/css/style.css +339 -0
  19. data/doc/file.CHANGELOG.html +79 -0
  20. data/doc/file.README.html +89 -0
  21. data/doc/file_list.html +63 -0
  22. data/doc/frames.html +26 -0
  23. data/doc/index.html +89 -0
  24. data/doc/js/app.js +219 -0
  25. data/doc/js/full_list.js +181 -0
  26. data/doc/js/jquery.js +4 -0
  27. data/doc/method_list.html +399 -0
  28. data/doc/top-level-namespace.html +114 -0
  29. data/lib/rupat.rb +912 -0
  30. data/lib/version.rb +6 -0
  31. data/test/input/diff_test1.txt +10 -0
  32. data/test/input/diff_test2.txt +13 -0
  33. data/test/input/test_file1.txt +10 -0
  34. data/test/test_rupat.rb +213 -0
  35. data/test/test_rupat_bin.rb +27 -0
  36. metadata +96 -0
data/doc/Rupat.html ADDED
@@ -0,0 +1,973 @@
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: Rupat
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
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#!Rupat.html";
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 (R)</a> &raquo;
35
+
36
+
37
+ <span class="title">Rupat</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: Rupat
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">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Rupat</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r2">Includes:</dt>
94
+ <dd class="r2"><span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span></dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/rupat.rb<span class="defines">,<br />
102
+ lib/version.rb</span>
103
+ </dd>
104
+
105
+ </dl>
106
+ <div class="clear"></div>
107
+
108
+ <h2>Overview</h2><div class="docstring">
109
+ <div class="discussion">
110
+
111
+ <h1 id="label-Rupat">Rupat</h1>
112
+
113
+ <h2 id="label-Introduction">Introduction</h2>
114
+
115
+ <p><span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> is a Ruby Patching utility. It can be used to patch files or for
116
+ extracting information from files.</p>
117
+
118
+ <p><span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> includes:</p>
119
+ <dl class="rdoc-list label-list"><dt><span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span>
120
+ <dd>
121
+ <p>File content manipulation methods.</p>
122
+ </dd><dt><span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span>
123
+ <dd>
124
+ <p>Class methods for Rupat script creation.</p>
125
+ </dd><dt>Rupat command
126
+ <dd>
127
+ <p>Shell command for creating Rupat patch files.</p>
128
+ </dd></dl>
129
+
130
+ <p>Typical <span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> script opens a file for editing, uses Regexp searches to
131
+ find the file position(s) to change, and adds/replaces the content. File
132
+ positions can be referred also line numbers.</p>
133
+
134
+ <p>Rupat command can be used to create a patch script from diff output. The
135
+ generated script includes <span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span> commands which implement the
136
+ transformation.</p>
137
+
138
+ <p><span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> includes lines of the file in a line Array. <span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> keeps track of
139
+ the current line. Many editing commands use the current line to specify the
140
+ context for editing.</p>
141
+
142
+ <p><span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> has two parts: <span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> class and <span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span>. <span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> class is a
143
+ front end class to create <span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> instance for editing. <span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> includes
144
+ <span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span>. <span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span> can be used for other user classes that benefit from
145
+ lines editing.</p>
146
+
147
+ <p>The basic flow is:</p>
148
+ <dl class="rdoc-list label-list"><dt>open file
149
+ <dd>
150
+ <p>Source file can be opened in multiple editing modes.</p>
151
+ </dd><dt>line manipulation
152
+ <dd>
153
+ <p>Search/jump to lines, extract and edit content</p>
154
+ </dd></dl>
155
+
156
+ <pre class="code ruby"><code class="ruby">(See: {RupatMod} for all access/editing methods).</code></pre>
157
+ <dl class="rdoc-list label-list"><dt>save file
158
+ <dd>
159
+ <p>Save the editing results to the source file or to a newly created file.</p>
160
+ </dd></dl>
161
+
162
+ <h2 id="label-Rupat+class">Rupat class</h2>
163
+
164
+ <p><span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> is a class that provides the default entry point to the <span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span>
165
+ module.</p>
166
+
167
+ <p>The user can modify, duplicate, or just read file(s).</p>
168
+ <dl class="rdoc-list label-list"><dt>update
169
+ <dd>
170
+ <p>Perform content update for a file, but without any backups.</p>
171
+ </dd><dt>edit
172
+ <dd>
173
+ <p>Inplace editing with possibility to backup the original.</p>
174
+ </dd><dt>open
175
+ <dd>
176
+ <p>Open file in read-only mode. Possibility to save the changes later exist.</p>
177
+ </dd><dt>create
178
+ <dd>
179
+ <p>A named file is to be created from source file.</p>
180
+ </dd></dl>
181
+
182
+ <h3 id="label-Example+usage%3A">Example usage:</h3>
183
+
184
+ <pre class="code ruby"><code class="ruby"><span class='comment'># Open file for reading.
185
+ </span><span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>report.txt</span><span class='tstring_end'>&quot;</span></span> <span class='rparen'>)</span>
186
+
187
+ <span class='comment'># Find line.
188
+ </span><span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>cpp</span><span class='regexp_end'>/</span></span>
189
+
190
+ <span class='comment'># Collect some lines.
191
+ </span><span class='id identifier rubyid_line'>line</span> <span class='op'>=</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_line'>line</span>
192
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='int'>4</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
193
+ <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span> <span class='id identifier rubyid_line'>line</span> <span class='op'>+</span> <span class='id identifier rubyid_i'>i</span> <span class='rparen'>)</span>
194
+ <span class='kw'>end</span>
195
+
196
+ <span class='comment'># Duplicate the lines collected.
197
+ </span><span class='id identifier rubyid_insertMany'>insertMany</span><span class='lparen'>(</span> <span class='id identifier rubyid_data'>data</span> <span class='rparen'>)</span>
198
+
199
+ <span class='comment'># Save changes.
200
+ </span><span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
201
+ </code></pre>
202
+
203
+ <h2 id="label-Rupat+command">Rupat command</h2>
204
+
205
+ <p>Rupat command is a simple shell command using <span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span>. Main purpose is to
206
+ execute Rupat programs. It can also be used to generate a <span class='object_link'><a href="" title="Rupat (class)">Rupat</a></span> patch
207
+ from files with different content. When applied, the patch transforms file1
208
+ to file2.</p>
209
+
210
+
211
+ </div>
212
+ </div>
213
+ <div class="tags">
214
+
215
+
216
+ </div>
217
+ <h2>Constant Summary</h2>
218
+
219
+ <dl class="constants">
220
+
221
+ <dt id="VERSION-constant" class="">VERSION =
222
+
223
+ </dt>
224
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
225
+
226
+ </dl>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <h2>Instance Attribute Summary</h2>
235
+
236
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span></h3>
237
+ <p class="inherited"><span class='object_link'><a href="RupatMod.html#copybuf-instance_method" title="RupatMod#copybuf (method)">#copybuf</a></span>, <span class='object_link'><a href="RupatMod.html#lines-instance_method" title="RupatMod#lines (method)">#lines</a></span>, <span class='object_link'><a href="RupatMod.html#newFile-instance_method" title="RupatMod#newFile (method)">#newFile</a></span>, <span class='object_link'><a href="RupatMod.html#orgFile-instance_method" title="RupatMod#orgFile (method)">#orgFile</a></span></p>
238
+
239
+
240
+
241
+ <h2>
242
+ Class Method Summary
243
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
244
+ </h2>
245
+
246
+ <ul class="summary">
247
+
248
+ <li class="public ">
249
+ <span class="summary_signature">
250
+
251
+ <a href="#create-class_method" title="create (class method)">+ (Object) <strong>create</strong>(orgFile, newFile) </a>
252
+
253
+
254
+
255
+ </span>
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <span class="summary_desc"><div class='inline'>
266
+ <p>Create new file based on old file.</p>
267
+ </div></span>
268
+
269
+ </li>
270
+
271
+
272
+ <li class="public ">
273
+ <span class="summary_signature">
274
+
275
+ <a href="#edit-class_method" title="edit (class method)">+ (Object) <strong>edit</strong>(file, backup = true) </a>
276
+
277
+
278
+
279
+ </span>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+ <span class="summary_desc"><div class='inline'>
290
+ <p>Edit existing file and by default make backup.</p>
291
+ </div></span>
292
+
293
+ </li>
294
+
295
+
296
+ <li class="public ">
297
+ <span class="summary_signature">
298
+
299
+ <a href="#lines-class_method" title="lines (class method)">+ (Object) <strong>lines</strong>(lines) </a>
300
+
301
+
302
+
303
+ </span>
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+ <span class="summary_desc"><div class='inline'>
314
+ <p>Use set of lines for editing.</p>
315
+ </div></span>
316
+
317
+ </li>
318
+
319
+
320
+ <li class="public ">
321
+ <span class="summary_signature">
322
+
323
+ <a href="#open-class_method" title="open (class method)">+ (Object) <strong>open</strong>(file) </a>
324
+
325
+
326
+
327
+ </span>
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+ <span class="summary_desc"><div class='inline'>
338
+ <p>Open existing file for reading.</p>
339
+ </div></span>
340
+
341
+ </li>
342
+
343
+
344
+ <li class="public ">
345
+ <span class="summary_signature">
346
+
347
+ <a href="#readonly-class_method" title="readonly (class method)">+ (Object) <strong>readonly</strong>(file) </a>
348
+
349
+
350
+
351
+ </span>
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+ <span class="summary_desc"><div class='inline'>
362
+ <p>Open existing file for reading.</p>
363
+ </div></span>
364
+
365
+ </li>
366
+
367
+
368
+ <li class="public ">
369
+ <span class="summary_signature">
370
+
371
+ <a href="#update-class_method" title="update (class method)">+ (Object) <strong>update</strong>(file) </a>
372
+
373
+
374
+
375
+ </span>
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+ <span class="summary_desc"><div class='inline'>
386
+ <p>Edit existing file inplace without backups.</p>
387
+ </div></span>
388
+
389
+ </li>
390
+
391
+
392
+ <li class="public ">
393
+ <span class="summary_signature">
394
+
395
+ <a href="#version-class_method" title="version (class method)">+ (Object) <strong>version</strong> </a>
396
+
397
+
398
+
399
+ </span>
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+ <span class="summary_desc"><div class='inline'></div></span>
410
+
411
+ </li>
412
+
413
+
414
+ </ul>
415
+
416
+ <h2>
417
+ Instance Method Summary
418
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
419
+ </h2>
420
+
421
+ <ul class="summary">
422
+
423
+ <li class="public ">
424
+ <span class="summary_signature">
425
+
426
+ <a href="#useAlias-instance_method" title="#useAlias (instance method)">- (Object) <strong>useAlias</strong> </a>
427
+
428
+
429
+
430
+ </span>
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+ <span class="summary_desc"><div class='inline'>
441
+ <p>Use short aliases from <span class='object_link'><a href="RupatAlias.html" title="RupatAlias (module)">RupatAlias</a></span> module.</p>
442
+ </div></span>
443
+
444
+ </li>
445
+
446
+
447
+ </ul>
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="RupatMod.html" title="RupatMod (module)">RupatMod</a></span></h3>
460
+ <p class="inherited"><span class='object_link'><a href="RupatMod.html#%5B%5D-instance_method" title="RupatMod#[] (method)">#[]</a></span>, <span class='object_link'><a href="RupatMod.html#append-instance_method" title="RupatMod#append (method)">#append</a></span>, <span class='object_link'><a href="RupatMod.html#appendMany-instance_method" title="RupatMod#appendMany (method)">#appendMany</a></span>, <span class='object_link'><a href="RupatMod.html#backward-instance_method" title="RupatMod#backward (method)">#backward</a></span>, <span class='object_link'><a href="RupatMod.html#close-instance_method" title="RupatMod#close (method)">#close</a></span>, <span class='object_link'><a href="RupatMod.html#copy-instance_method" title="RupatMod#copy (method)">#copy</a></span>, <span class='object_link'><a href="RupatMod.html#create-instance_method" title="RupatMod#create (method)">#create</a></span>, <span class='object_link'><a href="RupatMod.html#cut-instance_method" title="RupatMod#cut (method)">#cut</a></span>, <span class='object_link'><a href="RupatMod.html#delete-instance_method" title="RupatMod#delete (method)">#delete</a></span>, <span class='object_link'><a href="RupatMod.html#deleteMany-instance_method" title="RupatMod#deleteMany (method)">#deleteMany</a></span>, <span class='object_link'><a href="RupatMod.html#edit-instance_method" title="RupatMod#edit (method)">#edit</a></span>, <span class='object_link'><a href="RupatMod.html#excursion-instance_method" title="RupatMod#excursion (method)">#excursion</a></span>, <span class='object_link'><a href="RupatMod.html#findBackward-instance_method" title="RupatMod#findBackward (method)">#findBackward</a></span>, <span class='object_link'><a href="RupatMod.html#findBackward%3F-instance_method" title="RupatMod#findBackward? (method)">#findBackward?</a></span>, <span class='object_link'><a href="RupatMod.html#findBlock-instance_method" title="RupatMod#findBlock (method)">#findBlock</a></span>, <span class='object_link'><a href="RupatMod.html#findForward-instance_method" title="RupatMod#findForward (method)">#findForward</a></span>, <span class='object_link'><a href="RupatMod.html#findForward%3F-instance_method" title="RupatMod#findForward? (method)">#findForward?</a></span>, <span class='object_link'><a href="RupatMod.html#forward-instance_method" title="RupatMod#forward (method)">#forward</a></span>, <span class='object_link'><a href="RupatMod.html#get-instance_method" title="RupatMod#get (method)">#get</a></span>, <span class='object_link'><a href="RupatMod.html#getMany-instance_method" title="RupatMod#getMany (method)">#getMany</a></span>, <span class='object_link'><a href="RupatMod.html#goto-instance_method" title="RupatMod#goto (method)">#goto</a></span>, <span class='object_link'><a href="RupatMod.html#goto1-instance_method" title="RupatMod#goto1 (method)">#goto1</a></span>, <span class='object_link'><a href="RupatMod.html#gotoEnd-instance_method" title="RupatMod#gotoEnd (method)">#gotoEnd</a></span>, <span class='object_link'><a href="RupatMod.html#gotoFirst-instance_method" title="RupatMod#gotoFirst (method)">#gotoFirst</a></span>, <span class='object_link'><a href="RupatMod.html#gotoForce-instance_method" title="RupatMod#gotoForce (method)">#gotoForce</a></span>, <span class='object_link'><a href="RupatMod.html#gotoLast-instance_method" title="RupatMod#gotoLast (method)">#gotoLast</a></span>, <span class='object_link'><a href="RupatMod.html#insert-instance_method" title="RupatMod#insert (method)">#insert</a></span>, <span class='object_link'><a href="RupatMod.html#insertFile-instance_method" title="RupatMod#insertFile (method)">#insertFile</a></span>, <span class='object_link'><a href="RupatMod.html#insertMany-instance_method" title="RupatMod#insertMany (method)">#insertMany</a></span>, <span class='object_link'><a href="RupatMod.html#last-instance_method" title="RupatMod#last (method)">#last</a></span>, <span class='object_link'><a href="RupatMod.html#length-instance_method" title="RupatMod#length (method)">#length</a></span>, <span class='object_link'><a href="RupatMod.html#line-instance_method" title="RupatMod#line (method)">#line</a></span>, <span class='object_link'><a href="RupatMod.html#line1-instance_method" title="RupatMod#line1 (method)">#line1</a></span>, <span class='object_link'><a href="RupatMod.html#next-instance_method" title="RupatMod#next (method)">#next</a></span>, <span class='object_link'><a href="RupatMod.html#open-instance_method" title="RupatMod#open (method)">#open</a></span>, <span class='object_link'><a href="RupatMod.html#paste-instance_method" title="RupatMod#paste (method)">#paste</a></span>, <span class='object_link'><a href="RupatMod.html#prev-instance_method" title="RupatMod#prev (method)">#prev</a></span>, <span class='object_link'><a href="RupatMod.html#print-instance_method" title="RupatMod#print (method)">#print</a></span>, <span class='object_link'><a href="RupatMod.html#replace-instance_method" title="RupatMod#replace (method)">#replace</a></span>, <span class='object_link'><a href="RupatMod.html#replaceAll-instance_method" title="RupatMod#replaceAll (method)">#replaceAll</a></span>, <span class='object_link'><a href="RupatMod.html#replaceWithin-instance_method" title="RupatMod#replaceWithin (method)">#replaceWithin</a></span>, <span class='object_link'><a href="RupatMod.html#save-instance_method" title="RupatMod#save (method)">#save</a></span>, <span class='object_link'><a href="RupatMod.html#set-instance_method" title="RupatMod#set (method)">#set</a></span>, <span class='object_link'><a href="RupatMod.html#update-instance_method" title="RupatMod#update (method)">#update</a></span>, <span class='object_link'><a href="RupatMod.html#use-instance_method" title="RupatMod#use (method)">#use</a></span></p>
461
+
462
+
463
+ <div id="class_method_details" class="method_details_list">
464
+ <h2>Class Method Details</h2>
465
+
466
+
467
+ <div class="method_details first">
468
+ <h3 class="signature first" id="create-class_method">
469
+
470
+ + (<tt>Object</tt>) <strong>create</strong>(orgFile, newFile)
471
+
472
+
473
+
474
+
475
+
476
+ </h3><div class="docstring">
477
+ <div class="discussion">
478
+
479
+ <p>Create new file based on old file.</p>
480
+
481
+
482
+ </div>
483
+ </div>
484
+ <div class="tags">
485
+ <p class="tag_title">Parameters:</p>
486
+ <ul class="param">
487
+
488
+ <li>
489
+
490
+ <span class='name'>orgFile</span>
491
+
492
+
493
+ <span class='type'>(<tt>String</tt>, <tt>File</tt>)</span>
494
+
495
+
496
+
497
+ &mdash;
498
+ <div class='inline'>
499
+ <p>Source file.</p>
500
+ </div>
501
+
502
+ </li>
503
+
504
+ <li>
505
+
506
+ <span class='name'>newFile</span>
507
+
508
+
509
+ <span class='type'>(<tt>String</tt>)</span>
510
+
511
+
512
+
513
+ &mdash;
514
+ <div class='inline'>
515
+ <p>Destination file.</p>
516
+ </div>
517
+
518
+ </li>
519
+
520
+ </ul>
521
+
522
+
523
+ </div><table class="source_code">
524
+ <tr>
525
+ <td>
526
+ <pre class="lines">
527
+
528
+
529
+ 887
530
+ 888
531
+ 889
532
+ 890
533
+ 891</pre>
534
+ </td>
535
+ <td>
536
+ <pre class="code"><span class="info file"># File 'lib/rupat.rb', line 887</span>
537
+
538
+ <span class='kw'>def</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span> <span class='id identifier rubyid_orgFile'>orgFile</span><span class='comma'>,</span> <span class='id identifier rubyid_newFile'>newFile</span> <span class='rparen'>)</span>
539
+ <span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
540
+ <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span> <span class='id identifier rubyid_orgFile'>orgFile</span><span class='comma'>,</span> <span class='id identifier rubyid_newFile'>newFile</span> <span class='rparen'>)</span>
541
+ <span class='id identifier rubyid_r'>r</span>
542
+ <span class='kw'>end</span></pre>
543
+ </td>
544
+ </tr>
545
+ </table>
546
+ </div>
547
+
548
+ <div class="method_details ">
549
+ <h3 class="signature " id="edit-class_method">
550
+
551
+ + (<tt>Object</tt>) <strong>edit</strong>(file, backup = true)
552
+
553
+
554
+
555
+
556
+
557
+ </h3><div class="docstring">
558
+ <div class="discussion">
559
+
560
+ <p>Edit existing file and by default make backup.</p>
561
+
562
+
563
+ </div>
564
+ </div>
565
+ <div class="tags">
566
+ <p class="tag_title">Parameters:</p>
567
+ <ul class="param">
568
+
569
+ <li>
570
+
571
+ <span class='name'>file</span>
572
+
573
+
574
+ <span class='type'>(<tt>String</tt>, <tt>File</tt>)</span>
575
+
576
+
577
+
578
+ &mdash;
579
+ <div class='inline'>
580
+ <p>Source file.</p>
581
+ </div>
582
+
583
+ </li>
584
+
585
+ <li>
586
+
587
+ <span class='name'>backup</span>
588
+
589
+
590
+ <span class='type'>(<tt>Boolean</tt>)</span>
591
+
592
+
593
+ <em class="default">(defaults to: <tt>true</tt>)</em>
594
+
595
+
596
+ &mdash;
597
+ <div class='inline'>
598
+ <p>Create backup from the source (original) file.</p>
599
+ </div>
600
+
601
+ </li>
602
+
603
+ </ul>
604
+
605
+
606
+ </div><table class="source_code">
607
+ <tr>
608
+ <td>
609
+ <pre class="lines">
610
+
611
+
612
+ 876
613
+ 877
614
+ 878
615
+ 879
616
+ 880</pre>
617
+ </td>
618
+ <td>
619
+ <pre class="code"><span class="info file"># File 'lib/rupat.rb', line 876</span>
620
+
621
+ <span class='kw'>def</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_backup'>backup</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='rparen'>)</span>
622
+ <span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
623
+ <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_backup'>backup</span> <span class='rparen'>)</span>
624
+ <span class='id identifier rubyid_r'>r</span>
625
+ <span class='kw'>end</span></pre>
626
+ </td>
627
+ </tr>
628
+ </table>
629
+ </div>
630
+
631
+ <div class="method_details ">
632
+ <h3 class="signature " id="lines-class_method">
633
+
634
+ + (<tt>Object</tt>) <strong>lines</strong>(lines)
635
+
636
+
637
+
638
+
639
+
640
+ </h3><div class="docstring">
641
+ <div class="discussion">
642
+
643
+ <p>Use set of lines for editing.</p>
644
+
645
+
646
+ </div>
647
+ </div>
648
+ <div class="tags">
649
+ <p class="tag_title">Parameters:</p>
650
+ <ul class="param">
651
+
652
+ <li>
653
+
654
+ <span class='name'>lines</span>
655
+
656
+
657
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
658
+
659
+
660
+
661
+ &mdash;
662
+ <div class='inline'>
663
+ <p>Lines to edit.</p>
664
+ </div>
665
+
666
+ </li>
667
+
668
+ </ul>
669
+
670
+
671
+ </div><table class="source_code">
672
+ <tr>
673
+ <td>
674
+ <pre class="lines">
675
+
676
+
677
+ 897
678
+ 898
679
+ 899
680
+ 900
681
+ 901</pre>
682
+ </td>
683
+ <td>
684
+ <pre class="code"><span class="info file"># File 'lib/rupat.rb', line 897</span>
685
+
686
+ <span class='kw'>def</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_lines'>lines</span><span class='lparen'>(</span> <span class='id identifier rubyid_lines'>lines</span> <span class='rparen'>)</span>
687
+ <span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
688
+ <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span><span class='lparen'>(</span> <span class='id identifier rubyid_lines'>lines</span> <span class='rparen'>)</span>
689
+ <span class='id identifier rubyid_r'>r</span>
690
+ <span class='kw'>end</span></pre>
691
+ </td>
692
+ </tr>
693
+ </table>
694
+ </div>
695
+
696
+ <div class="method_details ">
697
+ <h3 class="signature " id="open-class_method">
698
+
699
+ + (<tt>Object</tt>) <strong>open</strong>(file)
700
+
701
+
702
+
703
+
704
+
705
+ </h3><div class="docstring">
706
+ <div class="discussion">
707
+
708
+ <p>Open existing file for reading.</p>
709
+
710
+
711
+ </div>
712
+ </div>
713
+ <div class="tags">
714
+ <p class="tag_title">Parameters:</p>
715
+ <ul class="param">
716
+
717
+ <li>
718
+
719
+ <span class='name'>file</span>
720
+
721
+
722
+ <span class='type'>(<tt>String</tt>, <tt>File</tt>)</span>
723
+
724
+
725
+
726
+ &mdash;
727
+ <div class='inline'>
728
+ <p>Source file.</p>
729
+ </div>
730
+
731
+ </li>
732
+
733
+ </ul>
734
+
735
+
736
+ </div><table class="source_code">
737
+ <tr>
738
+ <td>
739
+ <pre class="lines">
740
+
741
+
742
+ 856
743
+ 857
744
+ 858
745
+ 859
746
+ 860</pre>
747
+ </td>
748
+ <td>
749
+ <pre class="code"><span class="info file"># File 'lib/rupat.rb', line 856</span>
750
+
751
+ <span class='kw'>def</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span>
752
+ <span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
753
+ <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span>
754
+ <span class='id identifier rubyid_r'>r</span>
755
+ <span class='kw'>end</span></pre>
756
+ </td>
757
+ </tr>
758
+ </table>
759
+ </div>
760
+
761
+ <div class="method_details ">
762
+ <h3 class="signature " id="readonly-class_method">
763
+
764
+ + (<tt>Object</tt>) <strong>readonly</strong>(file)
765
+
766
+
767
+
768
+
769
+
770
+ </h3><div class="docstring">
771
+ <div class="discussion">
772
+
773
+ <p>Open existing file for reading.</p>
774
+
775
+
776
+ </div>
777
+ </div>
778
+ <div class="tags">
779
+ <p class="tag_title">Parameters:</p>
780
+ <ul class="param">
781
+
782
+ <li>
783
+
784
+ <span class='name'>file</span>
785
+
786
+
787
+ <span class='type'>(<tt>String</tt>, <tt>File</tt>)</span>
788
+
789
+
790
+
791
+ &mdash;
792
+ <div class='inline'>
793
+ <p>Source file.</p>
794
+ </div>
795
+
796
+ </li>
797
+
798
+ </ul>
799
+
800
+
801
+ </div><table class="source_code">
802
+ <tr>
803
+ <td>
804
+ <pre class="lines">
805
+
806
+
807
+ 866
808
+ 867
809
+ 868</pre>
810
+ </td>
811
+ <td>
812
+ <pre class="code"><span class="info file"># File 'lib/rupat.rb', line 866</span>
813
+
814
+ <span class='kw'>def</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_readonly'>readonly</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span>
815
+ <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span>
816
+ <span class='kw'>end</span></pre>
817
+ </td>
818
+ </tr>
819
+ </table>
820
+ </div>
821
+
822
+ <div class="method_details ">
823
+ <h3 class="signature " id="update-class_method">
824
+
825
+ + (<tt>Object</tt>) <strong>update</strong>(file)
826
+
827
+
828
+
829
+
830
+
831
+ </h3><div class="docstring">
832
+ <div class="discussion">
833
+
834
+ <p>Edit existing file inplace without backups.</p>
835
+
836
+
837
+ </div>
838
+ </div>
839
+ <div class="tags">
840
+ <p class="tag_title">Parameters:</p>
841
+ <ul class="param">
842
+
843
+ <li>
844
+
845
+ <span class='name'>file</span>
846
+
847
+
848
+ <span class='type'>(<tt>String</tt>, <tt>File</tt>)</span>
849
+
850
+
851
+
852
+ &mdash;
853
+ <div class='inline'>
854
+ <p>Source file.</p>
855
+ </div>
856
+
857
+ </li>
858
+
859
+ </ul>
860
+
861
+
862
+ </div><table class="source_code">
863
+ <tr>
864
+ <td>
865
+ <pre class="lines">
866
+
867
+
868
+ 848
869
+ 849
870
+ 850</pre>
871
+ </td>
872
+ <td>
873
+ <pre class="code"><span class="info file"># File 'lib/rupat.rb', line 848</span>
874
+
875
+ <span class='kw'>def</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span>
876
+ <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='kw'>false</span> <span class='rparen'>)</span>
877
+ <span class='kw'>end</span></pre>
878
+ </td>
879
+ </tr>
880
+ </table>
881
+ </div>
882
+
883
+ <div class="method_details ">
884
+ <h3 class="signature " id="version-class_method">
885
+
886
+ + (<tt>Object</tt>) <strong>version</strong>
887
+
888
+
889
+
890
+
891
+
892
+ </h3><table class="source_code">
893
+ <tr>
894
+ <td>
895
+ <pre class="lines">
896
+
897
+
898
+ 3
899
+ 4
900
+ 5</pre>
901
+ </td>
902
+ <td>
903
+ <pre class="code"><span class="info file"># File 'lib/version.rb', line 3</span>
904
+
905
+ <span class='kw'>def</span> <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
906
+ <span class='const'>Rupat</span><span class='op'>::</span><span class='const'>VERSION</span>
907
+ <span class='kw'>end</span></pre>
908
+ </td>
909
+ </tr>
910
+ </table>
911
+ </div>
912
+
913
+ </div>
914
+
915
+ <div id="instance_method_details" class="method_details_list">
916
+ <h2>Instance Method Details</h2>
917
+
918
+
919
+ <div class="method_details first">
920
+ <h3 class="signature first" id="useAlias-instance_method">
921
+
922
+ - (<tt>Object</tt>) <strong>useAlias</strong>
923
+
924
+
925
+
926
+
927
+
928
+ </h3><div class="docstring">
929
+ <div class="discussion">
930
+
931
+ <p>Use short aliases from <span class='object_link'><a href="RupatAlias.html" title="RupatAlias (module)">RupatAlias</a></span> module.</p>
932
+
933
+
934
+ </div>
935
+ </div>
936
+ <div class="tags">
937
+
938
+
939
+ </div><table class="source_code">
940
+ <tr>
941
+ <td>
942
+ <pre class="lines">
943
+
944
+
945
+ 905
946
+ 906
947
+ 907
948
+ 908</pre>
949
+ </td>
950
+ <td>
951
+ <pre class="code"><span class="info file"># File 'lib/rupat.rb', line 905</span>
952
+
953
+ <span class='kw'>def</span> <span class='id identifier rubyid_useAlias'>useAlias</span>
954
+ <span class='const'>Rupat</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span> <span class='symbol'>:include</span><span class='comma'>,</span> <span class='const'>RupatAlias</span> <span class='rparen'>)</span>
955
+ <span class='kw'>self</span>
956
+ <span class='kw'>end</span></pre>
957
+ </td>
958
+ </tr>
959
+ </table>
960
+ </div>
961
+
962
+ </div>
963
+
964
+ </div>
965
+
966
+ <div id="footer">
967
+ Generated on Mon Apr 20 18:59:15 2015 by
968
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
969
+ 0.8.7.6 (ruby-2.1.2).
970
+ </div>
971
+
972
+ </body>
973
+ </html>