bigbench 0.0.3 → 0.0.4

data/README.textile

@@ -1,6 +1,15 @@
 h1. BigBench
 
-BigBench is a http penetration tool. It allows you to test the performance of any web server with very high loads.
+BigBench is a http penetration tool. It allows you to test the performance of any web server with very high loads. It:
+
+* Is a fancy ruby solution for local and remote load benchmarking
+* Creates about 16% more load then Apache's JMeter
+* Has an own very easy to use DSL
+* Makes remote testing a breeze with bots
+* Offers an awesome post processor environment to analyze your benchmarks that includes @tracking iteration@, @polynomial regressions@, @normal distributions@, ...
+* Offers the ability to hook in and execute any code after the benchmarks are finished
+* Comes with included post processors that create statistics and graphs
+* Is very easy to extend!
 
 h3. Installation
 
@@ -8,8 +17,7 @@ bc.. gem install bigbench
 
 h3. Further Reading
 
-* "BigBench Website":http://southdesign.github.com/bigbench
-* "BigBench RDoc":http://southdesign.github.com/bigbench/doc/BigBench.html
+* "BigBench RDoc":http://southdesign.github.com/bigbench
 
 h3. Requirements
 
@@ -122,7 +130,7 @@ bc.. module BigBench
     module PostProcessor
         module SamplePostProcessor
             
-            def self.run!
+            def self.run!(options)
                 # Do whatever you want here
             end
             
@@ -136,6 +144,225 @@ bc.. post_process :sample_post_processor
 # or
 post_process BigBench::PostProcessor::SamplePostProcessor
 
