poefy 1.1.1 → 2.0.0

data/lib/poefy/core_extensions/array.rb

@@ -1,121 +1,121 @@
-#!/usr/bin/env ruby
-# Encoding: UTF-8
-
-################################################################################
-# Monkey patch the Array class.
-################################################################################
-
-#--
-# Declare module structure.
-#++
-module Poefy
-  module CoreExtensions
-    module Array
-      module SortByDistance
-      end
-      module ModuloIndex
-      end
-    end
-  end
-end
-
-#--
-# Define module methods.
-#++
-module Poefy::CoreExtensions::Array::SortByDistance
-
-  ##
-  # Take an array index and return a permutation of the
-  # items sorted by distance from that index.
-  # If 'index' is not specified, return an Enumerator
-  # of the results for all indices, in order.
-  #
-  # The ':reverse' keyword argument switches the equally close
-  # neighbours from lowest index first to highest first.
-  # It's an option added mostly for completeness, but it's
-  # there if you need it.
-  #
-  def sort_by_distance_from_index index = nil, reverse: false
-
-    # Return Enumerator of all possible output arrays.
-    if index.nil?
-      Enumerator.new(self.count) do |y|
-        self.each.with_index do |value, index|
-          y << self.sort_by_distance_from_index(index, reverse: reverse)
-        end
-      end
-
-    # Return Enumerator of results for a single index.
-    else
-      Enumerator.new(self.count) do |y|
-        y << self[index]
-        counter = 0
-        loop do
-          counter += 1
-
-          # Consider negative indices OOB, not from array tail.
-          below_index = index - counter
-          below_index = nil if below_index < 0
-          below = self[below_index] if below_index
-
-          # This is fine, uses nil as default value if OOB.
-          above = self[index + counter]
-
-          # Both the elements with index one higher and one lower
-          # are equally close neighbours to the subject element.
-          # The default is to output the element with the lowest
-          # index first. With ':reverse' set to true, the highest
-          # index is appended first.
-          if reverse
-            y << above if above
-            y << below if below
-          else
-            y << below if below
-            y << above if above
-          end
-
-          # Break if we're at the last element.
-          break if !above and !below
-        end
-      end
-    end
-  end
-
-  ##
-  # Find all elements that match 'value' and return the
-  # sort_by_distance results for all, as an Enumerator.
-  #
-  def sort_by_distance_from_value value = nil, reverse: false
-    matching = self.each_index.select { |i| self[i] == value }
-    Enumerator.new(matching.count) do |y|
-      matching.each do |index|
-        y << self.sort_by_distance_from_index(index, reverse: reverse)
-      end
-    end
-  end
-end
-
-#--
-# Define module methods.
-#++
-module Poefy::CoreExtensions::Array::ModuloIndex
-
-  ##
-  # Return elements located at specific index periods.
-  #
-  def modulo_index(divider, remainder = 0, start_index = 0)
-    self.values_at(* self.each_index.select do |i|
-      (i + start_index) % divider == remainder
-    end)
-  end
-end
-
-#--
-# Extend Array class.
-#++
-class Array
-  include Poefy::CoreExtensions::Array::SortByDistance
-  include Poefy::CoreExtensions::Array::ModuloIndex
-end
-
-################################################################################
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+################################################################################
+# Monkey patch the Array class.
+################################################################################
+
+#--
+# Declare module structure.
+#++
+module Poefy
+  module CoreExtensions
+    module Array
+      module SortByDistance
+      end
+      module ModuloIndex
+      end
+    end
+  end
+end
+
+#--
+# Define module methods.
+#++
+module Poefy::CoreExtensions::Array::SortByDistance
+
+  ##
+  # Take an array index and return a permutation of the
+  # items sorted by distance from that index.
+  # If 'index' is not specified, return an Enumerator
+  # of the results for all indices, in order.
+  #
+  # The ':reverse' keyword argument switches the equally close
+  # neighbours from lowest index first to highest first.
+  # It's an option added mostly for completeness, but it's
+  # there if you need it.
+  #
+  def sort_by_distance_from_index index = nil, reverse: false
+
+    # Return Enumerator of all possible output arrays.
+    if index.nil?
+      Enumerator.new(self.count) do |y|
+        self.each.with_index do |value, index|
+          y << self.sort_by_distance_from_index(index, reverse: reverse)
+        end
+      end
+
+    # Return Enumerator of results for a single index.
+    else
+      Enumerator.new(self.count) do |y|
+        y << self[index]
+        counter = 0
+        loop do
+          counter += 1
+
+          # Consider negative indices OOB, not from array tail.
+          below_index = index - counter
+          below_index = nil if below_index < 0
+          below = self[below_index] if below_index
+
+          # This is fine, uses nil as default value if OOB.
+          above = self[index + counter]
+
+          # Both the elements with index one higher and one lower
+          # are equally close neighbours to the subject element.
+          # The default is to output the element with the lowest
+          # index first. With ':reverse' set to true, the highest
+          # index is appended first.
+          if reverse
+            y << above if above
+            y << below if below
+          else
+            y << below if below
+            y << above if above
+          end
+
+          # Break if we're at the last element.
+          break if !above and !below
+        end
+      end
+    end
+  end
+
+  ##
+  # Find all elements that match 'value' and return the
+  # sort_by_distance results for all, as an Enumerator.
+  #
+  def sort_by_distance_from_value value = nil, reverse: false
+    matching = self.each_index.select { |i| self[i] == value }
+    Enumerator.new(matching.count) do |y|
+      matching.each do |index|
+        y << self.sort_by_distance_from_index(index, reverse: reverse)
+      end
+    end
+  end
+end
+
+#--
+# Define module methods.
+#++
+module Poefy::CoreExtensions::Array::ModuloIndex
+
+  ##
+  # Return elements located at specific index periods.
+  #
+  def modulo_index(divider, remainder = 0, start_index = 0)
+    self.values_at(* self.each_index.select do |i|
+      (i + start_index) % divider == remainder
+    end)
+  end
+end
+
+#--
+# Extend Array class.
+#++
+class Array
+  include Poefy::CoreExtensions::Array::SortByDistance
+  include Poefy::CoreExtensions::Array::ModuloIndex
+end
+
+################################################################################

