doc/BigBench.html in bigbench-0.0.4 vs doc/BigBench.html in bigbench-0.0.5
- old
+ new
@@ -80,15 +80,13 @@
<li><a href="#method-c-benchmark">::benchmark</a>
<li><a href="#method-c-benchmarks">::benchmarks</a>
- <li><a href="#method-c-check_config-21">::check_config!</a>
-
<li><a href="#method-c-config">::config</a>
- <li><a href="#method-c-configure-3D">::configure=</a>
+ <li><a href="#method-c-configure">::configure</a>
<li><a href="#method-c-duration">::duration</a>
<li><a href="#method-c-load_test-21">::load_test!</a>
@@ -143,26 +141,24 @@
<li><a href="./BigBench/Bot.html">BigBench::Bot</a>
<li><a href="./BigBench/Configuration.html">BigBench::Configuration</a>
- <li><a href="./BigBench/Configuration/Config.html">BigBench::Configuration::Config</a>
-
- <li><a href="./BigBench/Configuration/InvalidOptions.html">BigBench::Configuration::InvalidOptions</a>
-
<li><a href="./BigBench/Executor.html">BigBench::Executor</a>
- <li><a href="./BigBench/Executor/InvalidCommand.html">BigBench::Executor::InvalidCommand</a>
+ <li><a href="./BigBench/Executor/Executable.html">BigBench::Executor::Executable</a>
<li><a href="./BigBench/Fragment.html">BigBench::Fragment</a>
<li><a href="./BigBench/Fragment/Fragment.html">BigBench::Fragment::Fragment</a>
<li><a href="./BigBench/Output.html">BigBench::Output</a>
<li><a href="./BigBench/PostProcessor.html">BigBench::PostProcessor</a>
+ <li><a href="./BigBench/PostProcessor/Context.html">BigBench::PostProcessor::Context</a>
+
<li><a href="./BigBench/PostProcessor/Environment.html">BigBench::PostProcessor::Environment</a>
<li><a href="./BigBench/PostProcessor/Environment/Appearings.html">BigBench::PostProcessor::Environment::Appearings</a>
<li><a href="./BigBench/PostProcessor/Environment/AttributeCluster.html">BigBench::PostProcessor::Environment::AttributeCluster</a>
@@ -189,10 +185,12 @@
<li><a href="./BigBench/PostProcessor/Statistics.html">BigBench::PostProcessor::Statistics</a>
<li><a href="./BigBench/PostProcessor/Test.html">BigBench::PostProcessor::Test</a>
+ <li><a href="./BigBench/PostProcessor/TestPretty.html">BigBench::PostProcessor::TestPretty</a>
+
<li><a href="./BigBench/Runner.html">BigBench::Runner</a>
<li><a href="./BigBench/Runner/NoBenchmarksDefined.html">BigBench::Runner::NoBenchmarksDefined</a>
<li><a href="./BigBench/Store.html">BigBench::Store</a>
@@ -326,42 +324,10 @@
</div><!-- benchmarks-method -->
- <div id="method-c-check_config-21" class="method-detail ">
-
- <div class="method-heading">
- <span class="method-name">check_config!</span><span
- class="method-args">()</span>
- <span class="method-click-advice">click to toggle source</span>
- </div>
-
-
- <div class="method-description">
-
- <p>Checks if all necessary config options are set and raises an
-<code>InvalidOptions</code> exception if not</p>
-
-
-
- <div class="method-source-code" id="check_config-21-source">
- <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 111</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">check_config!</span>
- <span class="ruby-identifier">raise</span> <span class="ruby-constant">Configuration</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidOptions</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">valid?</span>
- <span class="ruby-keyword">true</span>
-<span class="ruby-keyword">end</span></pre>
- </div><!-- check_config-21-source -->
-
- </div>
-
-
-
-
- </div><!-- check_config-21-method -->
-
-
<div id="method-c-config" class="method-detail ">
<div class="method-heading">
<span class="method-name">config</span><span
class="method-args">()</span>
@@ -378,11 +344,11 @@
</pre>
<div class="method-source-code" id="config-source">
- <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 106</span>
+ <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">config</span>
<span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">config</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- config-source -->
@@ -392,49 +358,51 @@
</div><!-- config-method -->
- <div id="method-c-configure-3D" class="method-detail ">
+ <div id="method-c-configure" class="method-detail ">
<div class="method-heading">
- <span class="method-name">configure=</span><span
- class="method-args">(config)</span>
+ <span class="method-name">configure</span><span
+ class="method-args">() { |config| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Configure the benchmark by supplying a hash of options like this:</p>
-<pre class="ruby"><span class="ruby-constant">BigBench</span>.<span class="ruby-identifier">configure</span> = {
- :<span class="ruby-identifier">duration</span> =<span class="ruby-operator">></span> <span class="ruby-value">10</span>.<span class="ruby-identifier">seconds</span>,
- :<span class="ruby-identifier">output</span> =<span class="ruby-operator">></span> <span class="ruby-string">"test.ljson"</span>,
- :<span class="ruby-identifier">users</span> =<span class="ruby-operator">></span> <span class="ruby-value">20</span>,
- :<span class="ruby-identifier">basic_auth</span> =<span class="ruby-operator">></span> [<span class="ruby-string">'username'</span>, <span class="ruby-string">'secret'</span>]
-}
+<pre class="ruby"><span class="ruby-constant">BigBench</span>.<span class="ruby-identifier">configure</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span>
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">duration</span> = <span class="ruby-value">10</span>.<span class="ruby-identifier">seconds</span>,
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">output</span> = <span class="ruby-string">"test.ljson"</span>,
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">users</span> = <span class="ruby-value">20</span>,
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">basic_auth</span> = [<span class="ruby-string">'username'</span>, <span class="ruby-string">'secret'</span>]
+<span class="ruby-keyword">end</span>
</pre>
<p>Those values can then be set and retreived with
<code>BigBench.config.duration</code>, …</p>
- <div class="method-source-code" id="configure-3D-source">
- <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 97</span>
-<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">configure=</span>(<span class="ruby-identifier">config</span>)
- <span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">configure</span>=(<span class="ruby-identifier">config</span>)
+ <div class="method-source-code" id="configure-source">
+ <pre><span class="ruby-comment"># File lib/bigbench/configuration.rb, line 62</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">configure</span>
+ <span class="ruby-identifier">raise</span> <span class="ruby-string">"No block to configure given"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">block_given?</span>
+ <span class="ruby-keyword">yield</span>(<span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">config</span>)
+ <span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">config</span>
<span class="ruby-keyword">end</span></pre>
- </div><!-- configure-3D-source -->
+ </div><!-- configure-source -->
</div>
- </div><!-- configure-3D-method -->
+ </div><!-- configure-method -->
<div id="method-c-duration" class="method-detail ">
<div class="method-heading">
@@ -492,11 +460,10 @@
<div class="method-source-code" id="load_test-21-source">
<pre><span class="ruby-comment"># File lib/bigbench/runner.rb, line 46</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">load_test!</span>(<span class="ruby-identifier">test</span>)
<span class="ruby-constant">BigBench</span><span class="ruby-operator">::</span><span class="ruby-constant">Benchmark</span>.<span class="ruby-identifier">reset!</span>
<span class="ruby-identifier">eval</span>(<span class="ruby-identifier">test</span>)
- <span class="ruby-identifier">check_config!</span>
<span class="ruby-constant">BigBench</span><span class="ruby-operator">::</span><span class="ruby-constant">Output</span>.<span class="ruby-identifier">loaded_tests</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- load_test-21-source -->
</div>
@@ -574,11 +541,11 @@
</dd></dl>
<div class="method-source-code" id="post_process-source">
- <pre><span class="ruby-comment"># File lib/bigbench/post_processor.rb, line 176</span>
+ <pre><span class="ruby-comment"># File lib/bigbench/post_processor.rb, line 188</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">post_process</span> <span class="ruby-identifier">processor</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span> = {}
<span class="ruby-identifier">raise</span> <span class="ruby-constant">PostProcessor</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidProcessor</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">processor</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-constant">PostProcessor</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">processor</span>, <span class="ruby-identifier">options</span>, &<span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span>) <span class="ruby-operator">:</span> <span class="ruby-constant">PostProcessor</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">processor</span>, <span class="ruby-identifier">options</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- post_process-source -->
@@ -605,11 +572,11 @@
<p>List all initialized post processors</p>
<div class="method-source-code" id="post_processors-source">
- <pre><span class="ruby-comment"># File lib/bigbench/post_processor.rb, line 182</span>
+ <pre><span class="ruby-comment"># File lib/bigbench/post_processor.rb, line 194</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">post_processors</span>
<span class="ruby-constant">PostProcessor</span>.<span class="ruby-identifier">all</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- post_processors-source -->
@@ -667,10 +634,10 @@
<p>Runs all initialized post processors after the trackings have been written</p>
<div class="method-source-code" id="run_post_processors-21-source">
- <pre><span class="ruby-comment"># File lib/bigbench/post_processor.rb, line 187</span>
+ <pre><span class="ruby-comment"># File lib/bigbench/post_processor.rb, line 199</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">run_post_processors!</span>
<span class="ruby-constant">PostProcessor</span>.<span class="ruby-identifier">run!</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- run_post_processors-21-source -->