spoonerize 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c887f63e01d902734fb320a70c601f47b106df4a0aa7d947c81bd0526551888a
+  data.tar.gz: 655efdb264c515d783593ac758108aeb7cd007bfa57eb330116821879aaa0900
+SHA512:
+  metadata.gz: b845888c7a817fcf82a0bda6b8b30511360fb8eb3418fb54ced28cda89945dcf86554352b79c40d9bec457625dcc09341e84080f56da3bb57bd0b71d54591abc
+  data.tar.gz: 4ff21e42bc4b4a9f0ec6acde250e1337ed1029ab9f6beb844b1c7d98d65d3f1b126e6901f5472125e76bf5e71bf943c6a51a698c0cfd2e9ca0309ac3938358e9

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install
+        bundle exec rake test

data/.gitignore

@@ -0,0 +1 @@
+spoonerise-*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Evan Gray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# Welcome to [Spoonerize](https://evanthegrayt.github.io/spoonerize) -- a word game
+> Sponerism *[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.
+
+## Table of Contents
+- [Installation](#installation)
+  - [Automated](#automated)
+  - [Manual](#manual)
+- [Command Line Usage](#command-line-usage)
+- [API](#api)
+- [Rules of the Game](#rules-of-the-game)
+- [Self-Promotion](#self-promotion)
+
+## Installation
+### Automated
+Just install the gem!
+
+```sh
+gem install spoonerize
+```
+
+If you don't have permission on your system to install ruby or gems, I recommend
+using
+[rbenv](http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html),
+or you can try the manual methods below.
+
+
+### Manual
+From your terminal, clone the repository where you want it. From there, you have
+a couple of installation options.
+
+```sh
+git clone https://github.com/evanthegrayt/spoonerize.git
+cd spoonerize
+
+# Use rake to build and install the gem.
+rake install
+
+# OR manually link the executable somewhere. If you use this method, you cannot
+# move the repository after you link it!
+ln -s $PWD/bin/spoonerize /usr/local/bin/spoonerize
+```
+
+## Command Line Usage
+Call the executable and pass a phrase as arguments:
+
+```sh
+$ spoonerize not too shabby # => tot shoo nabby
+```
+
+If it didn't flip the way you wanted it to, you can reverse it:
+
+```sh
+$ spoonerize -r not too shabby # => shot noo tabby
+```
+
+If you find a phrase funny enough to save, you can pass the `-s` flag. This will
+write the results to the logfile. You can print your log file with the `-p`
+flag. It will show the original phrase, the end result, and the options used to
+get the results. For example:
+
+```
+$ spoonerize -s not too shabby
+Saving [tot shoo nabby] to /Users/evan.gray/workflow/spoonerize/log/spoonerize.csv
+
+$ spoonerize -rs not too shabby
+Saving [shot noo tabby] to /Users/evan.gray/workflow/spoonerize/log/spoonerize.csv
+
+$ spoonerize -p
+not too shabby | tot shoo nabby | No Options
+not too shabby | shot noo tabby | Reverse
+```
+
+To get a list of all available options, run with `-h`.
+
+## API
+This readme isn't finished, but you can view [API
+documentation](https://evanthegrayt.github.io/spoonerize/doc/index.html).
+
+## 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.
+
+## Self Promotion
+I do these projects for fun, and I enjoy knowing that they're helpful to people.
+Consider starring [the repository](https://github.com/evanthegrayt/spoonerize)
+if you like it! If you love it, follow me [on
+github](https://github.com/evanthegrayt)!

data/Rakefile

@@ -0,0 +1,19 @@
+require_relative 'lib/spoonerize'
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib']
+  t.warning = true
+  t.verbose = true
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end
+
+task :default => :test

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-midnight

data/bin/spoonerize

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/spoonerize'
+
+Spoonerize::Cli.execute(ARGV)

data/doc/README_md.html

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