spoonerize 0.0.5 → 0.0.7

data/doc/created.rid

@@ -1,8 +1,8 @@
-Sat, 02 May 2020 22:21:49 -0500
-README.md	Sat, 02 May 2020 22:16:45 -0500
-lib/spoonerize.rb	Sat, 02 May 2020 22:16:01 -0500
-lib/spoonerize/bumper.rb	Sat, 02 May 2020 22:15:15 -0500
-lib/spoonerize/cli.rb	Sat, 02 May 2020 22:15:46 -0500
-lib/spoonerize/log.rb	Sat, 02 May 2020 22:15:24 -0500
-lib/spoonerize/spoonerism.rb	Sat, 02 May 2020 22:15:11 -0500
-lib/spoonerize/version.rb	Sat, 02 May 2020 22:20:51 -0500
+Sun, 03 May 2020 21:49:14 -0500
+README.md	Sun, 03 May 2020 21:42:49 -0500
+lib/spoonerize.rb	Sat, 02 May 2020 22:24:00 -0500
+lib/spoonerize/bumper.rb	Sat, 02 May 2020 22:24:00 -0500
+lib/spoonerize/cli.rb	Sun, 03 May 2020 21:34:21 -0500
+lib/spoonerize/log.rb	Sat, 02 May 2020 22:24:00 -0500
+lib/spoonerize/spoonerism.rb	Sun, 03 May 2020 21:49:09 -0500
+lib/spoonerize/version.rb	Sun, 03 May 2020 21:34:21 -0500

data/doc/index.html

@@ -91,16 +91,20 @@
 <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>
+<h1 id="label-Welcome+to+Spoonerize+--+a+word+game.">Welcome to <a href="Spoonerize.html"><code>Spoonerize</code></a> – a word game.<span><a href="#label-Welcome+to+Spoonerize+--+a+word+game.">&para;</a> <a href="#top">&uarr;</a></span></h1>
+
+<p><a href="https://actions-badge.atrox.dev/evanthegrayt/spoonerize/goto?ref=master"><img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fspoonerize%2Fbadge%3Fref%3Dmaster&style=flat"></a> <a href="https://badge.fury.io/rb/spoonerize"><img src="https://badge.fury.io/rb/spoonerize.svg"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg"></a></p>
 
 <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>
+<p>Spoonerism <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>
+<p>View on <a href="https://github.com/evanthegrayt/spoonerize">Github</a> | <a href="https://evanthegrayt.github.io/spoonerize/">Github Pages</a> | <a href="https://rubygems.org/gems/spoonerize">RubyGems</a></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="#about">About</a></p>
+</li><li>
 <p><a href="#installation">Installation</a></p>
 </li><li>
 <p><a href="#automated">Automated</a></p>
@@ -109,13 +113,34 @@
 </li><li>
 <p><a href="#command-line-usage">Command Line Usage</a></p>
 </li><li>
+<p><a href="#config-file">Config file</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>
+<p><a href="https://evanthegrayt.github.io/spoonerize/doc/index.html">Documentation</a></p>
 </li><li>
 <p><a href="#self-promotion">Self-Promotion</a></p>
 </li></ul>
 
+<h2 id="label-About">About<span><a href="#label-About">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<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 gem, which includes a command-line executable, follows those rules, which are:</p>
+<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-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>
@@ -154,37 +179,71 @@ ln -s $PWD/bin/spoonerize /usr/local/bin/spoonerize
 <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
+Saving [tot shoo nabby] to ~/.cache/spoonerize/spoonerize.csv
 
 $ spoonerize -rs not too shabby
