como 0.1.5 → 0.1.6
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.rdoc +2 -1
- data/doc/Como/ArgsParseState.html +51 -51
- data/doc/Como/ComoCommon.html +2 -2
- data/doc/Como/MainOpt.html +47 -47
- data/doc/Como/Opt/ErrorWithData.html +2 -2
- data/doc/Como/Opt/InvalidOption.html +2 -2
- data/doc/Como/Opt/MissingArgument.html +2 -2
- data/doc/Como/Opt.html +108 -26
- data/doc/Como/RuleCheck.html +76 -75
- data/doc/Como/RuleDisplay.html +80 -80
- data/doc/Como/Spec.html +2 -2
- data/doc/Como.html +39 -21
- data/doc/_index.html +2 -2
- data/doc/file.CHANGELOG.html +6 -3
- data/doc/file.README.html +2 -2
- data/doc/index.html +2 -2
- data/doc/method_list.html +78 -72
- data/doc/top-level-namespace.html +2 -2
- data/examples/como_subcmd +1 -1
- data/lib/como.rb +15 -0
- data/lib/version.rb +1 -1
- metadata +65 -62
- checksums.yaml +0 -7
- data/doc/Como/MasterOpt.html +0 -636
- data/doc/file.como.html +0 -1962
data/doc/Como/RuleDisplay.html
CHANGED
@@ -554,13 +554,13 @@ Example expansion of options:
|
|
554
554
|
<pre class="lines">
|
555
555
|
|
556
556
|
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
557
|
+
2258
|
558
|
+
2259
|
559
|
+
2260
|
560
|
+
2261</pre>
|
561
561
|
</td>
|
562
562
|
<td>
|
563
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
563
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2258</span>
|
564
564
|
|
565
565
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_prefixStr'>prefixStr</span> <span class='rparen'>)</span>
|
566
566
|
<span class='comment'># Prefix string for lines. Rules add/rm from it.
|
@@ -604,13 +604,13 @@ Example expansion of options:
|
|
604
604
|
<pre class="lines">
|
605
605
|
|
606
606
|
|
607
|
-
|
608
|
-
|
609
|
-
|
610
|
-
|
607
|
+
2252
|
608
|
+
2253
|
609
|
+
2254
|
610
|
+
2255</pre>
|
611
611
|
</td>
|
612
612
|
<td>
|
613
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
613
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2252</span>
|
614
614
|
|
615
615
|
<span class='kw'>def</span> <span class='const'>RuleDisplay</span><span class='period'>.</span><span class='id identifier rubyid_print'>print</span><span class='lparen'>(</span> <span class='id identifier rubyid_prefixStr'>prefixStr</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='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_rule'>rule</span> <span class='rparen'>)</span>
|
616
616
|
<span class='id identifier rubyid_rd'>rd</span> <span class='op'>=</span> <span class='const'>RuleDisplay</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_prefixStr'>prefixStr</span> <span class='rparen'>)</span>
|
@@ -653,12 +653,12 @@ Example expansion of options:
|
|
653
653
|
<pre class="lines">
|
654
654
|
|
655
655
|
|
656
|
-
|
657
|
-
|
658
|
-
|
656
|
+
2269
|
657
|
+
2270
|
658
|
+
2271</pre>
|
659
659
|
</td>
|
660
660
|
<td>
|
661
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
661
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2269</span>
|
662
662
|
|
663
663
|
<span class='kw'>def</span> <span class='id identifier rubyid_addPrefix'>addPrefix</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
|
664
664
|
<span class='ivar'>@prefixStr</span> <span class='op'>+=</span> <span class='id identifier rubyid_str'>str</span>
|
@@ -694,12 +694,12 @@ Example expansion of options:
|
|
694
694
|
<pre class="lines">
|
695
695
|
|
696
696
|
|
697
|
-
|
698
|
-
|
699
|
-
|
697
|
+
2333
|
698
|
+
2334
|
699
|
+
2335</pre>
|
700
700
|
</td>
|
701
701
|
<td>
|
702
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
702
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2333</span>
|
703
703
|
|
704
704
|
<span class='kw'>def</span> <span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
|
705
705
|
<span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>All of</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rbracket'>]</span>
|
@@ -735,12 +735,12 @@ Example expansion of options:
|
|
735
735
|
<pre class="lines">
|
736
736
|
|
737
737
|
|
738
|
-
|
739
|
-
|
740
|
-
|
738
|
+
2328
|
739
|
+
2329
|
740
|
+
2330</pre>
|
741
741
|
</td>
|
742
742
|
<td>
|
743
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
743
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2328</span>
|
744
744
|
|
745
745
|
<span class='kw'>def</span> <span class='id identifier rubyid_any'>any</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
|
746
746
|
<span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>One or more of</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rbracket'>]</span>
|
@@ -776,12 +776,12 @@ Example expansion of options:
|
|
776
776
|
<pre class="lines">
|
777
777
|
|
778
778
|
|
779
|
-
|
780
|
-
|
781
|
-
|
779
|
+
2264
|
780
|
+
2265
|
781
|
+
2266</pre>
|
782
782
|
</td>
|
783
783
|
<td>
|
784
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
784
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2264</span>
|
785
785
|
|
786
786
|
<span class='kw'>def</span> <span class='id identifier rubyid_evalAndDisplay'>evalAndDisplay</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_rule'>rule</span> <span class='rparen'>)</span>
|
787
787
|
<span class='id identifier rubyid_printRule'>printRule</span><span class='lparen'>(</span> <span class='id identifier rubyid_instance_eval'>instance_eval</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_rule'>rule</span> <span class='rparen'>)</span> <span class='rparen'>)</span>
|
@@ -817,12 +817,12 @@ Example expansion of options:
|
|
817
817
|
<pre class="lines">
|
818
818
|
|
819
819
|
|
820
|
-
|
821
|
-
|
822
|
-
|
820
|
+
2318
|
821
|
+
2319
|
822
|
+
2320</pre>
|
823
823
|
</td>
|
824
824
|
<td>
|
825
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
825
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2318</span>
|
826
826
|
|
827
827
|
<span class='kw'>def</span> <span class='id identifier rubyid_follow'>follow</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
|
828
828
|
<span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>If first then rest</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rbracket'>]</span>
|
@@ -858,12 +858,12 @@ Example expansion of options:
|
|
858
858
|
<pre class="lines">
|
859
859
|
|
860
860
|
|
861
|
-
|
862
|
-
|
863
|
-
|
861
|
+
2312
|
862
|
+
2313
|
863
|
+
2314</pre>
|
864
864
|
</td>
|
865
865
|
<td>
|
866
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
866
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2312</span>
|
867
867
|
|
868
868
|
<span class='kw'>def</span> <span class='id identifier rubyid_incr'>incr</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
|
869
869
|
<span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Adding in order</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rbracket'>]</span>
|
@@ -899,12 +899,12 @@ Example expansion of options:
|
|
899
899
|
<pre class="lines">
|
900
900
|
|
901
901
|
|
902
|
-
|
903
|
-
|
904
|
-
|
902
|
+
2338
|
903
|
+
2339
|
904
|
+
2340</pre>
|
905
905
|
</td>
|
906
906
|
<td>
|
907
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
907
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2338</span>
|
908
908
|
|
909
909
|
<span class='kw'>def</span> <span class='id identifier rubyid_inv'>inv</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
|
910
910
|
<span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Not</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rbracket'>]</span>
|
@@ -940,12 +940,12 @@ Example expansion of options:
|
|
940
940
|
<pre class="lines">
|
941
941
|
|
942
942
|
|
943
|
-
|
944
|
-
|
945
|
-
|
943
|
+
2343
|
944
|
+
2344
|
945
|
+
2345</pre>
|
946
946
|
</td>
|
947
947
|
<td>
|
948
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
948
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2343</span>
|
949
949
|
|
950
950
|
<span class='kw'>def</span> <span class='id identifier rubyid_meh'>meh</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
|
951
951
|
<span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Ignoring</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rbracket'>]</span>
|
@@ -981,12 +981,12 @@ Example expansion of options:
|
|
981
981
|
<pre class="lines">
|
982
982
|
|
983
983
|
|
984
|
-
|
985
|
-
|
986
|
-
|
984
|
+
2306
|
985
|
+
2307
|
986
|
+
2308</pre>
|
987
987
|
</td>
|
988
988
|
<td>
|
989
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
989
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2306</span>
|
990
990
|
|
991
991
|
<span class='kw'>def</span> <span class='id identifier rubyid_none'>none</span>
|
992
992
|
<span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>NONE</span><span class='tstring_end'>"</span></span> <span class='rbracket'>]</span>
|
@@ -1022,12 +1022,12 @@ Example expansion of options:
|
|
1022
1022
|
<pre class="lines">
|
1023
1023
|
|
1024
1024
|
|
1025
|
-
|
1026
|
-
|
1027
|
-
|
1025
|
+
2323
|
1026
|
+
2324
|
1027
|
+
2325</pre>
|
1028
1028
|
</td>
|
1029
1029
|
<td>
|
1030
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
1030
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2323</span>
|
1031
1031
|
|
1032
1032
|
<span class='kw'>def</span> <span class='id identifier rubyid_one'>one</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
|
1033
1033
|
<span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>One of</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rbracket'>]</span>
|
@@ -1063,12 +1063,12 @@ Example expansion of options:
|
|
1063
1063
|
<pre class="lines">
|
1064
1064
|
|
1065
1065
|
|
1066
|
-
|
1067
|
-
|
1068
|
-
|
1066
|
+
2284
|
1067
|
+
2285
|
1068
|
+
2286</pre>
|
1069
1069
|
</td>
|
1070
1070
|
<td>
|
1071
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
1071
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2284</span>
|
1072
1072
|
|
1073
1073
|
<span class='kw'>def</span> <span class='id identifier rubyid_p'>p</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
|
1074
1074
|
<span class='cvar'>@@io</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span> <span class='ivar'>@prefixStr</span> <span class='op'>+</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
|
@@ -1104,23 +1104,23 @@ Example expansion of options:
|
|
1104
1104
|
<pre class="lines">
|
1105
1105
|
|
1106
1106
|
|
1107
|
-
|
1108
|
-
|
1109
|
-
|
1110
|
-
|
1111
|
-
|
1112
|
-
|
1113
|
-
|
1114
|
-
|
1115
|
-
|
1116
|
-
|
1117
|
-
|
1118
|
-
|
1119
|
-
|
1120
|
-
|
1107
|
+
2290
|
1108
|
+
2291
|
1109
|
+
2292
|
1110
|
+
2293
|
1111
|
+
2294
|
1112
|
+
2295
|
1113
|
+
2296
|
1114
|
+
2297
|
1115
|
+
2298
|
1116
|
+
2299
|
1117
|
+
2300
|
1118
|
+
2301
|
1119
|
+
2302
|
1120
|
+
2303</pre>
|
1121
1121
|
</td>
|
1122
1122
|
<td>
|
1123
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
1123
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2290</span>
|
1124
1124
|
|
1125
1125
|
<span class='kw'>def</span> <span class='id identifier rubyid_printRule'>printRule</span><span class='lparen'>(</span> <span class='id identifier rubyid_arr'>arr</span> <span class='rparen'>)</span>
|
1126
1126
|
<span class='id identifier rubyid_p'>p</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>|--# </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_arr'>arr</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
|
@@ -1167,17 +1167,17 @@ Example expansion of options:
|
|
1167
1167
|
<pre class="lines">
|
1168
1168
|
|
1169
1169
|
|
1170
|
-
|
1171
|
-
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1170
|
+
2274
|
1171
|
+
2275
|
1172
|
+
2276
|
1173
|
+
2277
|
1174
|
+
2278
|
1175
|
+
2279
|
1176
|
+
2280
|
1177
|
+
2281</pre>
|
1178
1178
|
</td>
|
1179
1179
|
<td>
|
1180
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
1180
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 2274</span>
|
1181
1181
|
|
1182
1182
|
<span class='kw'>def</span> <span class='id identifier rubyid_rmPrefix'>rmPrefix</span><span class='lparen'>(</span> <span class='id identifier rubyid_item'>item</span> <span class='rparen'>)</span>
|
1183
1183
|
<span class='kw'>if</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='const'>String</span>
|
@@ -1197,9 +1197,9 @@ Example expansion of options:
|
|
1197
1197
|
</div>
|
1198
1198
|
|
1199
1199
|
<div id="footer">
|
1200
|
-
Generated on
|
1200
|
+
Generated on Tue Jun 21 10:45:06 2016 by
|
1201
1201
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1202
|
-
0.8.7.6 (ruby-2.1
|
1202
|
+
0.8.7.6 (ruby-2.3.1).
|
1203
1203
|
</div>
|
1204
1204
|
|
1205
1205
|
</body>
|
data/doc/Como/Spec.html
CHANGED
@@ -2217,9 +2217,9 @@ the command line. Performs “usage” display if “help” was selected.</p>
|
|
2217
2217
|
</div>
|
2218
2218
|
|
2219
2219
|
<div id="footer">
|
2220
|
-
Generated on
|
2220
|
+
Generated on Tue Jun 21 10:45:06 2016 by
|
2221
2221
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2222
|
-
0.8.7.6 (ruby-2.1
|
2222
|
+
0.8.7.6 (ruby-2.3.1).
|
2223
2223
|
</div>
|
2224
2224
|
|
2225
2225
|
</body>
|
data/doc/Como.html
CHANGED
@@ -147,7 +147,8 @@ usage.</p>
|
|
147
147
|
<p>Each option table entry (row/sub-array) includes 4 fields and specifies one
|
148
148
|
option:</p>
|
149
149
|
|
150
|
-
<pre class="code ruby"><code class="ruby"><span class='lbracket'>[</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_mnemonic'>mnemonic</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span> <span class='rbracket'>]</span
|
150
|
+
<pre class="code ruby"><code class="ruby"><span class='lbracket'>[</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_mnemonic'>mnemonic</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span> <span class='rbracket'>]</span>
|
151
|
+
</code></pre>
|
151
152
|
|
152
153
|
<p>Two different types are present in the example:</p>
|
153
154
|
<dl class="rdoc-list label-list"><dt>:single
|
@@ -162,7 +163,8 @@ option:</p>
|
|
162
163
|
command line option values are stored automatically. For example the file
|
163
164
|
option value is returned by:</p>
|
164
165
|
|
165
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>file</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span
|
166
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>file</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
|
167
|
+
</code></pre>
|
166
168
|
|
167
169
|
<p>The option name also doubles as long option format, i.e. one could use
|
168
170
|
“–file <filename>” on the command line.</p>
|
@@ -170,7 +172,8 @@ option value is returned by:</p>
|
|
170
172
|
<p>Existence of optional options can be tested using the <span class='object_link'><a href="Como/Opt.html#given-instance_method" title="Como::Opt#given (method)">Opt#given</a></span> method.
|
171
173
|
For example</p>
|
172
174
|
|
173
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>debug</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span
|
175
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>debug</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
|
176
|
+
</code></pre>
|
174
177
|
|
175
178
|
<p>would return “true” if “-d” was given on the command line.</p>
|
176
179
|
|
@@ -190,7 +193,8 @@ as default behavior.</p>
|
|
190
193
|
<p>The program would execute with the following output:</p>
|
191
194
|
|
192
195
|
<pre class="code ruby"><code class="ruby"><span class='const'>File</span> <span class='label'>option:</span> <span class='id identifier rubyid_example'>example</span>
|
193
|
-
<span class='const'>Debugging</span> <span class='id identifier rubyid_selected!'>selected!</span
|
196
|
+
<span class='const'>Debugging</span> <span class='id identifier rubyid_selected!'>selected!</span>
|
197
|
+
</code></pre>
|
194
198
|
|
195
199
|
<p>Same output would be achieved with:</p>
|
196
200
|
|
@@ -203,7 +207,8 @@ checked for existence and error is displayed if arguments are not given.</p>
|
|
203
207
|
|
204
208
|
<p>For example given the command:</p>
|
205
209
|
|
206
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_shell'>shell</span><span class='op'>></span> <span class='id identifier rubyid_como_simple'>como_simple</span
|
210
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_shell'>shell</span><span class='op'>></span> <span class='id identifier rubyid_como_simple'>como_simple</span>
|
211
|
+
</code></pre>
|
207
212
|
|
208
213
|
<p>The following is displayed on the screen:</p>
|
209
214
|
|
@@ -290,20 +295,24 @@ definition allows “add” to have either the “-fo” option defined or
|
|
290
295
|
|
291
296
|
<p>Main (root) commands can be referenced through</p>
|
292
297
|
|
293
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span
|
298
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span>
|
299
|
+
</code></pre>
|
294
300
|
|
295
301
|
<p>or alternatively</p>
|
296
302
|
|
297
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>como_subcmd</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span
|
303
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>como_subcmd</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
304
|
+
</code></pre>
|
298
305
|
|
299
306
|
<p>The subcommands can be referenced through <span class='object_link'><a href="Como/Opt.html#main-class_method" title="Como::Opt.main (method)">Opt.main</a></span> (etc.)</p>
|
300
307
|
|
301
308
|
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>add</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
302
|
-
<span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>como_subcmd</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>add</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span
|
309
|
+
<span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>como_subcmd</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>add</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
310
|
+
</code></pre>
|
303
311
|
|
304
312
|
<p>or directly from <span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span> if subcommand names do not collide:</p>
|
305
313
|
|
306
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>add</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span
|
314
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>add</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
315
|
+
</code></pre>
|
307
316
|
|
308
317
|
<p>The given subcommand can be accessed with <span class='object_link'><a href="Como/Opt.html#givenSubcmd-instance_method" title="Como::Opt#givenSubcmd (method)">Opt#givenSubcmd</a></span> method from
|
309
318
|
each parent command.</p>
|
@@ -416,7 +425,8 @@ option in Usage Help display. In effect a sub-option of :exclusive.</p>
|
|
416
425
|
|
417
426
|
<p>Options use typically all the 4 option fields:</p>
|
418
427
|
|
419
|
-
<pre class="code ruby"><code class="ruby"><span class='lbracket'>[</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_mnemonic'>mnemonic</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span> <span class='rbracket'>]</span
|
428
|
+
<pre class="code ruby"><code class="ruby"><span class='lbracket'>[</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_mnemonic'>mnemonic</span><span class='comma'>,</span> <span class='id identifier rubyid_doc'>doc</span> <span class='rbracket'>]</span>
|
429
|
+
</code></pre>
|
420
430
|
|
421
431
|
<p>“type” field is mandatory for all options.</p>
|
422
432
|
|
@@ -485,7 +495,8 @@ provided and it can be made also visible to user.</p>
|
|
485
495
|
<p>Opt class includes the parsed option values. All options can be tested
|
486
496
|
whether they are specified on the command line using:</p>
|
487
497
|
|
488
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span
|
498
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
|
499
|
+
</code></pre>
|
489
500
|
|
490
501
|
<p>The <span class='object_link'><a href="Como/Opt.html#given-instance_method" title="Como::Opt#given (method)">Opt#given</a></span> method takes optionally a block argument. When block
|
491
502
|
argument is used, the block is supplied with option value and the block is
|
@@ -493,7 +504,8 @@ executed if the option has been set (See: <span class='object_link'><a href="Com
|
|
493
504
|
|
494
505
|
<p>Provided value is returned by:</p>
|
495
506
|
|
496
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span
|
507
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
|
508
|
+
</code></pre>
|
497
509
|
|
498
510
|
<p>For “:switch” type it is true/false value and for the other types a String
|
499
511
|
or an Array of Strings.</p>
|
@@ -509,19 +521,23 @@ Array. The values can be iterated simply by:</p>
|
|
509
521
|
<p>Short syntax for value referencing is performed with unary operator “~”.
|
510
522
|
Thus</p>
|
511
523
|
|
512
|
-
<pre class="code ruby"><code class="ruby"><span class='op'>~</span><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>files</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span
|
524
|
+
<pre class="code ruby"><code class="ruby"><span class='op'>~</span><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>files</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
525
|
+
</code></pre>
|
513
526
|
|
514
527
|
<p>is equal to</p>
|
515
528
|
|
516
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>files</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span
|
529
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>files</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span>
|
530
|
+
</code></pre>
|
517
531
|
|
518
532
|
<p>With “:opt_any” type, the user should first check if the option was given:</p>
|
519
533
|
|
520
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>many_files_or_none</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span
|
534
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>many_files_or_none</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_given'>given</span>
|
535
|
+
</code></pre>
|
521
536
|
|
522
537
|
<p>Then check how many arguments where given:</p>
|
523
538
|
|
524
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>many_files_or_none</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span
|
539
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>many_files_or_none</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
|
540
|
+
</code></pre>
|
525
541
|
|
526
542
|
<p>And finally decide what to do.</p>
|
527
543
|
|
@@ -536,7 +552,8 @@ example with option:</p>
|
|
536
552
|
|
537
553
|
<p>Como can be used extract the parameter values with the “params” method:</p>
|
538
554
|
|
539
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>set</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span
|
555
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Opt</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>set</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span>
|
556
|
+
</code></pre>
|
540
557
|
|
541
558
|
<p>And a Hash is returned:</p>
|
542
559
|
|
@@ -647,7 +664,8 @@ of the internal workings of Como is required though.</p>
|
|
647
664
|
|
648
665
|
<p>Como version is returned with:</p>
|
649
666
|
|
650
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span
|
667
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
|
668
|
+
</code></pre>
|
651
669
|
|
652
670
|
|
653
671
|
</div>
|
@@ -673,7 +691,7 @@ of the internal workings of Como is required though.</p>
|
|
673
691
|
<dt id="VERSION-constant" class="">VERSION =
|
674
692
|
|
675
693
|
</dt>
|
676
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.1.
|
694
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.1.6</span><span class='tstring_end'>"</span></span></pre></dd>
|
677
695
|
|
678
696
|
</dl>
|
679
697
|
|
@@ -888,9 +906,9 @@ of the internal workings of Como is required though.</p>
|
|
888
906
|
</div>
|
889
907
|
|
890
908
|
<div id="footer">
|
891
|
-
Generated on
|
909
|
+
Generated on Tue Jun 21 10:45:05 2016 by
|
892
910
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
893
|
-
0.8.7.6 (ruby-2.1
|
911
|
+
0.8.7.6 (ruby-2.3.1).
|
894
912
|
</div>
|
895
913
|
|
896
914
|
</body>
|
data/doc/_index.html
CHANGED
@@ -233,9 +233,9 @@
|
|
233
233
|
</div>
|
234
234
|
|
235
235
|
<div id="footer">
|
236
|
-
Generated on
|
236
|
+
Generated on Tue Jun 21 10:45:05 2016 by
|
237
237
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
238
|
-
0.8.7.6 (ruby-2.1
|
238
|
+
0.8.7.6 (ruby-2.3.1).
|
239
239
|
</div>
|
240
240
|
|
241
241
|
</body>
|
data/doc/file.CHANGELOG.html
CHANGED
@@ -63,7 +63,10 @@
|
|
63
63
|
|
64
64
|
<div id="content"><div id='filecontents'>
|
65
65
|
<h1 id="label-Version+history">Version history</h1>
|
66
|
-
<dl class="rdoc-list label-list"><dt>0.1.
|
66
|
+
<dl class="rdoc-list label-list"><dt>0.1.6
|
67
|
+
<dd>
|
68
|
+
<p>Added to_hash method to Opt.</p>
|
69
|
+
</dd><dt>0.1.5
|
67
70
|
<dd>
|
68
71
|
<p>Moved evalCheck from private methods to public methods.
|
69
72
|
Opt.error/fatal/warn API methods.</p>
|
@@ -112,9 +115,9 @@ settings, i.e. the Opt#params method added.</p>
|
|
112
115
|
</div></div>
|
113
116
|
|
114
117
|
<div id="footer">
|
115
|
-
Generated on
|
118
|
+
Generated on Tue Jun 21 10:45:05 2016 by
|
116
119
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
117
|
-
0.8.7.6 (ruby-2.1
|
120
|
+
0.8.7.6 (ruby-2.3.1).
|
118
121
|
</div>
|
119
122
|
|
120
123
|
</body>
|
data/doc/file.README.html
CHANGED
@@ -85,9 +85,9 @@ used.</p>
|
|
85
85
|
</div></div>
|
86
86
|
|
87
87
|
<div id="footer">
|
88
|
-
Generated on
|
88
|
+
Generated on Tue Jun 21 10:45:05 2016 by
|
89
89
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
90
|
-
0.8.7.6 (ruby-2.1
|
90
|
+
0.8.7.6 (ruby-2.3.1).
|
91
91
|
</div>
|
92
92
|
|
93
93
|
</body>
|
data/doc/index.html
CHANGED
@@ -85,9 +85,9 @@ used.</p>
|
|
85
85
|
</div></div>
|
86
86
|
|
87
87
|
<div id="footer">
|
88
|
-
Generated on
|
88
|
+
Generated on Tue Jun 21 10:45:05 2016 by
|
89
89
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
90
|
-
0.8.7.6 (ruby-2.1
|
90
|
+
0.8.7.6 (ruby-2.3.1).
|
91
91
|
</div>
|
92
92
|
|
93
93
|
</body>
|