bigbench 0.0.1

data/doc/js/search.js

@@ -0,0 +1,94 @@
+Search = function(data, input, result) {
+  this.data = data;
+  this.$input = $(input);
+  this.$result = $(result);
+
+  this.$current = null;
+  this.$view = this.$result.parent();
+  this.searcher = new Searcher(data.index);
+  this.init();
+}
+
+Search.prototype = $.extend({}, Navigation, new function() {
+  var suid = 1;
+
+  this.init = function() {
+    var _this = this;
+    var observer = function() {
+      _this.search(_this.$input[0].value);
+    };
+    this.$input.keyup(observer);
+    this.$input.click(observer); // mac's clear field
+
+    this.searcher.ready(function(results, isLast) {
+      _this.addResults(results, isLast);
+    })
+
+    this.initNavigation();
+    this.setNavigationActive(false);
+  }
+
+  this.search = function(value, selectFirstMatch) {
+    value = jQuery.trim(value).toLowerCase();
+    if (value) {
+      this.setNavigationActive(true);
+    } else {
+      this.setNavigationActive(false);
+    }
+
+    if (value == '') {
+      this.lastQuery = value;
+      this.$result.empty();
+      this.setNavigationActive(false);
+    } else if (value != this.lastQuery) {
+      this.lastQuery = value;
+      this.firstRun = true;
+      this.searcher.find(value);
+    }
+  }
+
+  this.addResults = function(results, isLast) {
+    var target = this.$result.get(0);
+    if (this.firstRun && (results.length > 0 || isLast)) {
+      this.$current = null;
+      this.$result.empty();
+    }
+
+    for (var i=0, l = results.length; i < l; i++) {
+      target.appendChild(this.renderItem.call(this, results[i]));
+    };
+
+    if (this.firstRun && results.length > 0) {
+      this.firstRun = false;
+      this.$current = $(target.firstChild);
+      this.$current.addClass('current');
+    }
+    if (jQuery.browser.msie) this.$element[0].className += '';
+  }
+
+  this.move = function(isDown) {
+    if (!this.$current) return;
+    var $next = this.$current[isDown ? 'next' : 'prev']();
+    if ($next.length) {
+      this.$current.removeClass('current');
+      $next.addClass('current');
+      this.scrollIntoView($next[0], this.$view[0]);
+      this.$current = $next;
+    }
+    return true;
+  }
+
+  this.hlt = function(html) {
+    return this.escapeHTML(html).
+      replace(/\u0001/g, '<em>').
+      replace(/\u0002/g, '</em>');
+  }
+
+  this.escapeHTML = function(html) {
+    return html.replace(/[&<>]/g, function(c) {
+      return '&#' + c.charCodeAt(0) + ';';
+    });
+  }
+
+});
+

data/doc/js/search_index.js

