spoonerize 0.0.5

data/doc/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/doc/table_of_contents.html

@@ -0,0 +1,242 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>Table of Contents - RDoc Documentation</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 - RDoc Documentation</h1>
+
+
+
+<h2 id="pages">Pages</h2>
+<ul>
+
+  <li class="file">
+    <a href="README_md.html">README</a>
+
+    <ul>
+
+      <li><a href="README_md.html#label-Welcome+to+Spoonerize+--+a+word+game">Welcome to <a href="https://evanthegrayt.github.io/spoonerize">Spoonerize</a> – a word game</a>
+
+      <li><a href="README_md.html#label-Table+of+Contents">Table of Contents</a>
+
+      <li><a href="README_md.html#label-Installation">Installation</a>
+
+      <li><a href="README_md.html#label-Automated">Automated</a>
+
+      <li><a href="README_md.html#label-Manual">Manual</a>
+
+      <li><a href="README_md.html#label-Command+Line+Usage">Command Line Usage</a>
+
+      <li><a href="README_md.html#label-API">API</a>
+
+      <li><a href="README_md.html#label-Rules+of+the+Game">Rules of the Game</a>
+
+      <li><a href="README_md.html#label-Self+Promotion">Self Promotion</a>
+
+    </ul>
+
+  </li>
+  
+</ul>
+
+
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+
+  <li class="module">
+    <a href="Spoonerize.html">Spoonerize</a>
+
+  </li>
+
+  <li class="class">
+    <a href="Spoonerize/Bumper.html">Spoonerize::Bumper</a>
+
+  </li>
+
+  <li class="class">
+    <a href="Spoonerize/Cli.html">Spoonerize::Cli</a>
+
+  </li>
+
+  <li class="class">
+    <a href="Spoonerize/Log.html">Spoonerize::Log</a>
+
+  </li>
+
+  <li class="class">
+    <a href="Spoonerize/Spoonerism.html">Spoonerize::Spoonerism</a>
+
+  </li>
+
+</ul>
+
+<h2 id="methods">Methods</h2>
+<ul>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-c-execute">::execute</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Log.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Spoonerize::Log</span>
+
+  <li class="method">
+    <a href="Spoonerize/Bumper.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Spoonerize::Bumper</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-all_excluded_words">#all_excluded_words</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Bumper.html#method-i-bump">#bump</a>
+    &mdash;
+    <span class="container">Spoonerize::Bumper</span>
+
+  <li class="method">
+    <a href="Spoonerize/Log.html#method-i-contents">#contents</a>
+    &mdash;
+    <span class="container">Spoonerize::Log</span>
+
+  <li class="method">
+    <a href="Spoonerize/Log.html#method-i-each">#each</a>
+    &mdash;
+    <span class="container">Spoonerize::Log</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-enough_flippable_words-3F">#enough_flippable_words?</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-lazy-3F">#lazy?</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-i-longest_word_length">#longest_word_length</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-i-map-3F">#map?</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-i-print-3F">#print?</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-i-print_log">#print_log</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-i-print_mappings">#print_mappings</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-reverse-3F">#reverse?</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Bumper.html#method-i-reverse-3F">#reverse?</a>
+    &mdash;
+    <span class="container">Spoonerize::Bumper</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-save">#save</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-i-save-3F">#save?</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Log.html#method-i-size">#size</a>
+    &mdash;
+    <span class="container">Spoonerize::Log</span>
+
+  <li class="method">
+    <a href="Spoonerize/Cli.html#method-i-spoonerism">#spoonerism</a>
+    &mdash;
+    <span class="container">Spoonerize::Cli</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-spoonerize">#spoonerize</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-to_h">#to_h</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-to_json">#to_json</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-to_s">#to_s</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Log.html#method-i-write">#write</a>
+    &mdash;
+    <span class="container">Spoonerize::Log</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.2.1.
+  <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/config/lazy_words.yml

@@ -0,0 +1,21 @@
+#=================================================================#
+#         File: lazy_words.yml                                    #
+#  Description: Words to be excluded when "lazy" mode is enabled  #
+#                                                                 #
+#       Author: Evan Gray                                         #
+#=================================================================#
+
+- i
+- a
+- an
+- and
+- in
+- of
+- the
+- my
+- your
+- his
+- her
+- him
+- hers
+

data/lib/spoonerize/bumper.rb

@@ -0,0 +1,61 @@
+module Spoonerize
+  ##
+  # Class that handles bumping an index.
+  class Bumper
+
+    ##
+    # The number after being bumped.
+    #
+    # @return [Integer]
+    attr_reader :value
+
+    ##
+    # The maximum before index wraps back to zero.
+    #
+    # @return [Integer]
+    attr_reader :max_value
+
+    ##
+    # Sets the bumper relative to the current index of words array. The value
+    # is automatically bumped once when instantiated. If on the last element
+    # of the words array, sets the bumper to 0.
+    #
+    # @param [Integer] initial_value
+    #
+    # @param [Integer] max_value
+    #
+    # @param [Boolean] reverse Flip the order
+    def initialize(initial_value, max_value, reverse = false)
+      @max_value = max_value
+      @reverse = reverse
+      @value = bump_value(initial_value)
+    end
+
+    ##
+    # Increments/Decrements the bumper. If on the last element of the words
+    # array, sets the bumper to 0. We don't need to worry about resetting the
+    # value to 0 when going in reverse, because when the array index is
+    # negative, it reads from the end of the array, which is already what we
+    # want.
+    #
+    # @return [Integer]
+    def bump
+      @value = bump_value(value)
+    end
+
+    ##
+    # Should we decrement instead of increment?
+    #
+    # @return [Boolean]
+    def reverse?
+      @reverse
+    end
+
+    private
+
+    def bump_value(val) # :nodoc:
+      return val - 1 if @reverse
+      val + 1 == @max_value ? 0 : val + 1
+    end
+  end
+end