-Saving [shot noo tabby] to /Users/evan.gray/workflow/spoonerize/log/spoonerize.csv
+Saving [shot noo tabby] to ~/.cache/spoonerize/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>
+<p>Here is a list of all available options:</p>
+
+<pre>-r, --[no-]reverse               Reverse flipping
+-l, --[no-]lazy                  Skip small words
+-m, --[no-]map                   Print words mapping
+-p, --[no-]print                 Print all entries in the log
+-s, --[no-]save                  Save results in log
+    --exclude=WORDS              Words to skip</pre>
+
+<h3 id="label-Config+File">Config File<span><a href="#label-Config+File">&para;</a> <a href="#top">&uarr;</a></span></h3>
+
+<p>You can create a config file called <code>~/.spoonerize.yml</code>. In this file, you can change default options at runtime. Available settings are:</p>
+
+<pre># Setting       Default
+excluded_words: []
+lazy:           false
+reverse:        false
+logfile_name:   &#39;~/.cache/spoonerize/spoonerize.csv&#39;</pre>
+
+<p>Options set by this file can be overridden at runtime by the use of the executable&#39;s flags.</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>
+<p>The API is <a href="https://evanthegrayt.github.io/spoonerize/doc/index.html">fully documented</a>, but below are some quick examples of how you could use this in your ruby code.</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>
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;spoonerize&#39;</span>
+
+<span class="ruby-identifier">spoonerism</span> = <span class="ruby-constant">Spoonerize</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">s</span><span class="ruby-operator">|</span>
+  <span class="ruby-identifier">s</span>.<span class="ruby-identifier">reverse</span> = <span class="ruby-keyword">true</span>
+<span class="ruby-keyword">end</span>
+
+<span class="ruby-identifier">spoonerism</span>.<span class="ruby-identifier">spoonerize</span>
+<span class="ruby-comment"># =&gt; shot noo tabby</span>
+
+<span class="ruby-identifier">spoonerism</span>.<span class="ruby-identifier">reverse</span> = <span class="ruby-keyword">false</span>
+<span class="ruby-identifier">spoonerism</span>.<span class="ruby-identifier">spoonerize</span>
+<span class="ruby-comment"># =&gt; tot shoo nabby</span>
+
+<span class="ruby-identifier">spoonerism</span>.<span class="ruby-identifier">logfile_name</span> = <span class="ruby-string">&#39;~/.cache/spoonerize/spoonerize.csv&#39;</span>
+<span class="ruby-identifier">spoonerism</span>.<span class="ruby-identifier">save</span>
+</pre>
+
+<p>You can also use the <a href="#config-file">config file</a>, 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 <code>#load_config_file</code>.</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-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-keyword">end</span>
+
+<span class="ruby-identifier">s</span>.<span class="ruby-identifier">load_config_file</span>
+</pre>
 
 <h2 id="label-Self+Promotion">Self Promotion<span><a href="#label-Self+Promotion">&para;</a> <a href="#top">&uarr;</a></span></h2>
 

data/doc/js/search_index.js

