poefy 1.1.1 → 2.0.0

data/bin/poefy

@@ -1,310 +1,347 @@
-#!/usr/bin/env ruby
-# Encoding: UTF-8
-
-################################################################################
-# Use Poefy::Poem to make a poem from the command line.
-################################################################################
-
-require 'optparse'
-
-require_relative '../lib/poefy.rb'
-
-Poefy.console = true
-Poefy.require_db
-
-################################################################################
-
-# List the corpora & descriptions in a nice table format.
-def corpora
-  output = Poefy.corpora_with_desc
-  width = output.keys.max_by(&:length).length
-  output.map do |key, value|
-    sprintf "%-#{width}s  %s", key, value
-  end
-end
-
-# Create a new Poefy::Poem object, and catch any exceptions thrown.
-def poefy_new corpus, options = nil
-  Poefy::Poem.new corpus, options
-rescue Poefy::DatabaseError => e
-  STDERR.puts e.console_msg
-  exit 1
-end
-
-################################################################################
-
-def parse_options
-  options = {}
-
-  # Set up variables used later.
-  forms = Poefy.poetic_forms
-  forms_by_4 = forms.each_slice(4).to_a.map { |i| i.join ', ' }
-  rhyme_docs = "    This is the most important argument.
-      All other form strings are based on this.
-    Each token represents a line.
-      (Token examples: 'a', 'b', 'A1', ' ')
-    Letters indicate rhymes, so all 'a' or 'A' lines have the same rhyme.
-      (Example, limerick: 'aabba')
-    Uppercase letter lines will be duplicated exactly.
-      This is used to create refrain lines.
-      (Example, rondeau: 'aabba aabR aabbaR')
-    Numbers after a capital letter indicate which specific line to repeat.
-      (Example, villanelle: 'A1bA2 abA1 abA2 abA1 abA2 abA1A2'"
-
-  # Get all of the command-line options.
-  optparse = OptionParser.new do |opts|
-
-    # Set a banner, displayed at the top of the help screen.
-    program_info = %[      Poefy, Line-Based Poem Generator
-      Version #{Poefy.version_number} - #{Poefy.version_date}
-      https://github.com/nossidge/poefy
-      Paul Thompson - nossidge@gmail.com
-    ].gsub('      ','  ')
-
-    usage = %[Usage: poefy shakespeare -m < shakespeare_sonnets.txt
-      poefy shakespeare -d "The sonnets of Shakespeare"
-      poefy shakespeare sonnet
-      poefy spoke haiku
-      poefy therese -r 'abab cdcd efef gg' -i '0101 0101 0011 01'
-      poefy whitman -r 'A1bA2 abA1 abA2 abA1 abA2 abA1A2'
-      poefy -Lc
-      poefy -f
-    ].gsub('      ','       ')
-
-    list = 'Corpora: ' + corpora.join("\n         ")
-
-    opts.banner = program_info + "\n" + usage + "\n" + list + "\n\n"
-
-    # These will be further validated within the class.
-    opts.on('-f', '--form [STRING]',
-            "A named poetic form for the output\n" +
-            ' ' * 37 + "Specifies rhyme, indent and syllable\n" +
-            ' ' * 37 + "One of:\n" +
-            ' ' * 39 + forms_by_4.join("\n" + ' ' * 39)) do |s|
-      if s.nil?
-        puts forms
-        exit 0
-      end
-      options[:form] = s
-    end
-    opts.on('-r', '--rhyme STRING', "(See 'Description of rhyme string' below)") do |s|
-      options[:rhyme] = s
-    end
-    opts.on('-i', '--indent STRING', "Indentation of each line") do |s|
-      options[:indent] = s
-    end
-    opts.on('-s', '--syllable STRING',
-                  "Apply syllable constraints to certain lines") do |s|
-      options[:syllable] = s
-    end
-    opts.on('-x', '--regex STRING',
-                  "Apply regex constraints to certain lines") do |s|
-      options[:regex] = s
-    end
-
-    # Options for acrostic poems.
-    opts.on('-a', '--acrostic STRING',
-            "Generate an acrostic on a certain word") do |s|
-      options[:acrostic] = s
-    end
-    opts.on('-A', '--acrostic_x STRING',
-            "Generate an acrostic with better handling of 'x'") do |s|
-      options[:acrostic_x] = s
-    end
-
-    # Handle proper sentence structure.
-    opts.separator nil
-    opts.on('-p', '--proper',
-            "Ensure first word is not 'and but or nor yet'\n" +
-            ' ' * 39 + "and final line ends with closing punctuation'\n" +
-            ' ' * 39 + "Defaults to ON -- Use this option to DISABLE") do
-      options[:proper] = false
-    end
-    opts.on('-c', '--capital',
-            "Capitalise the first letter of each line") do
-      options[:transform] = proc { |line| line.capitalize }
-    end
-
-    # Poem output options.
-    opts.separator nil
-    opts.on('-n', '--number INTEGER',
-            "Number of poems to generate") do |n|
-      options[:number] = n.to_i
-    end
-
-    # Corpus options.
-    opts.separator nil
-    opts.on('-m', '--make [STRING]',
-            "Make new or overwrite existing corpus with piped input\n" + ' ' * 39 +
-            "Argument is a description of the corpus") do |s|
-      options[:make_corpus] = true
-      options[:corpus_desc] = s
-    end
-    opts.on('-d', '--desc STRING',
-            "Overwrite the description of the corpus") do |s|
-      options[:corpus_desc] = s
-    end
-    opts.on('-l', '--local',
-            "(SQLite only) Default is to use database files from /data/\n" + ' ' * 39 +
-            "With this option, paths are relative to working directory") do
-      options[:local] = true
-    end
-
-    # Database internals.
-    opts.separator nil
-    opts.on('-L', '--list [C|D]',
-            "List all the installed corpora\n" + ' ' * 39 +
-            "Append 'c' or 'd' to list just the corpora or descriptions") do |s|
-      s ||= ' '
-      if s[0].casecmp('c').zero?
-        puts Poefy.corpora
-      elsif s[0].casecmp('d').zero?
-        puts Poefy.corpora_with_desc.values
-      else
-        puts corpora
-      end
-      exit 0
-    end
-    opts.on('-D', '--database [pg|sqlite3]',
-            "Display the database implementation setting\n" + ' ' * 39 +
-            "Append 'pg' or 'sqlite3' to change programs") do |s|
-      s ||= ' '
-      if s[0].casecmp('p').zero?
-        Poefy.database_type = 'pg'
-      elsif s[0].casecmp('s').zero?
-        Poefy.database_type = 'sqlite3'
-      end
-      puts Poefy.database_type
-      exit 0
-    end
-
-    # Help output.
-    opts.separator nil
-    opts.on('-h', '--help', 'Display this help screen' ) do
-      puts opts
-      exit 0
-    end
-    opts.on('-v', '--version', 'Display the version number' ) do
-      puts "poefy #{Poefy.version_number} (#{Poefy.version_date})"
-      exit 0
-    end
-
-    opts.separator nil
-    opts.separator "Description of rhyme string:"
-    opts.separator rhyme_docs
-    opts.separator nil
-    opts.separator "All of this is much better documented in README.md"
-  end
-
-  # Parse the options and show errors on failure.
-  begin
-    optparse.parse! ARGV
-  rescue OptionParser::ParseError => e
-    puts e
-    exit 1
-  end
-
-  options
-end
-
-################################################################################
-
-# Parse the options to shift the ARGV list.
-options = parse_options
-
-# Read data lines from STDIN.
-data = (not STDIN.tty? and not STDIN.closed?) ? STDIN.read : nil
-
-# Corpus name is the first argument.
-first_arg = ARGV.first
-if first_arg.nil?
-  STDERR.puts "ERROR: Please specify a corpus name to read from/to"
-  exit 1
-end
-
-# Poetic form name is the second argument, if it exists.
-second_arg = (ARGV.length > 1) ? ARGV[1] : ''
-options[:form] = second_arg if second_arg != ''
-
-# If we need to make a corpus.
-# Exit the program after corpus is generated.
-if options[:make_corpus]
-
-  # It's okay if there's an error with an existing database, because
-  # we're creating a new one. So we can swallow any errors here.
-  begin
-    poefy = Poefy::Poem.new first_arg
-  rescue Poefy::DatabaseError
-  end
-
-  if data
-    poefy.make_database data, options[:corpus_desc], true
-    poefy.close
-    exit 0
-  else
-    STDERR.puts 'ERROR: Need text input to generate a corpus'
-    STDERR.puts '       Please pipe some data into the program'
-    exit 1
-  end
-end
-
-# If we need to update a corpus description.
-# Exit the program after corpus is generated.
-if options[:corpus_desc]
-  poefy = poefy_new first_arg
-  begin
-    poefy.corpus.desc = options[:corpus_desc]
-    poefy.close
-    exit 0
-  rescue
-    STDERR.puts "ERROR: Corpus '#{first_arg}' does not yet exist"
-    exit 1
-  end
-end
-
-# If the second argument is 'rhyme', then output all
-#   lines that rhyme with the word.
-if second_arg == 'rhyme'
-  poefy = poefy_new first_arg
-  third_arg  = (ARGV.length > 2) ? ARGV[2] : nil
-  fourth_arg = (ARGV.length > 3) ? ARGV[3] : nil
-  puts poefy.corpus.rhymes(third_arg, fourth_arg)
-  exit 0
-end
-
-# If there is piped data, or the second argument is a file,
-#   then use that as the poetic_form.
-if data or File.exists?(second_arg)
-  options[:form_from_text] = (data || second_arg)
-end
-
-# Create poefy object using the options.
-begin
-  poefy = poefy_new first_arg, options
-rescue Poefy::DatabaseError => e
-  STDERR.puts e.console_msg
-  exit 1
-end
-
-# Make the correct number of poems, and output them.
-number = options[:number] || 1
-number.times do |i|
-
-  # Exit the program if a Poefy error is raised.
-  begin
-    poem = poefy.poem
-  rescue Poefy::Error => e
-    STDERR.puts e.console_msg
-    exit 1
-  end
-
-  if poem
-    puts poem
-    puts nil if i < number - 1
-  end
-end
-
-# Close the database connection.
-poefy.close
-
-################################################################################
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+################################################################################
+# Use Poefy::Poem to make a poem from the command line.
+################################################################################
+
+require 'optparse'
+
+require_relative '../lib/poefy.rb'
+
+Poefy.console = true
+Poefy.require_db
+
+################################################################################
+
+# List the corpora & descriptions in a nice table format.
+def corpora
+  output = Poefy.corpora_with_desc
+  width = output.keys.max_by(&:length).length
+  output.map do |key, value|
+    sprintf "%-#{width}s  %s", key, value
+  end
+end
+
+# Create a new Poefy::Poem object, and catch any exceptions thrown.
+def poefy_new corpus, options = nil
+  Poefy::Poem.new corpus, options
+rescue Poefy::DatabaseError => e
+  STDERR.puts e.console_msg
+  exit 1
+end
+
+################################################################################
+
+def parse_options
+  options = {}
+
+  # Set up variables used later.
+  forms = Poefy.poetic_forms
+  forms_by_4 = forms.each_slice(4).to_a.map { |i| i.join ', ' }
+  rhyme_docs = "    This is the most important argument.
+      All other form strings are based on this.
+    Each token represents a line.
+      (Token examples: 'a', 'b', 'A1', ' ')
+    Letters indicate rhymes, so all 'a' or 'A' lines have the same rhyme.
+      (Example, limerick: 'aabba')
+    Uppercase letter lines will be duplicated exactly.
+      This is used to create refrain lines.
+      (Example, rondeau: 'aabba aabR aabbaR')
+    Numbers after a capital letter indicate which specific line to repeat.
+      (Example, villanelle: 'A1bA2 abA1 abA2 abA1 abA2 abA1A2'"
+
+  # Get all of the command-line options.
+  optparse = OptionParser.new do |opts|
+
+    # Set a banner, displayed at the top of the help screen.
+    program_info = %[      Poefy, Line-Based Poem Generator
+      Version #{Poefy.version_number} - #{Poefy.version_date}
+      https://github.com/nossidge/poefy
+      Paul Thompson - nossidge@gmail.com
+    ].gsub('      ','  ')
+
+    usage = %[Usage: poefy shakespeare -m < shakespeare_sonnets.txt
+      poefy shakespeare -d "The sonnets of Shakespeare"
+      poefy shakespeare sonnet
+      poefy spoke haiku
+      poefy therese -r 'abab cdcd efef gg' -i '0101 0101 0011 01'
+      poefy whitman -r 'A1bA2 abA1 abA2 abA1 abA2 abA1A2'
+      poefy -Lc
+      poefy -f
+    ].gsub('      ','       ')
+
+    list = 'Corpora: ' + corpora.join("\n         ")
+
+    opts.banner = program_info + "\n" + usage + "\n" + list + "\n\n"
+
+    # These will be further validated within the class.
+    opts.on('-f', '--form [STRING]',
+            "A named poetic form for the output\n" +
+            ' ' * 37 + "Specifies rhyme, indent and syllable\n" +
+            ' ' * 37 + "One of:\n" +
+            ' ' * 39 + forms_by_4.join("\n" + ' ' * 39)) do |s|
+      if s.nil?
+        puts forms
+        exit 0
+      end
+      options[:form] = s
+    end
+    opts.on('-r', '--rhyme STRING', "(See 'Description of rhyme string' below)") do |s|
+      options[:rhyme] = s
+    end
+    opts.on('-i', '--indent STRING', "Indentation of each line") do |s|
+      options[:indent] = s
+    end
+    opts.on('-s', '--syllable STRING',
+                  "Apply syllable constraints to certain lines") do |s|
+      options[:syllable] = s
+    end
+    opts.on('-x', '--regex STRING',
+                  "Apply regex constraints to certain lines") do |s|
+      options[:regex] = s
+    end
+
+    # Options for acrostic poems.
+    opts.on('-a', '--acrostic STRING',
+            "Generate an acrostic on a certain word") do |s|
+      options[:acrostic] = s
+    end
+    opts.on('-A', '--acrostic_x STRING',
+            "Generate an acrostic with better handling of 'x'") do |s|
+      options[:acrostic_x] = s
+    end
+
+    # Handle proper sentence structure.
+    opts.separator nil
+    opts.on('-p', '--proper',
+            "Ensure first word is not 'and but or nor yet'\n" +
+            ' ' * 39 + "and final line ends with closing punctuation'\n" +
+            ' ' * 39 + "Defaults to ON -- Use this option to DISABLE") do
+      options[:proper] = false
+    end
+    opts.on('-c', '--capital',
+            "Capitalise the first letter of each line") do
+      options[:transform] = proc do |line|
+        regex = /[a-zA-Z]/
+        line[regex] = line[regex].upcase if line[regex]
+        line
+      end
+    end
+
+    # Poem output options.
+    opts.separator nil
+    opts.on('-n', '--number INTEGER',
+            "Number of poems to generate") do |n|
+      options[:number] = n.to_i
+    end
+
+    # Corpus options.
+    opts.separator nil
+    opts.on('-m', '--make [STRING]',
+            "Make new or overwrite existing corpus with piped input\n" + ' ' * 39 +
+            "Argument is a description of the corpus") do |s|
+      options[:make_corpus] = true
+      options[:corpus_desc] = s
+    end
+    opts.on('-d', '--desc STRING',
+            "Overwrite the description of the corpus") do |s|
+      options[:corpus_desc] = s
+    end
+    opts.on('-l', '--local',
+            "(SQLite only) Default is to use database files from /data/\n" + ' ' * 39 +
+            "With this option, paths are relative to working directory") do
+      options[:local] = true
+    end
+
+    # Database internals.
+    opts.separator nil
+    opts.on('-L', '--list [C|D]',
+            "List all the installed corpora\n" + ' ' * 39 +
+            "Append 'c' or 'd' to list just the corpora or descriptions") do |s|
+      s ||= ' '
+      if s[0].casecmp('c').zero?
+        puts Poefy.corpora
+      elsif s[0].casecmp('d').zero?
+        puts Poefy.corpora_with_desc.values
+      else
+        puts corpora
+      end
+      exit 0
+    end
+    opts.on('-D', '--database [pg|sqlite3]',
+            "Display the database implementation setting\n" + ' ' * 39 +
+            "Append 'pg' or 'sqlite3' to change programs") do |s|
+      s ||= ' '
+      if s[0].casecmp('p').zero?
+        Poefy.database_type = 'pg'
+      elsif s[0].casecmp('s').zero?
+        Poefy.database_type = 'sqlite3'
+      end
+      puts Poefy.database_type
+      exit 0
+    end
+
+    # Help output.
+    opts.separator nil
+    opts.on('-h', '--help', 'Display this help screen' ) do
+      puts opts
+      exit 0
+    end
+    opts.on('-v', '--version', 'Display the version number' ) do
+      puts "poefy #{Poefy.version_number} (#{Poefy.version_date})"
+      exit 0
+    end
+
+    opts.separator nil
+    opts.separator "Description of rhyme string:"
+    opts.separator rhyme_docs
+    opts.separator nil
+    opts.separator "All of this is much better documented in README.md"
+  end
+
+  # Parse the options and show errors on failure.
+  begin
+    optparse.parse! ARGV
+  rescue OptionParser::ParseError => e
+    puts e
+    exit 1
+  end
+
+  options
+end
+
+################################################################################
+
+# Parse the options to shift the ARGV list.
+options = parse_options
+
+# Read data lines from STDIN.
+data = (not STDIN.tty? and not STDIN.closed?) ? STDIN.read : nil
+
+# Corpus name is the first argument.
+first_arg = ARGV.first
+if first_arg.nil?
+  STDERR.puts "ERROR: Please specify a corpus name to read from/to"
+  exit 1
+end
+
+# Poetic form name is the second argument, if it exists.
+second_arg = (ARGV.length > 1) ? ARGV[1] : ''
+options[:form] = second_arg if second_arg != ''
+
+# If we need to make a corpus.
+# Exit the program after corpus is generated.
+if options[:make_corpus]
+
+  # It's okay if there's an error with an existing database, because
+  # we're creating a new one. So we can swallow any errors here.
+  begin
+    poefy = Poefy::Poem.new first_arg
+  rescue Poefy::DatabaseError
+  end
+
+  if data
+    poefy.make_database data, options[:corpus_desc], true
+    poefy.close
+    exit 0
+  else
+    STDERR.puts 'ERROR: Need text input to generate a corpus'
+    STDERR.puts '       Please pipe some data into the program'
+    exit 1
+  end
+end
+
+# If we need to update a corpus description.
+# Exit the program after corpus is generated.
+if options[:corpus_desc]
+  poefy = poefy_new first_arg
+  begin
+    poefy.corpus.desc = options[:corpus_desc]
+    poefy.close
+    exit 0
+  rescue
+    STDERR.puts "ERROR: Corpus '#{first_arg}' does not yet exist"
+    exit 1
+  end
+end
+
+# If the second argument is 'rhyme', then output all
+#   lines that rhyme with the word.
+if second_arg == 'rhyme'
+  poefy = poefy_new first_arg
+  rhyme_word = (ARGV.length > 2) ? ARGV[2] : nil
+  rhyme_key  = (ARGV.length > 3) ? ARGV[3] : nil
+
+  # If the value for 'rhyme_key' is instead 'json', then set that bool.
+  is_output_json = (rhyme_key.to_s.downcase == 'json')
+  rhyme_key = nil if is_output_json
+
+  # This will return an array of elements.
+  # If the 'rhyme_key' is nil, it will be an array of hashes.
+  # If the 'rhyme_key' is not, it will be an array of strings.
+  lines = poefy.corpus.rhymes(rhyme_word, rhyme_key)
+
+  if is_output_json or !rhyme_key.nil?
+    puts lines
+  else
+    # Convert the array of hashes to an array of arrays.
+    lines.map! { |i| i.values }
+
+    # Find the max length of each column.
+    max_len = []
+    lines.each do |row|
+      row.each.with_index do |col, index|
+        max_len[index] ||= 0
+        if col.length > max_len[index]
+          max_len[index] = col.length
+        end
+      end
+    end
+
+    # Output to console as whitespace delimited.
+    lines.each do |i|
+      pform  = "%-#{max_len[0]+3}s %-#{max_len[1]+3}s "
+      pform += "%-#{max_len[2]+3}s %-#{max_len[3]}s\n"
+      printf pform, *i
+    end
+  end
+  exit 0
+end
+
+# If there is piped data, or the second argument is a file,
+#   then use that as the poetic_form.
+if data or File.exist?(second_arg)
+  options[:form_from_text] = (data || second_arg)
+end
+
+# Create poefy object using the options.
+begin
+  poefy = poefy_new first_arg, options
+rescue Poefy::DatabaseError => e
+  STDERR.puts e.console_msg
+  exit 1
+end
+
+# Make the correct number of poems, and output them.
+number = options[:number] || 1
+number.times do |i|
+
+  # Exit the program if a Poefy error is raised.
+  begin
+    poem = poefy.poem
+  rescue Poefy::Error => e
+    STDERR.puts e.console_msg
+    exit 1
+  end
+
+  if poem
+    puts poem
+    puts nil if i < number - 1
+  end
+end
+
+# Close the database connection.
+poefy.close
+
+################################################################################