+h3. Post Processor Environment
+
+Post processors by default offer a great load of functionality that helps to evaluate the benchmarks. The available methods are:
+
+h4. each_tracking
+
+Iterate over each of the tracking elements. The trackings are read line-by-line. This is the fastest approach and should be used for huge datasets because the trackings are not loaded completely into memory.
+
+bc.. total_trackings, total_errors = 0, 0                
+each_tracking do |tracking|
+    total_trackings += 1
+    total_errors    += 1 unless tracking[:status] == 200
+end
+
+h4. trackings
+
+An array with all tracking hashes in it. The creation might take some time at the first usage, afterwards the array is cached automatically.
+
+bc.. trackings.size # => 650456
+trackings.each do |tracking|
+    puts tracking[:duration]
+end
+
+h4. statistics
+
+Computes the default statistics for any attribute
+
+bc.. # Unclustered statistics
+statistics.durations.max                    # => 78.2
+statistics.durations.min                    # => 12.3
+
+statistics.durations.mean                   # => 45.2
+statistics.durations.average                # => 45.2
+
+statistics.durations.standard_deviation     # => 11.3
+statistics.durations.sd                     # => 11.3
+
+statistics.durations.squared_deviation      # => 60.7
+statistics.durations.variance               # => 60.7
+
+# Time clustered statistics - 1.second
+statistics.requests.max                     # => 42.1
+statistics.requests.min                     # => 12.3
+statistics.methods(:get).max                # => 42.1
+statistics.methods(:get).average            # => 33.1
+statistics.benchmark("index page").average  # => 32.9
+statistics.paths("/").average               # => 12.5
+
+h4. cluster
+
+Clusters the resulting trackings by a timebase. The default timebase is @1.second@ which means, that it groups all trackings to full seconds and calculates the amount of requests and the average duration.
+
+bc.. # Duration is 120 seconds for this example
+
+# 1.second
+cluster.timesteps                       # => [1, 2, ..., 120]
+cluster.durations                       # => [43, 96, ..., 41]
+cluster.requests                        # => [503, 541, ..., 511]
+cluster.methods(:get)                   # => [200, 204, ..., 209]
+cluster.methods(:post)                  # => [201, 102, ..., 401]
+cluster.statuses(200)                   # => [501, 502, ..., 102]
+cluster.statuses(404)                   # => [3, 1, ..., 0]
+cluster.paths("/")                      # => [401, 482, ..., 271]
+cluster.paths("/logout")                # => [56, 51, ..., 38]
+cluster.benchmark("index")              # => [342, 531, ..., 234]
+cluster.benchmark("user")               # => [22, 41, ..., 556]
+
+# 1.minute
+cluster(1.minute).timesteps             # => [0, 1]
+cluster(1.minute).durations             # => [42, 44]
+cluster(1.minute).requests              # => [24032, 21893]
+cluster(1.minute).methods(:get)         # => [200, 204]
+cluster(1.minute).statuses(200)         # => [501, 502]
+cluster(1.minute).paths("/")            # => [401, 482]
+cluster(1.minute).benchmark("user")     # => [22, 41]
+
+# 30.seconds
+cluster(30.seconds).timesteps           # => [0, 1, 2, 3]
+cluster(30.seconds).durations           # => [42, 44, 41, 40]
+cluster(30.seconds).requests            # => [11023, 10234, 12345, 13789]
+cluster(30.seconds).methods(:get)       # => [200, 204, 34, 124]
+cluster(30.seconds).statuses(200)       # => [501, 502, 243, 57]
+cluster(30.seconds).paths("/")          # => [401, 482, 124, 234]
+cluster(30.seconds).benchmark("user")   # => [22, 41, 12, 51]
+
+h4. appearing
+
+Lists the unique attribute values that appeared in all trackings or the selected tracking scope.
+
+bc.. appearing.statuses  # => [200, 404]
+appearing.methods   # => ["get", "post"]
+appearing.paths     # => ["/", "/basic/auth"
+
+h4. polynomial_regression
+
+The polynomial regression creates a function that tries to map the test data best. With this function you have the ability do derivate and thereby plot the changes of the tested system over time. The degree of the regression can be freely chosen.
+
+bc.. # Linear regression by default
+polynomial_regression.durations.x                               # => [1, 2, ..., 120]
+polynomial_regression.durations.y                               # => [45, 23, ..., 36]
+polynomial_regression.requests.y                                # => [43, 45, ..., 62]
+polynomial_regression.methods(:get).y                           # => [23, 62, ..., 23]
+polynomial_regression.statuses(200).y                           # => [51, 22, ..., 15]
+polynomial_regression.paths("/").y                              # => [78, 12, ..., 63]
+polynomial_regression.benchmarks("index page").y                # => [12, 45, ..., 23]
+polynomial_regression.durations.degree                          # => 1
+polynomial_regression.durations.formula                         # => "43.00886000234 + 0.0167548964060689x^1"
+
+# 1. Derivation
+polynomial_regression.durations.derivation(1)                   # => [0.01, 0.01, ..., 0.01]
+polynomial_regression.requests.derivation(1)                    # => [405, 405, ..., 406]
+polynomial_regression.methods(:get).derivation(1)               # => [23, 62, ..., 23]
+polynomial_regression.statuses(200).derivation(1)               # => [51, 22, ..., 15]
+polynomial_regression.paths("/").derivation(1)                  # => [78, 12, ..., 63]
+polynomial_regression.benchmarks("index page").derivation(1)    # => [12, 45, ..., 23]
+polynomial_regression.durations.formula(1)                      # => "0.0167548964060689"
+
+# Quadratic regression
+polynomial_regression(:degree => 2).requests.x                  # => [1, 2, ..., 120]
+polynomial_regression(:degree => 2).durations.y                 # => [43, 41, ..., 44]
+polynomial_regression(:degree => 2).requests.y                  # => [43, 41, ..., 44]
+polynomial_regression(:degree => 2).methods(:get).y             # => [23, 62, ..., 23]
+polynomial_regression(:degree => 2).statuses(200).y             # => [51, 22, ..., 15]
+polynomial_regression(:degree => 2).paths("/").y                # => [78, 12, ..., 63]
+polynomial_regression(:degree => 2).benchmarks("index page").y  # => [12, 45, ..., 23]
+polynomial_regression(:degree => 2).requests.formula            # => "33.00886000234 + 0.0167548964060689x^1 + 0.0167548964060689x^2"
+
+# Different timebase clustering
+polynomial_regression(:degree => 2, :timebase => 1.minute).requests.x                   # => [0, 1]
+polynomial_regression(:degree => 2, :timebase => 1.minute).requests.y                   # => [24032, 21893]
+polynomial_regression(:degree => 2, :timebase => 1.minute).durations.y                  # => [43, 41]
+polynomial_regression(:degree => 2, :timebase => 1.minute).requests.y                   # => [43, 41]
+polynomial_regression(:degree => 2, :timebase => 1.minute).methods(:get).y              # => [23, 62]
+polynomial_regression(:degree => 2, :timebase => 1.minute).statuses(200).y              # => [51, 22]
+polynomial_regression(:degree => 2, :timebase => 1.minute).paths("/").y                 # => [78, 12]
+polynomial_regression(:degree => 2, :timebase => 1.minute).benchmarks("index page").y   # => [12, 45]
+
+h4. normal_distribution
+
+The normal distribution method creates a Gaussian bell function that visualizes the distribution of a special attribute. If you want to know if all your requests take about the same time, or if they vary a lot this is method to use. The x-values are automatically scaled to 4-times the variance around the mean, so it should map the whole bell all the time.
+
+bc.. # Normal distribution without time clustering
+normal_distribution.durations.x                               # => [1, 2, ..., 120]
+normal_distribution.durations.y                               # => [45, 23, ..., 36]
+normal_distribution.durations.formula                         # => "(1 / (10.242257627240862 * sqrt(2*PI))) * exp(-1 * ((x - 2.04671984377919)^2) / (2*10.242257627240862))"
+
+# Normal distribution with default time slicing of 1.second
+normal_distribution.requests.y                                # => [43, 45, ..., 62]
+normal_distribution.methods(:get).y                           # => [23, 62, ..., 23]
+normal_distribution.statuses(200).y                           # => [51, 22, ..., 15]
+normal_distribution.paths("/").y                              # => [78, 12, ..., 63]
+normal_distribution.benchmarks("index page").y                # => [12, 45, ..., 23]
+
+# Normal distribution with custom time slicing
+normal_distribution(1.minute).requests.y                      # => [43, 45, ..., 62]
+normal_distribution(1.minute).methods(:get).y                 # => [23, 62, ..., 23]
+normal_distribution(1.minute).statuses(200).y                 # => [51, 22, ..., 15]
+normal_distribution(1.minute).paths("/").y                    # => [78, 12, ..., 63]
+normal_distribution(1.minute).benchmarks("index page").y      # => [12, 45, ..., 23]
+
+h4. scope_to_benchmark
+
+The scope_to_benchmark method lets you scope any result to a single benchmark. The values computed in this block have entirely been created by this benchmark.
+
+bc.. # Results for the index page benchmark
+scope_to_benchmark "index page" do
+    cluster.durations                       # => [43, 96, ..., 41]
+    cluster.requests                        # => [503, 541, ..., 511]
+    cluster.methods(:get)                   # => [200, 204, ..., 209]
+    cluster.methods(:post)                  # => [201, 102, ..., 401]
+    polynomial_regression.durations.x       # => [1, 2, ..., 120]
+    polynomial_regression.durations.y       # => [45, 23, ..., 36]
+    normal_distribution.requests.y          # => [43, 45, ..., 62]
+    normal_distribution.methods(:get).y     # => [23, 62, ..., 23]
+    normal_distribution.statuses(200).y     # => [51, 22, ..., 15]
+end
+
+# Results for the login and logout benchmark
+scope_to_benchmark "login and logout" do
+    cluster.durations                       # => [43, 96, ..., 41]
+    cluster.requests                        # => [300, 141, ..., 511]
+    cluster.methods(:get)                   # => [100, 204, ..., 209]
+    cluster.methods(:post)                  # => [101, 102, ..., 401]
+    polynomial_regression.durations.x       # => [1, 2, ..., 120]
+    polynomial_regression.durations.y       # => [45, 23, ..., 36]
+    normal_distribution.requests.y          # => [43, 45, ..., 62]
+    normal_distribution.methods(:get).y     # => [23, 62, ..., 23]
+    normal_distribution.statuses(200).y     # => [51, 22, ..., 15]
+end
+
+h4. each_benchmark
+
+Iterates over all benchmarks and automatically scopes the results at each iteration to the current benchmark. This is useful if you want to access the detailed differences of each benchmark.
+
+bc.. # Iterate over all benchmarks and calculate the results
+each_benchmark do |benchmark|
+    benchmark.name                          # => "index page" then "login and logout"
+    
+    cluster.durations                       # => [43, 96, ..., 41]
+    cluster.requests                        # => [300, 141, ..., 511]
+    cluster.methods(:get)                   # => [100, 204, ..., 209]
+    cluster.methods(:post)                  # => [101, 102, ..., 401]
+    polynomial_regression.durations.x       # => [1, 2, ..., 120]
+    polynomial_regression.durations.y       # => [45, 23, ..., 36]
+    normal_distribution.requests.y          # => [43, 45, ..., 62]
+    normal_distribution.methods(:get).y     # => [23, 62, ..., 23]
+    normal_distribution.statuses(200).y     # => [51, 22, ..., 15]
+end
+
+h3. Running Post Processors separately
+
+You can also re-run the currently defined post processors or run a separate post processor you never even defined in the first place without collecting the test data again like this:
+
+bc.. # Re-run the postprocessors defined in example.rb
+bigbench run postprocessors example.rb
+
+# Run a separate post processor independently - the already defined post processors are ignored
+bigbench run postprocessor example.rb statistics
+
 p. Contribute, create great post processors and send me a pull request!
 
 h3. Statistics