@@ -1 +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","","<p>The main namespace for the gem.\n"],["Spoonerize::Bumper","","Spoonerize/Bumper.html","","<p>Class that handles bumping an index.\n"],["Spoonerize::Cli","","Spoonerize/Cli.html","","<p>The class for handling the command-line interface.\n"],["Spoonerize::Log","","Spoonerize/Log.html","","<p>Class that handles reading/writing logs.\n"],["Spoonerize::Spoonerism","","Spoonerize/Spoonerism.html","","<p>The main word-flipper.\n"],["all_excluded_words","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-all_excluded_words","()","<p>Returns an array of words to exclude by combining three arrays:\n<p>Any word in the passed arguments that&#39;s …\n"],["bump","Spoonerize::Bumper","Spoonerize/Bumper.html#method-i-bump","()","<p>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","()","<p>The contents of the log file.\n<p>@return [Array]\n"],["each","Spoonerize::Log","Spoonerize/Log.html#method-i-each","()","<p>Iterate through each line of the file.\n<p>@return [Array]\n"],["enough_flippable_words?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-enough_flippable_words-3F","()","<p>Returns true if there are more than one non-excluded word to flip\n"],["execute","Spoonerize::Cli","Spoonerize/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>StandupMD</code> and runs what the user requested.\n<p>@param [Array] options\n"],["lazy?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-lazy-3F","()","<p>Should the lazy words be excluded?\n"],["longest_word_length","Spoonerize::Cli","Spoonerize/Cli.html#method-i-longest_word_length","()","<p>The length of the longest word in the phrase.\n<p>@return [Integer]\n"],["map?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-map-3F","()","<p>Should we print the mappings to the command line?\n<p>@return [Boolean]\n"],["new","Spoonerize::Bumper","Spoonerize/Bumper.html#method-c-new","(initial_value, max_value, reverse = false)","<p>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)","<p>Create instance of <code>Cli</code>\n<p>@param [Array] options\n<p>@return [self]\n"],["new","Spoonerize::Log","Spoonerize/Log.html#method-c-new","(file)","<p>Constructor for Log.\n<p>@param [String] file\n<p>@return [Spoonerize::Log]\n"],["new","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-c-new","(words)","<p>Initialize instance and raise if there aren&#39;t enough words to flip.\n<p>@param [Array] words\n"],["print?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print-3F","()","<p>Should we print to the command line?\n<p>@return [Boolean]\n"],["print_log","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print_log","()","<p>Print the log file contents to the command line.\n<p>@return [nil]\n"],["print_mappings","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print_mappings","()","<p>Print the hash of mappings to the command line.\n<p>@return [nil]\n"],["reverse?","Spoonerize::Bumper","Spoonerize/Bumper.html#method-i-reverse-3F","()","<p>Should we decrement instead of increment?\n<p>@return [Boolean]\n"],["reverse?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-reverse-3F","()","<p>Should the words flip the other direction?\n"],["save","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-save","()","<p>Saves the flipped words to the log file, along with the options\n"],["save?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-save-3F","()","<p>Should we save to the log file?\n<p>@return [Boolean]\n"],["size","Spoonerize::Log","Spoonerize/Log.html#method-i-size","()","<p>Number of entries in the file.\n<p>@return [Integer]\n"],["spoonerism","Spoonerize::Cli","Spoonerize/Cli.html#method-i-spoonerism","()","<p>Sets up an instance of <code>Spoonerize::Spoonerism</code> and passes all user preferences.\n<p>@return [Spoonerize::Spoonerism] …\n"],["spoonerize","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-spoonerize","()","<p>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","()","<p>Returns hash of the original words mapped to their flipped counterparts.\n"],["to_json","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-to_json","()","<p>Same as to_h, but as json.\n"],["to_s","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-to_s","()","<p>Returns spoonerize array as a joined string.\n"],["write","Spoonerize::Log","Spoonerize/Log.html#method-i-write","(row)","<p>Writes a line to the log.\n<p>@param [Array] row\n<p>@return [Array]\n"],["README","","README_md.html","","<p>Welcome to Spoonerize – a word game\n\n<blockquote><p>Sponerism <em>noun</em> a verbal error in which a speaker accidentally transposes …\n</blockquote>\n"]]}}
+var search_data = {"index":{"searchIndex":["spoonerize","bumper","cli","log","spoonerism","all_excluded_words()","bump()","config_file=()","config_file_loaded?()","contents()","each()","enough_flippable_words?()","execute()","lazy?()","load_config_file()","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::spoonerism#config_file=()","spoonerize::spoonerism#config_file_loaded?()","spoonerize::log#contents()","spoonerize::log#each()","spoonerize::spoonerism#enough_flippable_words?()","spoonerize::cli::execute()","spoonerize::spoonerism#lazy?()","spoonerize::spoonerism#load_config_file()","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","","<p>The main namespace for the gem.\n"],["Spoonerize::Bumper","","Spoonerize/Bumper.html","","<p>Class that handles bumping an index.\n"],["Spoonerize::Cli","","Spoonerize/Cli.html","","<p>The class for handling the command-line interface.\n"],["Spoonerize::Log","","Spoonerize/Log.html","","<p>Class that handles reading/writing logs.\n"],["Spoonerize::Spoonerism","","Spoonerize/Spoonerism.html","","<p>The main word-flipper.\n"],["all_excluded_words","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-all_excluded_words","()","<p>Returns an array of words to exclude by combining three arrays:\n<p>Any word in the passed arguments that&#39;s …\n"],["bump","Spoonerize::Bumper","Spoonerize/Bumper.html#method-i-bump","()","<p>Increments/Decrements the bumper. If on the last element of the words array, sets the bumper to 0. We …\n"],["config_file=","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-config_file-3D","(config_file)","<p>Setter for <code>config_file</code>. Must be expanded in case the user uses `~` for home.\n<p>@param [String] file\n<p>@return …\n"],["config_file_loaded?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-config_file_loaded-3F","()","<p>Has a config file been loaded?\n<p>@return [Boolean]\n"],["contents","Spoonerize::Log","Spoonerize/Log.html#method-i-contents","()","<p>The contents of the log file.\n<p>@return [Array]\n"],["each","Spoonerize::Log","Spoonerize/Log.html#method-i-each","()","<p>Iterate through each line of the file.\n<p>@return [Array]\n"],["enough_flippable_words?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-enough_flippable_words-3F","()","<p>Returns true if there are more than one non-excluded word to flip\n"],["execute","Spoonerize::Cli","Spoonerize/Cli.html#method-c-execute","(options = [])","<p>Creates an instance of <code>Spoonerism</code> and runs what the user requested.\n<p>@param [Array] options\n"],["lazy?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-lazy-3F","()","<p>Should the lazy words be excluded?\n"],["load_config_file","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-load_config_file","()","<p>Loads the config file\n<p>@return [Hash] The config options\n"],["longest_word_length","Spoonerize::Cli","Spoonerize/Cli.html#method-i-longest_word_length","()","<p>The length of the longest word in the phrase.\n<p>@return [Integer]\n"],["map?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-map-3F","()","<p>Should we print the mappings to the command line?\n<p>@return [Boolean]\n"],["new","Spoonerize::Bumper","Spoonerize/Bumper.html#method-c-new","(initial_value, max_value, reverse = false)","<p>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)","<p>Create instance of <code>Cli</code>\n<p>@param [Array] options\n<p>@return [self]\n"],["new","Spoonerize::Log","Spoonerize/Log.html#method-c-new","(file)","<p>Constructor for Log.\n<p>@param [String] file\n<p>@return [Spoonerize::Log]\n"],["new","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-c-new","(words, config_file = nil)","<p>Initialize instance. You can also use the <code>config_file</code> either by passing it at initialization, or via …\n"],["print?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print-3F","()","<p>Should we print to the command line?\n<p>@return [Boolean]\n"],["print_log","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print_log","()","<p>Print the log file contents to the command line.\n<p>@return [nil]\n"],["print_mappings","Spoonerize::Cli","Spoonerize/Cli.html#method-i-print_mappings","()","<p>Print the hash of mappings to the command line.\n<p>@return [nil]\n"],["reverse?","Spoonerize::Bumper","Spoonerize/Bumper.html#method-i-reverse-3F","()","<p>Should we decrement instead of increment?\n<p>@return [Boolean]\n"],["reverse?","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-reverse-3F","()","<p>Should the words flip the other direction?\n"],["save","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-save","()","<p>Saves the flipped words to the log file, along with the options\n"],["save?","Spoonerize::Cli","Spoonerize/Cli.html#method-i-save-3F","()","<p>Should we save to the log file?\n<p>@return [Boolean]\n"],["size","Spoonerize::Log","Spoonerize/Log.html#method-i-size","()","<p>Number of entries in the file.\n<p>@return [Integer]\n"],["spoonerism","Spoonerize::Cli","Spoonerize/Cli.html#method-i-spoonerism","()","<p>Sets up an instance of <code>Spoonerize::Spoonerism</code> and passes all user preferences.\n<p>@return [Spoonerize::Spoonerism] …\n"],["spoonerize","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-spoonerize","()","<p>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","()","<p>Returns hash of the original words mapped to their flipped counterparts.\n"],["to_json","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-to_json","()","<p>Same as to_h, but as json.\n"],["to_s","Spoonerize::Spoonerism","Spoonerize/Spoonerism.html#method-i-to_s","()","<p>Returns spoonerize array as a joined string.\n"],["write","Spoonerize::Log","Spoonerize/Log.html#method-i-write","(row)","<p>Writes a line to the log.\n<p>@param [Array] row\n<p>@return [Array]\n"],["README","","README_md.html","","<p>Welcome to Spoonerize – a word game.\n<p><img src=\"https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fspoonerize%2Fbadge%3Fref%3Dmaster&style=flat\"> …\n\n<blockquote>"]]}}

