poefy 0.6.1 → 1.0.0

data/lib/poefy/generation.rb

@@ -16,7 +16,7 @@ module Poefy
     # Generate specific poem types.
     def poem poetic_form = @poetic_form
 
-      if !@db.exists?
+      if !@corpus.exists?
         return handle_error 'ERROR: Database does not yet exist', nil
       end
 
@@ -59,28 +59,6 @@ module Poefy
       output
     end
 
-    # Get all rhyming lines for the word.
-    def rhymes word, key = nil
-      return nil if word.nil?
-      sproc = @db.db.prepare %Q[
-        SELECT rhyme, final_word, syllables, line
-        FROM lines
-        WHERE rhyme = ?
-        ORDER BY rhyme, final_word, syllables, line
-      ]
-      output = word.to_phrase.rhymes.keys.map do |rhyme|
-        sproc.reset!
-        sproc.bind_param(1, rhyme)
-        sproc.execute.to_a
-      end.flatten
-      sproc.close
-      if !key.nil? and %w[rhyme final_word syllables line].include?(key)
-        output.map!{ |i| i[key] }
-      end
-      output
-    end
-
-
     private
 
       # Use the constraints in 'poetic_form' to generate a poem.
@@ -204,7 +182,7 @@ module Poefy
         # Loop through each rhyme group to find lines that satisfy the conditions.
         distinct_line_conds.each do |rhyme_letter, line_conds|
 
-          # The conditions that will be passed to '#conditional_selection'.
+          # The conditions that will be passed to '#conditional_sample'.
           # This is an array of procs, one for each line.
           conditions = line_conds.map do |cond|
             proc { |arr, elem| diff_end(arr, elem) and validate_line(elem, cond)}
@@ -221,7 +199,7 @@ module Poefy
           # If all the lines include a 'syllable' condition,
           #   then we can specify to only query for matching lines.
           min_max = syllable_min_max line_conds
-          rhymes = @db.sproc_rhymes_all!(line_conds.count, min_max)
+          rhymes = @corpus.rhymes_by_count(line_conds.count, min_max)
 
           # Get just the rhyme part of the hash.
           rhymes = rhymes.map{ |i| i['rhyme'] }
@@ -306,7 +284,7 @@ module Poefy
       # (In a reasonable time-frame)
       def try_rhyme conditions, rhyme, syllable_min_max = nil, regex_all = nil
         output = []
-        lines = @db.sproc_lines_all!(rhyme, syllable_min_max)
+        lines = @corpus.lines_by_rhyme(rhyme, syllable_min_max)
 
         # To reduce the number of permutations, reject lines
         #   that do not match any of the lines regex.
@@ -314,7 +292,7 @@ module Poefy
 
         begin
           Timeout::timeout(2) do
-            output = conditional_selection(lines.shuffle, conditions)
+            output = lines.shuffle.conditional_sample(conditions)
           end
         rescue
           output = []

data/lib/poefy/handle_error.rb

@@ -13,13 +13,21 @@ module Poefy
     private
 
       def handle_error msg, return_value = nil
-        if @console
+        if Poefy.console
           STDERR.puts msg
           exit 1
         end
         return_value
       end
 
+      def raise_error msg
+        if Poefy.console
+          STDERR.puts msg
+          exit 1
+        end
+        raise msg
+      end
+
   end
 
 end

data/lib/poefy/{poefy_gen_base.rb → poem_base.rb}

@@ -2,38 +2,42 @@
 # Encoding: UTF-8
 
 ################################################################################
-# Base internals for the PoefyGen class.
+# Base internals for the Poem class.
 ################################################################################
 
 module Poefy
 
-  module PoefyGenBase
+  module PoemBase
 
-    attr_reader :console, :db, :local, :overwrite
+    attr_reader :corpus, :local, :overwrite
 
     def initialize db_name, options = {}
       handle_options options
-      @db = Poefy::Database.new get_database_file(db_name.to_s), @console
+      @corpus = Poefy::Database.new db_name, @local
     end
 
     # Make a database using the given lines.
-    def make_database input, overwrite = @overwrite
+    def make_database input, description = nil, overwrite = @overwrite
       lines = validate_lines input
-      lines.map(&:strip!)
-      @db.close if @db
+      lines.map! do |line|
+        line.force_encoding('utf-8')
+            .gsub("\u00A0", ' ')
+            .strip
+      end
+      @corpus.close if @corpus
       if overwrite
-        @db.make_new! lines
+        @corpus.make_new! lines, description
       else
-        @db.make_new lines
+        @corpus.make_new lines, description
       end
     end
