como 0.2.2 → 0.2.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.rdoc +3 -0
- data/doc/Como.html +142 -105
- data/doc/Como/ArgsParseState.html +116 -115
- data/doc/Como/ComoCommon.html +78 -73
- data/doc/Como/MainOpt.html +105 -104
- data/doc/Como/Opt.html +900 -878
- data/doc/Como/Opt/ErrorWithData.html +59 -58
- data/doc/Como/Opt/InvalidOption.html +44 -43
- data/doc/Como/Opt/MissingArgument.html +44 -43
- data/doc/Como/RuleCheck.html +155 -154
- data/doc/Como/RuleDisplay.html +158 -156
- data/doc/Como/Spec.html +328 -319
- data/doc/_index.html +28 -31
- data/doc/class_list.html +24 -31
- data/doc/css/full_list.css +32 -31
- data/doc/css/style.css +250 -93
- data/doc/file.CHANGELOG.html +37 -33
- data/doc/file.README.html +28 -31
- data/doc/file_list.html +29 -31
- data/doc/frames.html +7 -16
- data/doc/index.html +28 -31
- data/doc/js/app.js +147 -74
- data/doc/js/full_list.js +170 -135
- data/doc/method_list.html +768 -476
- data/doc/top-level-namespace.html +34 -36
- data/lib/como.rb +46 -19
- data/lib/version.rb +1 -1
- data/test/como_options +1 -0
- data/test/como_type_prim +2 -2
- data/test/golden/options.txt +71 -11
- data/test/test_como.rb +2 -2
- data/test/test_options +3 -0
- metadata +3 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: de77762e4355adb8c093c1ea89ad792d0060fffb64c42710e5c3871d63b88699
|
4
|
+
data.tar.gz: 804dd952518b87f4ce379327c85036619dc8894eeeeb1339205abc5ff164ba93
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fd7077bd230a9bcb87c982d866848d2d2fb830d8c6f8788c7178b76c46ee2e179f56fd31932251f29dff1ce65a03fcbf28e385aca7967e402541797ec4a8e919
|
7
|
+
data.tar.gz: f08e5f09e9a79cdf49669011e347147b63f72716a24e995d975707a85a98d5e985eefa12a9e1305c2a2786b112eeb94207f4a97cf9dbb09ac130c8d7ec317dbd
|
data/CHANGELOG.rdoc
CHANGED
data/doc/Como.html
CHANGED
@@ -1,12 +1,12 @@
|
|
1
|
-
<!DOCTYPE html
|
2
|
-
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
4
3
|
<head>
|
5
|
-
<meta
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
7
|
Module: Como
|
8
8
|
|
9
|
-
— Documentation by YARD 0.
|
9
|
+
— Documentation by YARD 0.9.16
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -15,9 +15,8 @@
|
|
15
15
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
16
|
|
17
17
|
<script type="text/javascript" charset="utf-8">
|
18
|
-
|
18
|
+
pathId = "Como";
|
19
19
|
relpath = '';
|
20
|
-
framesUrl = "frames.html#!Como.html";
|
21
20
|
</script>
|
22
21
|
|
23
22
|
|
@@ -28,63 +27,63 @@
|
|
28
27
|
|
29
28
|
</head>
|
30
29
|
<body>
|
31
|
-
<div
|
32
|
-
<
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
33
38
|
|
34
39
|
<a href="_index.html">Index (C)</a> »
|
35
40
|
|
36
41
|
|
37
42
|
<span class="title">Como</span>
|
38
43
|
|
39
|
-
|
40
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
44
|
</div>
|
42
45
|
|
43
|
-
|
46
|
+
<div id="search">
|
44
47
|
|
45
48
|
<a class="full_list_link" id="class_list_link"
|
46
49
|
href="class_list.html">
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
</a>
|
54
|
-
|
55
|
-
<a class="full_list_link" id="file_list_link"
|
56
|
-
href="file_list.html">
|
57
|
-
File List
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
58
56
|
</a>
|
59
57
|
|
60
58
|
</div>
|
61
|
-
|
62
|
-
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
63
61
|
|
64
|
-
|
65
|
-
|
66
|
-
<div id="content"><h1>Module: Como
|
62
|
+
<div id="content"><h1>Module: Como
|
67
63
|
|
68
64
|
|
69
65
|
|
70
66
|
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
71
69
|
|
72
|
-
<dl class="box">
|
73
70
|
|
74
71
|
|
75
|
-
|
76
72
|
|
77
|
-
|
78
73
|
|
79
74
|
|
75
|
+
|
76
|
+
|
77
|
+
|
80
78
|
|
81
|
-
|
82
|
-
<
|
79
|
+
<dl>
|
80
|
+
<dt>Defined in:</dt>
|
81
|
+
<dd>lib/como.rb<span class="defines">,<br />
|
83
82
|
lib/version.rb</span>
|
84
83
|
</dd>
|
84
|
+
</dl>
|
85
85
|
|
86
|
-
</
|
87
|
-
<div class="clear"></div>
|
86
|
+
</div>
|
88
87
|
|
89
88
|
<h2>Overview</h2><div class="docstring">
|
90
89
|
<div class="discussion">
|
@@ -117,14 +116,14 @@ usage.</p>
|
|
117
116
|
<span class='id identifier rubyid_include'>include</span> <span class='const'>Como</span>
|
118
117
|
|
119
118
|
<span class='comment'># Define command line arguments:
|
120
|
-
</span><span class='const'>Spec</span><span class='period'>.</span><span class='id identifier rubyid_command'>command</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>como_simple</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Programmer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2013</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
119
|
+
</span><span class='const'><span class='object_link'><a href="Como/Spec.html" title="Como::Spec (class)">Spec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_command'><span class='object_link'><a href="Como/Spec.html#command-class_method" title="Como::Spec.command (method)">command</a></span></span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>como_simple</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Programmer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2013</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
121
120
|
<span class='lbracket'>[</span>
|
122
121
|
<span class='lbracket'>[</span> <span class='symbol'>:single</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>file</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-f</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>File argument.</span><span class='tstring_end'>"</span></span> <span class='rbracket'>]</span><span class='comma'>,</span>
|
123
122
|
<span class='lbracket'>[</span> <span class='symbol'>:switch</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>debug</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-d</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Enable debugging.</span><span class='tstring_end'>"</span></span> <span class='rbracket'>]</span><span class='comma'>,</span>
|
124
123
|
<span class='rbracket'>]</span> <span class='rparen'>)</span>
|
125
124
|
|
126
|
-
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> File option: </span><span class='embexpr_beg'>#{</span><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><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
127
|
-
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> Debugging selected!</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <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>
|
125
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> File option: </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
126
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> Debugging selected!</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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>
|
128
127
|
</code></pre>
|
129
128
|
|
130
129
|
<p>First Como is required and Como module is included.</p>
|
@@ -163,7 +162,7 @@ option:</p>
|
|
163
162
|
command line option values are stored automatically. For example the file
|
164
163
|
option value is returned by:</p>
|
165
164
|
|
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>
|
165
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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
166
|
</code></pre>
|
168
167
|
|
169
168
|
<p>The option name also doubles as long option format, i.e. one could use
|
@@ -172,7 +171,7 @@ option value is returned by:</p>
|
|
172
171
|
<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.
|
173
172
|
For example</p>
|
174
173
|
|
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>
|
174
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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
175
|
</code></pre>
|
177
176
|
|
178
177
|
<p>would return “true” if “-d” was given on the command line.</p>
|
@@ -188,7 +187,8 @@ as default behavior.</p>
|
|
188
187
|
|
189
188
|
<p>Normal behavior would be achieved by executing:</p>
|
190
189
|
|
191
|
-
<pre class="code ruby"><code class="ruby">shell> como_simple -f example -d
|
190
|
+
<pre class="code ruby"><code class="ruby">shell> como_simple -f example -d
|
191
|
+
</code></pre>
|
192
192
|
|
193
193
|
<p>The program would execute with the following output:</p>
|
194
194
|
|
@@ -198,7 +198,8 @@ as default behavior.</p>
|
|
198
198
|
|
199
199
|
<p>Same output would be achieved with:</p>
|
200
200
|
|
201
|
-
<pre class="code ruby"><code class="ruby">shell> como_simple --file example --debug
|
201
|
+
<pre class="code ruby"><code class="ruby">shell> como_simple --file example --debug
|
202
|
+
</code></pre>
|
202
203
|
|
203
204
|
<p>Since option name doubles as long option.</p>
|
204
205
|
|
@@ -219,7 +220,8 @@ checked for existence and error is displayed if arguments are not given.</p>
|
|
219
220
|
-f File argument.
|
220
221
|
-d Enable debugging.
|
221
222
|
|
222
|
-
Copyright (c) 2013 by Programmer
|
223
|
+
Copyright (c) 2013 by Programmer
|
224
|
+
</code></pre>
|
223
225
|
|
224
226
|
<p>Missing option error is displayed since “file” is a mandatory option. The
|
225
227
|
error message is followed by “usage” display (Usage Help). Documentation
|
@@ -227,7 +229,8 @@ string is taken from the option specification to “usage” display.</p>
|
|
227
229
|
|
228
230
|
<p>Given the command:</p>
|
229
231
|
|
230
|
-
<pre class="code ruby"><code class="ruby">shell> como_simple -h
|
232
|
+
<pre class="code ruby"><code class="ruby">shell> como_simple -h
|
233
|
+
</code></pre>
|
231
234
|
|
232
235
|
<p>would display the same “usage” screen except without the error line.</p>
|
233
236
|
|
@@ -241,7 +244,7 @@ have their own command line switches and options.</p>
|
|
241
244
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>como</span><span class='tstring_end'>"</span></span>
|
242
245
|
<span class='id identifier rubyid_include'>include</span> <span class='const'>Como</span>
|
243
246
|
|
244
|
-
<span class='const'>Spec</span><span class='period'>.</span><span class='id identifier rubyid_program'>program</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Programmer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2013</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span> <span class='kw'>do</span>
|
247
|
+
<span class='const'><span class='object_link'><a href="Como/Spec.html" title="Como::Spec (class)">Spec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_program'><span class='object_link'><a href="Como/Spec.html#program-class_method" title="Como::Spec.program (method)">program</a></span></span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Programmer</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2013</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span> <span class='kw'>do</span>
|
245
248
|
|
246
249
|
<span class='id identifier rubyid_command'>command</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>como_subcmd</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span>
|
247
250
|
<span class='lbracket'>[</span> <span class='symbol'>:subcmd</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>add</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Add file.</span><span class='tstring_end'>"</span></span> <span class='rbracket'>]</span><span class='comma'>,</span>
|
@@ -268,7 +271,7 @@ have their own command line switches and options.</p>
|
|
268
271
|
|
269
272
|
<span class='kw'>end</span>
|
270
273
|
|
271
|
-
<span class='id identifier rubyid_subcmd'>subcmd</span> <span class='op'>=</span> <span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_main'>main</span><span class='period'>.</span><span class='id identifier rubyid_givenSubcmd'>givenSubcmd</span>
|
274
|
+
<span class='id identifier rubyid_subcmd'>subcmd</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></span><span class='period'>.</span><span class='id identifier rubyid_main'><span class='object_link'><a href="Como/Opt.html#main-class_method" title="Como::Opt.main (method)">main</a></span></span><span class='period'>.</span><span class='id identifier rubyid_givenSubcmd'>givenSubcmd</span>
|
272
275
|
|
273
276
|
<span class='kw'>case</span> <span class='id identifier rubyid_subcmd'>subcmd</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
|
274
277
|
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>add</span><span class='tstring_end'>'</span></span><span class='semicolon'>;</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> Adding file \"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_subcmd'>subcmd</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><span class='embexpr_end'>}</span><span class='tstring_content'>\"...</span><span class='tstring_end'>"</span></span>
|
@@ -295,23 +298,23 @@ definition allows “add” to have either the “-fo” option defined or
|
|
295
298
|
|
296
299
|
<p>Main (root) commands can be referenced through</p>
|
297
300
|
|
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>
|
301
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></span><span class='period'>.</span><span class='id identifier rubyid_main'><span class='object_link'><a href="Como/Opt.html#main-class_method" title="Como::Opt.main (method)">main</a></span></span>
|
299
302
|
</code></pre>
|
300
303
|
|
301
304
|
<p>or alternatively</p>
|
302
305
|
|
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>
|
306
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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
307
|
</code></pre>
|
305
308
|
|
306
309
|
<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>
|
307
310
|
|
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>
|
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>
|
311
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></span><span class='period'>.</span><span class='id identifier rubyid_main'><span class='object_link'><a href="Como/Opt.html#main-class_method" title="Como::Opt.main (method)">main</a></span></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>
|
312
|
+
<span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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
313
|
</code></pre>
|
311
314
|
|
312
315
|
<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>
|
313
316
|
|
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>
|
317
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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
318
|
</code></pre>
|
316
319
|
|
317
320
|
<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
|
@@ -321,16 +324,19 @@ each parent command.</p>
|
|
321
324
|
|
322
325
|
<p>Normal behavior would be achieved by executing:</p>
|
323
326
|
|
324
|
-
<pre class="code ruby"><code class="ruby">shell> como_subcmd add -fo -f example
|
327
|
+
<pre class="code ruby"><code class="ruby">shell> como_subcmd add -fo -f example
|
328
|
+
</code></pre>
|
325
329
|
|
326
330
|
<p>The program would execute with the following output:</p>
|
327
331
|
|
328
|
-
<pre class="code ruby"><code class="ruby">Adding file "example"
|
332
|
+
<pre class="code ruby"><code class="ruby">Adding file "example"...
|
333
|
+
</code></pre>
|
329
334
|
|
330
335
|
<p>The option combinations for “add” subcommand are automatically checked.
|
331
336
|
Thus executing:</p>
|
332
337
|
|
333
|
-
<pre class="code ruby"><code class="ruby">shell> como_subcmd add -f example
|
338
|
+
<pre class="code ruby"><code class="ruby">shell> como_subcmd add -f example
|
339
|
+
</code></pre>
|
334
340
|
|
335
341
|
<p>Would result to:</p>
|
336
342
|
|
@@ -349,7 +355,8 @@ Thus executing:</p>
|
|
349
355
|
| |--<-fo>
|
350
356
|
| |--# All of:
|
351
357
|
| | |--<password>
|
352
|
-
| | |--<username>
|
358
|
+
| | |--<username>
|
359
|
+
</code></pre>
|
353
360
|
|
354
361
|
<p>since the combination rule requires either “-fo”, or both “password” and
|
355
362
|
“username”.</p>
|
@@ -357,11 +364,13 @@ Thus executing:</p>
|
|
357
364
|
<p>Help is automatically provided on each command level, thus these are both
|
358
365
|
valid.</p>
|
359
366
|
|
360
|
-
<pre class="code ruby"><code class="ruby">shell> como_subcmd -h
|
367
|
+
<pre class="code ruby"><code class="ruby">shell> como_subcmd -h
|
368
|
+
</code></pre>
|
361
369
|
|
362
370
|
<p>and</p>
|
363
371
|
|
364
|
-
<pre class="code ruby"><code class="ruby">shell> como_subcmd rm -h
|
372
|
+
<pre class="code ruby"><code class="ruby">shell> como_subcmd rm -h
|
373
|
+
</code></pre>
|
365
374
|
|
366
375
|
<h1 id="label-Option+specification">Option specification</h1>
|
367
376
|
|
@@ -395,12 +404,19 @@ command line parsing. It is used to:</p>
|
|
395
404
|
</dd><dt>:single
|
396
405
|
<dd>
|
397
406
|
<p>Mandatory single argument option.</p>
|
407
|
+
</dd><dt>:comp
|
408
|
+
<dd>
|
409
|
+
<p>Mandatory single argument option (multiple times). Option values in array.</p>
|
398
410
|
</dd><dt>:multi
|
399
411
|
<dd>
|
400
412
|
<p>Mandatory multiple argument option (one or many). Option values in array.</p>
|
401
413
|
</dd><dt>:opt_single
|
402
414
|
<dd>
|
403
415
|
<p>Optional single argument option. Value is nil when option is not given.</p>
|
416
|
+
</dd><dt>:opt_comp
|
417
|
+
<dd>
|
418
|
+
<p>Optional single argument option (multiple times). Value is nil when option
|
419
|
+
is not given.</p>
|
404
420
|
</dd><dt>:opt_multi
|
405
421
|
<dd>
|
406
422
|
<p>Optional multiple argument option (one or many). Option values in array.</p>
|
@@ -437,10 +453,13 @@ field.</p>
|
|
437
453
|
|
438
454
|
<p>“:multi”, “:opt_multi”, and “:opt_any” option arguments are terminated only
|
439
455
|
when an option specifier is found. This can be a problem if “:default”
|
440
|
-
option follows.
|
441
|
-
|
456
|
+
option follows. There are two simple solutions to this issue. “:comp”
|
457
|
+
option takes only one argument per given switch, and hence is not ambiguous
|
458
|
+
towards “:default” option. Another possibility is to use a “:silent” option
|
459
|
+
that can be used to terminate the argument list. For example:</p>
|
442
460
|
|
443
|
-
<pre class="code ruby"><code class="ruby">[ :silent, "terminator", "-", "The terminator." ]
|
461
|
+
<pre class="code ruby"><code class="ruby">[ :silent, "terminator", "-", "The terminator." ],
|
462
|
+
</code></pre>
|
444
463
|
|
445
464
|
<h2 id="label-Option+type+primitives">Option type primitives</h2>
|
446
465
|
|
@@ -457,6 +476,9 @@ not completely orthogonal, but primitives are.</p>
|
|
457
476
|
</dd><dt>:many
|
458
477
|
<dd>
|
459
478
|
<p>More than one argument.</p>
|
479
|
+
</dd><dt>:repeat
|
480
|
+
<dd>
|
481
|
+
<p>Option can be repeated.</p>
|
460
482
|
</dd><dt>:opt
|
461
483
|
<dd>
|
462
484
|
<p>Optional argument(s).</p>
|
@@ -478,18 +500,24 @@ not completely orthogonal, but primitives are.</p>
|
|
478
500
|
</dd><dt>:single
|
479
501
|
<dd>
|
480
502
|
<p>:one</p>
|
503
|
+
</dd><dt>:comp
|
504
|
+
<dd>
|
505
|
+
<p>:one, :repeat</p>
|
481
506
|
</dd><dt>:multi
|
482
507
|
<dd>
|
483
|
-
<p>:one, :many</p>
|
508
|
+
<p>:one, :many, :repeat</p>
|
484
509
|
</dd><dt>:opt_single
|
485
510
|
<dd>
|
486
511
|
<p>:one, :opt</p>
|
512
|
+
</dd><dt>:opt_comp
|
513
|
+
<dd>
|
514
|
+
<p>:one, :repeat, :opt</p>
|
487
515
|
</dd><dt>:opt_multi
|
488
516
|
<dd>
|
489
|
-
<p>:one, :many, :opt</p>
|
517
|
+
<p>:one, :many, :repeat, :opt</p>
|
490
518
|
</dd><dt>:opt_any
|
491
519
|
<dd>
|
492
|
-
<p>:none, :one, :many, :opt</p>
|
520
|
+
<p>:none, :one, :many, :repeat, :opt</p>
|
493
521
|
</dd><dt>:default
|
494
522
|
<dd>
|
495
523
|
<p>:none, :one, :many, :opt, :default</p>
|
@@ -498,7 +526,7 @@ not completely orthogonal, but primitives are.</p>
|
|
498
526
|
<p>:none, :one, :many, :opt, :mutex</p>
|
499
527
|
</dd><dt>:silent
|
500
528
|
<dd>
|
501
|
-
<p>:none, :opt, :hidden</p>
|
529
|
+
<p>:none, :opt, :hidden, :repeat</p>
|
502
530
|
</dd></dl>
|
503
531
|
|
504
532
|
<p>Primitives can be used in place of types if exotic options are needed.
|
@@ -507,7 +535,8 @@ type. Order of primitives is not significant.</p>
|
|
507
535
|
|
508
536
|
<p>For example:</p>
|
509
537
|
|
510
|
-
<pre class="code ruby"><code class="ruby">[ [ :none, :hidden, :opt ], "terminator", "-", "The terminator." ]
|
538
|
+
<pre class="code ruby"><code class="ruby">[ [ :none, :hidden, :opt ], "terminator", "-", "The terminator." ],
|
539
|
+
</code></pre>
|
511
540
|
|
512
541
|
<p>Como does not check the primitive combinations, thus care and consideration
|
513
542
|
should be applied.</p>
|
@@ -564,7 +593,7 @@ provided and it can be made also visible to user.</p>
|
|
564
593
|
<p>Opt class includes the parsed option values. All options can be tested
|
565
594
|
whether they are specified on the command line using:</p>
|
566
595
|
|
567
|
-
<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>
|
596
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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>
|
568
597
|
</code></pre>
|
569
598
|
|
570
599
|
<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
|
@@ -573,7 +602,7 @@ executed if the option has been set (See: <span class='object_link'><a href="Com
|
|
573
602
|
|
574
603
|
<p>Provided value is returned by:</p>
|
575
604
|
|
576
|
-
<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>
|
605
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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>
|
577
606
|
</code></pre>
|
578
607
|
|
579
608
|
<p>For “:switch” type it is true/false value and for the other types a String
|
@@ -582,7 +611,7 @@ or an Array of Strings.</p>
|
|
582
611
|
<p>If an option takes multiple arguments, the value for the option is an
|
583
612
|
Array. The values can be iterated simply by:</p>
|
584
613
|
|
585
|
-
<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><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_val'>val</span><span class='op'>|</span>
|
614
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_val'>val</span><span class='op'>|</span>
|
586
615
|
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_val'>val</span>
|
587
616
|
<span class='kw'>end</span>
|
588
617
|
</code></pre>
|
@@ -590,22 +619,22 @@ Array. The values can be iterated simply by:</p>
|
|
590
619
|
<p>Short syntax for value referencing is performed with unary operator “~”.
|
591
620
|
Thus</p>
|
592
621
|
|
593
|
-
<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>
|
622
|
+
<pre class="code ruby"><code class="ruby"><span class='op'>~</span><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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>
|
594
623
|
</code></pre>
|
595
624
|
|
596
625
|
<p>is equal to</p>
|
597
626
|
|
598
|
-
<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>
|
627
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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>
|
599
628
|
</code></pre>
|
600
629
|
|
601
630
|
<p>With “:opt_any” type, the user should first check if the option was given:</p>
|
602
631
|
|
603
|
-
<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>
|
632
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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>
|
604
633
|
</code></pre>
|
605
634
|
|
606
635
|
<p>Then check how many arguments where given:</p>
|
607
636
|
|
608
|
-
<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>
|
637
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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>
|
609
638
|
</code></pre>
|
610
639
|
|
611
640
|
<p>And finally decide what to do.</p>
|
@@ -617,11 +646,12 @@ multiple parameter settings. These settings can be parsed and mapped to a
|
|
617
646
|
Hash. Como performs automatic conversion to numeric values if possible. For
|
618
647
|
example with option:</p>
|
619
648
|
|
620
|
-
<pre class="code ruby"><code class="ruby">--set rounds=10 length=5
|
649
|
+
<pre class="code ruby"><code class="ruby">--set rounds=10 length=5
|
650
|
+
</code></pre>
|
621
651
|
|
622
652
|
<p>Como can be used extract the parameter values with the “params” method:</p>
|
623
653
|
|
624
|
-
<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>
|
654
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></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>
|
625
655
|
</code></pre>
|
626
656
|
|
627
657
|
<p>And a Hash is returned:</p>
|
@@ -636,7 +666,8 @@ Commonly the program creator should just check directly which subcommand
|
|
636
666
|
has been selected and check for any subcommand options set. For example:</p>
|
637
667
|
|
638
668
|
<pre class="code ruby"><code class="ruby">if Opt['como_subcmd']['add'].given
|
639
|
-
|
669
|
+
...
|
670
|
+
</code></pre>
|
640
671
|
|
641
672
|
<h2 id="label-Program+external+options">Program external options</h2>
|
642
673
|
|
@@ -687,7 +718,8 @@ referenced file is read in as Ruby file as a last phase when Como is loaded
|
|
687
718
|
from the program (require). Proposed naming convention for the
|
688
719
|
customization is:</p>
|
689
720
|
|
690
|
-
<pre class="code ruby"><code class="ruby">$HOME/.como
|
721
|
+
<pre class="code ruby"><code class="ruby">$HOME/.como
|
722
|
+
</code></pre>
|
691
723
|
|
692
724
|
<p>User can define a pre and a post action hook in the file.</p>
|
693
725
|
|
@@ -700,10 +732,10 @@ parameter names as symbols.</p>
|
|
700
732
|
<p>Example:</p>
|
701
733
|
|
702
734
|
<pre class="code ruby"><code class="ruby"><span class='comment'># Define pre parser hook for Como.
|
703
|
-
</span><span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_preHook'>preHook</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_args'>args</span><span class='op'>|</span>
|
735
|
+
</span><span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_preHook'><span class='object_link'><a href="#preHook-class_method" title="Como.preHook (method)">preHook</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_args'>args</span><span class='op'>|</span>
|
704
736
|
|
705
737
|
<span class='comment'># Get default config for options.
|
706
|
-
</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='const'>Como</span><span class='op'>::</span><span class='const'>Opt</span><span class='period'>.</span><span class='id identifier rubyid_configGet'>configGet</span>
|
738
|
+
</span> <span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='const'>Como</span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Como/Opt.html" title="Como::Opt (class)">Opt</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configGet'><span class='object_link'><a href="Como/Opt.html#configGet-class_method" title="Como::Opt.configGet (method)">configGet</a></span></span>
|
707
739
|
|
708
740
|
<span class='comment'># Disable 'copyright' lines from usage.
|
709
741
|
</span> <span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span> <span class='symbol'>:copyright</span> <span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>false</span>
|
@@ -733,7 +765,7 @@ of the internal workings of Como is required though.</p>
|
|
733
765
|
|
734
766
|
<p>Como version is returned with:</p>
|
735
767
|
|
736
|
-
<pre class="code ruby"><code class="ruby"><span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
|
768
|
+
<pre class="code ruby"><code class="ruby"><span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_version'><span class='object_link'><a href="#version-class_method" title="Como.version (method)">version</a></span></span>
|
737
769
|
</code></pre>
|
738
770
|
|
739
771
|
|
@@ -753,14 +785,18 @@ of the internal workings of Como is required though.</p>
|
|
753
785
|
|
754
786
|
</p>
|
755
787
|
|
756
|
-
<h2>Constant Summary</h2>
|
757
788
|
|
789
|
+
<h2>
|
790
|
+
Constant Summary
|
791
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
792
|
+
</h2>
|
793
|
+
|
758
794
|
<dl class="constants">
|
759
795
|
|
760
796
|
<dt id="VERSION-constant" class="">VERSION =
|
761
797
|
|
762
798
|
</dt>
|
763
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.2.
|
799
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.2.3</span><span class='tstring_end'>"</span></span></pre></dd>
|
764
800
|
|
765
801
|
</dl>
|
766
802
|
|
@@ -774,7 +810,7 @@ of the internal workings of Como is required though.</p>
|
|
774
810
|
|
775
811
|
<h2>
|
776
812
|
Class Method Summary
|
777
|
-
<small
|
813
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
778
814
|
</h2>
|
779
815
|
|
780
816
|
<ul class="summary">
|
@@ -782,7 +818,7 @@ of the internal workings of Como is required though.</p>
|
|
782
818
|
<li class="public ">
|
783
819
|
<span class="summary_signature">
|
784
820
|
|
785
|
-
<a href="#postHook-class_method" title="postHook (class method)"
|
821
|
+
<a href="#postHook-class_method" title="postHook (class method)">.<strong>postHook</strong>(&code) ⇒ Object </a>
|
786
822
|
|
787
823
|
|
788
824
|
|
@@ -806,7 +842,7 @@ of the internal workings of Como is required though.</p>
|
|
806
842
|
<li class="public ">
|
807
843
|
<span class="summary_signature">
|
808
844
|
|
809
|
-
<a href="#preHook-class_method" title="preHook (class method)"
|
845
|
+
<a href="#preHook-class_method" title="preHook (class method)">.<strong>preHook</strong>(&code) ⇒ Object </a>
|
810
846
|
|
811
847
|
|
812
848
|
|
@@ -830,7 +866,7 @@ of the internal workings of Como is required though.</p>
|
|
830
866
|
<li class="public ">
|
831
867
|
<span class="summary_signature">
|
832
868
|
|
833
|
-
<a href="#version-class_method" title="version (class method)"
|
869
|
+
<a href="#version-class_method" title="version (class method)">.<strong>version</strong> ⇒ Object </a>
|
834
870
|
|
835
871
|
|
836
872
|
|
@@ -861,7 +897,7 @@ of the internal workings of Como is required though.</p>
|
|
861
897
|
<div class="method_details first">
|
862
898
|
<h3 class="signature first" id="postHook-class_method">
|
863
899
|
|
864
|
-
|
900
|
+
.<strong>postHook</strong>(&code) ⇒ <tt>Object</tt>
|
865
901
|
|
866
902
|
|
867
903
|
|
@@ -884,15 +920,15 @@ of the internal workings of Como is required though.</p>
|
|
884
920
|
<pre class="lines">
|
885
921
|
|
886
922
|
|
887
|
-
|
888
|
-
|
889
|
-
|
923
|
+
569
|
924
|
+
570
|
925
|
+
571</pre>
|
890
926
|
</td>
|
891
927
|
<td>
|
892
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
928
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 569</span>
|
893
929
|
|
894
|
-
<span class='kw'>def</span> <span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_postHook'>postHook</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
|
895
|
-
<span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_setHook'>setHook</span><span class='lparen'>(</span> <span class='symbol'>:postHook</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
|
930
|
+
<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Como (module)">Como</a></span></span><span class='period'>.</span><span class='id identifier rubyid_postHook'>postHook</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
|
931
|
+
<span class='const'><span class='object_link'><a href="Como/ComoCommon.html" title="Como::ComoCommon (class)">ComoCommon</a></span></span><span class='period'>.</span><span class='id identifier rubyid_setHook'><span class='object_link'><a href="Como/ComoCommon.html#setHook-class_method" title="Como::ComoCommon.setHook (method)">setHook</a></span></span><span class='lparen'>(</span> <span class='symbol'>:postHook</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
|
896
932
|
<span class='kw'>end</span></pre>
|
897
933
|
</td>
|
898
934
|
</tr>
|
@@ -902,7 +938,7 @@ of the internal workings of Como is required though.</p>
|
|
902
938
|
<div class="method_details ">
|
903
939
|
<h3 class="signature " id="preHook-class_method">
|
904
940
|
|
905
|
-
|
941
|
+
.<strong>preHook</strong>(&code) ⇒ <tt>Object</tt>
|
906
942
|
|
907
943
|
|
908
944
|
|
@@ -925,15 +961,15 @@ of the internal workings of Como is required though.</p>
|
|
925
961
|
<pre class="lines">
|
926
962
|
|
927
963
|
|
928
|
-
|
929
|
-
|
930
|
-
|
964
|
+
563
|
965
|
+
564
|
966
|
+
565</pre>
|
931
967
|
</td>
|
932
968
|
<td>
|
933
|
-
<pre class="code"><span class="info file"># File 'lib/como.rb', line
|
969
|
+
<pre class="code"><span class="info file"># File 'lib/como.rb', line 563</span>
|
934
970
|
|
935
|
-
<span class='kw'>def</span> <span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_preHook'>preHook</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
|
936
|
-
<span class='const'>ComoCommon</span><span class='period'>.</span><span class='id identifier rubyid_setHook'>setHook</span><span class='lparen'>(</span> <span class='symbol'>:preHook</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
|
971
|
+
<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Como (module)">Como</a></span></span><span class='period'>.</span><span class='id identifier rubyid_preHook'>preHook</span><span class='lparen'>(</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
|
972
|
+
<span class='const'><span class='object_link'><a href="Como/ComoCommon.html" title="Como::ComoCommon (class)">ComoCommon</a></span></span><span class='period'>.</span><span class='id identifier rubyid_setHook'><span class='object_link'><a href="Como/ComoCommon.html#setHook-class_method" title="Como::ComoCommon.setHook (method)">setHook</a></span></span><span class='lparen'>(</span> <span class='symbol'>:preHook</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
|
937
973
|
<span class='kw'>end</span></pre>
|
938
974
|
</td>
|
939
975
|
</tr>
|
@@ -943,7 +979,7 @@ of the internal workings of Como is required though.</p>
|
|
943
979
|
<div class="method_details ">
|
944
980
|
<h3 class="signature " id="version-class_method">
|
945
981
|
|
946
|
-
|
982
|
+
.<strong>version</strong> ⇒ <tt>Object</tt>
|
947
983
|
|
948
984
|
|
949
985
|
|
@@ -962,8 +998,8 @@ of the internal workings of Como is required though.</p>
|
|
962
998
|
<td>
|
963
999
|
<pre class="code"><span class="info file"># File 'lib/version.rb', line 3</span>
|
964
1000
|
|
965
|
-
<span class='kw'>def</span> <span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
|
966
|
-
<span class='const'>Como</span><span class='op'>::</span><span class='const'>VERSION</span>
|
1001
|
+
<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Como (module)">Como</a></span></span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
|
1002
|
+
<span class='const'><span class='object_link'><a href="" title="Como (module)">Como</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="#VERSION-constant" title="Como::VERSION (constant)">VERSION</a></span></span>
|
967
1003
|
<span class='kw'>end</span></pre>
|
968
1004
|
</td>
|
969
1005
|
</tr>
|
@@ -974,11 +1010,12 @@ of the internal workings of Como is required though.</p>
|
|
974
1010
|
|
975
1011
|
</div>
|
976
1012
|
|
977
|
-
|
978
|
-
Generated on
|
1013
|
+
<div id="footer">
|
1014
|
+
Generated on Sat Sep 29 19:17:49 2018 by
|
979
1015
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
980
|
-
0.
|
1016
|
+
0.9.16 (ruby-2.5.1).
|
981
1017
|
</div>
|
982
1018
|
|
1019
|
+
</div>
|
983
1020
|
</body>
|
984
1021
|
</html>
|