data/doc/table_of_contents.html

@@ -37,10 +37,12 @@
 
     <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-Welcome+to+Spoonerize+--+a+word+game.">Welcome to Spoonerize – 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-About">About</a>
+
       <li><a href="README_md.html#label-Installation">Installation</a>
 
       <li><a href="README_md.html#label-Automated">Automated</a>
@@ -49,9 +51,9 @@
 
       <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-Config+File">Config File</a>
 
-      <li><a href="README_md.html#label-Rules+of+the+Game">Rules of the Game</a>
+      <li><a href="README_md.html#label-API">API</a>
 
       <li><a href="README_md.html#label-Self+Promotion">Self Promotion</a>
 
@@ -130,6 +132,16 @@
     &mdash;
     <span class="container">Spoonerize::Bumper</span>
 
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-config_file-3D">#config_file=</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-config_file_loaded-3F">#config_file_loaded?</a>
+    &mdash;
+    <span class="container">Spoonerize::Spoonerism</span>
+
   <li class="method">
     <a href="Spoonerize/Log.html#method-i-contents">#contents</a>
     &mdash;
@@ -150,6 +162,11 @@
     &mdash;
     <span class="container">Spoonerize::Spoonerism</span>
 
+  <li class="method">
+    <a href="Spoonerize/Spoonerism.html#method-i-load_config_file">#load_config_file</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;
@@ -176,14 +193,14 @@
     <span class="container">Spoonerize::Cli</span>
 
   <li class="method">
