como 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 6abe56829893db16ba0a4e8edc68ac151d0581df
4
+ data.tar.gz: 5f77bff2462357c36f9f4e50c19b595164469c76
5
+ SHA512:
6
+ metadata.gz: 7dbe4187f2d360b07e4be7efbddf97acc88b8f0899f7852224e2e2e567e196afb6df74609ae228b6e561090241b08b5c3a135440f4c139488648a37135e02101
7
+ data.tar.gz: 44ac5dbe7ccfff7270ee98eef31774f03eeb7b5b4acd917f84df65fe48eb6b82acd3b64c8ed892d1acf0dd473d0c68ff1be1ec418d5876bf30da80ed3f360606
data/CHANGELOG.rdoc CHANGED
@@ -1,5 +1,12 @@
1
1
  = Version history
2
2
 
3
+ [0.1.4] Documentation improvements (links to methods).
4
+ Fix to Opt#apply return value when type is :switch.
5
+ Opt#fatal added for user error reporting towards command line user.
6
+ Non-existing options for option with multiple values defaults
7
+ to an empty array.
8
+ Possibility to separate option definition and execution.
9
+
3
10
  [0.1.3] Customization through COMO env variable and hooks.
4
11
  Version information returned programmatically with Como.version.
5
12
  "command" is aliased to "subcmd" to enable highlighting of the
@@ -193,7 +193,7 @@
193
193
 
194
194
 
195
195
  <span class="summary_desc"><div class='inline'>
196
- <p>A new instance of ArgsParseState.</p>
196
+ <p>Create parse state.</p>
197
197
  </div></span>
198
198
 
199
199
  </li>
@@ -409,7 +409,7 @@
409
409
  </h3><div class="docstring">
410
410
  <div class="discussion">
411
411
 
412
- <p>A new instance of ArgsParseState</p>
412
+ <p>Create parse state.</p>
413
413
 
414
414
 
415
415
  </div>
@@ -443,13 +443,13 @@
443
443
  <pre class="lines">
444
444
 
445
445
 
446
- 1897
447
- 1898
448
- 1899
449
- 1900</pre>
446
+ 2004
447
+ 2005
448
+ 2006
449
+ 2007</pre>
450
450
  </td>
451
451
  <td>
452
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1897</span>
452
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2004</span>
453
453
 
454
454
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_list'>list</span> <span class='rparen'>)</span>
455
455
  <span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span> <span class='id identifier rubyid_list'>list</span> <span class='rparen'>)</span>
@@ -506,12 +506,12 @@
506
506
  <pre class="lines">
507
507
 
508
508
 
509
- 1933
510
- 1934
511
- 1935</pre>
509
+ 2040
510
+ 2041
511
+ 2042</pre>
512
512
  </td>
513
513
  <td>
514
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1933</span>
514
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2040</span>
515
515
 
516
516
  <span class='kw'>def</span> <span class='id identifier rubyid_done?'>done?</span>
517
517
  <span class='ivar'>@idx</span> <span class='op'>&gt;=</span> <span class='ivar'>@list</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
@@ -547,12 +547,12 @@
547
547
  <pre class="lines">
548
548
 
549
549
 
550
- 1918
551
- 1919
552
- 1920</pre>
550
+ 2025
551
+ 2026
552
+ 2027</pre>
553
553
  </td>
554
554
  <td>
555
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1918</span>
555
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2025</span>
556
556
 
557
557
  <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span> <span class='id identifier rubyid_idx'>idx</span> <span class='op'>=</span> <span class='ivar'>@idx</span> <span class='rparen'>)</span>
558
558
  <span class='ivar'>@args</span><span class='lbracket'>[</span> <span class='id identifier rubyid_idx'>idx</span> <span class='rbracket'>]</span>
@@ -588,12 +588,12 @@
588
588
  <pre class="lines">
589
589
 
590
590
 
591
- 1939
592
- 1940
593
- 1941</pre>
591
+ 2046
592
+ 2047
593
+ 2048</pre>
594
594
  </td>
595
595
  <td>
596
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1939</span>
596
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2046</span>
597
597
 
598
598
  <span class='kw'>def</span> <span class='id identifier rubyid_isOpt'>isOpt</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span> <span class='rparen'>)</span>
599
599
  <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>-</span><span class='tstring_end'>&quot;</span></span>
@@ -629,12 +629,12 @@
629
629
  <pre class="lines">
630
630
 
631
631
 