@@ -0,0 +1 @@
+var search_data = {"index":{"searchIndex":["bigbench","benchmark","benchmark","bot","configuration","config","invalidoptions","executor","invalidcommand","fragment","fragment","output","runner","nobenchmarksdefined","store","tracker","tracker","float","helpers","object","testwebserver","add()","add_option()","add_tracking()","all()","benchmark()","benchmarks()","bot_is_checking()","bot_is_working()","bot_received_test_instructions()","bot_stopped_working()","bots()","check_config!()","check_test!()","config()","config()","configure=()","configure=()","count_trackings()","delete()","deployed_test()","done()","duration()","finished_bots_loop()","finished_running_benchmarks()","finished_writing_trackings()","get()","is_running?()","load_test!()","loaded_tests()","max_duration()","message()","message()","message()","new()","new()","new()","new()","parse()","pop_tracking()","post()","put()","reset()","reset!()","reset!()","reset!()","reset!()","run!()","run!()","run!()","run!()","run!()","running?()","running_benchmarks()","running_bots_loop()","setup!()","start()","start()","start()","starting_bots_loop()","stop()","stop()","test()","test=()","to_milliseconds()","track()","track!()","valid?()","write_local_trackings_to_file!()","write_store_trackings_to_file!()","write_trackings_to_store!()","writing_trackings()","wrote_trackings()","gemfile","rakefile","executor"],"longSearchIndex":["bigbench","bigbench::benchmark","bigbench::benchmark::benchmark","bigbench::bot","bigbench::configuration","bigbench::configuration::config","bigbench::configuration::invalidoptions","bigbench::executor","bigbench::executor::invalidcommand","bigbench::fragment","bigbench::fragment::fragment","bigbench::output","bigbench::runner","bigbench::runner::nobenchmarksdefined","bigbench::store","bigbench::tracker","bigbench::tracker::tracker","float","helpers","object","testwebserver","bigbench::benchmark::add()","bigbench::configuration::config::add_option()","bigbench::store::add_tracking()","bigbench::benchmark::all()","bigbench::benchmark()","bigbench::benchmarks()","bigbench::output::bot_is_checking()","bigbench::store::bot_is_working()","bigbench::output::bot_received_test_instructions()","bigbench::store::bot_stopped_working()","bigbench::store::bots()","bigbench::check_config!()","bigbench::bot::check_test!()","bigbench::config()","bigbench::configuration::config()","bigbench::configure=()","bigbench::configuration::configure=()","bigbench::store::count_trackings()","bigbench::fragment::delete()","bigbench::output::deployed_test()","bigbench::output::done()","bigbench::duration()","bigbench::output::finished_bots_loop()","bigbench::output::finished_running_benchmarks()","bigbench::output::finished_writing_trackings()","bigbench::fragment::get()","bigbench::benchmark::benchmark#is_running?()","bigbench::load_test!()","bigbench::output::loaded_tests()","bigbench::benchmark::max_duration()","bigbench::configuration::invalidoptions#message()","bigbench::executor::invalidcommand#message()","bigbench::runner::nobenchmarksdefined#message()","bigbench::benchmark::benchmark::new()","bigbench::configuration::config::new()","bigbench::fragment::fragment::new()","bigbench::tracker::tracker::new()","bigbench::fragment::parse()","bigbench::store::pop_tracking()","bigbench::fragment::post()","bigbench::fragment::put()","bigbench::output::reset()","bigbench::benchmark::reset!()","bigbench::configuration::reset!()","bigbench::fragment::reset!()","bigbench::store::reset!()","bigbench::run!()","bigbench::benchmark::benchmark#run!()","bigbench::executor::run!()","bigbench::fragment::fragment#run!()","bigbench::runner::run!()","bigbench::store::running?()","bigbench::output::running_benchmarks()","bigbench::output::running_bots_loop()","bigbench::store::setup!()","bigbench::output::start()","bigbench::store::start()","testwebserver::start()","bigbench::output::starting_bots_loop()","bigbench::store::stop()","testwebserver::stop()","bigbench::store::test()","bigbench::store::test=()","float#to_milliseconds()","bigbench::tracker::tracker#track()","bigbench::fragment::fragment#track!()","bigbench::configuration::config#valid?()","bigbench::write_local_trackings_to_file!()","bigbench::write_store_trackings_to_file!()","bigbench::write_trackings_to_store!()","bigbench::output::writing_trackings()","bigbench::output::wrote_trackings()","","",""],"info":[["BigBench","","BigBench.html","",""],["BigBench::Benchmark","","BigBench/Benchmark.html","","<p>Holds the actual benchmark methods. A benchmark is a sequence of requests\nto the same server, but to …\n"],["BigBench::Benchmark::Benchmark","","BigBench/Benchmark/Benchmark.html","",""],["BigBench::Bot","","BigBench/Bot.html","","<p>A bot is used for remote testing. It is running in the background of a\nmachine and waits for tests to …\n"],["BigBench::Configuration","","BigBench/Configuration.html","","<p>The configuration is configured in the test reciepts and looks like this:\n\n<pre>BigBench.configure = {\n  :duration ...</pre>\n"],["BigBench::Configuration::Config","","BigBench/Configuration/Config.html","","<p>The main config object for BigBench. It allows config options to be added\nand forces some default values …\n"],["BigBench::Configuration::InvalidOptions","","BigBench/Configuration/InvalidOptions.html","","<p>Is returned if the configuration is not filled sufficiently\n"],["BigBench::Executor","","BigBench/Executor.html","","<p>Dispatches the command line commands to BigBench calls. Available commands\nare:\n<p>Usage:\n\n<pre># Local Testing ...</pre>\n"],["BigBench::Executor::InvalidCommand","","BigBench/Executor/InvalidCommand.html","","<p>Is thrown when the command is not known\n"],["BigBench::Fragment","","BigBench/Fragment.html","","<p>A fragment represents a single http request inside a benchmark. It is\nexecuted by the benchmark and resides …\n"],["BigBench::Fragment::Fragment","","BigBench/Fragment/Fragment.html","",""],["BigBench::Output","","BigBench/Output.html","","<p>This module is used to keep all the command line outputs in a single place.\nThe output module gets notified …\n"],["BigBench::Runner","","BigBench/Runner.html","","<p>The runner runs all available benchmarks and returns as soon as all of them\nare finished. Additionally …\n"],["BigBench::Runner::NoBenchmarksDefined","","BigBench/Runner/NoBenchmarksDefined.html","","<p>Is thrown when no benchmarks are defined\n"],["BigBench::Store","","BigBench/Store.html","","<p>The store encapsulates the communication with the redis key-value store. To\nthe outside it looks like …\n"],["BigBench::Tracker","","BigBench/Tracker.html","","<p>The tracker records all request results a benchmark makes. When the\nbenchmark is finished, the trackings …\n"],["BigBench::Tracker::Tracker","","BigBench/Tracker/Tracker.html","",""],["Float","","Float.html","","<p>Adds the <code>to_milliseconds</code> method to any float value\n"],["Helpers","","Helpers.html","",""],["Object","","Object.html","",""],["TestWebServer","","TestWebServer.html","",""],["add","BigBench::Benchmark","BigBench/Benchmark.html#method-c-add","(options, &block)","<p>Adds a benchmark to the <code>BigBench</code> module. It can later be\nretrieved with the <code>all</code> method.\n"],["add_option","BigBench::Configuration::Config","BigBench/Configuration/Config.html#method-c-add_option","(name)",""],["add_tracking","BigBench::Store","BigBench/Store.html#method-c-add_tracking","(tracking)","<p>Add a tracking to the trackings\n"],["all","BigBench::Benchmark","BigBench/Benchmark.html#method-c-all","()","<p>Returns all benchmarks that are registered\n"],["benchmark","BigBench","BigBench.html#method-c-benchmark","(options)","<p>Add a benchmark like this:\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">benchmark</span> <span class=\"ruby-string\">&quot;default website pages&quot;</span> =<span class=\"ruby-operator\">&gt;</span> <span class=\"ruby-string\">&quot;http://localhost:3000&quot;</span> <span class=\"ruby-keyword\">do</span>\n   <span class=\"ruby-identifier\">get</span> <span class=\"ruby-string\">&quot;/&quot;</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["benchmarks","BigBench","BigBench.html#method-c-benchmarks","()","<p>List all available benchmarks\n"],["bot_is_checking","BigBench::Output","BigBench/Output.html#method-c-bot_is_checking","()",""],["bot_is_working","BigBench::Store","BigBench/Store.html#method-c-bot_is_working","(id)","<p>Adds a bot to the currently working bots list\n"],["bot_received_test_instructions","BigBench::Output","BigBench/Output.html#method-c-bot_received_test_instructions","()",""],["bot_stopped_working","BigBench::Store","BigBench/Store.html#method-c-bot_stopped_working","(id)","<p>Removes a bot to the currently working bots list\n"],["bots","BigBench::Store","BigBench/Store.html#method-c-bots","()","<p>Shows all currently working bots\n"],["check_config!","BigBench","BigBench.html#method-c-check_config-21","()","<p>Checks if all necessary config options are set and raises an\n<code>InvalidOptions</code> exception if not\n"],["check_test!","BigBench::Bot","BigBench/Bot.html#method-c-check_test-21","()","<p>Checks if there is a new test waiting on the store.\n<p>If yes, it loads this test and executes it. After …\n"],["config","BigBench","BigBench.html#method-c-config","()","<p>Set and retreive the config values like this:\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">BigBench</span>.<span class=\"ruby-identifier\">config</span>.<span class=\"ruby-identifier\">duration</span> <span class=\"ruby-comment\"># =&gt; 10.seconds</span>\n<span class=\"ruby-constant\">BigBench</span>.<span class=\"ruby-identifier\">config</span>.<span class=\"ruby-identifier\">duration</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["config","BigBench::Configuration","BigBench/Configuration.html#method-c-config","()","<p>Returns the current config object\n"],["configure=","BigBench","BigBench.html#method-c-configure-3D","(config)","<p>Configure the benchmark by supplying a hash of options like this:\n\n<pre class=\"ruby\"><span class=\"ruby-constant\">BigBench</span>.<span class=\"ruby-identifier\">configure</span> = {\n  :<span class=\"ruby-identifier\">duration</span> =<span class=\"ruby-operator\">&gt;</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["configure=","BigBench::Configuration","BigBench/Configuration.html#method-c-configure-3D","(config)","<p>Configures the benchmarks with a hash. If the config methods are not\npresent yet, they are added to the …\n"],["count_trackings","BigBench::Store","BigBench/Store.html#method-c-count_trackings","()","<p>How many trackings are in the list\n"],["delete","BigBench::Fragment","BigBench/Fragment.html#method-c-delete","(path, params = {})","<p>Performs a DELETE request to the given url, e.g.\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">delete</span> <span class=\"ruby-string\">&quot;/books/5&quot;</span>, { :<span class=\"ruby-identifier\">user</span> =<span class=\"ruby-operator\">&gt;</span> <span class=\"ruby-string\">&quot;some@sample.com&quot;</span>, :<span class=\"ruby-identifier\">password</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["deployed_test","BigBench::Output","BigBench/Output.html#method-c-deployed_test","()",""],["done","BigBench::Output","BigBench/Output.html#method-c-done","()",""],["duration","BigBench","BigBench.html#method-c-duration","()","<p>Returns the duration of all benchmarks - ergo the duration of the longest\none\n"],["finished_bots_loop","BigBench::Output","BigBench/Output.html#method-c-finished_bots_loop","()",""],["finished_running_benchmarks","BigBench::Output","BigBench/Output.html#method-c-finished_running_benchmarks","()",""],["finished_writing_trackings","BigBench::Output","BigBench/Output.html#method-c-finished_writing_trackings","(count)",""],["get","BigBench::Fragment","BigBench/Fragment.html#method-c-get","(path)","<p>Performs a GET request to the given url, e.g.\n\n<pre>get &quot;/some/page&quot;</pre>\n"],["is_running?","BigBench::Benchmark::Benchmark","BigBench/Benchmark/Benchmark.html#method-i-is_running-3F","()","<p>Returns if this benchmark is currently running\n"],["load_test!","BigBench","BigBench.html#method-c-load_test-21","(test)","<p>Loads a test from a string file that is either parsed from a local file or\nretreived from the key-value …\n"],["loaded_tests","BigBench::Output","BigBench/Output.html#method-c-loaded_tests","()",""],["max_duration","BigBench::Benchmark","BigBench/Benchmark.html#method-c-max_duration","()","<p>Returns the longest duration of all benchmarks\n"],["message","BigBench::Configuration::InvalidOptions","BigBench/Configuration/InvalidOptions.html#method-i-message","()",""],["message","BigBench::Executor::InvalidCommand","BigBench/Executor/InvalidCommand.html#method-i-message","()",""],["message","BigBench::Runner::NoBenchmarksDefined","BigBench/Runner/NoBenchmarksDefined.html#method-i-message","()",""],["new","BigBench::Benchmark::Benchmark","BigBench/Benchmark/Benchmark.html#method-c-new","(name, url, options, &block)","<p>Initizalizes a new benchmark\n"],["new","BigBench::Configuration::Config","BigBench/Configuration/Config.html#method-c-new","()",""],["new","BigBench::Fragment::Fragment","BigBench/Fragment/Fragment.html#method-c-new","(benchmark, path, method, params = {})",""],["new","BigBench::Tracker::Tracker","BigBench/Tracker/Tracker.html#method-c-new","()",""],["parse","BigBench::Fragment","BigBench/Fragment.html#method-c-parse","(benchmark, &block)","<p>Evaluates a benchmark block full of puts and gets and returns an array of\nfully configured fragments …\n"],["pop_tracking","BigBench::Store","BigBench/Store.html#method-c-pop_tracking","()","<p>Pop a tracking from the beginning of the list\n"],["post","BigBench::Fragment","BigBench/Fragment.html#method-c-post","(path, params = {})","<p>Performs a POST request to the given url, e.g.\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">post</span> <span class=\"ruby-string\">&quot;/login&quot;</span>, { :<span class=\"ruby-identifier\">user</span> =<span class=\"ruby-operator\">&gt;</span> <span class=\"ruby-string\">&quot;some@sample.com&quot;</span>, :<span class=\"ruby-identifier\">password</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["put","BigBench::Fragment","BigBench/Fragment.html#method-c-put","(path, params = {})","<p>Performs a PUT request to the given url, e.g.\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">put</span> <span class=\"ruby-string\">&quot;/books&quot;</span>, { :<span class=\"ruby-identifier\">book</span> =<span class=\"ruby-operator\">&gt;</span> <span class=\"ruby-string\">&quot;Some book content&quot;</span> }\n</pre>\n"],["reset","BigBench::Output","BigBench/Output.html#method-c-reset","()",""],["reset!","BigBench::Benchmark","BigBench/Benchmark.html#method-c-reset-21","()","<p>Resets all benchmarks\n"],["reset!","BigBench::Configuration","BigBench/Configuration.html#method-c-reset-21","()","<p>Resets the config object\n"],["reset!","BigBench::Fragment","BigBench/Fragment.html#method-c-reset-21","()","<p>Reset all fragments\n"],["reset!","BigBench::Store","BigBench/Store.html#method-c-reset-21","()","<p>Deletes all BigBench related keys on the redis store\n"],["run!","BigBench","BigBench.html#method-c-run-21","()","<p>Runs all initialized benchmarks\n"],["run!","BigBench::Benchmark::Benchmark","BigBench/Benchmark/Benchmark.html#method-i-run-21","()","<p>Execute this benchmark\n"],["run!","BigBench::Executor","BigBench/Executor.html#method-c-run-21","(argv)","<p>Parses and runs the BigBench funtion that is supplied via the commandline’s\nARGV. It throws an <code>InvalidCommand</code> …\n"],["run!","BigBench::Fragment::Fragment","BigBench/Fragment/Fragment.html#method-i-run-21","(http)","<p>Initiates the request in the context of a <code>Net::HTTP.start</code>\nblock\n"],["run!","BigBench::Runner","BigBench/Runner.html#method-c-run-21","()","<p>Runs all benchmarks\n"],["running?","BigBench::Store","BigBench/Store.html#method-c-running-3F","()","<p>Returns true if a bot test has been started\n"],["running_benchmarks","BigBench::Output","BigBench/Output.html#method-c-running_benchmarks","()",""],["running_bots_loop","BigBench::Output","BigBench/Output.html#method-c-running_bots_loop","(bots)",""],["setup!","BigBench::Store","BigBench/Store.html#method-c-setup-21","(url = \"localhost:6379\", password = nil)","<p>Setup the redis storage. Default values are <code>localhost:6379</code> and\nno password. This needs to be called for …\n"],["start","BigBench::Output","BigBench/Output.html#method-c-start","()",""],["start","BigBench::Store","BigBench/Store.html#method-c-start","()","<p>Start the tests for all bots by setting the running key\n"],["start","TestWebServer","TestWebServer.html#method-c-start","()",""],["starting_bots_loop","BigBench::Output","BigBench/Output.html#method-c-starting_bots_loop","()",""],["stop","BigBench::Store","BigBench/Store.html#method-c-stop","()","<p>Stops the test for all bots by unsetting the running key\n"],["stop","TestWebServer","TestWebServer.html#method-c-stop","()",""],["test","BigBench::Store","BigBench/Store.html#method-c-test","()","<p>Gets the current test from the redis\n"],["test=","BigBench::Store","BigBench/Store.html#method-c-test-3D","(test)","<p>Stores the current test receipt for all bots on the redis instance\n"],["to_milliseconds","Float","Float.html#method-i-to_milliseconds","()",""],["track","BigBench::Tracker::Tracker","BigBench/Tracker/Tracker.html#method-i-track","(object)",""],["track!","BigBench::Fragment::Fragment","BigBench/Fragment/Fragment.html#method-i-track-21","(start, stop, response)","<p>Adds the current tracking result as a hash to the benchmark’s tracker\n"],["valid?","BigBench::Configuration::Config","BigBench/Configuration/Config.html#method-i-valid-3F","()",""],["write_local_trackings_to_file!","BigBench","BigBench.html#method-c-write_local_trackings_to_file-21","()","<p>Writes the locals trackings from the benchmark to a file\n"],["write_store_trackings_to_file!","BigBench","BigBench.html#method-c-write_store_trackings_to_file-21","()","<p>Gathers the trackings from the redis and writes them to a local file\n"],["write_trackings_to_store!","BigBench","BigBench.html#method-c-write_trackings_to_store-21","()","<p>Writes the trackings of a bot to the redis after he finishes the run\n"],["writing_trackings","BigBench::Output","BigBench/Output.html#method-c-writing_trackings","(count)",""],["wrote_trackings","BigBench::Output","BigBench/Output.html#method-c-wrote_trackings","(count)",""],["Gemfile","","Gemfile.html","","<p>source “rubygems.org”\n<p># Specify your gem’s dependencies in big_bench.gemspec gemspec\n"],["Rakefile","","Rakefile.html","","<p>require “bundler/gem_tasks”\n<p>namespace :bigbench do\n\n<pre>desc &quot;Create and open documentation&quot;\ntask ...</pre>\n"],["executor","","lib/bigbench/help/executor_txt.html","","<p>Usage:\n\n<pre># Local Testing\nbigbench run local PATH_TO_TEST                                       # Runs a ...</pre>\n"]]}}

data/doc/js/searcher.js

@@ -0,0 +1,228 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/)
+    });
+  }
+
+  function buildRegexps(queries) {
+    return jQuery.map(queries, function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i')
+    });
+  }
+
+  function buildHilighters(queries) {
+    return jQuery.map(queries, function(query) {
+      return jQuery.map(query.split(''), function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}
+

data/doc/lib/bigbench/help/executor_txt.html

@@ -0,0 +1,145 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>executor - 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 class="file">
+<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="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="../../../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/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/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="../../../Float.html">Float</a>
+  
+    <li><a href="../../../Helpers.html">Helpers</a>
+  
+    <li><a href="../../../Object.html">Object</a>
+  
+    <li><a href="../../../TestWebServer.html">TestWebServer</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation" class="description">
+  
+<p>Usage:</p>
+
+<pre># Local Testing
+bigbench run local PATH_TO_TEST                                       # Runs a test from the local machine. No redis needed.
+
+# Remote Testing
+bigbench run bots PATH_TO_TEST [REDIS_URL_WITH_PORT REDIS_PASSWORD]   # Deploys and starts the test on all bots
+bigbench start bot [REDIS_URL_WITH_PORT REDIS_PASSWORD]               # Starts a bot on a remote machine
+
+# Reseting
+bigbench reset all                                                    # Resets everything
+
+# Help
+bigbench --help || show help                                          # Displays this help</pre>
+
+<p>Options:</p>
+
+<pre>REDIS_URL_WITH_PORT   # Defaults to http://localhost:6379
+REDIS_PASSWORD        # Defaults to no password</pre>
+
+</div>
+
+
+
+<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>
+