como 0.1.3 → 0.1.4

data/doc/Como.html

@@ -128,7 +128,7 @@ usage.</p>
 
 <p>First Como is required and Como module is included.</p>
 
-<p>"Spec.command" method takes 4 arguments:</p>
+<p><span class='object_link'><a href="Como/Spec.html#command-class_method" title="Como::Spec.command (method)">Spec.command</a></span> method takes 4 arguments:</p>
 <dl class="rdoc-list"><dt>progname</dt>
 <dd>
 <p>Name of the program (or command).</p>
@@ -166,8 +166,8 @@ option value is returned by:</p>
 <p>The option name also doubles as long option format, i.e. one could use
 "--file &lt;filename&gt;" on the command line.</p>
 
-<p>Existence of optional options can be tested using the "given" method. For
-example</p>
+<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.
+For example</p>
 
 <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></code></pre>
 
@@ -269,13 +269,13 @@ have their own command line switches and options.</p>
 <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rm</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'>&quot;</span><span class='tstring_content'>  Removing file \&quot;</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='rbrace'>}</span><span class='tstring_content'>\&quot;...</span><span class='tstring_end'>&quot;</span></span>
 <span class='kw'>end</span></code></pre>
 
-<p>"Spec.program" method defines a program (command) with subcommands. The
+<p><span class='object_link'><a href="Como/Spec.html#program-class_method" title="Como::Spec.program (method)">Spec.program</a></span> method defines a program (command) with subcommands. The
 author and date are provided as parameters, and the program and subcommand
 options are defined in block.</p>
 
-<p>The first "command" (or "subcmd") method call defines the main command
-("Opt.main") which represents the program. It has two "subcmd" options
-("add" and "rm").</p>
+<p>The first <span class='object_link'><a href="Como/Spec.html#command-instance_method" title="Como::Spec#command (method)">Spec#command</a></span> (or <span class='object_link'><a href="Como/Spec.html#subcmd-instance_method" title="Como::Spec#subcmd (method)">Spec#subcmd</a></span>) method call defines the main
+command (<span class='object_link'><a href="Como/Opt.html#main-class_method" title="Como::Opt.main (method)">Opt.main</a></span>) which represents the program. It has two "subcmd"
+options ("add" and "rm").</p>
 
 <p>The rest of the "subcmd" methods define subcommands for the parent command.
 This example includes one subcommand level, but multiple levels are
@@ -294,17 +294,17 @@ definition allows "add" to have either the "-fo" option defined or
 
 <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></code></pre>
 
-<p>The subcommands can be referenced through "Opt.main" (etc.)</p>
+<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>
 
 <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>
 <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></code></pre>
 
-<p>or directly from "Opt" if subcommand names do not collide:</p>
+<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>
 
 <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></code></pre>
 
-<p>The given subcommand can be accessed with "givenSubcmd" method from each
-parent command.</p>
+<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
+each parent command.</p>
 
 <h3>Subcommand example executions</h3>
 
@@ -389,7 +389,7 @@ command line parsing. It is used to:</p>
 <p>Mandatory multiple argument option (one or many). Option values in array.</p>
 </dd><dt>:opt_single</dt>
 <dd>
-<p>Optional single argument option.</p>
+<p>Optional single argument option. Value is nil when option is not given.</p>
 </dd><dt>:opt_multi</dt>
 <dd>
 <p>Optional multiple argument option (one or many). Option values in array.</p>
@@ -404,7 +404,7 @@ left out, since only the document string is used. Default option is
 referred with ":default" or "nil".</p>
 </dd><dt>:exclusive</dt>
 <dd>
-<p>Option that does not coexist with other options. :exclusive can have
+<p>Option that does not co-exist with other options. :exclusive can have
 arguments as with :opt_any, however :exclusive is documented like :switch.</p>
 </dd><dt>:silent</dt>
 <dd>
@@ -435,8 +435,8 @@ can be used to terminate the argument list. For example:</p>
 <p>Option behavior can be controlled with several configuration options.</p>
 
 <p>The configuration options are provided in a Hash. These are the passed as