-    <a href="Spoonerize/Spoonerism.html#method-i-reverse-3F">#reverse?</a>
+    <a href="Spoonerize/Bumper.html#method-i-reverse-3F">#reverse?</a>
     &mdash;
-    <span class="container">Spoonerize::Spoonerism</span>
+    <span class="container">Spoonerize::Bumper</span>
 
   <li class="method">
-    <a href="Spoonerize/Bumper.html#method-i-reverse-3F">#reverse?</a>
+    <a href="Spoonerize/Spoonerism.html#method-i-reverse-3F">#reverse?</a>
     &mdash;
-    <span class="container">Spoonerize::Bumper</span>
+    <span class="container">Spoonerize::Spoonerism</span>
 
   <li class="method">
     <a href="Spoonerize/Spoonerism.html#method-i-save">#save</a>

data/lib/config/lazy_words.yml

@@ -18,4 +18,5 @@
 - her
 - him
 - hers
-
+- to
+- is

data/lib/spoonerize/cli.rb

@@ -14,7 +14,7 @@ module Spoonerize
       File.expand_path(File.join(ENV['HOME'], '.spoonerize.yml')).freeze
 
     ##
-    # Creates an instance of +StandupMD+ and runs what the user requested.
+    # Creates an instance of +Spoonerism+ and runs what the user requested.
     #
     # @param [Array] options
     def self.execute(options = [])
@@ -66,7 +66,8 @@ module Spoonerize
     #
     # @return [Spoonerize::Spoonerism]
     def spoonerism
