doc/Rubu/Step.html in rubu-0.0.3 vs doc/Rubu/Step.html in rubu-0.0.4

- old
+ new

@@ -552,10 +552,34 @@ <li class="public "> <span class="summary_signature"> + <a href="#step-instance_method" title="#step (instance method)">- (Object) <strong>step</strong> </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'> +<p>Default to no action.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#target-instance_method" title="#target (instance method)">- (Object) <strong>target</strong> </a> </span> @@ -645,11 +669,11 @@ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Move.html" title="Rubu::Move (class)">Move</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Move.html#display-instance_method" title="Rubu::Move#display (method)">#display</a></span>, <span class='object_link'><a href="Move.html#error-instance_method" title="Rubu::Move#error (method)">#error</a></span>, <span class='object_link'><a href="Move.html#host-instance_method" title="Rubu::Move#host (method)">#host</a></span>, <span class='object_link'><a href="Move.html#host_in-instance_method" title="Rubu::Move#host_in (method)">#host_in</a></span>, <span class='object_link'><a href="Move.html#host_out-instance_method" title="Rubu::Move#host_out (method)">#host_out</a></span>, <span class='object_link'><a href="Move.html#use-instance_method" title="Rubu::Move#use (method)">#use</a></span></p> + <p class="inherited"><span class='object_link'><a href="Move.html#display-instance_method" title="Rubu::Move#display (method)">#display</a></span>, <span class='object_link'><a href="Move.html#error-instance_method" title="Rubu::Move#error (method)">#error</a></span>, <span class='object_link'><a href="Move.html#host-instance_method" title="Rubu::Move#host (method)">#host</a></span>, <span class='object_link'><a href="Move.html#host_in-instance_method" title="Rubu::Move#host_in (method)">#host_in</a></span>, <span class='object_link'><a href="Move.html#host_out-instance_method" title="Rubu::Move#host_out (method)">#host_out</a></span>, <span class='object_link'><a href="Move.html#set_show_shell_warning-instance_method" title="Rubu::Move#set_show_shell_warning (method)">#set_show_shell_warning</a></span>, <span class='object_link'><a href="Move.html#use-instance_method" title="Rubu::Move#use (method)">#use</a></span>, <span class='object_link'><a href="Move.html#warn-instance_method" title="Rubu::Move#warn (method)">#warn</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> @@ -715,30 +739,30 @@ <tr> <td> <pre class="lines"> -506 -507 -508 -509 -510 -511 -512 -513 -514 -515 -516 -517 518 519 520 521 -522</pre> +522 +523 +524 +525 +526 +527 +528 +529 +530 +531 +532 +533 +534</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 506</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 518</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_sources'>sources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_targets'>targets</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='rparen'>)</span> <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_sources'>sources</span><span class='period'>.</span><span class='id identifier rubyid_kind_of?'>kind_of?</span> <span class='const'>Array</span> @@ -791,16 +815,16 @@ <tr> <td> <pre class="lines"> -499 -500 -501</pre> +511 +512 +513</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 499</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 511</span> <span class='kw'>def</span> <span class='id identifier rubyid_sources'>sources</span> <span class='ivar'>@sources</span> <span class='kw'>end</span></pre> </td> @@ -834,16 +858,16 @@ <tr> <td> <pre class="lines"> -500 -501 -502</pre> +512 +513 +514</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 500</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 512</span> <span class='kw'>def</span> <span class='id identifier rubyid_targets'>targets</span> <span class='ivar'>@targets</span> <span class='kw'>end</span></pre> </td> @@ -922,16 +946,16 @@ <tr> <td> <pre class="lines"> -473 -474 -475</pre> +485 +486 +487</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 473</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 485</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span><span class='lparen'>(</span> <span class='id identifier rubyid_sources'>sources</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_targets'>targets</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='rparen'>)</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_sources'>sources</span><span class='comma'>,</span> <span class='id identifier rubyid_targets'>targets</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='kw'>end</span></pre> </td> @@ -999,18 +1023,18 @@ <tr> <td> <pre class="lines"> -492 -493 -494 -495 -496</pre> +504 +505 +506 +507 +508</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 492</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 504</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_usezip'>usezip</span><span class='lparen'>(</span> <span class='id identifier rubyid_sources'>sources</span><span class='comma'>,</span> <span class='id identifier rubyid_targets'>targets</span> <span class='rparen'>)</span> <span class='id identifier rubyid_sources'>sources</span><span class='period'>.</span><span class='id identifier rubyid_zip'>zip</span><span class='lparen'>(</span> <span class='id identifier rubyid_targets'>targets</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_pair'>pair</span><span class='op'>|</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_pair'>pair</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='kw'>end</span> @@ -1080,18 +1104,18 @@ <tr> <td> <pre class="lines"> -481 -482 -483 -484 -485</pre> +493 +494 +495 +496 +497</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 481</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 493</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_zip'>zip</span><span class='lparen'>(</span> <span class='id identifier rubyid_sources'>sources</span><span class='comma'>,</span> <span class='id identifier rubyid_targets'>targets</span> <span class='rparen'>)</span> <span class='id identifier rubyid_sources'>sources</span><span class='period'>.</span><span class='id identifier rubyid_zip'>zip</span><span class='lparen'>(</span> <span class='id identifier rubyid_targets'>targets</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_pair'>pair</span><span class='op'>|</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_pair'>pair</span> <span class='rparen'>)</span> <span class='kw'>end</span> @@ -1144,40 +1168,40 @@ <tr> <td> <pre class="lines"> -549 -550 -551 -552 -553 -554 -555 -556 -557 -558 -559 -560 -561 -562 -563 -564 -565 566 567 568 569 570 571 572 573 574 -575</pre> +575 +576 +577 +578 +579 +580 +581 +582 +583 +584 +585 +586 +587 +588 +589 +590 +591 +592</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 549</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 566</span> <span class='kw'>def</span> <span class='id identifier rubyid_date_update?'>date_update?</span> <span class='comment'># Check if targets are missing. </span> <span class='ivar'>@targets</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_target'>target</span><span class='op'>|</span> @@ -1233,19 +1257,19 @@ <tr> <td> <pre class="lines"> -647 -648 -649 -650 -651 -652</pre> +664 +665 +666 +667 +668 +669</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 647</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 664</span> <span class='kw'>def</span> <span class='id identifier rubyid_fork'>fork</span><span class='lparen'>(</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span> <span class='id identifier rubyid_host_in'>host_in</span> <span class='id identifier rubyid_instance_eval'>instance_eval</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span> <span class='id identifier rubyid_host_out'>host_out</span> @@ -1293,27 +1317,10 @@ <tr> <td> <pre class="lines"> -579 -580 -581 -582 -583 -584 -585 -586 -587 -588 -589 -590 -591 -592 -593 -594 -595 596 597 598 599 600 @@ -1321,14 +1328,31 @@ 602 603 604 605 606 -607</pre> +607 +608 +609 +610 +611 +612 +613 +614 +615 +616 +617 +618 +619 +620 +621 +622 +623 +624</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 579</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 596</span> <span class='kw'>def</span> <span class='id identifier rubyid_mark_update?'>mark_update?</span> <span class='kw'>unless</span> <span class='id identifier rubyid_date_update?'>date_update?</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_skip'>skip</span> <span class='op'>=</span> <span class='kw'>true</span> @@ -1408,16 +1432,16 @@ <tr> <td> <pre class="lines"> -634 -635 -636</pre> +651 +652 +653</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 634</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 651</span> <span class='kw'>def</span> <span class='id identifier rubyid_rbrun'>rbrun</span><span class='lparen'>(</span> <span class='id identifier rubyid_desc'>desc</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span> <span class='const'>RubyCommand</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_desc'>desc</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='kw'>end</span></pre> </td> @@ -1471,17 +1495,17 @@ <tr> <td> <pre class="lines"> -641 -642 -643 -644</pre> +658 +659 +660 +661</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 641</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 658</span> <span class='kw'>def</span> <span class='id identifier rubyid_rbuse'>rbuse</span><span class='lparen'>(</span> <span class='id identifier rubyid_desc'>desc</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span> <span class='id identifier rubyid_rb'>rb</span> <span class='op'>=</span> <span class='const'>RubyCommand</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_desc'>desc</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span> <span class='id identifier rubyid_rb'>rb</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='kw'>end</span></pre> @@ -1514,21 +1538,21 @@ <tr> <td> <pre class="lines"> -532 -533 -534 -535 -536 -537 -538 -539</pre> +549 +550 +551 +552 +553 +554 +555 +556</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 532</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 549</span> <span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span> <span class='kw'>if</span> <span class='id identifier rubyid_update?'>update?</span> <span class='id identifier rubyid_step'>step</span> <span class='kw'>else</span> @@ -1565,15 +1589,15 @@ <tr> <td> <pre class="lines"> -527 -528</pre> +539 +540</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 527</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 539</span> <span class='kw'>def</span> <span class='id identifier rubyid_setup'>setup</span> <span class='kw'>end</span></pre> </td> </tr> @@ -1604,16 +1628,16 @@ <tr> <td> <pre class="lines"> -621 -622 -623</pre> +638 +639 +640</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 621</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 638</span> <span class='kw'>def</span> <span class='id identifier rubyid_shrun'>shrun</span><span class='lparen'>(</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span> <span class='const'>ShellCommand</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='kw'>end</span></pre> </td> @@ -1645,17 +1669,17 @@ <tr> <td> <pre class="lines"> -626 -627 -628 -629</pre> +643 +644 +645 +646</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 626</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 643</span> <span class='kw'>def</span> <span class='id identifier rubyid_shuse'>shuse</span><span class='lparen'>(</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span> <span class='id identifier rubyid_sh'>sh</span> <span class='op'>=</span> <span class='const'>ShellCommand</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='id identifier rubyid_cmd'>cmd</span> <span class='rparen'>)</span> <span class='id identifier rubyid_sh'>sh</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='kw'>end</span></pre> @@ -1688,26 +1712,65 @@ <tr> <td> <pre class="lines"> -611 -612 -613</pre> +628 +629 +630</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 611</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 628</span> <span class='kw'>def</span> <span class='id identifier rubyid_source'>source</span> <span class='ivar'>@sources</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> </tr> </table> </div> <div class="method_details "> + <h3 class="signature " id="step-instance_method"> + + - (<tt>Object</tt>) <strong>step</strong> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Default to no action. Typically this method is redefined.</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +544 +545</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 544</span> + +<span class='kw'>def</span> <span class='id identifier rubyid_step'>step</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> <h3 class="signature " id="target-instance_method"> - (<tt>Object</tt>) <strong>target</strong> @@ -1729,16 +1792,16 @@ <tr> <td> <pre class="lines"> -616 -617 -618</pre> +633 +634 +635</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 616</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 633</span> <span class='kw'>def</span> <span class='id identifier rubyid_target'>target</span> <span class='ivar'>@targets</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='kw'>end</span></pre> </td> @@ -1783,16 +1846,16 @@ <tr> <td> <pre class="lines"> -543 -544 -545</pre> +560 +561 +562</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 543</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 560</span> <span class='kw'>def</span> <span class='id identifier rubyid_update?'>update?</span> <span class='kw'>true</span> <span class='kw'>end</span></pre> </td> @@ -1824,19 +1887,19 @@ <tr> <td> <pre class="lines"> -655 -656 -657 -658 -659 -660</pre> +672 +673 +674 +675 +676 +677</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 655</span> + <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 672</span> <span class='kw'>def</span> <span class='id identifier rubyid_walk'>walk</span><span class='lparen'>(</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span> <span class='id identifier rubyid_host_in'>host_in</span> <span class='id identifier rubyid_instance_eval'>instance_eval</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span> <span class='id identifier rubyid_host_out'>host_out</span> @@ -1850,10 +1913,10 @@ </div> </div> <div id="footer"> - Generated on Sun Jul 8 19:50:19 2018 by + Generated on Thu Aug 30 16:05:51 2018 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.7.6 (ruby-2.3.3). </div> </body> \ No newline at end of file