632
- 1944
633
- 1945
634
- 1946</pre>
632
+ 2051
633
+ 2052
634
+ 2053</pre>
635
635
  </td>
636
636
  <td>
637
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1944</span>
637
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2051</span>
638
638
 
639
639
  <span class='kw'>def</span> <span class='id identifier rubyid_isOptTerm'>isOptTerm</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span> <span class='rparen'>)</span>
640
640
  <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--</span><span class='tstring_end'>&quot;</span></span>
@@ -670,12 +670,12 @@
670
670
  <pre class="lines">
671
671
 
672
672
 
673
- 1923
674
- 1924
675
- 1925</pre>
673
+ 2030
674
+ 2031
675
+ 2032</pre>
676
676
  </td>
677
677
  <td>
678
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1923</span>
678
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2030</span>
679
679
 
680
680
  <span class='kw'>def</span> <span class='id identifier rubyid_last'>last</span><span class='lparen'>(</span> <span class='id identifier rubyid_idx'>idx</span> <span class='op'>=</span> <span class='ivar'>@idx</span> <span class='rparen'>)</span>
681
681
  <span class='id identifier rubyid_idx'>idx</span> <span class='op'>==</span> <span class='lparen'>(</span> <span class='ivar'>@args</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span><span class='op'>-</span><span class='int'>1</span> <span class='rparen'>)</span>
@@ -711,12 +711,12 @@
711
711
  <pre class="lines">
712
712
 
713
713
 
714
- 1908
715
- 1909
716
- 1910</pre>
714
+ 2015
715
+ 2016
716
+ 2017</pre>
717
717
  </td>
718
718
  <td>
719
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1908</span>
719
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2015</span>
720
720
 
721
721
  <span class='kw'>def</span> <span class='kw'>next</span>
722
722
  <span class='ivar'>@idx</span> <span class='op'>+=</span> <span class='int'>1</span>
@@ -752,12 +752,12 @@
752
752
  <pre class="lines">
753
753
 
754
754
 
755
- 1913
756
- 1914
757
- 1915</pre>
755
+ 2020
756
+ 2021
757
+ 2022</pre>
758
758
  </td>
759
759
  <td>
760
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1913</span>
760
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2020</span>
761
761
 
762
762
  <span class='kw'>def</span> <span class='id identifier rubyid_prev'>prev</span>
763
763
  <span class='ivar'>@idx</span> <span class='op'>-=</span> <span class='int'>1</span>
@@ -793,12 +793,12 @@
793
793
  <pre class="lines">
794
794
 
795
795
 
796
- 1928
797
- 1929
798
- 1930</pre>
796
+ 2035
797
+ 2036
798
+ 2037</pre>
799
799
  </td>
800
800
  <td>
801
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1928</span>
801
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2035</span>
802
802
 
803
803
  <span class='kw'>def</span> <span class='id identifier rubyid_rest'>rest</span><span class='lparen'>(</span> <span class='id identifier rubyid_idx'>idx</span> <span class='op'>=</span> <span class='ivar'>@idx</span> <span class='rparen'>)</span>
804
804
  <span class='ivar'>@args</span><span class='lbracket'>[</span> <span class='id identifier rubyid_idx'>idx</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span> <span class='rbracket'>]</span>
@@ -834,12 +834,12 @@
834
834
  <pre class="lines">
835
835
 
836
836
 
837
- 1903
838
- 1904
839
- 1905</pre>
837
+ 2010
838
+ 2011
839
+ 2012</pre>
840
840
  </td>
841
841
  <td>
842
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1903</span>
842
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2010</span>
843
843
 
844
844
  <span class='kw'>def</span> <span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span> <span class='id identifier rubyid_list'>list</span> <span class='rparen'>)</span>
845
845
  <span class='ivar'>@args</span> <span class='op'>=</span> <span class='id identifier rubyid_list'>list</span>
@@ -875,16 +875,16 @@
875
875
  <pre class="lines">
876
876
 
877
877
 
878
- 1949
879
- 1950
880
- 1951
881
- 1952
882
- 1953
883
- 1954
884
- 1955</pre>
878
+ 2056
879
+ 2057
880
+ 2058
881
+ 2059
882
+ 2060
883
+ 2061
884
+ 2062</pre>
885
885
  </td>
886
886
  <td>
887
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 1949</span>
887
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 2056</span>
888
888
 
889
889
  <span class='kw'>def</span> <span class='id identifier rubyid_toValue'>toValue</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_get'>get</span> <span class='rparen'>)</span>