-      @spoonerism ||= ::Spoonerize::Spoonerism.new(options) do |s|
+      pf = File.file?(PREFERENCE_FILE) ? PREFERENCE_FILE : nil
+      @spoonerism ||= Spoonerism.new(options, pf) do |s|
         preferences.each { |k, v| s.send("#{k}=", v) }
       end
     end
@@ -151,8 +152,7 @@ module Spoonerize
         end
       end.parse!(options)
 
-      (File.file?(PREFERENCE_FILE) ? YAML.load_file(PREFERENCE_FILE) : {})
-        .merge(prefs)
+      prefs
     end
   end
 end

data/lib/spoonerize/spoonerism.rb

@@ -1,166 +1,235 @@
 module Spoonerize
-##
-# The main word-flipper.
-class Spoonerism
-
-  ##
-  # The words originally passed at initialization.
-  #
-  # @return [Array]
-  attr_reader :words
-
-  ##
-  # This boolean determines if flipping should be performed lazily.
-  #
-  # @param [Boolean] true if should be lazy.
-  #
-  # @return [Boolean]
-  attr_writer :lazy
-
-  ##
-  # This boolean determines if flipping should be reversed.
-  #
-  # @param [Boolean] true if should be reversed.
-  #
-  # @return [Boolean]
-  attr_writer :reverse
-
-  ##
-  # The full path to the log file.
-  #
-  # @param [String] file
-  #
-  # @return [String]
-  attr_accessor :logfile_name
-
-  ##
-  # The words that are to be excluded.
-  #
-  # @param [Array] words
-  #
-  # @return [Array]
-  attr_accessor :excluded_words
-
-  ##
-  # Initialize instance and raise if there aren't enough words to flip.
-  #
-  # @param [Array] words
-  def initialize(words)
-    @excluded_words = []
-    @words = words.map(&:downcase)
-    @lazy = false
-    @reverse = false
-    @logfile_name = File.expand_path(
-      File.join(ENV['HOME'], '.cache', 'spoonerize', 'spoonerize.csv')
-    )
-    yield self if block_given?
-  end
-
-  ##
-  # Iterates through words array, and maps its elements to the output of
-  # flip_words. Returns results as an array.
-  def spoonerize
-    raise JakPibError, 'Not enough words to flip' unless enough_flippable_words?
-    words.map.with_index { |word, idx| flip_words(word, idx) }
-  end
-
-  ##
-  # Returns spoonerize array as a joined string.
-  def to_s
-    spoonerize.join(' ')
-  end
-
-  ##
-  # Returns hash of the original words mapped to their flipped counterparts.
-  def to_h
-    Hash[words.zip(spoonerize)]
-  end
-
-  ##
-  # Same as to_h, but as json.
-  def to_json
-    to_h.to_json
-  end
-
-  ##
-  # Returns true if there are more than one non-excluded word to flip
-  def enough_flippable_words?
-    (words - all_excluded_words).size > 1
-  end
-
   ##