-    def make_database! input
-      make_database input, true
+    def make_database! input, description = nil
+      make_database input, description, true
     end
 
     # Close the database.
     def close
-      @db.close
+      @corpus.close
     end
 
     # Validate the lines. Arg could be a filename,
@@ -44,28 +48,13 @@ module Poefy
       lines = File.exists?(input.to_s) ? File.read(input) : input
 
       # If lines is not an array, assume string and split on newlines.
-      lines = lines.respond_to?(:each) ? lines : lines.split("\n")
-      lines
+      lines.respond_to?(:each) ? lines : lines.split("\n")
     end
 
     private
 
-      # Find the correct database file.
-      # If local, just use the value.
-      # Else, use the database in /data/ directory.
-      def get_database_file database_name
-        if @local
-          database_name
-        else
-          path = File.expand_path('../../../data', __FILE__)
-          file = File.basename(database_name, '.db')
-          path + '/' + file + '.db'
-        end
-      end
-
       # Handle the optional initialize options hash.
       def handle_options options
-        @console     = options[:console]   || false
         @overwrite   = options[:overwrite] || false
         @local       = options[:local]     || false
         @poetic_form = {}
@@ -116,15 +105,6 @@ module Poefy
         output
       end
 
-      # Handle error message. Quit the program if called from console.
-      def handle_error msg
-        if @console
-          STDERR.puts msg
-          exit 1
-        end
-        nil
-      end
-
   end
 
 end

data/lib/poefy/poetic_form_from_text.rb

@@ -90,7 +90,7 @@ module Poefy
         # Compare each other rhyme tag, order by closeness.
         found_rhyme = line[:rhyme_tags].first
         if line[:rhyme_tags].length > 1
-          lines.by_distance(index).each do |i|
+          lines.sort_by_distance_from_index(index).each do |i|
             i[:rhyme_tags].each do |tag|
               if line[:rhyme_tags].include?(tag)
                 found_rhyme = tag

data/lib/poefy/poetic_forms.rb

@@ -357,7 +357,6 @@ module Poefy
         output.reject!{ |k| k <= 0 }
 
         # Return sorted hash.
-        # ToDo: Doesn't need to be sorted in final code.
         sort_hash output
       end
 

data/lib/poefy/self.rb

@@ -1,21 +1,39 @@
-#!/usr/bin/env ruby
-# Encoding: UTF-8
-
-################################################################################
-# Class methods for Poefy module.
-################################################################################
-
-module Poefy
-
-  # Array of all '.db' files in /data/.
-  # Do not include databases used for testing.
-  def self.all_databases
-    path = File.expand_path('../../../data', __FILE__)
-    Dir["#{path}/*.db"].map do |i|
-      File.basename(i, '.db')
-    end.reject{ |i| i.start_with?('spec_') }
-  end
-
-end
-
-################################################################################
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+################################################################################
+# Class methods for Poefy module.
+################################################################################
+
+module Poefy
+  class << self
+
+    # Array of all databases (SQLite) or tables (Postgres)
+    # Does not include databases used for testing.
+    def corpora
+      Poefy::Database.list
+    end
+    alias_method :tables,    :corpora
+    alias_method :databases, :corpora
+
+    # Same, but with the description of the corpus too.
+    def corpora_with_desc
+      Poefy::Database.list_with_desc
+    end
+    alias_method :tables_with_desc,    :corpora_with_desc
+    alias_method :databases_with_desc, :corpora_with_desc
+
+    # Array of all names of poetic forms.
+    def poetic_forms
+      PoeticForms::POETIC_FORMS.keys.reject { |i| i == :default }
+    end
+
+    # Find the root of the directory tree.
+    def root
+      File.expand_path('../../../', __FILE__)
+    end
+
+  end
+end
+
+################################################################################

data/lib/poefy/string_manipulation.rb

@@ -45,7 +45,7 @@ module Poefy
       # This will not work for floats.
       # It will also break emoticons, but GIGO.
       def humanize_instr text
-        output = text
+        output = text.dup
         loop do
           num = output[/\d+/]
           break if not num

data/lib/poefy/version.rb

@@ -1,29 +1,26 @@
-#!/usr/bin/env ruby
-# Encoding: UTF-8
-
-################################################################################
-# The current version number and date.
-################################################################################
-
-module Poefy
-
-  def self.version_number
-    Gem::Version.new VERSION::STRING
-  end
-
-  def self.version_date
-    '2017-06-19'
-  end
-
-  module VERSION
-    MAJOR = 0
-    MINOR = 6
-    TINY  = 1
-    PRE   = nil
-
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
-  end
-
-end
-
-################################################################################
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+################################################################################
+# The current version number and date.
+################################################################################
+
+module Poefy
+
+  def self.version_number
+    major = 1
+    minor = 0
+    tiny  = 0
+    pre   = nil
+
+    string = [major, minor, tiny, pre].compact.join('.')
+    Gem::Version.new string
+  end
+
+  def self.version_date
+    '2017-10-02'
+  end
+
+end
+
+################################################################################