890
890
  <span class='kw'>if</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>0</span><span class='op'>..</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\</span><span class='tstring_end'>&quot;</span></span>
@@ -903,7 +903,7 @@
903
903
  </div>
904
904
 
905
905
  <div id="footer">
906
- Generated on Wed Jul 9 14:02:43 2014 by
906
+ Generated on Sat Nov 22 10:05:16 2014 by
907
907
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
908
908
  0.8.6.1 (ruby-1.9.3).
909
909
  </div>
@@ -94,9 +94,7 @@
94
94
 
95
95
 
96
96
  <dt class="r2 last">Defined in:</dt>
97
- <dd class="r2 last">lib/como.rb<span class="defines">,<br />
98
- lib/version.rb</span>
99
- </dd>
97
+ <dd class="r2 last">lib/como.rb</dd>
100
98
 
101
99
  </dl>
102
100
  <div class="clear"></div>
@@ -121,11 +119,6 @@
121
119
 
122
120
  <dl class="constants">
123
121
 
124
- <dt id="VERSION-constant" class="">VERSION =
125
-
126
- </dt>
127
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.3</span><span class='tstring_end'>&quot;</span></span></pre></dd>
128
-
129
122
  <dt id="io-classvariable" class="">@@io =
130
123
  <div class="docstring">
131
124
  <div class="discussion">
@@ -202,7 +195,7 @@
202
195
  <li class="public ">
203
196
  <span class="summary_signature">
204
197
 
205
- <a href="#runHook-class_method" title="runHook (class method)">+ (Object) <strong>runHook</strong>(name, args) </a>
198
+ <a href="#runHook-class_method" title="runHook (class method)">+ (Object) <strong>runHook</strong>(name, args) { ... }</a>
206
199
 
207
200
 
208
201
 
@@ -216,7 +209,9 @@
216
209
 
217
210
 
218
211
 
219
- <span class="summary_desc"><div class='inline'></div></span>
212
+ <span class="summary_desc"><div class='inline'>
213
+ <p>Run hook.</p>
214
+ </div></span>
220
215
 
221
216
  </li>
222
217
 
@@ -224,7 +219,7 @@
224
219
  <li class="public ">
225
220
  <span class="summary_signature">
226
221
 
227
- <a href="#setHook-class_method" title="setHook (class method)">+ (Object) <strong>setHook</strong>(name, &amp;code) </a>
222
+ <a href="#setHook-class_method" title="setHook (class method)">+ (Object) <strong>setHook</strong>(name) { ... }</a>
228
223
 
229
224
 
230
225
 
@@ -238,7 +233,9 @@
238
233
 
239
234
 
240
235
 
241
- <span class="summary_desc"><div class='inline'></div></span>
236
+ <span class="summary_desc"><div class='inline'>
237
+ <p>Set hook content.</p>
238
+ </div></span>
242
239
 
243
240
  </li>
244
241
 
@@ -302,12 +299,12 @@
302
299
  <pre class="lines">
303
300
 
304
301
 
305
- 480
306
- 481
307
- 482</pre>
302
+ 490
303
+ 491
304
+ 492</pre>
308
305
  </td>
309
306
  <td>
310
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 480</span>
307
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 490</span>
311
308
 
312
309
  <span class='kw'>def</span> <span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_getIo'>getIo</span>
313
310
  <span class='cvar'>@@io</span>
@@ -320,24 +317,73 @@
320
317
  <div class="method_details ">
321
318
  <h3 class="signature " id="runHook-class_method">
322
319
 
323
- + (<tt>Object</tt>) <strong>runHook</strong>(name, args)
320
+ + (<tt>Object</tt>) <strong>runHook</strong>(name, args) { ... }
321
+
322
+
324
323
 
325
324
 
326
325
 
326
+ </h3><div class="docstring">
327
+ <div class="discussion">
328
+
329
+ <p>Run hook.</p>
327
330
 
331
+
332
+ </div>
333
+ </div>
334
+ <div class="tags">
335
+ <p class="tag_title">Parameters:</p>
336
+ <ul class="param">
337
+
338
+ <li>
339
+
340
+ <span class='name'>name</span>
341
+
342
+
343
+ <span class='type'>(<tt>String</tt>)</span>
344
+
345
+
346
+
347
+ &mdash;
348
+ <div class='inline'>
349
+ <p>Hook name.</p>
350
+ </div>
351
+
352
+ </li>
353
+
354
+ </ul>
355
+
356
+ <p class="tag_title">Yields:</p>
357
+ <ul class="yield">
358
+
359
+ <li>
360
+
361
+
362
+ <span class='type'></span>
363
+
364
+
365
+
366
+
367
+ <div class='inline'>
368
+ <p>code Hook arguments.</p>
369
+ </div>
370
+
371
+ </li>
328
372
 