data/lib/poefy/database.rb

@@ -1,151 +1,151 @@
-#!/usr/bin/env ruby
-# Encoding: UTF-8
-
-################################################################################
-# Base class for connecting to a database.
-# Install gem 'poefy-sqlite3' or 'poefy-pg' for implementation.
-################################################################################
-
-require_relative 'string_manipulation.rb'
-
-################################################################################
-
-module Poefy
-
-  class Database
-
-    include Poefy::StringManipulation
-
-    attr_reader :name, :local
-
-    def initialize name, local = false
-      @local = local
-      @name = name.to_s
-      @sproc = {}
-      type
-      db
-    end
-
-    ############################################################################
-
-    # Validate that a database type has been required.
-    # This will be overwritten by a database-specific method,
-    #   so raise an error if no database has been specified yet.
-    # Due to the way 'bin/poefy' is set up, that code will fail before
-    #   this point is reached, so this error is only from Ruby calls.
-    def type
-      msg = "No database interface specified. " +
-            "Please require 'poefy/sqlite3' or 'poefy/pg'"
-      raise LoadError, msg
-    end
-
-    # Open instance database session, if not already existing.
-    def db
-      if not @db and exists?
-        begin
-          open_connection
-          create_sprocs
-        rescue
-          @db = nil
-          raise Poefy::StructureInvalid
-        end
-      end
-      @db
-    end
-
-    # Close the database file.
-    def close
-      @sproc.each { |k, v| v.close rescue nil }
-      @db.close if @db
-      @db = nil
-    end
-
-    # Creates a database with the correct format.
-    #   Convert input lines array to SQL import format file.
-    #   Delete database if already exists.
-    #   Create database using SQL import file.
-    #   Delete both files.
-    def make_new lines, description = nil
-      make_new!(lines, description) if !exists?
-    end
-
-    # Force new database, overwriting existing.
-    def make_new! lines, description = nil
-
-      # Create a new database.
-      new_connection
-
-      # Create the lines table and the index.
-      create_table table, description
-
-      # Convert the lines array into an expanded array of rhyme metadata.
-      import_data = lines_rhyme_metadata lines
-
-      # Import the data.
-      insert_lines table, import_data
-
-      # Recreate the stored procedures.
-      create_sprocs
-    end
-
-    # Public interfaces for private stored procedure methods.
-    # Use instance variables to keep a cache of the results.
-    def rhymes_by_count rhyme_count, syllable_min_max = nil
-      db
-      @rbc = Hash.new { |h,k| h[k] = {} } if @rbc.nil?
-      if @rbc[rhyme_count][syllable_min_max].nil?
-        @rbc[rhyme_count][syllable_min_max] = if syllable_min_max
-          sproc_rhymes_by_count_syllables(rhyme_count, syllable_min_max)
-        else
-          sproc_rhymes_by_count(rhyme_count)
-        end
-      end
-      @rbc[rhyme_count][syllable_min_max].dup
-    end
-    def lines_by_rhyme rhyme, syllable_min_max = nil
-      db
-      @la = Hash.new { |h,k| h[k] = {} } if @la.nil?
-      if @la[rhyme][syllable_min_max].nil?
-        @la[rhyme][syllable_min_max] = if syllable_min_max
-          sproc_lines_by_rhyme_syllables(rhyme, syllable_min_max)
-        else
-          sproc_lines_by_rhyme(rhyme)
-        end
-      end
-      @la[rhyme][syllable_min_max].dup
-    end
-
-    private
-
-      ##########################################################################
-
-      # For each line, figure out the needed rhyme metadata.
-      # Output is an array: [line, final_word, rhyme, syllables]
-      def lines_rhyme_metadata lines
-        output = []
-        lines.map do |line|
-
-          # Don't add the line if it contains a blacklisted? substring.
-          next if Wordfilter.blacklisted? line
-
-          # Get the phrase info for the line.
-          phrase = phrase_info line
-          syll   = phrase[:syllables]
-          rhymes = phrase[:rhymes]
-          final  = phrase[:last_word]
-
-          # There may be more than one rhyme, so add a database
-          #   record for each rhyme.
-          rhymes.each do |rhyme|
-            output << [line, syll, final, rhyme]
-          end
-        end
-
-        output
-      end
-
-  end
-
-end
-
-################################################################################
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+################################################################################
+# Base class for connecting to a database.
+# Install gem 'poefy-sqlite3' or 'poefy-pg' for implementation.
+################################################################################
+
+require_relative 'string_manipulation.rb'
+
+################################################################################
+
+module Poefy
+
+  class Database
+
+    include Poefy::StringManipulation
+
+    attr_reader :name, :local
+
+    def initialize name, local = false
+      @local = local
+      @name = name.to_s
+      @sproc = {}
+      type
+      db
+    end
+
+    ############################################################################
+
+    # Validate that a database type has been required.
+    # This will be overwritten by a database-specific method,
+    #   so raise an error if no database has been specified yet.
+    # Due to the way 'bin/poefy' is set up, that code will fail before
+    #   this point is reached, so this error is only from Ruby calls.
+    def type
+      msg = "No database interface specified. " +
+            "Please require 'poefy/sqlite3' or 'poefy/pg'"
+      raise LoadError, msg
+    end
+
+    # Open instance database session, if not already existing.
+    def db
+      if not @db and exist?
+        begin
+          open_connection
+          create_sprocs
+        rescue
+          @db = nil
+          raise Poefy::StructureInvalid
+        end
+      end
+      @db
+    end
+
+    # Close the database file.
+    def close
+      @sproc.each { |k, v| v.close rescue nil }
+      @db.close if @db
+      @db = nil
+    end
+
+    # Creates a database with the correct format.
+    #   Convert input lines array to SQL import format file.
+    #   Delete database if already exists.
+    #   Create database using SQL import file.
+    #   Delete both files.
+    def make_new lines, description = nil
+      make_new!(lines, description) unless exist?
+    end
+
+    # Force new database, overwriting existing.
+    def make_new! lines, description = nil
+
+      # Create a new database.
+      new_connection
+
+      # Create the lines table and the index.
+      create_table table, description
+
+      # Convert the lines array into an expanded array of rhyme metadata.
+      import_data = lines_rhyme_metadata lines
+
+      # Import the data.
+      insert_lines table, import_data
+
+      # Recreate the stored procedures.
+      create_sprocs
+    end
+
+    # Public interfaces for private stored procedure methods.
+    # Use instance variables to keep a cache of the results.
+    def rhymes_by_count rhyme_count, syllable_min_max = nil
+      db
+      @rbc = Hash.new { |h,k| h[k] = {} } if @rbc.nil?
+      if @rbc[rhyme_count][syllable_min_max].nil?
+        @rbc[rhyme_count][syllable_min_max] = if syllable_min_max
+          sproc_rhymes_by_count_syllables(rhyme_count, syllable_min_max)
+        else
+          sproc_rhymes_by_count(rhyme_count)
+        end
+      end
+      @rbc[rhyme_count][syllable_min_max].dup
+    end
+    def lines_by_rhyme rhyme, syllable_min_max = nil
+      db
+      @la = Hash.new { |h,k| h[k] = {} } if @la.nil?
+      if @la[rhyme][syllable_min_max].nil?
+        @la[rhyme][syllable_min_max] = if syllable_min_max
+          sproc_lines_by_rhyme_syllables(rhyme, syllable_min_max)
+        else
+          sproc_lines_by_rhyme(rhyme)
+        end
+      end
+      @la[rhyme][syllable_min_max].dup
+    end
+
+    private
+
+      ##########################################################################
+
+      # For each line, figure out the needed rhyme metadata.
+      # Output is an array: [line, final_word, rhyme, syllables]
+      def lines_rhyme_metadata lines
+        output = []
+        lines.map do |line|
+
+          # Don't add the line if it contains a blacklisted? substring.
+          next if Wordfilter.blacklisted? line
+
+          # Get the phrase info for the line.
+          phrase = phrase_info line
+          syll   = phrase[:syllables]
+          rhymes = phrase[:rhymes]
+          final  = phrase[:last_word]
+
+          # There may be more than one rhyme, so add a database
+          #   record for each rhyme.
+          rhymes.each do |rhyme|
+            output << [line, syll, final, rhyme]
+          end
+        end
+
+        output
+      end
+
+  end
+
+end
+
+################################################################################