data/lib/poefy.rb

@@ -2,47 +2,42 @@
 # Encoding: UTF-8
 
 ################################################################################
-# Line-based, used only to rearrange lines of text, not create new lines.
-# Also uses 'wordfilter' to get rid of yucky words.
-#
-# https://en.wikipedia.org/wiki/Category:Western_medieval_lyric_forms
-# https://en.wikipedia.org/wiki/Virelai
-# https://en.wikipedia.org/wiki/List_of_compositions_by_Guillaume_de_Machaut#Virelais
+# Create a database from text lines.
+# Read the database to generate poetry.
 ################################################################################
 
+require 'conditional_sample'
 require 'ruby_rhymes'
 require 'wordfilter'
 require 'humanize'
-require 'tempfile'
-require 'sqlite3'
 require 'timeout'
+require 'yaml'
 
 require_relative 'poefy/version.rb'
 require_relative 'poefy/self.rb'
-require_relative 'poefy/poefy_gen_base.rb'
+require_relative 'poefy/db_type.rb'
+require_relative 'poefy/poem_base.rb'
 require_relative 'poefy/generation.rb'
 require_relative 'poefy/poetic_forms.rb'
 require_relative 'poefy/poetic_form_from_text.rb'
 require_relative 'poefy/string_manipulation.rb'
 require_relative 'poefy/handle_error.rb'
 require_relative 'poefy/database.rb'
-require_relative 'poefy/conditional_satisfaction.rb'
+require_relative 'poefy/conditional_sample.rb'
 require_relative 'poefy/core_extensions/array.rb'
 
 ################################################################################
 
-# Create a database from text lines.
-# Read the database to generate poetry.
 module Poefy
 
-  class PoefyGen
+  class Poem
 
-    include Poefy::PoefyGenBase
+    include Poefy::PoemBase
     include Poefy::Generation
     include Poefy::PoeticForms
     include Poefy::PoeticFormFromText
     include Poefy::StringManipulation
-    include Poefy::ConditionalSatisfaction
+    include Poefy::ConditionalSample
     include Poefy::HandleError
 
   end

data/poefy.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email         = ['nossidge@gmail.com']
 
   s.summary       = %q{Create rhyming poetry by rearranging lines of text}
-  s.description   = %q{Create poems from an input text file, by generating and querying a SQLite database describing each line. Poems are created using a template to select lines from the database, according to closing rhyme, syllable count, and regex matching.}
+  s.description   = %q{Create poems from an input text file, by generating and querying a SQLite or PostgreSQL database describing each line. Poems are created using a template to select lines from the database, according to closing rhyme, syllable count, and regex matching.}
   s.homepage      = 'https://github.com/nossidge/poefy'
 
   s.version       = Poefy.version_number
@@ -23,12 +23,23 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.bindir        = 'bin'
 
+  s.post_install_message = %q{---
+    Thanks for installing poefy.
+    Please also install one of the below gems:
+      $ gem install poefy-pg
+      $ gem install poefy-sqlite
+    Then run this command to generate the included corpora:
+      $ poefy_make
+    ---}.split("\n").map{ |i| i.sub('    ','') }.join("\n")
+
   s.add_development_dependency('bundler', '~> 1.13')
   s.add_development_dependency('rake',    '~> 10.0')
   s.add_development_dependency('rspec',   '~> 3.0')
+  s.add_development_dependency('poefy-sqlite3', '~> 0.1')
+  s.add_development_dependency('poefy-pg',      '~> 0.1')
 
-  s.add_runtime_dependency('sqlite3',     '~> 1.3', '>= 1.3.13')
-  s.add_runtime_dependency('ruby_rhymes', '~> 0.1', '>= 0.1.2')
-  s.add_runtime_dependency('wordfilter',  '~> 0.2', '>= 0.2.6')
-  s.add_runtime_dependency('humanize',    '~> 1.4', '>= 1.4.0')
+  s.add_runtime_dependency('conditional_sample', '~> 1.0', '>= 1.0.0')
+  s.add_runtime_dependency('ruby_rhymes',        '~> 0.1', '>= 0.1.2')
+  s.add_runtime_dependency('wordfilter',         '~> 0.2', '>= 0.2.6')
+  s.add_runtime_dependency('humanize',           '~> 1.4', '>= 1.4.0')
 end

