spoonerize 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c887f63e01d902734fb320a70c601f47b106df4a0aa7d947c81bd0526551888a
-  data.tar.gz: 655efdb264c515d783593ac758108aeb7cd007bfa57eb330116821879aaa0900
+  metadata.gz: 9b87634fd09d0a168098bb2c91ee8ffd978e2d1bfd6fe1783ebce28e64617fbb
+  data.tar.gz: b852745fc0fe8a2ecbb95181275de0642d2975380f79b29f6cac3252116d9901
 SHA512:
-  metadata.gz: b845888c7a817fcf82a0bda6b8b30511360fb8eb3418fb54ced28cda89945dcf86554352b79c40d9bec457625dcc09341e84080f56da3bb57bd0b71d54591abc
-  data.tar.gz: 4ff21e42bc4b4a9f0ec6acde250e1337ed1029ab9f6beb844b1c7d98d65d3f1b126e6901f5472125e76bf5e71bf943c6a51a698c0cfd2e9ca0309ac3938358e9
+  metadata.gz: c2f178fbed34dceed86b76bdc1c97d6d5f0aa23daeb73b6d5cc233a9a9c2292bd4fd83bb671a1a0e009d28fda6a71b221378d161927852b43b9f47b985b847ee
+  data.tar.gz: e92bfa5bd30bdeee7515bda37cd58a112552ece8709d515468b5c3f2497527f15ac87eaa9c71f3f09eeb71dff4b7b0572749d6faf75e086d32b548017292061c

data/.gitignore

@@ -1 +1 @@
-spoonerise-*.gem
+spoonerize-*.gem

data/README.md