-the last regular parameter for both "Spec.command" and "Spec.program"
-methods. Setting the configuration at "Spec.program" will propagate the
+the last regular parameter for both <span class='object_link'><a href="Como/Spec.html#command-class_method" title="Como::Spec.command (method)">Spec.command</a></span> and <span class='object_link'><a href="Como/Spec.html#program-class_method" title="Como::Spec.program (method)">Spec.program</a></span>
+methods. Setting the configuration at <span class='object_link'><a href="Como/Spec.html#program-class_method" title="Como::Spec.program (method)">Spec.program</a></span> will propagate the
 config options to all the subcommands as well. Configuration can be given
 to each subcommand separately to override the inherited config values.
 Subcommand settings are not inherited, but apply only in the subcommand.</p>
@@ -484,9 +484,9 @@ whether they are specified on the command line using:</p>
 
 <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></code></pre>
 
-<p>The "given" method takes optionally a block argument. When block argument
-is used, the block is supplied with option value and the block is executed
-if the option has been set (See: Opt#given).</p>
+<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
+argument is used, the block is supplied with option value and the block is
+executed if the option has been set (See: <span class='object_link'><a href="Como/Opt.html#given-instance_method" title="Como::Opt#given (method)">Opt#given</a></span>).</p>
 
 <p>Provided value is returned by:</p>
 
@@ -540,7 +540,7 @@ example with option:</p>
 
 <h2>Subcommand options</h2>
 
-<p>The given subcommand for the parent command is return by "givenSubcmd".
+<p>The given subcommand for the parent command is return by <span class='object_link'><a href="Como/Opt.html#givenSubcmd-instance_method" title="Como::Opt#givenSubcmd (method)">Opt#givenSubcmd</a></span>.
 Commonly the program creator should just check directly which subcommand
 has been selected and check for any subcommand options set. For example:</p>
 
@@ -550,7 +550,7 @@ has been selected and check for any subcommand options set. For example:</p>
 <h2>Program external options</h2>
 
 <p>If the user gives the "--" option (double-dash), the arguments after that
-option are returned as an Array with "Opt.external".</p>
+option are returned as an Array with <span class='object_link'><a href="Como/Opt.html#external-class_method" title="Como::Opt.external (method)">Opt.external</a></span>.</p>
 
 <h1>Option combination checks</h1>
 
@@ -590,8 +590,8 @@ exclusive.</p>
 
 <h1>Customization</h1>
 
-<p>A user specific customization file can be referenced through the "COMO"
-environment variable. If environment variable "COMO" is defined, the
+<p>A Como user specific customization file can be referenced through the
+"COMO" environment variable. If environment variable "COMO" is defined, the
 referenced file is read in as Ruby file as a last phase when Como is loaded
 from the program (require). Proposed naming convention for the
 customization is:</p>
@@ -601,9 +601,9 @@ customization is:</p>
 <p>User can define a pre and a post action hook in the file.</p>
 
 <p>The pre-hook can be used for example to change the Como config defaults. It
-is run before the body of "Spec.command" or "Spec.program" is executed. It
-is passed all the parameters that has been passed to "Spec.command" or
-"Spec.program", only collected into a Hash. The Hash keys are method
+is run before the body of <span class='object_link'><a href="Como/Spec.html#command-class_method" title="Como::Spec.command (method)">Spec.command</a></span> or <span class='object_link'><a href="Como/Spec.html#program-class_method" title="Como::Spec.program (method)">Spec.program</a></span> is executed. It
+is passed all the parameters that has been passed to <span class='object_link'><a href="Como/Spec.html#command-class_method" title="Como::Spec.command (method)">Spec.command</a></span> or
+<span class='object_link'><a href="Como/Spec.html#program-class_method" title="Como::Spec.program (method)">Spec.program</a></span>, only collected into a Hash. The Hash keys are method
 parameter names as symbols.</p>
 
 <p>Example:</p>
@@ -625,7 +625,15 @@ parameter names as symbols.</p>
 <span class='kw'>end</span></code></pre>
 
 <p>There is no predefined use cases for post-hook. Post-hook is passed the
-Opt.main as parameter.</p>
+<span class='object_link'><a href="Como/Opt.html#main-class_method" title="Como::Opt.main (method)">Opt.main</a></span> as parameter.</p>
+
+<p><span class='object_link'><a href="Como/Spec.html#program-class_method" title="Como::Spec.program (method)">Spec.program</a></span> and <span class='object_link'><a href="Como/Spec.html#command-class_method" title="Como::Spec.command (method)">Spec.command</a></span> both process and check options in one
+pass. Como user can separate the definition and checking phase. Definition
+phase is performed by executing <span class='object_link'><a href="Como/Spec.html#defineProgram-class_method" title="Como::Spec.defineProgram (method)">Spec.defineProgram</a></span> or
+<span class='object_link'><a href="Como/Spec.html#defineCommand-class_method" title="Como::Spec.defineCommand (method)">Spec.defineCommand</a></span>. After definition phase the user can for example
+programmatically add new subcommands or options, in addition to existing
+options. When the subcommands and options are complete, <span class='object_link'><a href="Como/Spec.html#execute-class_method" title="Como::Spec.execute (method)">Spec.execute</a></span>
+should be called to perform options checking.</p>
 
 <p>If the provided customization facilities are not satisfactory, changes can
 be implemented simply by overloading the existing functions. Some knowledge
@@ -652,6 +660,18 @@ of the internal workings of Como is required though.</p>
   
 </p>
 
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.4</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+    </dl>
+  
+
 
 
 
@@ -771,12 +791,12 @@ of the internal workings of Como is required though.</p>
       <pre class="lines">
 
 
-502
-503
-504</pre>
+520
+521
+522</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/como.rb', line 502</span>
+      <pre class="code"><span class="info file"># File 'lib/como.rb', line 520</span>
 
 <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'>&amp;</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
     <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'>&amp;</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
@@ -812,12 +832,12 @@ of the internal workings of Como is required though.</p>
       <pre class="lines">
 
 
-496
-497
-498</pre>
+514
+515
+516</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/como.rb', line 496</span>
+      <pre class="code"><span class="info file"># File 'lib/como.rb', line 514</span>
 
 <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'>&amp;</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
     <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'>&amp;</span><span class='id identifier rubyid_code'>code</span> <span class='rparen'>)</span>
@@ -850,7 +870,7 @@ of the internal workings of Como is required though.</p>
       <pre class="code"><span class="info file"># File 'lib/version.rb', line 3</span>
 
 <span class='kw'>def</span> <span class='const'>Como</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
-    <span class='const'>ComoCommon</span><span class='op'>::</span><span class='const'>VERSION</span>
+    <span class='const'>Como</span><span class='op'>::</span><span class='const'>VERSION</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -862,7 +882,7 @@ of the internal workings of Como is required though.</p>
 </div>
 
     <div id="footer">
-  Generated on Wed Jul  9 14:02:42 2014 by
+  Generated on Sat Nov 22 10:05:15 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/doc/_index.html

@@ -233,7 +233,7 @@
 </div>
 
     <div id="footer">
-  Generated on Wed Jul  9 14:02:42 2014 by
+  Generated on Sat Nov 22 10:05:15 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/doc/file.CHANGELOG.html

@@ -63,7 +63,17 @@
 
     <div id="content"><div id='filecontents'>
 <h1>Version history</h1>
-<dl class="rdoc-list"><dt>0.1.3</dt>
+<dl class="rdoc-list"><dt>0.1.4</dt>
+<dd>
+<p>Documentation improvements (links to methods). Fix to Opt#apply return
+value when type is :switch. Opt#fatal added for user error reporting
+towards command line user. Non-existing options for option with multiple
+values defaults</p>
+
+<pre class="code ruby"><code class="ruby">to an empty array.</code></pre>
+
+<p>Possibility to separate option definition and execution.</p>
+</dd><dt>0.1.3</dt>
 <dd>
 <p>Customization through COMO env variable and hooks. Version information
 returned programmatically with Como.version. "command" is aliased to
@@ -98,7 +108,7 @@ settings, i.e. the Opt#params method added.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Wed Jul  9 14:02:42 2014 by
+  Generated on Sat Nov 22 10:05:15 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/doc/file.README.html

@@ -85,7 +85,7 @@ used.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Wed Jul  9 14:02:42 2014 by
+  Generated on Sat Nov 22 10:05:15 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>

data/doc/index.html

@@ -85,7 +85,7 @@ used.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Wed Jul  9 14:02:42 2014 by
+  Generated on Sat Nov 22 10:05:15 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>