-  # Should the lazy words be excluded?
-  def lazy?
-    @lazy
+  # The main word-flipper.
+  class Spoonerism
+
+    ##
+    # The words originally passed at initialization.
+    #
+    # @return [Array]
+    attr_reader :words
+
+    ##
+    # This boolean determines if flipping should be performed lazily.
+    #
+    # @param [Boolean] true if should be lazy.
+    #
+    # @return [Boolean]
+    attr_writer :lazy
+
+    ##
+    # This boolean determines if flipping should be reversed.
+    #
+    # @param [Boolean] true if should be reversed.
+    #
+    # @return [Boolean]
+    attr_writer :reverse
+
+    ##
+    # The full path to the log file.
+    #
+    # @param [String] file
+    #
+    # @return [String]
+    attr_accessor :logfile_name
+
+    ##
+    # The words that are to be excluded.
+    #
+    # @param [Array] words
+    #
+    # @return [Array]
+    attr_accessor :excluded_words
+
+    ##
+    # The configuration file. Default is +nil+. If set to a string, and the file
+    # exists, it is used to set options.
+    #
+    # @return [String] file path
+    attr_reader :config_file
+
+    ##
+    # The options from +config_file+ as a hash.
+    #
+    # @return [Hash] Options from +config_file+
+    attr_reader :config
+
+    ##
+    # Initialize instance. You can also use the +config_file+ 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`.
+    #
+    # @param [Array] words
+    #
+    # @param [String] config_file
+    #
+    # @example
+    #  # Config file would be automatically loaded before block is executed.
+    #  s = Spoonerise::Spoonerism.new(%w[not too shabby], '~/.spoonerize.yml') do |sp|
+    #    sp.reverse = true # Would override setting from config file
+    #  end
+    #  # Config file would need to be manually loaded.
+    #  s = Spoonerise::Spoonerism.new(%w[not too shabby]) do |sp|
+    #    sp.config_file = '~/.spoonerize.yml'
+    #    sp.reverse = true
+    #  end
+    #  s.load_config_file # Would override setting from initialization
+
+    def initialize(words, config_file = nil)
+      @config = {}
+      @excluded_words = []
+      @words = words.map(&:downcase)
+      @lazy = false
+      @reverse = false
+      @config_file = config_file && File.expand_path(config_file)
+      @config_file_loaded = false
+      @logfile_name = File.expand_path(
+        File.join(ENV['HOME'], '.cache', 'spoonerize', 'spoonerize.csv')
+      )
+
+      load_config_file if config_file
+
+      yield self if block_given?
+    end
+
+    ##
+    # Iterates through words array, and maps its elements to the output of
+    # flip_words. Returns results as an array.
+    def spoonerize
+      raise JakPibError, 'Not enough words to flip' unless enough_flippable_words?
+      words.map.with_index { |word, idx| flip_words(word, idx) }
+    end
+
+    ##
+    # Returns spoonerize array as a joined string.
+    def to_s
+      spoonerize.join(' ')
+    end
+
+    ##
+    # Returns hash of the original words mapped to their flipped counterparts.
+    def to_h
+      Hash[words.zip(spoonerize)]
+    end
+
+    ##
+    # Same as to_h, but as json.
+    def to_json
+      to_h.to_json
+    end
+
+    ##
+    # Has a config file been loaded?
+    #
+    # @return [Boolean]
+    def config_file_loaded?
+      @config_file_loaded
+    end
+
+    ##
+    # Returns true if there are more than one non-excluded word to flip
+    def enough_flippable_words?
+      (words - all_excluded_words).size > 1
+    end
+
+    ##
+    # Should the lazy words be excluded?
+    def lazy?
+      @lazy
+    end
+
+    ##
+    # Should the words flip the other direction?
+    def reverse?
+      @reverse
+    end
+
+    ##
+    # Saves the flipped words to the log file, along with the options
+    def save
+      log.write([words.join(' '), to_s, options.join(', ')])
+    end
+
+    ##
+    # Returns an array of words to exclude by combining three arrays:
+    # * Any word in the passed arguments that's only one character
+    # * Any user-passed words, stored in +excluded_words+
+    # * If lazy-mode, the LAZY_WORDS from yaml file are added
+    def all_excluded_words
+      (excluded_words + (lazy? ? LAZY_WORDS : [])).map(&:downcase)
+    end
+
+    ##
+    # Setter for +config_file+. Must be expanded in case the user uses `~` for
+    # home.
+    #
+    # @param [String] file
+    #
+    # @return [String]
+    def config_file=(config_file)
+      @config_file = File.expand_path(config_file)
+    end
+
+    ##
+    # Loads the config file
+    #
+    # @return [Hash] The config options
+    def load_config_file
+      raise 'No config file set' if config_file.nil?
+      raise "File #{config_file} does not exist" unless File.file?(config_file)
+      @config = YAML::load_file(config_file)
+      @config_file_loaded = true
+      @config.each { |k, v| send("#{k}=", v) }
+    end
+
+    private
+
+    ##
+    # Main flipping method. Creates the replacement word from the next
+    # non-excluded word's leading syllables, and the current word's first vowels
+    # through the end of the word.
+    def flip_words(word, idx) # :nodoc:
+      return word if excluded?(idx)
+      bumper = Bumper.new(idx, words.size, reverse?)
+      bumper.bump until !excluded?(bumper.value)
+      words[bumper.value].match(consonants).to_s + word.match(vowels).to_s
+    end
+
+    ##
+    # Returns true if word[index] is in the excluded_words array
+    def excluded?(index) # :nodoc:
+      all_excluded_words.include?(words[index])
+    end
+
+    ##
+    # Returns regex to match first vowels through the rest of the word
+    def vowels # :nodoc:
+      /((?<!q)u|[aeio]|(?<=[bcdfghjklmnprstvwxz])y).*$/
+    end
+
+    ##
+    # Returns regex to match leading consonants
+    def consonants # :nodoc:
+      /^(y|[bcdfghjklmnprstvwxz]+|qu)/
+    end
+
+    ##
+    # Creates and memoizes instance of the log file.
+    def log # :nodoc:
+      @log ||= Spoonerize::Log.new(logfile_name)
+    end
+
+    ##
+    # the options as a string
+    def options # :nodoc:
+      o = []
+      o << 'Lazy' if lazy?
+      o << 'Reverse' if reverse?
+      o << "Exclude [#{all_excluded_words.join(', ')}]" if excluded_words.any?
+      o << 'No Options' if o.empty?
+      o
+    end
   end
