RubyGems - spoonerize - Versions diffs - 0.1.0 → 0.1.1 - Mend

spoonerize 0.1.0 → 0.1.1

Files changed (57) hide show

checksums.yaml +4 -4
data/.gitignore +2 -0
data/README.md +2 -4
data/Rakefile +1 -1
data/lib/spoonerize/version.rb +1 -1
data/spoonerize.gemspec +1 -1
metadata +3 -53
data/doc/README_md.html +0 -238
data/doc/Spoonerize.html +0 -125
data/doc/Spoonerize/Bumper.html +0 -287
data/doc/Spoonerize/Cli.html +0 -545
data/doc/Spoonerize/Log.html +0 -362
data/doc/Spoonerize/Spoonerism.html +0 -759
data/doc/created.rid +0 -8
data/doc/css/fonts.css +0 -167
data/doc/css/rdoc.css +0 -619
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 +0 -241
data/doc/js/darkfish.js +0 -84
data/doc/js/navigation.js +0 -105
data/doc/js/navigation.js.gz +0 -0
data/doc/js/search.js +0 -110
data/doc/js/search_index.js +0 -1
data/doc/js/search_index.js.gz +0 -0
data/doc/js/searcher.js +0 -229
data/doc/js/searcher.js.gz +0 -0
data/doc/table_of_contents.html +0 -257

data/doc/Spoonerize/Log.html DELETED Viewed

@@ -1,362 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>class Spoonerize::Log - 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="class">
-<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="class-metadata">
-    <div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-  <p class="link">Object
-</div>
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-c-new">::new</a>
-    <li ><a href="#method-i-contents">#contents</a>
-    <li ><a href="#method-i-each">#each</a>
-    <li ><a href="#method-i-size">#size</a>
-    <li ><a href="#method-i-write">#write</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-Spoonerize::Log">
-  <h1 id="class-Spoonerize::Log" class="class">
-    class Spoonerize::Log
-  </h1>
-  <section class="description">
-<p>Class that handles reading/writing logs.</p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-    <section class="attribute-method-details" class="method-section">
-      <header>
-        <h3>Attributes</h3>
-      </header>
-      <div id="attribute-i-directory" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">directory</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The directory the file is located.</p>
-<p>@return [String]</p>
-        </div>
-      </div>
-      <div id="attribute-i-file" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">file</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The file name to use.</p>
-<p>@return [String]</p>
-        </div>
-      </div>
-    </section>
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-new" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">new</span><span
-            class="method-args">(file)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Constructor for <a href="Log.html"><code>Log</code></a>.</p>
-<p>@param [String] file</p>
-<p>@return [Spoonerize::Log]</p>
-          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/log.rb, line 27</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">file</span>)
-  <span class="ruby-ivar">@file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">file</span>)
-  <span class="ruby-ivar">@directory</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">file</span>)
-  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">directory</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">directory</span>)
-  <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">touch</span>(<span class="ruby-identifier">file</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">file</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-contents" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">contents</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>The contents of the log file.</p>
-<p>@return [Array]</p>
-          <div class="method-source-code" id="contents-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/log.rb, line 38</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">contents</span>
-  <span class="ruby-operator">::</span><span class="ruby-constant">CSV</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">file</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-each" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">each</span><span
-            class="method-args">() { |row| ... }</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Iterate through each line of the file.</p>
-<p>@return [Array]</p>
-          <div class="method-source-code" id="each-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/log.rb, line 56</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>
-  <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">row</span> }
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-size" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">size</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Number of entries in the file.</p>
-<p>@return [Integer]</p>
-          <div class="method-source-code" id="size-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/log.rb, line 64</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
-  <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">size</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-write" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">write</span><span
-            class="method-args">(row)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Writes a line to the log.</p>
-<p>@param [Array] row</p>
-<p>@return [Array]</p>
-          <div class="method-source-code" id="write-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/log.rb, line 48</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">row</span>)
-  <span class="ruby-operator">::</span><span class="ruby-constant">CSV</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">file</span>, <span class="ruby-string">&#39;a&#39;</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">csv</span><span class="ruby-operator">|</span> <span class="ruby-identifier">csv</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">row</span> }
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-</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/Spoonerize/Spoonerism.html DELETED Viewed