@@ -198,6 +425,29 @@ h3. Test Results
 
 h2. Version History
 
+h3. 0.4
+
+* Added command line tool to run the post processors again
+* Added command line tool to run any post processor on already collected data
+* Pimped the post processor environment. Available functions now include:
+* trackings array is now available with all hashes of the trackings at once
+* *Clustering by any timebase*, e.g. @1.second@, @20.seconds@, or @2.minutes@ which automatically calculates these values per time slice:
+** @average duration@
+** @requests@
+** @methods(:get, :post, :put, ...)@
+** @statuses(200, 404, 403, ...)@
+** @paths("/", "/logout", "/login", ...)@
+** @benchmarks("index page", "user behavior", "bot crawling", ...)@
+* *Polynomial Regression of any Degree* for all attributes including the derivatives and a formula printer
+* *Statistics* with the following values for all attributes:
+** @max@
+** @min@
+** @mean@
+** @standard_deviation@
+** @squared_deviation@ or @variance@
+* *Gaussian Normal Distribution* for all attributes including a *formula printer*
+* *Appearing* method to quickly list all appearing @statuses@, @methods@, @paths@ in the test results
+
 h3. 0.3
 
 * Added post processors hook that run after the benchmark with a simple plugin structure

data/Rakefile

@@ -1,17 +1,51 @@
 require "bundler/gem_tasks"
 require "rack"