@@ -1,22 +1,50 @@
-# Welcome to [Spoonerize](https://evanthegrayt.github.io/spoonerize) -- a word game
-> Sponerism *[noun]* a verbal error in which a speaker accidentally transposes
+# Welcome to Spoonerize -- a word game.
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fspoonerize%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/evanthegrayt/spoonerize/goto?ref=master)
+[![Gem Version](https://badge.fury.io/rb/spoonerize.svg)](https://badge.fury.io/rb/spoonerize)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> Spoonerism *[noun]* a verbal error in which a speaker accidentally transposes
 > the initial sounds or letters of two or more words, often to humorous effect.
 
-We'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.
+View on [Github](https://github.com/evanthegrayt/spoonerize) |
+[Github Pages](https://evanthegrayt.github.io/spoonerize/) |
+[RubyGems](https://rubygems.org/gems/spoonerize)
 
 ## Table of Contents
+- [About](#about)
 - [Installation](#installation)
   - [Automated](#automated)
   - [Manual](#manual)
 - [Command Line Usage](#command-line-usage)
+  - [Config file](#config-file)
 - [API](#api)
-- [Rules of the Game](#rules-of-the-game)
+  - [Documentation](https://evanthegrayt.github.io/spoonerize/doc/index.html)
 - [Self-Promotion](#self-promotion)
 
+## About
+We'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:
+
+- Each word drops its leading consonant group and takes the leading consonant
+group of the next word.
+- If the word has no leading consonants, nothing is dropped, but it still
+receives the next word's leading consonants if it has any.
+- If the next word has no leading consonants, the current word receives no
+consonants, but will still lose its own if it has any.
+- When being "lazy", common words ("the", "his", etc.) remain unchanged.
+- If the word to pull from is excluded, that word is skipped, and you pull the
+leading consonants from the next non-excluded word.
+- "Q" and "U" should stay together (like "queen").
+- A lot of the time, the words won't look how they're supposed to sound, as you
+go by how the word *used* to sound, not how it's spelled. For instance,
+`$ spoonerize two new cuties` becomes "no cew twuties", but it would be
+pronounced "new coo tooties", as the words retain their original sounds.
+
+
 ## Installation
 ### Automated
 Just install the gem!
@@ -67,37 +95,84 @@ get the results. For example:
 
 ```
 $ 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
 ```
 
-To get a list of all available options, run with `-h`.
+Here is a list of all available options:
+
+```
+-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
+```
+
+### Config File
+You can create a config file called `~/.spoonerize.yml`. In this file, you can
+change default options at runtime. Available settings are:
+
+```yaml
+# Setting       Default
+excluded_words: []
+lazy:           false
+reverse:        false
+logfile_name:   '~/.cache/spoonerize/spoonerize.csv'
+```
+
+Options set by this file can be overridden at runtime by the use of the
+executable's flags.
 
 ## API
-This readme isn't finished, but you can view [API
-documentation](https://evanthegrayt.github.io/spoonerize/doc/index.html).
+The API is [fully
+documented](https://evanthegrayt.github.io/spoonerize/doc/index.html), but below
+are some quick examples of how you could use this in your ruby code.
 
-## Rules of the Game
-- Each word drops its leading consonant group and takes the leading consonant
-group of the next word.
-- If the word has no leading consonants, nothing is dropped, but it still
-receives the next word's leading consonants if it has any.
-- If the next word has no leading consonants, the current word receives no
-consonants, but will still lose its own if it has any.
-- When being "lazy", common words ("the", "his", etc.) remain unchanged.
-- If the word to pull from is excluded, that word is skipped, and you pull the
-leading consonants from the next non-excluded word.
-- "Q" and "U" should stay together (like "queen").
-- A lot of the time, the words won't look how they're supposed to sound, as you
-go by how the word *used* to sound, not how it's spelled. For instance,
-`$ spoonerize two new cuties` becomes "no cew twuties", but it would be
-pronounced "new coo tooties", as the words retain their original sounds.
+```ruby
+require 'spoonerize'
+
+spoonerism = Spoonerize::Spoonerism.new(%w[not too shabby]) do |s|
+  s.reverse = true
+end
+
+spoonerism.spoonerize
+# => shot noo tabby
+
+spoonerism.reverse = false
+spoonerism.spoonerize
+# => tot shoo nabby
+
+spoonerism.logfile_name = '~/.cache/spoonerize/spoonerize.csv'
+spoonerism.save
+```
+
+You can also use the [config file](#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`.
+
+```ruby
+# 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
+end
+
+# Config file would need to be manually loaded.
+s = Spoonerise::Spoonerism.new(%w[not too shabby]) do |sp|
+  sp.config_file = '~/.spoonerize.yml'
+end
+
+s.load_config_file
+```
 
 ## Self Promotion
 I do these projects for fun, and I enjoy knowing that they're helpful to people.

data/doc/README_md.html

@@ -60,14 +60,15 @@
   <h3>Table of Contents</h3>
 
   <ul class="link-list" role="directory">
-    <li><a href="#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="#label-Welcome+to+Spoonerize+--+a+word+game.">Welcome to Spoonerize – a word game.</a>
     <li><a href="#label-Table+of+Contents">Table of Contents</a>
+    <li><a href="#label-About">About</a>
     <li><a href="#label-Installation">Installation</a>
     <li><a href="#label-Automated">Automated</a>
     <li><a href="#label-Manual">Manual</a>
     <li><a href="#label-Command+Line+Usage">Command Line Usage</a>
+    <li><a href="#label-Config+File">Config File</a>
     <li><a href="#label-API">API</a>
-    <li><a href="#label-Rules+of+the+Game">Rules of the Game</a>
     <li><a href="#label-Self+Promotion">Self Promotion</a>
   </ul>
 </div>
@@ -89,16 +90,20 @@
 
 <main role="main" aria-label="Page README.md">
 
-<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>
@@ -107,13 +112,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>
@@ -152,37 +178,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/Spoonerize/Cli.html

@@ -194,7 +194,7 @@
 
         <div class="method-description">
           
-          <p>Creates an instance of <code>StandupMD</code> and runs what the user requested.</p>
+          <p>Creates an instance of <code>Spoonerism</code> and runs what the user requested.</p>
 
 <p>@param [Array] options</p>
           
@@ -299,7 +299,7 @@
 
           
           <div class="method-source-code" id="longest_word_length-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 102</span>
+            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 103</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">longest_word_length</span>
   <span class="ruby-ivar">@longest_word_length</span> <span class="ruby-operator">||=</span>
     <span class="ruby-identifier">spoonerism</span>.<span class="ruby-identifier">spoonerize</span>.<span class="ruby-identifier">group_by</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:size</span>).<span class="ruby-identifier">max</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">size</span>
@@ -335,7 +335,7 @@
 
           
           <div class="method-source-code" id="map-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 86</span>
+            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 87</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">map?</span>
   <span class="ruby-ivar">@map</span>
 <span class="ruby-keyword">end</span></pre>
@@ -370,7 +370,7 @@
 
           
           <div class="method-source-code" id="print-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 94</span>
+            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 95</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print?</span>
   <span class="ruby-ivar">@print</span>
 <span class="ruby-keyword">end</span></pre>
@@ -405,7 +405,7 @@
 
           
           <div class="method-source-code" id="print_log-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 111</span>
+            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 112</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_log</span>
   <span class="ruby-identifier">s</span> = <span class="ruby-constant">Spoonerize</span><span class="ruby-operator">::</span><span class="ruby-constant">Log</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">spoonerism</span>.<span class="ruby-identifier">logfile_name</span>)
   <span class="ruby-identifier">s</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-identifier">print</span> <span class="ruby-identifier">row</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39; | &#39;</span>) <span class="ruby-operator">+</span> <span class="ruby-string">&quot;\n&quot;</span> }
@@ -441,7 +441,7 @@
 
           
           <div class="method-source-code" id="print_mappings-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 120</span>
+            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 121</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print_mappings</span>
   <span class="ruby-identifier">spoonerism</span>.<span class="ruby-identifier">to_h</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</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">puts</span> <span class="ruby-node">&quot;%-#{longest_word_length}s =&gt; %s&quot;</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>]
@@ -478,7 +478,7 @@
 
           
           <div class="method-source-code" id="save-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 78</span>
+            <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 79</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">save?</span>
   <span class="ruby-ivar">@save</span>
 <span class="ruby-keyword">end</span></pre>
@@ -515,7 +515,8 @@
           <div class="method-source-code" id="spoonerism-source">
             <pre><span class="ruby-comment"># File lib/spoonerize/cli.rb, line 68</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">spoonerism</span>
-  <span class="ruby-ivar">@spoonerism</span> <span class="ruby-operator">||=</span> <span class="ruby-operator">::</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-identifier">options</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">pf</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-constant">PREFERENCE_FILE</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">PREFERENCE_FILE</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
+  <span class="ruby-ivar">@spoonerism</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Spoonerism</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>, <span class="ruby-identifier">pf</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">preferences</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">s</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>
 <span class="ruby-keyword">end</span></pre>

data/doc/Spoonerize/Spoonerism.html

@@ -79,10 +79,16 @@
     
     <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>
@@ -127,6 +133,36 @@
       </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
@@ -224,7 +260,7 @@
         
         <div class="method-heading">
           <span class="method-name">new</span><span
-            class="method-args">(words) { |self| ... }</span>
+            class="method-args">(words, config_file = nil) { |self| ... }</span>
           
           <span class="method-click-advice">click to toggle source</span>
           
@@ -233,23 +269,45 @@
 
         <div class="method-description">
           
-          <p>Initialize instance and raise if there aren&#39;t enough words to flip.</p>
+          <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 48</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">words</span>)
+            <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>
@@ -296,7 +354,7 @@
 
           
           <div class="method-source-code" id="all_excluded_words-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 114</span>
+            <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>
@@ -307,6 +365,78 @@
         
 
         
+      </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>
 
     
@@ -329,7 +459,7 @@
 
           
           <div class="method-source-code" id="enough_flippable_words-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 87</span>
+            <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>
@@ -362,7 +492,7 @@
 
           
           <div class="method-source-code" id="lazy-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 93</span>
+            <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>
@@ -373,6 +503,45 @@
         
 
         
+      </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>
 
     
@@ -395,7 +564,7 @@
 
           
           <div class="method-source-code" id="reverse-3F-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 99</span>
+            <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>
@@ -428,7 +597,7 @@
 
           
           <div class="method-source-code" id="save-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 105</span>
+            <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>
@@ -461,7 +630,7 @@
 
           
           <div class="method-source-code" id="spoonerize-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 62</span>
+            <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>) }
@@ -495,7 +664,7 @@
 
           
           <div class="method-source-code" id="to_h-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 75</span>
+            <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>
@@ -528,7 +697,7 @@
 
           
           <div class="method-source-code" id="to_json-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 81</span>
+            <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>
@@ -561,7 +730,7 @@
 
           
           <div class="method-source-code" id="to_s-source">
-            <pre><span class="ruby-comment"># File lib/spoonerize/spoonerism.rb, line 69</span>
+            <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>