doc/Bauxite/Action.html in bauxite-0.4.6 vs doc/Bauxite/Action.html in bauxite-0.5.0
- old
+ new
@@ -105,10 +105,12 @@
<li ><a href="#method-i-click">#click</a>
<li ><a href="#method-i-debug">#debug</a>
+ <li ><a href="#method-i-doif">#doif</a>
+
<li ><a href="#method-i-echo">#echo</a>
<li ><a href="#method-i-exec">#exec</a>
<li ><a href="#method-i-failif">#failif</a>
@@ -131,10 +133,12 @@
<li ><a href="#method-i-select">#select</a>
<li ><a href="#method-i-set">#set</a>
+ <li ><a href="#method-i-setif">#setif</a>
+
<li ><a href="#method-i-source">#source</a>
<li ><a href="#method-i-store">#store</a>
<li ><a href="#method-i-submit">#submit</a>
@@ -598,10 +602,60 @@
</div>
+ <div id="method-i-doif" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">doif</span><span
+ class="method-args">(expected, actual, action, *args)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Executes <code>action</code> only if <code>expected</code> matches
+<code>actual</code>.</p>
+
+<p>The conditional check in this action is similar to <a
+href="Action.html#method-i-assertv">assertv</a>.</p>
+
+<p>For example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">set</span> <span class="ruby-identifier">first</span> <span class="ruby-identifier">john</span>
+<span class="ruby-identifier">set</span> <span class="ruby-identifier">last</span> <span class="ruby-identifier">doe</span>
+<span class="ruby-identifier">doif</span> <span class="ruby-identifier">john</span> ${<span class="ruby-identifier">first</span>} <span class="ruby-identifier">assertv</span> <span class="ruby-identifier">doe</span> ${<span class="ruby-identifier">last</span>}
+<span class="ruby-comment"># => this assertion would pass.</span>
+
+<span class="ruby-identifier">doif</span> <span class="ruby-identifier">smith</span> ${<span class="ruby-identifier">last</span>} <span class="ruby-identifier">load</span> <span class="ruby-identifier">smith_specific_text</span>.<span class="ruby-identifier">bxt</span>
+<span class="ruby-comment"># => this would only load smith_specific_text.bxt if the last</span>
+<span class="ruby-comment"># variable matches 'smith'</span>
+</pre>
+
+
+
+
+ <div class="method-source-code" id="doif-source">
+ <pre><span class="ruby-comment"># File lib/bauxite/actions/doif.rb, line 39</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">doif</span>(<span class="ruby-identifier">expected</span>, <span class="ruby-identifier">actual</span>, <span class="ruby-identifier">action</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">actual</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">_pattern</span>(<span class="ruby-identifier">expected</span>)
+ <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">exec_action_object</span>(<span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">get_action</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>))
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
<div id="method-i-echo" class="method-detail ">
<div class="method-heading">
<span class="method-name">echo</span><span
class="method-args">(text)</span>
@@ -737,23 +791,14 @@
<div class="method-source-code" id="failif-source">
<pre><span class="ruby-comment"># File lib/bauxite/actions/failif.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">failif</span>(<span class="ruby-identifier">action</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
- <span class="ruby-identifier">action</span> = <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">get_action</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">variables</span>[<span class="ruby-string">'__FILE__'</span>], <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">variables</span>[<span class="ruby-string">'__LINE__'</span>])
-
- <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">with_timeout</span> <span class="ruby-constant">Bauxite</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">AssertionError</span> <span class="ruby-keyword">do</span>
- <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">with_vars</span>({ <span class="ruby-string">'__TIMEOUT__'</span> =<span class="ruby-operator">></span> <span class="ruby-value">0</span>}) <span class="ruby-keyword">do</span>
- <span class="ruby-keyword">begin</span>
- <span class="ruby-identifier">ret</span> = <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">exec_action_object</span>(<span class="ruby-identifier">action</span>)
- <span class="ruby-identifier">ret</span>.<span class="ruby-identifier">call</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ret</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:call</span>
- <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Bauxite</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">AssertionError</span>
- <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>
- <span class="ruby-keyword">end</span>
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">Bauxite</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">AssertionError</span>, <span class="ruby-node">"Assertion did not failed as expected:#{action.text}"</span>
- <span class="ruby-keyword">end</span>
+ <span class="ruby-keyword">if</span> <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">try_exec_action</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>)
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">Bauxite</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">AssertionError</span>, <span class="ruby-node">"Assertion did not failed as expected:#{action} #{args.join(' ')}"</span>
<span class="ruby-keyword">end</span>
+ <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
@@ -1273,10 +1318,55 @@
</div>
+ <div id="method-i-setif" class="method-detail ">
+
+ <div class="method-heading">
+ <span class="method-name">setif</span><span
+ class="method-args">(name, value, action, *args)</span>
+
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+
+ <div class="method-description">
+
+ <p>Sets the variable named <code>name</code> to the <code>value</code>
+specified only if the. <code>action</code> execution succeeds. If the
+execution fails, the value of <code>name</code> is left unchanged.</p>
+
+<p>For example:</p>
+
+<pre class="ruby"><span class="ruby-identifier">set</span> <span class="ruby-identifier">name</span> <span class="ruby-identifier">john</span>
+<span class="ruby-identifier">setif</span> <span class="ruby-identifier">is_john</span> <span class="ruby-keyword">true</span> <span class="ruby-identifier">assertv</span> <span class="ruby-string">"/John/i"</span> <span class="ruby-string">"${name}"</span>
+<span class="ruby-identifier">assertv</span> <span class="ruby-keyword">true</span> ${<span class="ruby-identifier">is_john</span>]}
+<span class="ruby-comment"># => the assertion would pass</span>
+</pre>
+
+
+
+
+ <div class="method-source-code" id="setif-source">
+ <pre><span class="ruby-comment"># File lib/bauxite/actions/setif.rb, line 35</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">setif</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">action</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">try_exec_action</span>(<span class="ruby-identifier">action</span>, <span class="ruby-identifier">args</span>)
+ <span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">variables</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">value</span>
+ <span class="ruby-keyword">true</span>
+<span class="ruby-keyword">end</span></pre>
+ </div>
+
+ </div>
+
+
+
+
+ </div>
+
+
<div id="method-i-source" class="method-detail ">
<div class="method-heading">
<span class="method-name">source</span><span
class="method-args">(text)</span>
@@ -1631,9 +1721,9 @@
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
+ <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>