329
- </h3><table class="source_code">
373
+ </ul>
374
+
375
+ </div><table class="source_code">
330
376
  <tr>
331
377
  <td>
332
378
  <pre class="lines">
333
379
 
334
380
 
335
- 488
336
- 489
337
- 490</pre>
381
+ 506
382
+ 507
383
+ 508</pre>
338
384
  </td>
339
385
  <td>
340
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 488</span>
386
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 506</span>
341
387
 
342
388
  <span class='kw'>def</span> <span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_runHook'>runHook</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
343
389
  <span class='cvar'>@@hook</span><span class='lbracket'>[</span> <span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_yield'>yield</span><span class='lparen'>(</span> <span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span> <span class='kw'>if</span> <span class='cvar'>@@hook</span><span class='lbracket'>[</span> <span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span>
@@ -350,24 +396,73 @@
350
396
  <div class="method_details ">
351
397
  <h3 class="signature " id="setHook-class_method">
352
398
 
353
- + (<tt>Object</tt>) <strong>setHook</strong>(name, &amp;code)
399
+ + (<tt>Object</tt>) <strong>setHook</strong>(name) { ... }
354
400
 
355
401
 
356
402
 
357
403
 
358
404
 
359
- </h3><table class="source_code">
405
+ </h3><div class="docstring">
406
+ <div class="discussion">
407
+
408
+ <p>Set hook content.</p>
409
+
410
+
411
+ </div>
412
+ </div>
413
+ <div class="tags">
414
+ <p class="tag_title">Parameters:</p>
415
+ <ul class="param">
416
+
417
+ <li>
418
+
419
+ <span class='name'>name</span>
420
+
421
+
422
+ <span class='type'>(<tt>String</tt>)</span>
423
+
424
+
425
+
426
+ &mdash;
427
+ <div class='inline'>
428
+ <p>Hook name.</p>
429
+ </div>
430
+
431
+ </li>
432
+
433
+ </ul>
434
+
435
+ <p class="tag_title">Yields:</p>
436
+ <ul class="yield">
437
+
438
+ <li>
439
+
440
+
441
+ <span class='type'></span>
442
+
443
+
444
+
445
+
446
+ <div class='inline'>
447
+ <p>code Hook code.</p>
448
+ </div>
449
+
450
+ </li>
451
+
452
+ </ul>
453
+
454
+ </div><table class="source_code">
360
455
  <tr>
361
456
  <td>
362
457
  <pre class="lines">
363
458
 
364
459
 
365
- 484
366
- 485
367
- 486</pre>
460
+ 498
461
+ 499
462
+ 500</pre>
368
463
  </td>
369
464
  <td>
370
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 484</span>
465
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 498</span>
371
466
 
372
467
  <span class='kw'>def</span> <span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_setHook'>setHook</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
373
468
  <span class='cvar'>@@hook</span><span class='lbracket'>[</span> <span class='id identifier rubyid_name'>name</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span>
@@ -403,12 +498,12 @@
403
498
  <pre class="lines">
404
499
 
405
500
 
406
- 475
407
- 476
408
- 477</pre>
501
+ 485
502
+ 486
503
+ 487</pre>
409
504
  </td>
410
505
  <td>
411
- <pre class="code"><span class="info file"># File 'lib/como.rb', line 475</span>
506
+ <pre class="code"><span class="info file"># File 'lib/como.rb', line 485</span>
412
507
 
413
508
  <span class='kw'>def</span> <span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_setIo'>setIo</span><span class='lparen'>(</span> <span class='id identifier rubyid_io'>io</span> <span class='rparen'>)</span>
414
509
  <span class='cvar'>@@io</span> <span class='op'>=</span> <span class='id identifier rubyid_io'>io</span>
@@ -423,7 +518,7 @@
423
518
  </div>
424
519
 
425
520
  <div id="footer">
426
- Generated on Wed Jul 9 14:02:42 2014 by
521
+ Generated on Sat Nov 22 10:05:15 2014 by
427
522
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
428
523
  0.8.6.1 (ruby-1.9.3).
429
524
  </div>