data/spec/poefy_unit_spec.rb

@@ -0,0 +1,199 @@
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+################################################################################
+
+describe Poefy::Poem, "-- Unit tests" do
+
+  describe "#transform_string_regex" do
+
+    # Singleton which includes the method.
+    # Make the private methods public.
+    let(:obj) do
+      class Sing
+        include Poefy::PoeticForms
+        include Poefy::StringManipulation
+        public *private_instance_methods
+      end.new
+    end
+
+    describe "using rhyme string 'aabba'" do
+      input_and_output = [
+        ['^[^e]*$',
+          {
+            1=>/^[^e]*$/,
+            2=>/^[^e]*$/,
+            3=>/^[^e]*$/,
+            4=>/^[^e]*$/,
+            5=>/^[^e]*$/
+          }],
+        ['[/(?=^[A-Z])(?=^[^eE]*$)/,/^[^eE]*$/,/^[^eE]*$/,/^[^eE]*$/,/^[^eE]*$/]',
+          {
+            1=>/(?=^[A-Z])(?=^[^eE]*$)/,
+            2=>/^[^eE]*$/,
+            3=>/^[^eE]*$/,
+            4=>/^[^eE]*$/,
+            5=>/^[^eE]*$/
+          }],
+        ['{1=>/(?=^[A-Z])(?=^[^eE]*$)/,2=>/^[^eE]*$/,3=>/^[^eE]*$/,4=>/^[^eE]*$/,5=>/^[^eE]*$/}',
+          {
+            1=>/(?=^[A-Z])(?=^[^eE]*$)/,
+            2=>/^[^eE]*$/,
+            3=>/^[^eE]*$/,
+            4=>/^[^eE]*$/,
+            5=>/^[^eE]*$/
+          }],
+        ['{0=>/^[^eE]*$/,1=>/(?=^[A-Z])(?=^[^eE]*$)/}',
+          {
+            1=>/(?=^[A-Z])(?=^[^eE]*$)/,
+            2=>/^[^eE]*$/,
+            3=>/^[^eE]*$/,
+            4=>/^[^eE]*$/,
+            5=>/^[^eE]*$/
+          }],
+        ['{1=>/(?=^[A-Z])(?=^[^eE]*$)/,2=>/^[^eE]*$/,3=>/^[^eE]*$/,5=>/^[^eE]*$/}',
+          {
+            1=>/(?=^[A-Z])(?=^[^eE]*$)/,
+            2=>/^[^eE]*$/,
+            3=>/^[^eE]*$/,
+            4=>nil,
+            5=>/^[^eE]*$/
+          }],
+        ['{1=>/(?=^[A-Z])(?=^[^eE]*$)/,4=>/^[^eE]*$/}',
+          {
+            1=>/(?=^[A-Z])(?=^[^eE]*$)/,
+            2=>nil,
+            3=>nil,
+            4=>/^[^eE]*$/,
+            5=>nil
+          }],
+        ['{1=>/(?=^[A-Z])(?=^[^eE]*$)/,2=>/^[^eE]*$/,3=>/^[^eE]*$/,-1=>/^[^eE]*$/,-2=>/^[^eE]*$/}',
+          {
+            1=>/(?=^[A-Z])(?=^[^eE]*$)/,
+            2=>/^[^eE]*$/,
+            3=>/^[^eE]*$/,
+            4=>/^[^eE]*$/,
+            5=>/^[^eE]*$/
+          }]
+      ]
+      input_and_output.each do |pair|
+        it "regex: #{pair.first}" do
+          out   = obj.transform_string_regex(pair.first, 'aabba')
+          again = obj.transform_string_regex(out, 'aabba')
+          expect(out).to eq pair.last
+          expect(again).to eq out
+          expect(again).to eq pair.last
+        end
+      end
+    end
+  end
+
+  ##############################################################################
+
+  describe "#transform_string_syllable" do
+
+    # Singleton which includes the method.
+    # Make the private methods public.
+    let(:obj) do
+      class Sing
+        include Poefy::PoeticForms
+        include Poefy::StringManipulation
+        public *private_instance_methods
+      end.new
+    end
+    describe "using rhyme string 'aabba'" do
+      input_and_output = [
+        ['10',
+          {1=>10,2=>10,3=>10,4=>10,5=>10}],
+        ['9,10,11',
+          {1=>[9,10,11],2=>[9,10,11],3=>[9,10,11],4=>[9,10,11],5=>[9,10,11]}],
+        ['[8,8,5,5,8]',
+          {1=>8,2=>8,3=>5,4=>5,5=>8}],
+        ['[[8,9],[8,9],[4,5,6],[4,5,6],[8,9]]',
+          {1=>[8,9],2=>[8,9],3=>[4,5,6],4=>[4,5,6],5=>[8,9]}],
+        ['{1:8,2:8,3:5,4:5,5:8}',
+          {1=>8,2=>8,3=>5,4=>5,5=>8}],
+        ['{1:8,2:8,3:5,5:8}',
+          {1=>8,2=>8,3=>5,4=>0,5=>8}],
+        ['{0:99,1:8,2:8,3:5,5:8}',
+          {1=>8,2=>8,3=>5,4=>99,5=>8}],
+        ['{1:[8,9],2:[8,9],3:[4,5,6],4:[4,5,6],5:[8,9]}',
+          {1=>[8,9],2=>[8,9],3=>[4,5,6],4=>[4,5,6],5=>[8,9]}],
+        ['{1:[8,9],2:[8,9],3:[4,5,6],5:[8,9]}',
+          {1=>[8,9],2=>[8,9],3=>[4,5,6],4=>0,5=>[8,9]}],
+        ['{0:99,1:[8,9],2:[8,9],3:[4,5,6],5:[8,9]}',
+          {1=>[8,9],2=>[8,9],3=>[4,5,6],4=>99,5=>[8,9]}],
+        ['{0:[8,9],3:[4,5,6],4:[4,5,6]}',
+          {1=>[8,9],2=>[8,9],3=>[4,5,6],4=>[4,5,6],5=>[8,9]}],
+        ['{1:8,5:8}',
+          {1=>8,2=>0,3=>0,4=>0,5=>8}],
+        ['{1:8,2:8,3:5,-2:5,-1:8}',
+          {1=>8,2=>8,3=>5,4=>5,5=>8}]
+      ]
+      input_and_output.each do |pair|
+        it "syllable: #{pair.first}" do
+          rhyme = obj.tokenise_rhyme('aabba')
+          out   = obj.transform_string_syllable(pair.first, 'aabba')
+          again = obj.transform_string_syllable(out, 'aabba')
+          expect(out).to eq pair.last
+          expect(again).to eq out
+          expect(again).to eq pair.last
+        end
+      end
+    end
+  end
+
+  ##############################################################################
+
+  describe "private method #poetic_form_from_text" do
+
+    # Singleton which includes the method.
+    # Make the private methods public.
+    let(:obj) do
+      class Sing
+        include Poefy::PoeticFormFromText
+        include Poefy::StringManipulation
+        public *private_instance_methods
+      end.new
+    end
+
+    it "'80' should rhyme with 'weighty'" do
+      lines = ["Lorem ipsum dolor weighty", "Lorem ipsum dolor 80"]
+      form = obj.poetic_form_from_text(lines)
+      expect(form[:rhyme].uniq.count).to be 1
+    end
+    it "'80' should not rhyme with 'shoe'" do
+      lines = ["Lorem ipsum dolor shoe", "Lorem ipsum dolor 80"]
+      form = obj.poetic_form_from_text(lines)
+      expect(form[:rhyme].uniq.count).to_not be 1
+    end
+    it "'2' should rhyme with 'shoe'" do
+      lines = ["Lorem ipsum dolor shoe", "Lorem ipsum dolor 2"]
+      form = obj.poetic_form_from_text(lines)
+      expect(form[:rhyme].uniq.count).to be 1
+    end
+    it "'2' should not rhyme with 'weighty'" do
+      lines = ["Lorem ipsum dolor weighty", "Lorem ipsum dolor 2"]
+      form = obj.poetic_form_from_text(lines)
+      expect(form[:rhyme].uniq.count).to_not be 1
+    end
+    it "'wind' should rhyme with 'sinned'" do
+      lines = ["A mighty wind", "A whitey sinned"]
+      form = obj.poetic_form_from_text(lines)
+      expect(form[:rhyme].uniq.count).to be 1
+    end
+    it "'wind' should rhyme with 'mind'" do
+      lines = ["A mighty wind", "A flighty mind"]
+      form = obj.poetic_form_from_text(lines)
+      expect(form[:rhyme].uniq.count).to be 1
+    end
+    it "'wind' should not rhyme with 'drunk'" do
+      lines = ["A mighty wind", "A fighty drunk"]
+      form = obj.poetic_form_from_text(lines)
+      expect(form[:rhyme].uniq.count).to_not be 1
+    end
+  end
+
+end
+
+################################################################################

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'bundler/setup'
 Bundler.setup
 
+require 'tempfile'
+
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require 'poefy'