+require "RedCloth"
+require "redcloth-formatters-rdoc"
+require "rdoc/task"
 
-namespace :bigbench do
+
+desc "Create and open documentation"
+task :doc do
   
-  desc "Create and open documentation"
-  task :doc do
-    `rdoc --main BigBench --include lib/bigbench/help/ && open doc/index.html`
-  end
+  # Compile the readme to the rdoc format
+  readme_textile = File.open('README.textile', 'r+'){ |file| file.read }
+  readme_rdoc = RedCloth.new(readme_textile).to_rdoc  
+  File.open('README.rdoc', 'w+'){ |file| file.write(readme_rdoc) }
   
-  desc "Start Thin RDoc Testserver"
-  task :testserver do
-    load "spec/lib/test_web_server.rb"
-    Rack::Handler::Thin.run Sinatra::Application, :Port => 3001
+  # Create rdoc with the readme as main file
+  `rdoc --main README.rdoc --include lib/bigbench/help/`
+  
+  RDoc::Task.new do |rdoc|
+    rdoc.main = "README.rdoc"
+    rdoc.rdoc_files.include("README.rdoc", "lib/bigbench/help/")
   end
   
+  # Fix RDocs inability to handle tables
+  index_html = File.open('doc/index.html', 'r+'){ |file| file.read }
+  index_html.gsub! '&lt;', '<'
+  index_html.gsub! '&gt;', '>'
+  index_html.gsub! '<p><table></p>', '<table>'
+  index_html.gsub! '<pre><tr>', '<tr>'
+  index_html.gsub! '</tr></pre>', '</tr>'
+  index_html.gsub! '<p></table></p>', '</table>'
+  File.open('doc/index.html', 'w+'){ |file| file.write(index_html) }
+  
+  # Add table style
+  rdoc_css = File.open('doc/rdoc.css', 'r+'){ |file| file.read }
+  rdoc_css += "\n table{ border: 1px dashed #D3D3D3; line-height: 30px; margin-top: 10px; border-collapse: collapse; }"
+  rdoc_css += "\n td{ padding-left:20px; padding-right:20px; border-top: 1px solid #E4E4E4; }"
+  rdoc_css += "\n th{ padding-left:20px; padding-right:20px; text-align:left; }"
+  File.open('doc/rdoc.css', 'w+'){ |file| file.write(rdoc_css) }
+  
+  # Clean up the rdoc file
+  File.delete("README.rdoc")
+  `open doc/index.html`
+  
+end
+
+desc "Start Thin RDoc Testserver"
+task :server do
+  load "spec/lib/test_web_server.rb"
+  Rack::Handler::Thin.run Sinatra::Application, :Port => 3001
 end

data/doc/Array.html

