RubyGems - spoonerize - Versions diffs - 0.0.5 - Mend

spoonerize 0.0.5

Files changed (69) hide show

checksums.yaml +7 -0
data/.github/workflows/ruby.yml +24 -0
data/.gitignore +1 -0
data/Gemfile +7 -0
data/LICENSE +21 -0
data/README.md +106 -0
data/Rakefile +19 -0
data/_config.yml +1 -0
data/bin/spoonerize +5 -0
data/doc/README_md.html +200 -0
data/doc/Spoonerize/Bumper.html +287 -0
data/doc/Spoonerize/Cli.html +544 -0
data/doc/Spoonerize/Log.html +362 -0
data/doc/Spoonerize/Spoonerism.html +590 -0
data/doc/Spoonerize.html +125 -0
data/doc/created.rid +8 -0
data/doc/css/fonts.css +167 -0
data/doc/css/rdoc.css +619 -0
data/doc/fonts/Lato-Light.ttf +0 -0
data/doc/fonts/Lato-LightItalic.ttf +0 -0
data/doc/fonts/Lato-Regular.ttf +0 -0
data/doc/fonts/Lato-RegularItalic.ttf +0 -0
data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
data/doc/images/add.png +0 -0
data/doc/images/arrow_up.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +203 -0
data/doc/js/darkfish.js +84 -0
data/doc/js/navigation.js +105 -0
data/doc/js/navigation.js.gz +0 -0
data/doc/js/search.js +110 -0
data/doc/js/search_index.js +1 -0
data/doc/js/search_index.js.gz +0 -0
data/doc/js/searcher.js +229 -0
data/doc/js/searcher.js.gz +0 -0
data/doc/table_of_contents.html +242 -0
data/lib/config/lazy_words.yml +21 -0
data/lib/spoonerize/bumper.rb +61 -0
data/lib/spoonerize/cli.rb +158 -0
data/lib/spoonerize/log.rb +68 -0
data/lib/spoonerize/spoonerism.rb +166 -0
data/lib/spoonerize/version.rb +5 -0
data/lib/spoonerize.rb +21 -0
data/pkg/spoonerize-0.0.7.gem +0 -0
data/spoonerize.gemspec +38 -0
metadata +154 -0

data/doc/index.html ADDED Viewed

