action_command 0.1.0 → 0.1.1

data/doc/ActionCommand/Executable.html

@@ -94,7 +94,7 @@
   
   
     <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/action_command.rb</dd>
+    <dd class="r2 last">lib/action_command/executable.rb</dd>
   
 </dl>
 <div class="clear"></div>
@@ -189,6 +189,30 @@ ActionCommand.execute_… to execute one.</p>
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#child_context%3F-instance_method" title="#child_context? (instance method)">- (Boolean) <strong>child_context?</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>True if this command is a child of another command.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#execute-instance_method" title="#execute (instance method)">- (ActionCommand::Result) <strong>execute</strong>(result) </a>
     
 
@@ -257,6 +281,102 @@ ActionCommand.execute_… to execute one.</p>
 <p>Do not call new directly, instead use ActionCommand#execute_…</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#rails_context%3F-instance_method" title="#rails_context? (instance method)">- (Boolean) <strong>rails_context?</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>True if this command was executed using ActionCommand.execute_rails.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#rake_context%3F-instance_method" title="#rake_context? (instance method)">- (Boolean) <strong>rake_context?</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>True if this command was executed using ActionCommand.execute_rake.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#root_context-instance_method" title="#root_context (instance method)">- (Symbol) <strong>root_context</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>action was executed in, see the ActionCommand::CONTEXT_ constants.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#test_context%3F-instance_method" title="#test_context? (instance method)">- (Boolean) <strong>test_context?</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>True if this command was executed using ActionCommand.execute_test.</p>
+</div></span>
+  
 </li>
 
       
@@ -317,15 +437,15 @@ validations within the testing context.</p>
       <pre class="lines">
 
 
-243
-244
-245</pre>
+11
+12
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 243</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
-  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_describe_io'>describe_io</span><span class='period'>.</span><span class='id identifier rubyid_assign_args'>assign_args</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_describe_io'>describe_io</span><span class='period'>.</span><span class='id identifier rubyid_process_input'>process_input</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -365,12 +485,12 @@ validations within the testing context.</p>
       <pre class="lines">
 
 
-240
-241
-242</pre>
+8
+9
+10</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 240</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 8</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_parent'>parent</span>
   <span class='ivar'>@parent</span>
@@ -408,12 +528,12 @@ validations within the testing context.</p>
       <pre class="lines">
 
 
-240
-241
-242</pre>
+8
+9
+10</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 240</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 8</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_test'>test</span>
   <span class='ivar'>@test</span>
@@ -431,7 +551,66 @@ validations within the testing context.</p>
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="execute-instance_method">
+  <h3 class="signature first" id="child_context?-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>child_context?</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns true if this command is a child of another command</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if this command is a child of another command</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 40</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_child_context?'>child_context?</span>
+  <span class='kw'>return</span> <span class='op'>!</span><span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="execute-instance_method">
   
     - (<tt><span class='object_link'><a href="Result.html" title="ActionCommand::Result (class)">ActionCommand::Result</a></span></tt>) <strong>execute</strong>(result) 
   
@@ -471,16 +650,18 @@ Command implementors should override execute_internal.</p>
       <pre class="lines">
 
 
-252
-253
-254
-255</pre>
+49
+50
+51
+52
+53</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 252</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 49</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_execute'>execute</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_execute_internal'>execute_internal</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_describe_io'>describe_io</span><span class='period'>.</span><span class='id identifier rubyid_process_output'>process_output</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
   <span class='kw'>return</span> <span class='id identifier rubyid_result'>result</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -535,15 +716,257 @@ that the command failed.</p>
       <pre class="lines">
 
 
-271
-272
-273</pre>
+70
+71
+72</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 271</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 70</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_execute_internal'>execute_internal</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
   
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="rails_context?-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>rails_context?</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns true if this command was executed using ActionCommand.execute_rails</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if this command was executed using ActionCommand.execute_rails</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+30
+31
+32</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 30</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_rails_context?'>rails_context?</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_root_context'>root_context</span> <span class='op'>==</span> <span class='const'>ActionCommand</span><span class='op'>::</span><span class='const'>CONTEXT_RAILS</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="rake_context?-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>rake_context?</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns true if this command was executed using ActionCommand.execute_rake</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if this command was executed using ActionCommand.execute_rake</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+35
+36
+37</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 35</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_rake_context?'>rake_context?</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_root_context'>root_context</span> <span class='op'>==</span> <span class='const'>ActionCommand</span><span class='op'>::</span><span class='const'>CONTEXT_RAKE</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="root_context-instance_method">
+  
+    - (<tt>Symbol</tt>) <strong>root_context</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>action was executed in, see the ActionCommand::CONTEXT_ constants.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the symbol indicating what context this</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+17
+18
+19
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 17</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_root_context'>root_context</span>
+  
+  <span class='id identifier rubyid_context'>context</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span>
+  <span class='id identifier rubyid_context'>context</span> <span class='op'>=</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_parent'>parent</span> <span class='kw'>until</span> <span class='id identifier rubyid_context'>context</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Symbol</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_context'>context</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="test_context?-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>test_context?</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns true if this command was executed using ActionCommand.execute_test</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if this command was executed using ActionCommand.execute_test</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</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/executable.rb', line 25</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_test_context?'>test_context?</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_root_context'>root_context</span> <span class='op'>==</span> <span class='const'>ActionCommand</span><span class='op'>::</span><span class='const'>CONTEXT_TEST</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -596,12 +1019,12 @@ ActionCommand#execute_test.</p>
       <pre class="lines">
 
 
-261
-262
-263</pre>
+59
+60
+61</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/action_command.rb', line 261</span>
+      <pre class="code"><span class="info file"># File 'lib/action_command/executable.rb', line 59</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_testing'>testing</span>
   <span class='kw'>yield</span> <span class='ivar'>@test</span> <span class='kw'>if</span> <span class='ivar'>@test</span>
@@ -616,7 +1039,7 @@ ActionCommand#execute_test.</p>
 </div>
 
     <div id="footer">
-  Generated on Sat Feb 13 10:16:47 2016 by
+  Generated on Thu Mar  3 16:34:07 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>