marked-conductor 1.0.9 → 1.0.11

data/html/js/searcher.js

@@ -0,0 +1,229 @@
+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 query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return queries.map(function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return queries.map(function(query) {
+      return query.split('').map(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];
+    result.badge = info[6];
+    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) {
+    this.handlers.forEach(function(fn) {
+      fn.call(this, results, isLast)
+    });
+  }
+}
+

data/html/table_of_contents.html

@@ -0,0 +1,345 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>Table of Contents - Marked Conductor</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" class="table-of-contents">
+<main role="main">
+<h1 class="class">Table of Contents - Marked Conductor</h1>
+
+<h2 id="pages">Pages</h2>
+<ul>
+  <li class="file">
+    <a href="README_rdoc.html">README</a>
+
+    <ul>
+      <li><a href="README_rdoc.html#label-Marked+Conductor">Marked Conductor</a>
+    </ul>
+  </li>
+</ul>
+
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+  <li class="class">
+    <a href="Array.html">Array</a>
+  </li>
+  <li class="module">
+    <a href="Conductor.html">Conductor</a>
+  </li>
+  <li class="class">
+    <a href="Conductor/Command.html">Conductor::Command</a>
+  </li>
+  <li class="class">
+    <a href="Conductor/Condition.html">Conductor::Condition</a>
+  </li>
+  <li class="class">
+    <a href="Conductor/Config.html">Conductor::Config</a>
+  </li>
+  <li class="module">
+    <a href="Conductor/Env.html">Conductor::Env</a>
+  </li>
+  <li class="class">
+    <a href="Conductor/Script.html">Conductor::Script</a>
+  </li>
+  <li class="class">
+    <a href="FalseClass.html">FalseClass</a>
+  </li>
+  <li class="class">
+    <a href="Hash.html">Hash</a>
+  </li>
+  <li class="class">
+    <a href="Object.html">Object</a>
+  </li>
+  <li class="class">
+    <a href="String.html">String</a>
+  </li>
+  <li class="class">
+    <a href="TrueClass.html">TrueClass</a>
+  </li>
+</ul>
+
+<h2 id="methods">Methods</h2>
+<ul>
+
+  <li class="method">
+    <a href="Conductor.html#method-c-conduct">::conduct</a>
+    &mdash;
+    <span class="container">Conductor</span>
+
+  <li class="method">
+    <a href="Conductor/Env.html#method-c-env">::env</a>
+    &mdash;
+    <span class="container">Conductor::Env</span>
+
+  <li class="method">
+    <a href="Conductor.html#method-c-execute_track">::execute_track</a>
+    &mdash;
+    <span class="container">Conductor</span>
+
+  <li class="method">
+    <a href="Conductor/Env.html#method-c-load_test_env">::load_test_env</a>
+    &mdash;
+    <span class="container">Conductor::Env</span>
+
+  <li class="method">
+    <a href="Conductor/Script.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Conductor::Script</span>
+
+  <li class="method">
+    <a href="Conductor/Config.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Conductor::Config</span>
+
+  <li class="method">
+    <a href="Conductor/Command.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Conductor::Command</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor.html#method-c-stdin">::stdin</a>
+    &mdash;
+    <span class="container">Conductor</span>
+
+  <li class="method">
+    <a href="Conductor/Env.html#method-c-to_s">::to_s</a>
+    &mdash;
+    <span class="container">Conductor::Env</span>
+
+  <li class="method">
+    <a href="Conductor/Command.html#method-i-args-3D">#args=</a>
+    &mdash;
+    <span class="container">Conductor::Command</span>
+
+  <li class="method">
+    <a href="Conductor/Script.html#method-i-args-3D">#args=</a>
+    &mdash;
+    <span class="container">Conductor::Script</span>
+
+  <li class="method">
+    <a href="String.html#method-i-bool-3F">#bool?</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="FalseClass.html#method-i-bool-3F">#bool?</a>
+    &mdash;
+    <span class="container">FalseClass</span>
+
+  <li class="method">
+    <a href="TrueClass.html#method-i-bool-3F">#bool?</a>
+    &mdash;
+    <span class="container">TrueClass</span>
+
+  <li class="method">
+    <a href="String.html#method-i-bool_to_symbol">#bool_to_symbol</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="Object.html#method-i-clean_condition">#clean_condition</a>
+    &mdash;
+    <span class="container">Object</span>
+
+  <li class="method">
+    <a href="Conductor.html#method-i-create_config">#create_config</a>
+    &mdash;
+    <span class="container">Conductor</span>
+
+  <li class="method">
+    <a href="String.html#method-i-date-3F">#date?</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="String.html#method-i-meta-3F">#meta?</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="String.html#method-i-number-3F">#number?</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-operator_to_symbol">#operator_to_symbol</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-parse_condition">#parse_condition</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Command.html#method-i-path-3D">#path=</a>
+    &mdash;
+    <span class="container">Conductor::Command</span>
+
+  <li class="method">
+    <a href="Conductor/Script.html#method-i-path-3D">#path=</a>
+    &mdash;
+    <span class="container">Conductor::Script</span>
+
+  <li class="method">
+    <a href="Conductor/Script.html#method-i-run">#run</a>
+    &mdash;
+    <span class="container">Conductor::Script</span>
+
+  <li class="method">
+    <a href="Conductor/Command.html#method-i-run">#run</a>
+    &mdash;
+    <span class="container">Conductor::Command</span>
+
+  <li class="method">
+    <a href="Conductor.html#method-i-sample_config">#sample_config</a>
+    &mdash;
+    <span class="container">Conductor</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-split_booleans">#split_booleans</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-split_condition">#split_condition</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="String.html#method-i-strip_time">#strip_time</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="Array.html#method-i-symbolize_keys">#symbolize_keys</a>
+    &mdash;
+    <span class="container">Array</span>
+
+  <li class="method">
+    <a href="Hash.html#method-i-symbolize_keys">#symbolize_keys</a>
+    &mdash;
+    <span class="container">Hash</span>
+
+  <li class="method">
+    <a href="Array.html#method-i-symbolize_keys-21">#symbolize_keys!</a>
+    &mdash;
+    <span class="container">Array</span>
+
+  <li class="method">
+    <a href="Hash.html#method-i-symbolize_keys-21">#symbolize_keys!</a>
+    &mdash;
+    <span class="container">Hash</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_condition">#test_condition</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_meta">#test_meta</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_operator">#test_operator</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_pandoc">#test_pandoc</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_string">#test_string</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_tree">#test_tree</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_truthy">#test_truthy</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_type">#test_type</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-test_yaml">#test_yaml</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="String.html#method-i-time-3F">#time?</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="String.html#method-i-to_bool">#to_bool</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="String.html#method-i-to_bool-21">#to_bool!</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="String.html#method-i-to_date">#to_date</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="String.html#method-i-to_day">#to_day</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="Conductor/Condition.html#method-i-true-3F">#true?</a>
+    &mdash;
+    <span class="container">Conductor::Condition</span>
+
+  <li class="method">
+    <a href="String.html#method-i-yaml-3F">#yaml?</a>
+    &mdash;
+    <span class="container">String</span>
+</ul>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/lib/conductor/condition.rb

@@ -2,17 +2,28 @@
 
 module Conductor
   class Condition
+
+    ##
+    ## Initializes the given condition.
+    ##
+    ## @param      condition  The condition
+    ##
     def initialize(condition)
       @condition = condition
       @env = Conductor::Env.env
     end
 
+    ##
+    ## Tests condition
+    ##
+    ## @return     [Boolean] test result
+    ##
     def true?
       parse_condition
     end
 
     ##
-    ## @brief      Splits booleans and tests components.
+    ## Splits booleans and tests components.
     ##
     ## @param      condition  The condition to test
     ##
@@ -52,7 +63,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test operators
+    ## Test operators
     ##
     ## @param      value1    Value
     ## @param      value2    Value to test
@@ -80,7 +91,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Splits a natural language condition.
+    ## Splits a natural language condition.
     ##
     ## @param      condition  The condition
     ## @return [Array] Value, value to compare, operator
@@ -105,7 +116,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test for type of value
+    ## Test for type of value
     ##
     ## @param      val1      value
     ## @param      val2      value to test against
@@ -130,7 +141,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Compare a string based on operator
+    ## Compare a string based on operator
     ##
     ## @param      val1      The string to test against
     ## @param      val2      The value to test
@@ -194,7 +205,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test for the existince of a
+    ## Test for the existince of a
     ##             file/directory in the parent tree
     ##
     ## @param      origin    Starting directory
@@ -219,7 +230,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test "truthiness"
+    ## Test "truthiness"
     ##
     ## @param      value1    Value to test against
     ## @param      value2    Value to test
@@ -238,7 +249,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test for presence of yaml, optionall for
+    ## Test for presence of yaml, optionall for
     ##             a key, optionally for a key's value
     ##
     ## @param      content   Text content containing YAML
@@ -249,7 +260,11 @@ module Conductor
     ## @return     [Boolean] test result
     ##
     def test_yaml(content, value, key, operator)
-      yaml = YAML.safe_load(content.split(/^(?:---|\.\.\.)/)[1])
+      begin
+        yaml = YAML.load(content.split(/^(?:---|\.\.\.)/)[1])
+      rescue StandardError
+        return false
+      end
 
       return operator == :not_equal unless yaml
 
@@ -282,7 +297,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test for MultiMarkdown metadata,
+    ## Test for MultiMarkdown metadata,
     ##             optionally key and value
     ##
     ## @param      content   [String] The text content