@@ -1,759 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta charset="UTF-8">
-<title>class Spoonerize::Spoonerism - 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="class">
-<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="class-metadata">
-    <div id="parent-class-section" class="nav-section">
-  <h3>Parent</h3>
-  <p class="link">Object
-</div>
-    <!-- Method Quickref -->
-<div id="method-list-section" class="nav-section">
-  <h3>Methods</h3>
-  <ul class="link-list" role="directory">
-    <li ><a href="#method-c-new">::new</a>
-    <li ><a href="#method-i-all_excluded_words">#all_excluded_words</a>
-    <li ><a href="#method-i-config_file-3D">#config_file=</a>
-    <li ><a href="#method-i-config_file_loaded-3F">#config_file_loaded?</a>
-    <li ><a href="#method-i-enough_flippable_words-3F">#enough_flippable_words?</a>
-    <li ><a href="#method-i-lazy-3F">#lazy?</a>
-    <li ><a href="#method-i-load_config_file">#load_config_file</a>
-    <li ><a href="#method-i-reverse-3F">#reverse?</a>
-    <li ><a href="#method-i-save">#save</a>
-    <li ><a href="#method-i-spoonerize">#spoonerize</a>
-    <li ><a href="#method-i-to_h">#to_h</a>
-    <li ><a href="#method-i-to_json">#to_json</a>
-    <li ><a href="#method-i-to_s">#to_s</a>
-  </ul>
-</div>
-  </div>
-</nav>
-<main role="main" aria-labelledby="class-Spoonerize::Spoonerism">
-  <h1 id="class-Spoonerize::Spoonerism" class="class">
-    class Spoonerize::Spoonerism
-  </h1>
-  <section class="description">
-<p>The main word-flipper.</p>
-  </section>
-  <section id="5Buntitled-5D" class="documentation-section">
-    <section class="attribute-method-details" class="method-section">
-      <header>
-        <h3>Attributes</h3>
-      </header>
-      <div id="attribute-i-config" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">config</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The options from <code>config_file</code> as a hash.</p>
-<p>@return [Hash] Options from <code>config_file</code></p>
-        </div>
-      </div>
-      <div id="attribute-i-config_file" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">config_file</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The configuration file. Default is <code>nil</code>. If set to a string, and the file exists, it is used to set options.</p>
-<p>@return [String] file path</p>
-        </div>
-      </div>
-      <div id="attribute-i-excluded_words" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">excluded_words</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>The words that are to be excluded.</p>
-<p>@param [Array] words</p>
-<p>@return [Array]</p>
-        </div>
-      </div>
-      <div id="attribute-i-lazy" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">lazy</span><span
-            class="attribute-access-type">[W]</span>
-        </div>
-        <div class="method-description">
-        <p>This boolean determines if flipping should be performed lazily.</p>
-<p>@param [Boolean] true if should be lazy.</p>
-<p>@return [Boolean]</p>
-        </div>
-      </div>
-      <div id="attribute-i-logfile_name" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">logfile_name</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-        <div class="method-description">
-        <p>The full path to the log file.</p>
-<p>@param [String] file</p>
-<p>@return [String]</p>
-        </div>
-      </div>
-      <div id="attribute-i-reverse" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">reverse</span><span
-            class="attribute-access-type">[W]</span>
-        </div>
-        <div class="method-description">
-        <p>This boolean determines if flipping should be reversed.</p>
-<p>@param [Boolean] true if should be reversed.</p>
-<p>@return [Boolean]</p>
-        </div>
-      </div>
-      <div id="attribute-i-words" class="method-detail">
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">words</span><span
-            class="attribute-access-type">[R]</span>
-        </div>
-        <div class="method-description">
-        <p>The words originally passed at initialization.</p>
-<p>@return [Array]</p>
-        </div>
-      </div>
-    </section>
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-      <div id="method-c-new" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">new</span><span
-            class="method-args">(words, config_file = nil) { |self| ... }</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Initialize instance. You can also use the <code>config_file</code> either by passing it at initialization, or via the setter. The config file will be automatically loaded if passed at initialization, before the instance is yielded so you can still change the values via the block. If set via the setter, you must call `#load_config_file`.</p>
-<p>@param [Array] words</p>
-<p>@param [String] <a href="Spoonerism.html#attribute-i-config_file"><code>config_file</code></a></p>
-<p>@example</p>
-<pre class="ruby"><span class="ruby-comment"># Config file would be automatically loaded before block is executed.</span>
-<span class="ruby-identifier">s</span> = <span class="ruby-constant">Spoonerise</span><span class="ruby-operator">::</span><span class="ruby-constant">Spoonerism</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">%w[not too shabby]</span>, <span class="ruby-string">&#39;~/.spoonerize.yml&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sp</span><span class="ruby-operator">|</span>
-  <span class="ruby-identifier">sp</span>.<span class="ruby-identifier">reverse</span> = <span class="ruby-keyword">true</span> <span class="ruby-comment"># Would override setting from config file</span>
-<span class="ruby-keyword">end</span>
-<span class="ruby-comment"># Config file would need to be manually loaded.</span>
-<span class="ruby-identifier">s</span> = <span class="ruby-constant">Spoonerise</span><span class="ruby-operator">::</span><span class="ruby-constant">Spoonerism</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">%w[not too shabby]</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sp</span><span class="ruby-operator">|</span>
-  <span class="ruby-identifier">sp</span>.<span class="ruby-identifier">config_file</span> = <span class="ruby-string">&#39;~/.spoonerize.yml&#39;</span>
-  <span class="ruby-identifier">sp</span>.<span class="ruby-identifier">reverse</span> = <span class="ruby-keyword">true</span>
-<span class="ruby-keyword">end</span>
-<span class="ruby-identifier">s</span>.<span class="ruby-identifier">load_config_file</span> <span class="ruby-comment"># Would override setting from initialization</span>
-</pre>
-          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 80</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">words</span>, <span class="ruby-identifier">config_file</span> = <span class="ruby-keyword">nil</span>)
-  <span class="ruby-ivar">@config</span> = {}
-  <span class="ruby-ivar">@excluded_words</span> = []
-  <span class="ruby-ivar">@words</span> = <span class="ruby-identifier">words</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:downcase</span>)
-  <span class="ruby-ivar">@lazy</span> = <span class="ruby-keyword">false</span>
-  <span class="ruby-ivar">@reverse</span> = <span class="ruby-keyword">false</span>
-  <span class="ruby-ivar">@config_file</span> = <span class="ruby-identifier">config_file</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">config_file</span>)
-  <span class="ruby-ivar">@config_file_loaded</span> = <span class="ruby-keyword">false</span>
-  <span class="ruby-ivar">@logfile_name</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(
-    <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;HOME&#39;</span>], <span class="ruby-string">&#39;.cache&#39;</span>, <span class="ruby-string">&#39;spoonerize&#39;</span>, <span class="ruby-string">&#39;spoonerize.csv&#39;</span>)
-  )
-  <span class="ruby-identifier">load_config_file</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">config_file</span>
-  <span class="ruby-keyword">yield</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-      <div id="method-i-all_excluded_words" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">all_excluded_words</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns an array of words to exclude by combining three arrays:</p>
-<ul><li>
-<p>Any word in the passed arguments that&#39;s only one character</p>
-</li><li>
-<p>Any user-passed words, stored in <code>excluded_words</code></p>
-</li><li>
-<p>If lazy-mode, the LAZY_WORDS from yaml file are added</p>
-</li></ul>
-          <div class="method-source-code" id="all_excluded_words-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 160</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">all_excluded_words</span>
-  (<span class="ruby-identifier">excluded_words</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">lazy?</span> <span class="ruby-operator">?</span> <span class="ruby-constant">LAZY_WORDS</span> <span class="ruby-operator">:</span> [])).<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:downcase</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-config_file-3D" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">config_file=</span><span
-            class="method-args">(config_file)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Setter for <code>config_file</code>. Must be expanded in case the user uses `~` for home.</p>
-<p>@param [String] file</p>
-<p>@return [String]</p>
-          <div class="method-source-code" id="config_file-3D-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 171</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">config_file=</span>(<span class="ruby-identifier">config_file</span>)
-  <span class="ruby-ivar">@config_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">config_file</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-config_file_loaded-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">config_file_loaded?</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Has a config file been loaded?</p>
-<p>@return [Boolean]</p>
-          <div class="method-source-code" id="config_file_loaded-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 127</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">config_file_loaded?</span>
-  <span class="ruby-ivar">@config_file_loaded</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-enough_flippable_words-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">enough_flippable_words?</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns true if there are more than one non-excluded word to flip</p>
-          <div class="method-source-code" id="enough_flippable_words-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 133</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">enough_flippable_words?</span>
-  (<span class="ruby-identifier">words</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">all_excluded_words</span>).<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-lazy-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">lazy?</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Should the lazy words be excluded?</p>
-          <div class="method-source-code" id="lazy-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 139</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">lazy?</span>
-  <span class="ruby-ivar">@lazy</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-load_config_file" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">load_config_file</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Loads the config file</p>
-<p>@return [Hash] The config options</p>
-          <div class="method-source-code" id="load_config_file-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 179</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_config_file</span>
-  <span class="ruby-identifier">raise</span> <span class="ruby-string">&#39;No config file set&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">config_file</span>.<span class="ruby-identifier">nil?</span>
-  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;File #{config_file} does not exist&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-identifier">config_file</span>)
-  <span class="ruby-ivar">@config</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_file</span>(<span class="ruby-identifier">config_file</span>)
-  <span class="ruby-ivar">@config_file_loaded</span> = <span class="ruby-keyword">true</span>
-  <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{k}=&quot;</span>, <span class="ruby-identifier">v</span>) }
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-reverse-3F" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">reverse?</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Should the words flip the other direction?</p>
-          <div class="method-source-code" id="reverse-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 145</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reverse?</span>
-  <span class="ruby-ivar">@reverse</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-save" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">save</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Saves the flipped words to the log file, along with the options</p>
-          <div class="method-source-code" id="save-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 151</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">save</span>
-  <span class="ruby-identifier">log</span>.<span class="ruby-identifier">write</span>([<span class="ruby-identifier">words</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; &#39;</span>), <span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">options</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;, &#39;</span>)])
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-spoonerize" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">spoonerize</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Iterates through words array, and maps its elements to the output of flip_words. Returns results as an array.</p>
-          <div class="method-source-code" id="spoonerize-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 100</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spoonerize</span>
-  <span class="ruby-identifier">raise</span> <span class="ruby-constant">JakPibError</span>, <span class="ruby-string">&#39;Not enough words to flip&#39;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">enough_flippable_words?</span>
-  <span class="ruby-identifier">words</span>.<span class="ruby-identifier">map</span>.<span class="ruby-identifier">with_index</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">word</span>, <span class="ruby-identifier">idx</span><span class="ruby-operator">|</span> <span class="ruby-identifier">flip_words</span>(<span class="ruby-identifier">word</span>, <span class="ruby-identifier">idx</span>) }
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-to_h" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">to_h</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns hash of the original words mapped to their flipped counterparts.</p>
-          <div class="method-source-code" id="to_h-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 113</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_h</span>
-  <span class="ruby-constant">Hash</span>[<span class="ruby-identifier">words</span>.<span class="ruby-identifier">zip</span>(<span class="ruby-identifier">spoonerize</span>)]
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-to_json" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">to_json</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Same as <a href="Spoonerism.html#method-i-to_h"><code>to_h</code></a>, but as json.</p>
-          <div class="method-source-code" id="to_json-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 119</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>
-  <span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">to_json</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-i-to_s" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">to_s</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Returns spoonerize array as a joined string.</p>
-          <div class="method-source-code" id="to_s-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 107</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_s</span>
-  <span class="ruby-identifier">spoonerize</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; &#39;</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-        </div>
-      </div>
-    </section>
-  </section>
-</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>