@@ -0,0 +1,288 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>class Array - RDoc Documentation</title>
+
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+
+
+<body id="top" class="class">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/bigbench/post_processor/environment.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    <nav id="parent-class-section" class="section">
+  <h3 class="section-header">Parent</h3>
+  
+  <p class="link"><a href="Object.html">Object</a>
+  
+</nav>
+
+    
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+
+  <ul class="link-list">
+    
+    <li><a href="#method-i-average">#average</a>
+    
+    <li><a href="#method-i-sum">#sum</a>
+    
+  </ul>
+</nav>
+
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="./Gemfile.html">Gemfile</a>
+  
+    <li class="file"><a href="./README_rdoc.html">README</a>
+  
+    <li class="file"><a href="./Rakefile.html">Rakefile</a>
+  
+    <li class="file"><a href="./lib/bigbench/help/executor_txt.html">executor</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./BigBench.html">BigBench</a>
+  
+    <li><a href="./BigBench/Benchmark.html">BigBench::Benchmark</a>
+  
+    <li><a href="./BigBench/Benchmark/Benchmark.html">BigBench::Benchmark::Benchmark</a>
+  
+    <li><a href="./BigBench/Benchmark/Looper.html">BigBench::Benchmark::Looper</a>
+  
+    <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/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/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>
+  
+    <li><a href="./BigBench/PostProcessor/Environment/BenchmarkNotFound.html">BigBench::PostProcessor::Environment::BenchmarkNotFound</a>
+  
+    <li><a href="./BigBench/PostProcessor/Environment/Cluster.html">BigBench::PostProcessor::Environment::Cluster</a>
+  
+    <li><a href="./BigBench/PostProcessor/Environment/NormalDistribution.html">BigBench::PostProcessor::Environment::NormalDistribution</a>
+  
+    <li><a href="./BigBench/PostProcessor/Environment/PolynomialRegression.html">BigBench::PostProcessor::Environment::PolynomialRegression</a>
+  
+    <li><a href="./BigBench/PostProcessor/Environment/Statistics.html">BigBench::PostProcessor::Environment::Statistics</a>
+  
+    <li><a href="./BigBench/PostProcessor/Graphs.html">BigBench::PostProcessor::Graphs</a>
+  
+    <li><a href="./BigBench/PostProcessor/Graphs/LineGraph.html">BigBench::PostProcessor::Graphs::LineGraph</a>
+  
+    <li><a href="./BigBench/PostProcessor/Graphs/PieGraph.html">BigBench::PostProcessor::Graphs::PieGraph</a>
+  
+    <li><a href="./BigBench/PostProcessor/InvalidProcessor.html">BigBench::PostProcessor::InvalidProcessor</a>
+  
+    <li><a href="./BigBench/PostProcessor/Processor.html">BigBench::PostProcessor::Processor</a>
+  
+    <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/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>
+  
+    <li><a href="./BigBench/Tracker.html">BigBench::Tracker</a>
+  
+    <li><a href="./BigBench/Tracker/Tracker.html">BigBench::Tracker::Tracker</a>
+  
+    <li><a href="./Array.html">Array</a>
+  
+    <li><a href="./EventMachineLoop.html">EventMachineLoop</a>
+  
+    <li><a href="./Float.html">Float</a>
+  
+    <li><a href="./Helpers.html">Helpers</a>
+  
+    <li><a href="./Object.html">Object</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="class">class Array</h1>
+
+  <div id="description" class="description">
+    
+<p>Adding the sum and average methods to the default array</p>
+
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Instance Methods</h3>
+
+    
+      <div id="method-i-average" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">average</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+
+          
+          <div class="method-source-code" id="average-source">
+            <pre><span class="ruby-comment"># File lib/bigbench/post_processor/environment.rb, line 22</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">average</span>
+  <span class="ruby-identifier">result</span> = <span class="ruby-identifier">sum</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">size</span>.<span class="ruby-identifier">to_f</span>
+  <span class="ruby-identifier">result</span>.<span class="ruby-identifier">nan?</span> <span class="ruby-operator">?</span> <span class="ruby-value">0</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">result</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- average-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- average-method -->
+
+    
+      <div id="method-i-sum" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">sum</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+
+          
+          <div class="method-source-code" id="sum-source">
+            <pre><span class="ruby-comment"># File lib/bigbench/post_processor/environment.rb, line 18</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">sum</span>
+  <span class="ruby-identifier">reduce</span>(<span class="ruby-value">:+</span>).<span class="ruby-identifier">to_f</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- sum-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- sum-method -->
+
+    
+    </section><!-- public-instance-method-details -->
+  
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+