action_command 0.1.3 → 0.1.4

data/doc/ActionCommand/InputOutput.html

@@ -254,6 +254,30 @@ can just access the hash you passed into the command as @params</p>
 <p>Defines input for a command.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#input_count-instance_method" title="#input_count (instance method)">- (Object) <strong>input_count</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>the number of input parameters for this command.</p>
+</div></span>
+  
 </li>
 
       
@@ -298,7 +322,9 @@ can just access the hash you passed into the command as @params</p>
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Defines output for a command.</p>
+</div></span>
   
 </li>
 
@@ -568,12 +594,12 @@ it, returning its result.</p>
       <pre class="lines">
 
 
-98
-99
-100</pre>
+103
+104
+105</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 98</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 103</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_desc'>desc</span>
   <span class='ivar'>@desc</span>
@@ -627,14 +653,14 @@ it, returning its result.</p>
       <pre class="lines">
 
 
-101
-102
-103
-104
-105</pre>
+106
+107
+108
+109
+110</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 101</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 106</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_help?'>help?</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_first_arg_sym'>first_arg_sym</span> <span class='op'>=</span> <span class='ivar'>@input</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='lbracket'>[</span><span class='symbol'>:symbol</span><span class='rbracket'>]</span>
@@ -727,12 +753,12 @@ href="help">your_task_name</a></p>
       <pre class="lines">
 
 
-120
-121
-122</pre>
+125
+126
+127</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 120</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 125</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_input'>input</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_desc'>desc</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid__block'>_block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_insert_io'>insert_io</span><span class='lparen'>(</span><span class='ivar'>@input</span><span class='comma'>,</span> <span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_desc'>desc</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
@@ -740,6 +766,47 @@ href="help">your_task_name</a></p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="input_count-instance_method">
+  
+    - (<tt>Object</tt>) <strong>input_count</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>the number of input parameters for this command.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+25
+26
+27</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 25</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_input_count'>input_count</span>
+  <span class='kw'>return</span> <span class='ivar'>@input</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -786,12 +853,12 @@ href="help">your_task_name</a></p>
       <pre class="lines">
 
 
-129
-130
-131</pre>
+139
+140
+141</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 129</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 139</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_keys'>keys</span> 
   <span class='ivar'>@input</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_p'>p</span><span class='lbracket'>[</span><span class='symbol'>:symbol</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
@@ -810,18 +877,84 @@ href="help">your_task_name</a></p>
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Defines output for a command</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>sym</span>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>symbol identifying the parameter</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>desc</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>description for use by internal developers, or on a rake task with  rake <a
+href="help">your_task_name</a></p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>opts</span>
+      
+      
+        <span class='type'></span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Optional arguments.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-124
-125
-126</pre>
+134
+135
+136</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 124</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 134</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_output'>output</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_desc'>desc</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_insert_io'>insert_io</span><span class='lparen'>(</span><span class='ivar'>@output</span><span class='comma'>,</span> <span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_desc'>desc</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
@@ -857,16 +990,16 @@ href="help">your_task_name</a></p>
       <pre class="lines">
 
 
-89
-90
-91
-92
-93
 94
-95</pre>
+95
+96
+97
+98
+99
+100</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 89</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 94</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_print_output'>print_output</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
   <span class='ivar'>@output</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_param'>param</span><span class='op'>|</span>
@@ -908,11 +1041,6 @@ missing</p>
       <pre class="lines">
 
 
-50
-51
-52
-53
-54
 55
 56
 57
@@ -922,10 +1050,15 @@ missing</p>
 61
 62
 63
-64</pre>
+64
+65
+66
+67
+68
+69</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 50</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 55</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_process_input'>process_input</span><span class='lparen'>(</span><span class='id identifier rubyid_dest'>dest</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='comment'># pass down predefined attributes.
@@ -973,20 +1106,20 @@ missing</p>
       <pre class="lines">
 
 
-67
-68
-69
-70
-71
 72
 73
 74
 75
 76
-77</pre>
+77
+78
+79
+80
+81
+82</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 67</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 72</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_process_output'>process_output</span><span class='lparen'>(</span><span class='id identifier rubyid_dest'>dest</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
   <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_ok?'>ok?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_should_validate'>should_validate</span><span class='lparen'>(</span><span class='id identifier rubyid_dest'>dest</span><span class='rparen'>)</span>
@@ -1030,16 +1163,16 @@ missing</p>
       <pre class="lines">
 
 
-80
-81
-82
-83
-84
 85
-86</pre>
+86
+87
+88
+89
+90
+91</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 80</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 85</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_rake_input'>rake_input</span><span class='lparen'>(</span><span class='id identifier rubyid_rake_arg'>rake_arg</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
@@ -1117,12 +1250,12 @@ missing</p>
       <pre class="lines">
 
 
-26
-27
-28</pre>
+31
+32
+33</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 31</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_should_validate'>should_validate</span><span class='lparen'>(</span><span class='id identifier rubyid_dest'>dest</span><span class='rparen'>)</span>
   <span class='kw'>return</span> <span class='id identifier rubyid_dest'>dest</span><span class='period'>.</span><span class='id identifier rubyid_test_context?'>test_context?</span>
@@ -1158,14 +1291,14 @@ missing</p>
       <pre class="lines">
 
 
-108
-109
-110
-111
-112</pre>
+113
+114
+115
+116
+117</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 108</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 113</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_show_help'>show_help</span>
   <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@action</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_desc'>desc</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -1224,11 +1357,6 @@ description.</p>
       <pre class="lines">
 
 
-32
-33
-34
-35
-36
 37
 38
 39
@@ -1238,10 +1366,15 @@ description.</p>
 43
 44
 45
-46</pre>
+46
+47
+48
+49
+50
+51</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 32</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/input_output.rb', line 37</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_validate_input'>validate_input</span><span class='lparen'>(</span><span class='id identifier rubyid_dest'>dest</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>unless</span> <span class='id identifier rubyid_should_validate'>should_validate</span><span class='lparen'>(</span><span class='id identifier rubyid_dest'>dest</span><span class='rparen'>)</span>
@@ -1268,7 +1401,7 @@ description.</p>
 </div>
 
     <div id="footer">
-  Generated on Fri Mar  4 10:20:15 2016 by
+  Generated on Mon Mar  7 14:27:17 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.3).
 </div>