@@ -0,0 +1,203 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>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" role="document" class="file">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+  </div>
+  <div id="project-metadata">
+    <div id="fileindex-section" class="nav-section">
+  <h3>Pages</h3>
+  <ul class="link-list">
+    <li><a href="./README_md.html">README</a>
+  </ul>
+</div>
+    <div id="classindex-section" class="nav-section">
+  <h3>Class and Module Index</h3>
+  <ul class="link-list">
+    <li><a href="./Spoonerize.html">Spoonerize</a>
+    <li><a href="./Spoonerize/Bumper.html">Spoonerize::Bumper</a>
+    <li><a href="./Spoonerize/Cli.html">Spoonerize::Cli</a>
+    <li><a href="./Spoonerize/Log.html">Spoonerize::Log</a>
+    <li><a href="./Spoonerize/Spoonerism.html">Spoonerize::Spoonerism</a>
+  </ul>
+</div>
+  </div>
+</nav>
+<main role="main">
+<h1 id="label-Welcome+to+Spoonerize+--+a+word+game">Welcome to <a href="https://evanthegrayt.github.io/spoonerize">Spoonerize</a> – a word game<span><a href="#label-Welcome+to+Spoonerize+--+a+word+game">&para;</a> <a href="#top">&uarr;</a></span></h1>
+<blockquote>
+<p>Sponerism <em>noun</em> a verbal error in which a speaker accidentally transposes the initial sounds or letters of two or more words, often to humorous effect.</p>
+</blockquote>
+<p>We&#39;ve all done it; someone says a phrase, and you flip the first few letters around, and sometimes, it makes an even funnier phrase. For example: “Tomb Raider” becomes “Romb Taider”. Well, when I was in high school, we took it further – probably too far – and made a rule set. This program follows those rules, which are listed below.</p>
+<h2 id="label-Table+of+Contents">Table of Contents<span><a href="#label-Table+of+Contents">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<ul><li>
+<p><a href="#installation">Installation</a></p>
+</li><li>
+<p><a href="#automated">Automated</a></p>
+</li><li>
+<p><a href="#manual">Manual</a></p>
+</li><li>
+<p><a href="#command-line-usage">Command Line Usage</a></p>
+</li><li>
+<p><a href="#api">API</a></p>
+</li><li>
+<p><a href="#rules-of-the-game">Rules of the Game</a></p>
+</li><li>
+<p><a href="#self-promotion">Self-Promotion</a></p>
+</li></ul>
+<h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<h3 id="label-Automated">Automated<span><a href="#label-Automated">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<p>Just install the gem!</p>
+<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-identifier">install</span> <span class="ruby-identifier">spoonerize</span>
+</pre>
+<p>If you don&#39;t have permission on your system to install ruby or gems, I recommend using <a href="http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html">rbenv</a>, or you can try the manual methods below.</p>
+<h3 id="label-Manual">Manual<span><a href="#label-Manual">&para;</a> <a href="#top">&uarr;</a></span></h3>
+<p>From your terminal, clone the repository where you want it. From there, you have a couple of installation options.</p>
+<pre>git clone https://github.com/evanthegrayt/spoonerize.git
+cd spoonerize
+# Use rake to build and install the gem.
+rake install
+# OR manually link the executable somewhere. If you use this method, you cannot
+# move the repository after you link it!
+ln -s $PWD/bin/spoonerize /usr/local/bin/spoonerize</pre>
+<h2 id="label-Command+Line+Usage">Command Line Usage<span><a href="#label-Command+Line+Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<p>Call the executable and pass a phrase as arguments:</p>
+<pre>$ spoonerize not too shabby # =&gt; tot shoo nabby</pre>
+<p>If it didn&#39;t flip the way you wanted it to, you can reverse it:</p>
+<pre>$ spoonerize -r not too shabby # =&gt; shot noo tabby</pre>
+<p>If you find a phrase funny enough to save, you can pass the <code>-s</code> flag. This will write the results to the logfile. You can print your log file with the <code>-p</code> flag. It will show the original phrase, the end result, and the options used to get the results. For example:</p>
+<pre>$ spoonerize -s not too shabby
+Saving [tot shoo nabby] to /Users/evan.gray/workflow/spoonerize/log/spoonerize.csv
+$ spoonerize -rs not too shabby
+Saving [shot noo tabby] to /Users/evan.gray/workflow/spoonerize/log/spoonerize.csv
+$ spoonerize -p
+not too shabby | tot shoo nabby | No Options
+not too shabby | shot noo tabby | Reverse</pre>
+<p>To get a list of all available options, run with <code>-h</code>.</p>
+<h2 id="label-API">API<span><a href="#label-API">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<p>This readme isn&#39;t finished, but you can view <a href="https://evanthegrayt.github.io/spoonerize/doc/index.html">API documentation</a>.</p>
+<h2 id="label-Rules+of+the+Game">Rules of the Game<span><a href="#label-Rules+of+the+Game">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<ul><li>
+<p>Each word drops its leading consonant group and takes the leading consonant group of the next word.</p>
+</li><li>
+<p>If the word has no leading consonants, nothing is dropped, but it still receives the next word&#39;s leading consonants if it has any.</p>
+</li><li>
+<p>If the next word has no leading consonants, the current word receives no consonants, but will still lose its own if it has any.</p>
+</li><li>
+<p>When being “lazy”, common words (“the”, “his”, etc.) remain unchanged.</p>
+</li><li>
+<p>If the word to pull from is excluded, that word is skipped, and you pull the leading consonants from the next non-excluded word.</p>
+</li><li>
+<p>“Q” and “U” should stay together (like “queen”).</p>
+</li><li>
+<p>A lot of the time, the words won&#39;t look how they&#39;re supposed to sound, as you go by how the word <em>used</em> to sound, not how it&#39;s spelled. For instance, <code>$ spoonerize two new cuties</code> becomes “no cew twuties”, but it would be pronounced “new coo tooties”, as the words retain their original sounds.</p>
+</li></ul>
+<h2 id="label-Self+Promotion">Self Promotion<span><a href="#label-Self+Promotion">&para;</a> <a href="#top">&uarr;</a></span></h2>
+<p>I do these projects for fun, and I enjoy knowing that they&#39;re helpful to people. Consider starring <a href="https://github.com/evanthegrayt/spoonerize">the repository</a> if you like it! If you love it, follow me <a href="https://github.com/evanthegrayt">on github</a>!</p>
+</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/doc/js/darkfish.js ADDED Viewed

