poefy 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42c9b9aed17a520bca45c074ceb06f6e797dd082
+  data.tar.gz: 3920e82bb6324eaf83f61091602e3c2398db4d42
+SHA512:
+  metadata.gz: be56e85cacb37a40c48995c7f032f1f5d12c396a69f317db12a17e401bcde8d3bbcc1f37c375aebf3b7e2aa164184d40c12e6d8481ff4ff70a634ab0bbf67e59
+  data.tar.gz: 6508356de1969dcfafa22b3f141f280c23c872bc9ca89ba4d9f066fb68981e24232d592cc412e593243489256b1265eb3e2347f47cf04b97009ba0676adb5ceb

data/.gitignore

@@ -0,0 +1,74 @@
+
+################################################################################
+# Ruby specific files
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+################################################################################
+# Rails stuff
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore application configuration
+/config/application.yml
+
+################################################################################
+# System and config files
+desktop.ini
+.agignore
+.ignore
+*.lnk
+
+################################################################################
+# App specific files
+
+# Development files
+work*.rb
+/~/
+
+# Data files
+/data/
+
+# Output files
+/output/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (C) 2017 Paul Thompson
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+Full text of this licence: <https://www.gnu.org/licenses/gpl.html>.

data/README.md

@@ -0,0 +1,522 @@
+# Poefy
+
+by [Paul Thompson](https://tilde.town/~nossidge) - nossidge@gmail.com
+
+Create poems from an input text file, by generating and querying a SQLite database that describes each line.
+
+Poems are created using a template to select lines from the database, according to closing rhyme, syllable count, and regex matching.
+
+I wrote this because I was banging my head against a wall trying to use [Tracery](https://github.com/galaxykate/tracery) to generate villanelles. Then I remembered that I know how to program computers. Lucky!
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'poefy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install poefy
+
+The repo comes with some text files included. To generate databases for these files, execute special `make_dbs` command:
+
+    $ poefy make_dbs
+
+The code rather hackily uses system to call `sqlite3`, so make sure you have that installed and in your PATH.
+
+
+## Usage
+
+### From the Command Line
+
+Make a poefy database from a text file:
+
+    $ poefy shakespeare < shakespeare_sonnets.txt
+
+Now, whenever you want to make poems using Shakespeare's lines, you can just use `poefy shakespeare` and it will read from the already created database:
+
+    $ poefy shakespeare sonnet
+    $ poefy shakespeare limerick
+    $ poefy shakespeare.db villanelle
+
+The file extension `.db` is assumed for all databases. You can leave it out if you want.
+
+If you later want to remake the database, for example to add new lines, you can use the `-o` option and the existing database will be overwritten.
+
+    $ cat shakespeare_sonnets.txt shakespeare_plays.txt | poefy shakespeare -o
+
+This database is stored in the same directory as the gem, so it can be accessed by all users on your system. To store a database in a different directory, you can use the `-l` or `--local` option:
+
+    $ poefy -l path/to/eliot.db < eliot.txt
+
+You then need to use the `-l` option when generating poems:
+
+    $ poefy -l path/to/eliot.db rondeau
+    $ poefy -l path/to/eliot    ballade
+    $ cd path/to
+    $ poefy -l eliot.db ballata
+
+You can use the `-h` or `--help` option to view available databases.
+
+
+#### Option `-f` or `--form`
+
+The `-f` option is used to specify a chosen poetic form, which sets the rhyme, syllable, and/or indent options to a predefined setting.
+
+The option switch is not mandatory; if not specified the second argument will be used. The below examples are identical:
+
+    $ poefy shakespeare sonnet
+    $ poefy shakespeare -f sonnet
+
+For forms where the syllables are constant through the poem, the syllable has not been specified. This is so you can use the `-s` option to set this. Syllables are only specified in forms where the syllable is a major factor of the form. At the moment these are: limerick, haiku, common, ballad.
+
+To view and amend these definitions, the code is in `lib/poefy/poetic_forms.rb`. Some examples:
+
+```ruby
+{
+  sonnet: {
+    rhyme:    'ababcdcdefefgg',
+    indent:   '',
+    syllable: ''
+  },
+  villanelle: {
+    rhyme:    'A1bA2 abA1 abA2 abA1 abA2 abA1A2',
+    indent:   '010 001 001 001 001 0011',
+    syllable: ''
+  },
+  haiku: {
+    rhyme:    'abc',
+    indent:   '',
+    syllable: '[5,7,5]'
+  },
+  limerick: {
+    rhyme:    'aabba',
+    indent:   '',
+    syllable: '{1:[8],2:[8],3:[4,5],4:[4,5],5:[8]}'
+  }
+}
+```
+
+You can use the `-h` or `--help` option to view available forms.
+
+
+#### Option `-r` or `--rhyme`
+
+Specifies a rhyme structure that the poem must follow. This is the most important argument; the whole poem is based on this.
+
+Each token in the rhyme string represents a line in the poem. Letters indicate rhymes, so all 'a' or 'A' lines have the same rhyme. Example, sonnet:
+
+    $ poefy whitman -r'ababcdcdefefgg'
+
+Uppercase letter lines will be duplicated exactly. This is used to create refrain lines. Example, rondeau:
+
+    $ poefy whitman -r'aabba aabC aabbaC'
+
+Numbers after a capital letter indicate which specific line to repeat. This is so you can have repeated lines that use the same rhyme scheme. Example, villanelle:
+
+    $ poefy whitman -r'A1bA2 abA1 abA2 abA1 abA2 abA1A2'
+
+
+#### Option `-i` or `--indent`
+
+Indent each line by a certain number of spaces. Examples:
+
+    $ poefy shakespeare sonnet -i'01010101010101'
+    $ poefy shakespeare -r'abcba abcdcba' -i'01210 0123210'
+    $ poefy shakespeare ballade -i'00000001 00000001 00000001 0001'
+
+Use zero `-i0` to specify no indentation.
+
+
+#### Option `-s` or `--syllable`
+
+Specify syllable count allowed for each line. There's a few valid forms it can take.
+
+If the string is just one number, all lines will be that number of syllables long.
+
+    $ poefy whitman -s'10'
+
+If the string is comma delimited, all lines will be any of those numbers of syllables long.
+
+    $ poefy whitman -s'9,10,11'
+
+If the string is an array, each element corresponds to a line in the output. This will skip blank lines.
+
+Both of the below will generate limericks, with the second more permissive than the first.
+
+    $ poefy whitman -r'aabba' -s'[8,8,5,5,8]'
+    $ poefy whitman -r'aabba' -s'[[8,9],[8,9],[4,5,6],[4,5,6],[8,9]]'
+
+If the string is a hash, the key will be used to match the line number.
+
+    $ poefy whitman -r'aabba' -s'{1:8,2:8,3:5,4:5,5:8}'
+    $ poefy whitman -r'aabba' -s'{1:[8,9],2:[8,9],3:[4,5,6],4:[4,5,6],5:[8,9]}'
+    $ poefy whitman -r'aabba' -s'{0:[8,9],3:[4,5,6],4:[4,5,6]}'
+
+In the hash form, any lines not explicitly specified will use the value of the '0' key. If there is no '0' key, the lines will be ignored.
+
+The below example will have 8 syllables for the first and fifth lines, but any number for the rest.
+
+    $ poefy whitman -r'aabba' -s'{1:8,5:8}'
+
+The key of the hash can take the form of negative numbers. In that case, they will refer to lines from the end of the poem. Any duplicated keys will be overwritten by the latest one.
+
+    $ poefy whitman -r'aabba' -s'{1:8,2:8,3:5,-2:5,-1:8}'
+
+Use zero `-s0` to specify no syllable matching.
+
+
+#### Option `-x` or `--regex`
+
+Specify a regular expression for lines to follow.
+
+If the string is just one regex, all lines will be forced to match that regex.
+
+    $ poefy whitman sonnet -x'^[A-Z].*$'
+    $ poefy whitman sonnet -x'^[^e]*$' -s0
+
+If the string is a hash, the key will be used to match the line number. Unlike in the `syllable` string, you must use ruby's `=>` key identifier. Also, you must put the regex inside `/slashes/`.
+
+Example, to ensure the first line always starts with capitalisation:
+
+    $ poefy whitman sonnet -x'{1=>/^[A-Z].*$/}'
+
+Use a space `-x' '` to specify no regex matching.
+
+
+#### Option `-a` or `--acrostic`
+
+Since there's a regular expression matcher it's pretty trivial to use it to generate acrostics. This option just creates regexes for the first character of each line, either upper or lowercase. Works best if you remove any indentation of lines.
+
+They need to include spaces where blank lines would normally go, for example a Petrarchan with rhyme 'abba abba cde cde':
+
+    $ poefy therese -r'abba abba cde cde' -i0 -a'stop that fat cat' -s10
+    $ poefy whitman -r'abba abba cde cde' -i0 -a'such good bum fun'
+
+You must also beware of repeated lines (uppercase letters in the rhyme string). For example, a rondeau uses the rhyme form 'aabba aabR aabbaR', so the acrostic needs to have the same letter for both 'R' repeated lines.
+
+    $ poefy therese rondeau -a'grown ever softer'
+
+
+#### Option `-p` or `--proper`
+
+This is used to ensure that the first word in the first line is not 'and but or nor yet', and the final line ends with closing punctuation (full stop, exclamation, or question mark). The default for this is `true`, but you can set it to `false` if necessary, for example if your input lines do not use punctuation.
+
+To clarify: using the `-p` or `--proper` option will DISABLE this functionality.
+
+
+#### Special case: `rhyme` command
+
+If the second argument is `rhyme`, then output all lines that rhyme with the word.
+
+This gives a basic look into the database contents.
+
+````
+$ poefy dickinson rhyme confuse
+  {"rhyme"=>"7d", "final_word"=>"choose", "syllables"=>6, "line"=>"As if for you to choose,"}
+  {"rhyme"=>"7d", "final_word"=>"dews", "syllables"=>6, "line"=>"The debauchee of dews!"}
+  {"rhyme"=>"7d", "final_word"=>"dews", "syllables"=>9, "line"=>"Like flowers that heard the tale of dews,"}
+  {"rhyme"=>"7d", "final_word"=>"hues", "syllables"=>6, "line"=>"Of independent hues,"}
+  {"rhyme"=>"7d", "final_word"=>"news", "syllables"=>8, "line"=>"The intuition of the news"}
+  {"rhyme"=>"7d", "final_word"=>"screws", "syllables"=>6, "line"=>"It is the gift of screws."}
+  {"rhyme"=>"7d", "final_word"=>"shoes", "syllables"=>8, "line"=>"Upon my ankle, -- then my shoes"}
+````
+
+You can select just the lines by using the hash key `line`:
+
+````
+$ poefy dickinson rhyme confuse line
+  As if for you to choose,
+  The debauchee of dews!
+  Like flowers that heard the tale of dews,
+  Of independent hues,
+  The intuition of the news
+  It is the gift of screws.
+  Upon my ankle, -- then my shoes
+````
+
+You can do the same thing for the other keys: `rhyme`, `final_word`, and `syllables`.
+
+
+### As a Ruby Gem
+
+To make a poefy database and generate poems from it:
+
+```ruby
+require 'poefy'
+poefy = Poefy::PoefyGen.new('shakespeare')
+poefy.make_database('shakespeare_sonnets.txt')
+```
+
+`make_database` will accept a filename string, an array of lines, or a long string delimited by newlines.
+
+You only have to make the database once. And then to generate poems:
+
+```ruby
+# Different ways to generate sonnets
+poefy = Poefy::PoefyGen.new('shakespeare')
+puts poefy.poem ({ rhyme: 'ababcdcdefefgg' })
+puts poefy.poem ({ rhyme: 'abab cdcd efef gg', indent: '0101 0101 0011 01' })
+puts poefy.poem ({ form: 'sonnet' })
+puts poefy.poem ({ form: :sonnet, syllable: 0 })
+puts poefy.poem ({ form: :sonnet, syllable: 10 })
+puts poefy.poem ({ form: :sonnet, regex: poefy.acrostic('pauldpthompson') })
+puts poefy.poem ({ form: 'sonnet', indent: '01010101001101' })
+puts poefy.poem ({ form: 'sonnet', proper: false })
+```
+
+All options can be specified at object initialisation, and subsequent poems will use those options as default:
+
+```ruby
+# Default to use rondeau poetic form, and proper sentence validation
+poefy = Poefy::PoefyGen.new('shakespeare', { form: 'rondeau', proper: true })
+
+# Generate a properly sentenced rondeau
+puts poefy.poem
+
+# Generate a rondeau without proper validation
+puts poefy.poem ({ proper: false })
+
+# Generate a proper rondeau with a certain indentation
+puts poefy.poem ({ indent: '01012 0012 010112' })
+```
+
+
+## Some tips
+
+### Make a database from a delimited file
+
+Databases are created using data piped into poefy, so you can do any pre-processing before piping.
+
+Use awk to get final field from tab delimited IRC logs.
+
+    $ awk -F$'\t' '{print $NF}' irc_log_20170413.txt | poefy -o irc
+
+
+### Make a database, ignoring short lines
+
+Use sed to filter out lines that are too short:
+
+    $ sed -r '/^.{,20}$/d' st_therese_of_lisieux.txt | poefy -o therese
+
+
+### Make a database, ignoring uppercase lines
+
+Use sed to filter out lines that only contain uppercase lines:
+
+    $ sed -r 'sed '/[a-z]/!d' shakespeare_sonnets.txt | poefy -o shakespeare
+
+
+### Problem: it won't output lines that I know are valid
+
+This code uses a gem called `wordfilter` that will automatically filter out lines that contain [grotty words](https://github.com/dariusk/wordfilter/blob/master/lib/badwords.json). If you really definitely truly don't want to exclude a certain word, you can remove them from the blacklist. For example, if your input lines are from a dissertation on the dance styles of the ska and reggae music scenes, you can call:
+
+```ruby
+Wordfilter.remove_word('skank')
+```
+
+
+### Problem: no seriously, it just won't work.
+
+Remember that the `proper` option is `true` by default. Maybe try setting this to `false` with the `-p` option?
+
+
+## Sample output
+
+### William Shakespeare, villanelle
+
+    $ poefy shakespeare villanelle
+
+````
+How many a holy and obsequious tear
+  Whilst many nymphs that vowed chaste life to keep
+From thee, the pleasure of the fleeting year!
+
+For truth proves thievish for a prize so dear.
+And his love-kindling fire did quickly steep
+  How many a holy and obsequious tear
+
+If thy soul check thee that I come so near,
+Cupid laid by his brand and fell asleep:
+  From thee, the pleasure of the fleeting year!
+
+Not making worse what nature made so clear,
+Whilst my poor lips which should that harvest reap,
+  How many a holy and obsequious tear
+
+Or, if they sing, 'tis with so dull a cheer,
+Do I envy those jacks that nimble leap,
+  From thee, the pleasure of the fleeting year!
+
+And even thence thou wilt be stol'n I fear,
+The world will be thy widow and still weep
+  How many a holy and obsequious tear
+  From thee, the pleasure of the fleeting year!
+````
+
+
+### Emily Dickinson, ballads
+
+    $ poefy dickinson ballad
+
+````
+Enlarged beyond my utmost scope,
+  It waits upon the lawn;
+A purple finger on the slope;
+  It wrinkled, and was gone.
+
+Wisdom is more becoming viewed
+  And yet with amber hands
+I taste a liquor never brewed,
+  Bound to opposing lands.
+
+Confided are his projects pink
+  To say good-by to men.
+And blushing birds go down to drink,
+  Unto the east again.
+
+You, unsuspecting, wear me too --
+  And yet abide the world!
+Whose garden wrestles with the dew,
+  The flying tidings whirled.
+
+We never know how high we are
+  I could not die with you,
+Past midnight, past the morning star!
+  That maketh all things new.
+````
+
+
+### Walt Whitman, Petrarchan sonnet
+
+    $ poefy whitman petrarchan
+
+````
+I see the seal-seeker in his boat poising his lance,
+  I am of the same style, for I am their friend,
+  We the youthful sinewy races, all the rest on us depend,
+Away with old romance!
+
+O something unprov'd! something in a trance!
+  Listen, lose not, it is toward thee they tend,
+  But I do not talk of the beginning or the end.
+And the dead advance as much as the living advance,
+
+I am a dance--play up there! the fit is whirling me fast!
+  I am the credulous man of qualities, ages, races,
+From the chants of the feudal world, the triumphs of kings, slavery, caste,
+
+Garrulous to the very last.
+  An old man bending I come among new faces,
+To justify the past.
+````
+
+
+### English As She Is Spoke, haikus
+
+    $ poefy spoke haiku
+
+````
+What I may to eat?
+Vegetables boiled to a pap
+It is excellent.
+
+Go through that meadow.
+I am going to Cadiz.
+With a inn keeper.
+
+The gossip mistress
+You not make who to babble.
+You interompt me.
+
+The fat of the Leg
+This girl have a beauty edge.
+You shall catch cold one's.
+
+How the times are changed!
+We have sung, danced, laugh and played.
+The curtains let down.
+````
+
+
+### St. Therese of Lisieux, villanelle
+
+    $ poefy therese villanelle
+
+````
+I shall behold Thy lovely Face once more,
+  And, oh! remember thou thy "little queen," --
+Joy seems on us to pour.
+
+Remember Thou that on my native shore,
+With Him for Guide, the fight I face serene;
+  I shall behold Thy lovely Face once more,
+
+And for His grace alone implore;
+And murmuring a prayer for her, "thy queen,"
+  Joy seems on us to pour.
+
+I come with comfort for sad hearts and sore.
+Remember thou thy faithful child, Celine,
+  I shall behold Thy lovely Face once more,
+
+Then angel-hands shall ope the door;
+Beside her King shall yet be seen.
+  Joy seems on us to pour.
+
+Comes to my ear sin's wild and blasphemous roar;
+Remember thou that on the terrace green
+  I shall behold Thy lovely Face once more,
+  Joy seems on us to pour.
+````
+
+
+### Walt Whitman, lipogram sonnet on 'e'
+
+    $ poefy whitman sonnet -x'^[^e]*$'
+
+````
+Land! land! O land!
+Boston bay.
+bright sword in thy hand,
+on our way?
+many a star at night,
+stand fast;)
+plain sight,
+In full rapport at last.
+I wait for a boat,
+musical rain,
+ribs and throat,
+thousands slain,
+walk hand in hand.
+Of city for city and land for land.
+````
+
+
+### William Shakespeare, acrostic sonnet
+
+    $ poefy shakespeare sonnet -s10 -a'pauldpthompson'
+
+````
+Pitiful thrivers, in their gazing spent?
+And such a counterpart shall fame his wit,
+Under the blow of thralled discontent,
+Let him but copy what in you is writ,
+Death's second self, that seals up all in rest.
+Past reason hated, as a swallowed bait,
+Then, in the blazon of sweet beauty's best,
+Haply I think on thee, and then my state,
+One blushing shame, another white despair;
+My heart doth plead that thou in him dost lie,
+Past cure I am, now Reason is past care,
+She carved thee for her seal, and meant thereby,
+Oh sure I am the wits of former days,
+Nor gates of steel so strong but Time decays?
+````

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+task :default => :spec
+task :test    => :spec