data/lib/poefy/db_type.rb

@@ -1,57 +1,57 @@
-#!/usr/bin/env ruby
-# Encoding: UTF-8
-
-################################################################################
-# Methods for selecting which database interface to use.
-# And for including the correct gem, based on that choice.
-################################################################################
-
-require 'yaml'
-
-################################################################################
-
-module Poefy
-
-  # Are we running this through the console? (Or as a Ruby library?)
-  def self.console= bool
-    @@console = !!bool
-  end
-  def self.console
-    @@console ||= false
-  end
-
-  # View and amend the database type in the 'settings' file.
-  def self.database_type= db_name
-    settings_file = Poefy.root + '/settings.yml'
-    File.open(settings_file, 'w') do |file|
-      hsh = {'database' => db_name}
-      file.write hsh.to_yaml
-    end
-    @@database_type = nil
-  end
-  def self.database_type create_file = true
-    @@database_type ||= nil
-    return @@database_type if @@database_type
-    settings_file = Poefy.root + '/settings.yml'
-    if not File.exists?(settings_file)
-      return nil if !create_file
-      Poefy.database_type = 'pg'
-    end
-    @@database_type = YAML::load_file(settings_file)['database']
-  end
-
-  # Requires the chosen database interface gem.
-  def self.require_db db_interface_gem = nil
-    begin
-      @@database_type = db_interface_gem if db_interface_gem
-      require 'poefy/' + (db_interface_gem || Poefy.database_type)
-
-    # Replace with custom exception.
-    rescue LoadError
-      raise Poefy::MissingDBInterface
-    end
-  end
-
-end
-
-################################################################################
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+################################################################################
+# Methods for selecting which database interface to use.
+# And for including the correct gem, based on that choice.
+################################################################################
+
+require 'yaml'
+
+################################################################################
+
+module Poefy
+
+  # Are we running this through the console? (Or as a Ruby library?)
+  def self.console= bool
+    @@console = !!bool
+  end
+  def self.console
+    @@console ||= false
+  end
+
+  # View and amend the database type in the 'settings' file.
+  def self.database_type= db_name
+    settings_file = Poefy.root + '/settings.yml'
+    File.open(settings_file, 'w') do |file|
+      hsh = {'database' => db_name}
+      file.write hsh.to_yaml
+    end
+    @@database_type = nil
+  end
+  def self.database_type create_file = true
+    @@database_type ||= nil
+    return @@database_type if @@database_type
+    settings_file = Poefy.root + '/settings.yml'
+    unless File.exist?(settings_file)
+      return nil if !create_file
+      Poefy.database_type = 'pg'
+    end
+    @@database_type = YAML::load_file(settings_file)['database']
+  end
+
+  # Requires the chosen database interface gem.
+  def self.require_db db_interface_gem = nil
+    begin
+      @@database_type = db_interface_gem if db_interface_gem
+      require 'poefy/' + (db_interface_gem || Poefy.database_type)
+
+    # Replace with custom exception.
+    rescue LoadError
+      raise Poefy::MissingDBInterface
+    end
+  end
+
+end
+
+################################################################################

data/lib/poefy/generation.rb

@@ -17,7 +17,7 @@ module Poefy
     def poem poetic_form = @poetic_form
 
       # Can't do much if the database doesn't exist.
-      raise Poefy::MissingDatabase unless @corpus.exists?
+      raise Poefy::MissingDatabase unless @corpus.exist?
 
       # Validate the poetic form hash.
       raise ArgumentError, 'Argument must be a hash' unless