@@ -0,0 +1,84 @@
+/**
+ *
+ * Darkfish Page Functions
+ * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
+ *
+ * Author: Michael Granger <mgranger@laika.com>
+ *
+ */
+/* Provide console simulation for firebug-less environments */
+/*
+if (!("console" in window) || !("firebug" in console)) {
+  var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
+    "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
+  window.console = {};
+  for (var i = 0; i < names.length; ++i)
+    window.console[names[i]] = function() {};
+};
+*/
+function showSource( e ) {
+  var target = e.target;
+  while (!target.classList.contains('method-detail')) {
+    target = target.parentNode;
+  }
+  if (typeof target !== "undefined" && target !== null) {
+    target = target.querySelector('.method-source-code');
+  }
+  if (typeof target !== "undefined" && target !== null) {
+    target.classList.toggle('active-menu')
+  }
+};
+function hookSourceViews() {
+  document.querySelectorAll('.method-heading').forEach(function (codeObject) {
+    codeObject.addEventListener('click', showSource);
+  });
+};
+function hookSearch() {
+  var input  = document.querySelector('#search-field');
+  var result = document.querySelector('#search-results');
+  result.classList.remove("initially-hidden");
+  var search_section = document.querySelector('#search-section');
+  search_section.classList.remove("initially-hidden");
+  var search = new Search(search_data, input, result);
+  search.renderItem = function(result) {
+    var li = document.createElement('li');
+    var html = '';
+    // TODO add relative path to <script> per-page
+    html += '<p class="search-match"><a href="' + index_rel_prefix + result.path + '">' + this.hlt(result.title);
+    if (result.params)
+      html += '<span class="params">' + result.params + '</span>';
+    html += '</a>';
+    if (result.namespace)
+      html += '<p class="search-namespace">' + this.hlt(result.namespace);
+    if (result.snippet)
+      html += '<div class="search-snippet">' + result.snippet + '</div>';
+    li.innerHTML = html;
+    return li;
+  }
+  search.select = function(result) {
+    window.location.href = result.firstChild.firstChild.href;
+  }
+  search.scrollIntoView = search.scrollInWindow;
+};
+document.addEventListener('DOMContentLoaded', function() {
+  hookSourceViews();
+  hookSearch();
+});

data/doc/js/navigation.js ADDED Viewed

@@ -0,0 +1,105 @@
+/*
+ * Navigation allows movement using the arrow keys through the search results.
+ *
+ * When using this library you will need to set scrollIntoView to the
+ * appropriate function for your layout.  Use scrollInWindow if the container
+ * is not scrollable and scrollInElement if the container is a separate
+ * scrolling region.
+ */
+Navigation = new function() {
+  this.initNavigation = function() {
+    var _this = this;
+    document.addEventListener('keydown', function(e) {
+      _this.onkeydown(e);
+    });
+    this.navigationActive = true;
+  }
+  this.setNavigationActive = function(state) {
+    this.navigationActive = state;
+  }
+  this.onkeydown = function(e) {
+    if (!this.navigationActive) return;
+    switch(e.keyCode) {
+      case 37: //Event.KEY_LEFT:
+        if (this.moveLeft()) e.preventDefault();
+        break;
+      case 38: //Event.KEY_UP:
+        if (e.keyCode == 38 || e.ctrlKey) {
+          if (this.moveUp()) e.preventDefault();
+        }
+        break;
+      case 39: //Event.KEY_RIGHT:
+        if (this.moveRight()) e.preventDefault();
+        break;
+      case 40: //Event.KEY_DOWN:
+        if (e.keyCode == 40 || e.ctrlKey) {
+          if (this.moveDown()) e.preventDefault();
+        }
+        break;
+      case 13: //Event.KEY_RETURN:
+        if (this.current) e.preventDefault();
+        this.select(this.current);
+        break;
+    }
+    if (e.ctrlKey && e.shiftKey) this.select(this.current);
+  }
+  this.moveRight = function() {
+  }
+  this.moveLeft = function() {
+  }
+  this.move = function(isDown) {
+  }
+  this.moveUp = function() {
+    return this.move(false);
+  }
+  this.moveDown = function() {
+    return this.move(true);
+  }
+  /*
+   * Scrolls to the given element in the scrollable element view.
+   */
+  this.scrollInElement = function(element, view) {
+    var offset, viewHeight, viewScroll, height;
+    offset = element.offsetTop;
+    height = element.offsetHeight;
+    viewHeight = view.offsetHeight;
+    viewScroll = view.scrollTop;
+    if (offset - viewScroll + height > viewHeight) {
+      view.scrollTop = offset - viewHeight + height;
+    }
+    if (offset < viewScroll) {
+      view.scrollTop = offset;
+    }
+  }
+  /*
+   * Scrolls to the given element in the window.  The second argument is
+   * ignored
+   */
+  this.scrollInWindow = function(element, ignored) {
+    var offset, viewHeight, viewScroll, height;
+    offset = element.offsetTop;
+    height = element.offsetHeight;
+    viewHeight = window.innerHeight;
+    viewScroll = window.scrollY;
+    if (offset - viewScroll + height > viewHeight) {
+      window.scrollTo(window.scrollX, offset - viewHeight + height);
+    }
+    if (offset < viewScroll) {
+      window.scrollTo(window.scrollX, offset);
+    }
+  }
+}