-
-  ##
-  # Should the words flip the other direction?
-  def reverse?
-    @reverse
-  end
-
-  ##
-  # Saves the flipped words to the log file, along with the options
-  def save
-    log.write([words.join(' '), to_s, options.join(', ')])
-  end
-
-  ##
-  # Returns an array of words to exclude by combining three arrays:
-  # * Any word in the passed arguments that's only one character
-  # * Any user-passed words, stored in +excluded_words+
-  # * If lazy-mode, the LAZY_WORDS from yaml file are added
-  def all_excluded_words
-    (excluded_words + (lazy? ? LAZY_WORDS : [])).map(&:downcase)
-  end
-
-  private
-
-  ##
-  # Main flipping method. Creates the replacement word from the next
-  # non-excluded word's leading syllables, and the current word's first vowels
-  # through the end of the word.
-  def flip_words(word, idx) # :nodoc:
-    return word if excluded?(idx)
-    bumper = Bumper.new(idx, words.size, reverse?)
-    bumper.bump until !excluded?(bumper.value)
-    words[bumper.value].match(consonants).to_s + word.match(vowels).to_s
-  end
-
-  ##
-  # Returns true if word[index] is in the excluded_words array
-  def excluded?(index) # :nodoc:
-    all_excluded_words.include?(words[index])
-  end
-
-  ##
-  # Returns regex to match first vowels through the rest of the word
-  def vowels # :nodoc:
-    /((?<!q)u|[aeio]|(?<=[bcdfghjklmnprstvwxz])y).*$/
-  end
-
-  ##
-  # Returns regex to match leading consonants
-  def consonants # :nodoc:
-    /^(y|[bcdfghjklmnprstvwxz]+|qu)/
-  end
-
-  ##
-  # Creates and memoizes instance of the log file.
-  def log # :nodoc:
-    @log ||= Spoonerize::Log.new(logfile_name)
-  end
-
-  ##
-  # the options as a string
-  def options # :nodoc:
-    o = []
-    o << 'Lazy' if lazy?
-    o << 'Reverse' if reverse?
-    o << 'Exclude [%s]' % [all_excluded_words.join(', ')] if excluded_words.any?
-    o << 'No Options' if o.empty?
-    o
-  end
-end
 end