data/doc/js/navigation.js.gz ADDED Viewed

Binary file

data/doc/js/search.js ADDED Viewed

@@ -0,0 +1,110 @@
+Search = function(data, input, result) {
+  this.data = data;
+  this.input = input;
+  this.result = result;
+  this.current = null;
+  this.view = this.result.parentNode;
+  this.searcher = new Searcher(data.index);
+  this.init();
+}
+Search.prototype = Object.assign({}, Navigation, new function() {
+  var suid = 1;
+  this.init = function() {
+    var _this = this;
+    var observer = function(e) {
+      switch(e.keyCode) {
+        case 38: // Event.KEY_UP
+        case 40: // Event.KEY_DOWN
+          return;
+      }
+      _this.search(_this.input.value);
+    };
+    this.input.addEventListener('keyup', observer);
+    this.input.addEventListener('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 = value.trim().toLowerCase();
+    if (value) {
+      this.setNavigationActive(true);
+    } else {
+      this.setNavigationActive(false);
+    }
+    if (value == '') {
+      this.lastQuery = value;
+      this.result.innerHTML = '';
+      this.result.setAttribute('aria-expanded', 'false');
+      this.setNavigationActive(false);
+    } else if (value != this.lastQuery) {
+      this.lastQuery = value;
+      this.result.setAttribute('aria-busy',     'true');
+      this.result.setAttribute('aria-expanded', 'true');
+      this.firstRun = true;
+      this.searcher.find(value);
+    }
+  }
+  this.addResults = function(results, isLast) {
+    var target = this.result;
+    if (this.firstRun && (results.length > 0 || isLast)) {
+      this.current = null;
+      this.result.innerHTML = '';
+    }
+    for (var i=0, l = results.length; i < l; i++) {
+      var item = this.renderItem.call(this, results[i]);
+      item.setAttribute('id', 'search-result-' + target.childElementCount);
+      target.appendChild(item);
+    };
+    if (this.firstRun && results.length > 0) {
+      this.firstRun = false;
+      this.current = target.firstChild;
+      this.current.classList.add('search-selected');
+    }
+    //TODO: ECMAScript
+    //if (jQuery.browser.msie) this.$element[0].className += '';
+    if (isLast) this.result.setAttribute('aria-busy', 'false');
+  }
+  this.move = function(isDown) {
+    if (!this.current) return;
+    var next = isDown ? this.current.nextElementSibling : this.current.previousElementSibling;
+    if (next) {
+      this.current.classList.remove('search-selected');
+      next.classList.add('search-selected');
+      this.input.setAttribute('aria-activedescendant', next.getAttribute('id'));
+      this.scrollIntoView(next, this.view);
+      this.current = next;
+      this.input.value = next.firstChild.firstChild.text;
+      this.input.select();
+    }
+    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 ADDED Viewed

@@ -0,0 +1 @@

+ var search_data = {"index":{"searchIndex":["spoonerize","bumper","cli","log","spoonerism","all_excluded_words()","bump()","contents()","each()","enough_flippable_words?()","execute()","lazy?()","longest_word_length()","map?()","new()","new()","new()","new()","print?()","print_log()","print_mappings()","reverse?()","reverse?()","save()","save?()","size()","spoonerism()","spoonerize()","to_h()","to_json()","to_s()","write()","readme"],"longSearchIndex":["spoonerize","spoonerize::bumper","spoonerize::cli","spoonerize::log","spoonerize::spoonerism","spoonerize::spoonerism#all_excluded_words()","spoonerize::bumper#bump()","spoonerize::log#contents()","spoonerize::log#each()","spoonerize::spoonerism#enough_flippable_words?()","spoonerize::cli::execute()","spoonerize::spoonerism#lazy?()","spoonerize::cli#longest_word_length()","spoonerize::cli#map?()","spoonerize::bumper::new()","spoonerize::cli::new()","spoonerize::log::new()","spoonerize::spoonerism::new()","spoonerize::cli#print?()","spoonerize::cli#print_log()","spoonerize::cli#print_mappings()","spoonerize::bumper#reverse?()","spoonerize::spoonerism#reverse?()","spoonerize::spoonerism#save()","spoonerize::cli#save?()","spoonerize::log#size()","spoonerize::cli#spoonerism()","spoonerize::spoonerism#spoonerize()","spoonerize::spoonerism#to_h()","spoonerize::spoonerism#to_json()","spoonerize::spoonerism#to_s()","spoonerize::log#write()",""],"info":[["Spoonerize","","Spoonerize.html","","The main namespace for the gem.\n"],["Spoonerize::Bumper","","Spoonerize/Bumper.html","","Class that handles bumping an index.\n"],["Spoonerize::Cli","","Spoonerize/Cli.html","","The class for handling the command-line interface.\n"],["Spoonerize::Log","","Spoonerize/Log.html","","Class that handles reading/writing logs.\n"],["Spoonerize::Spoonerism","","Spoonerize/Spoonerism.html","","The main word-flipper.\n"],["all_excluded_words","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-all_excluded_words","()","Returns an array of words to exclude by combining three arrays:\nAny word in the passed arguments that's …\n"],["bump","Spoonerize::Bumper","Spoonerize/Bumper.html#method-i-bump","()","Increments/Decrements the bumper. If on the last element of the words array, sets the bumper to 0. We …\n"],["contents","Spoonerize::Log","Spoonerize/Log.html#method-i-contents","()","The contents of the log file.\n@return [Array]\n"],["each","Spoonerize::Log","Spoonerize/Log.html#method-i-each","()","Iterate through each line of the file.\n@return [Array]\n"],["enough_flippable_words?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-enough_flippable_words-3F","()","Returns true if there are more than one non-excluded word to flip\n"],["execute","Spoonerize::Cli","Spoonerize/Cli.html#method-c-execute","(options = [])","Creates an instance of <code>StandupMD</code> and runs what the user requested.\n@param [Array] options\n"],["lazy?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-lazy-3F","()","Should the lazy words be excluded?\n"],["longest_word_length","Spoonerize::Cli","Spoonerize/Cli.html#method-i-longest_word_length","()","The length of the longest word in the phrase.\n@return [Integer]\n"],["map?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-map-3F","()","Should we print the mappings to the command line?\n@return [Boolean]\n"],["new","Spoonerize::Bumper","Spoonerize/Bumper.html#method-c-new","(initial_value, max_value, reverse = false)","Sets the bumper relative to the current index of words array. The value is automatically bumped once …\n"],["new","Spoonerize::Cli","Spoonerize/Cli.html#method-c-new","(options)","Create instance of <code>Cli</code>\n@param [Array] options\n@return [self]\n"],["new","Spoonerize::Log","Spoonerize/Log.html#method-c-new","(file)","Constructor for Log.\n@param [String] file\n@return [Spoonerize::Log]\n"],["new","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-c-new","(words)","Initialize instance and raise if there aren't enough words to flip.\n@param [Array] words\n"],["print?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print-3F","()","Should we print to the command line?\n@return [Boolean]\n"],["print_log","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print_log","()","Print the log file contents to the command line.\n@return [nil]\n"],["print_mappings","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print_mappings","()","Print the hash of mappings to the command line.\n@return [nil]\n"],["reverse?","Spoonerize::Bumper","Spoonerize/Bumper.html#method-i-reverse-3F","()","Should we decrement instead of increment?\n@return [Boolean]\n"],["reverse?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-reverse-3F","()","Should the words flip the other direction?\n"],["save","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-save","()","Saves the flipped words to the log file, along with the options\n"],["save?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-save-3F","()","Should we save to the log file?\n@return [Boolean]\n"],["size","Spoonerize::Log","Spoonerize/Log.html#method-i-size","()","Number of entries in the file.\n@return [Integer]\n"],["spoonerism","Spoonerize::Cli","Spoonerize/Cli.html#method-i-spoonerism","()","Sets up an instance of <code>Spoonerize::Spoonerism</code> and passes all user preferences.\n@return [Spoonerize::Spoonerism] …\n"],["spoonerize","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-spoonerize","()","Iterates through words array, and maps its elements to the output of flip_words. Returns results as an …\n"],["to_h","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-to_h","()","Returns hash of the original words mapped to their flipped counterparts.\n"],["to_json","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-to_json","()","Same as to_h, but as json.\n"],["to_s","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-to_s","()","Returns spoonerize array as a joined string.\n"],["write","Spoonerize::Log","Spoonerize/Log.html#method-i-write","(row)","Writes a line to the log.\n@param [Array] row\n@return [Array]\n"],["README","","README_md.html","","Welcome to Spoonerize – a word game\n\n<blockquote>Sponerism noun a verbal error in which a speaker accidentally transposes …\n</blockquote>\n"]]}}

data/doc/js/search_index.js.gz ADDED Viewed

Binary file