poefy-sqlite3 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8806b7669ce6afbcea42c28575acb64b355e021a
-  data.tar.gz: b15888762fcb9e759934545eb8f634bfbe5cd8b5
+SHA256:
+  metadata.gz: daf74cad1a2dc701ac781b586a78f5ae3f990eaf4d4000bfadaa0f9c9e06f73b
+  data.tar.gz: 2f9fd9ae80276649b77683c4344f1f28aaae8f709b09c89921e7ac9ba73e01cf
 SHA512:
-  metadata.gz: de5980e39718fdf884bac2c715915ed88ac7296a8150843e14af004caab42fd9c72e080ff383ec2eb7dba2326591e532b167cf172a3f6cbfd948bf7e4b79779a
-  data.tar.gz: e330587bdbe424830769e1b7b6104fad7b305a4aef621d3864556968c1204705b868bff5e907fb39a259cb2c236c00b9cb796480f14a176e588ad8f32583433a
+  metadata.gz: fc19e0f72f898aa30400d54f35ef9e519e2f8d94543abcc055b054e919652deaad9a63c84a12878851f6c3b06ae4dd85a246f8ac5f4e2d788c4db3635320d209
+  data.tar.gz: b110bd3ed13b0cf748f78c19e50414c3347eb6e182e3eca2f073188fc065747ceec79f0a20df62e140fda3fe48e2baa6119db012df4fc52086e7dee1330a51f6

data/.rspec

@@ -1 +1 @@
---require spec_helper
+--require spec_helper

data/LICENSE

@@ -1,13 +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>
+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

@@ -1,7 +1,7 @@
-# poefy-sqlite3
-
-by Paul Thompson - nossidge@gmail.com
-
-SQLite interface for the 'poefy' gem.
-
-Please see the [poefy](https://github.com/nossidge/poefy) documentation.
+# poefy-sqlite3
+
+by Paul Thompson - nossidge@gmail.com
+
+SQLite interface for the 'poefy' gem.
+
+Please see the [poefy](https://github.com/nossidge/poefy) documentation.

data/Rakefile

@@ -1,8 +1,8 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.verbose = false
-end
-task :default => :spec
-task :test    => :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+task :default => :spec
+task :test    => :spec

data/lib/poefy/sqlite3/version.rb

@@ -1,24 +1,24 @@
-#!/usr/bin/env ruby
-# Encoding: UTF-8
-
-module Poefy
-
-  module Sqlite3
-
-    def self.version_number
-      major = 1
-      minor = 1
-      tiny  = 0
-      pre   = nil
-
-      string = [major, minor, tiny, pre].compact.join('.')
-      Gem::Version.new string
-    end
-
-    def self.version_date
-      '2017-10-31'
-    end
-
-  end
-
-end
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+module Poefy
+
+  module Sqlite3
+
+    def self.version_number
+      major = 2
+      minor = 0
+      tiny  = 0
+      pre   = nil
+
+      string = [major, minor, tiny, pre].compact.join('.')
+      Gem::Version.new string
+    end
+
+    def self.version_date
+      '2025-06-28'
+    end
+
+  end
+
+end

data/lib/poefy/sqlite3.rb

@@ -1,275 +1,275 @@
-#!/usr/bin/env ruby
-# Encoding: UTF-8
-
-################################################################################
-# Extend 'Database' class for connecting to a sqlite3 database.
-# These methods are specific to sqlite3.
-# Other databases should be implemented in separate gems.
-################################################################################
-
-require 'sqlite3'
-
-################################################################################
-
-module Poefy
-
-  class Database
-
-    # Open a connection, execute a query, close the connection.
-    def self.single_exec! database_name, sql
-      path = Database::path database_name
-      con = SQLite3::Database.open path
-      rs = con.execute sql
-      con.close
-      rs
-    end
-
-    # List all database files in the directory.
-    # Does not include databases used for testing.
-    def self.list
-      Dir[Poefy.root + '/data/*.db'].map do |i|
-        File.basename(i, '.db')
-      end.reject do |i|
-        i.start_with?('spec_')
-      end.sort - ['test']
-    end
-
-    # Get the description of a database.
-    def self.desc database_name
-      begin
-        sql = "SELECT comment FROM comment;"
-        Database::single_exec!(database_name, sql).flatten.first
-      rescue
-        ''
-      end
-    end
-
-    # List all database files and their descriptions.
-    def self.list_with_desc
-      Database::list.map do |i|
-        begin
-          [i, Database::desc(i)]
-        rescue
-          [i, '']
-        end
-      end.to_h
-    end
-
-    # Get the path of a database.
-    def self.path database_name
-      Poefy.root + '/data/' + File.basename(database_name, '.db') + '.db'
-    end
-
-    ############################################################################
-
-    # This is the type of database that is being used.
-    # It is also used as a signifier that a database has been specified.
-    def type
-      'sqlite3'
-    end
-
-    # Get/set the description of the database.
-    def desc
-      Database::desc @name
-    end
-    def desc=(description)
-      execute! "DELETE FROM comment;"
-      execute! "INSERT INTO comment VALUES ( ? );", description.to_s
-    end
-
-    # The number of lines in the table.
-    def count
-      return 0 if not exists?
-      sql = "SELECT COUNT(*) AS num FROM #{table};"
-      execute!(sql).first['num'].to_i
-    end
-
-    # See if the database file exists or not.
-    def exists?
-      File.exists?(db_file)
-    end
-
-    # Get all rhyming lines for the word.
-    def rhymes word, key = nil
-      return nil if word.nil?
-
-      sql = <<-SQL
-        SELECT rhyme, final_word, syllables, line
-        FROM lines
-        WHERE rhyme = ?
-        ORDER BY rhyme, final_word, syllables, line
-      SQL
-      output = word.to_phrase.rhymes.keys.map do |rhyme|
-        rs = execute!(sql, [rhyme]).to_a
-        rs.each{ |a| a.reject!{ |k| k.is_a? Numeric }}
-      end.flatten
-
-      if !key.nil? and %w[rhyme final_word syllables line].include?(key)
-        output.map!{ |i| i[key] }
-      end
-      output
-    end
-
-    private
-
-      # The name of the table.
-      def table
-        'lines'
-      end
-
-      # Create a new database.
-      def new_connection
-        File.delete(db_file) if File.exists?(db_file)
-        @db = SQLite3::Database.new(db_file)
-        @db.results_as_hash = true
-      end
-
-      # Open a connection to the database.
-      def open_connection
-        @db = SQLite3::Database.open(db_file)
-        @db.results_as_hash = true
-      end
-
-      # Execute a query.
-      def execute! sql, *args
-        db.execute sql, *args
-      end
-
-      # Insert an array of poefy-described lines.
-      def insert_lines table_name, rows
-        sql = "INSERT INTO #{table_name} VALUES ( ?, ?, ?, ? )"
-        db.transaction do |db_tr|
-          rows.each do |line|
-            db_tr.execute sql, line
-          end
-        end
-      end
-
-      ##########################################################################
-
-      # Find the correct database file.
-      # If local, just use the value.
-      # Else, use the database in /data/ directory.
-      def db_file
-        if @local
-          @name
-        elsif @db_file
-          @db_file
-        else
-          path = Poefy.root + '/data'
-          file = File.basename(@name, '.db')
-          @db_file = path + '/' + file + '.db'
-        end
-      end
-
-      ##########################################################################
-
-      # Create the table and the index.
-      def create_table table_name, description = nil
-        execute! <<-SQL
-          CREATE TABLE #{table_name} (
-            line        TEXT,
-            syllables   SMALLINT,
-            final_word  TEXT,
-            rhyme       TEXT
-          );
-        SQL
-        execute! <<-SQL
-          CREATE TABLE comment (
-            comment     TEXT
-          );
-        SQL
-        execute! <<-SQL
-          CREATE INDEX idx ON #{table_name} (
-            rhyme, final_word, line
-          );
-        SQL
-        self.desc = description
-      end
-
-      ##########################################################################
-
-      # Define SQL of the stored procedures.
-      def sprocs_sql_hash
-        sql = {}
-        sql[:rbc] = <<-SQL
-          SELECT rhyme, COUNT(rhyme) AS count
-          FROM (
-            SELECT rhyme, final_word, COUNT(final_word) AS wc
-            FROM #{table}
-            GROUP BY rhyme, final_word
-          )
-          GROUP BY rhyme
-          HAVING count >= ?
-        SQL
-        sql[:rbcs] = <<-SQL
-          SELECT rhyme, COUNT(rhyme) AS count
-          FROM (
-            SELECT rhyme, final_word, COUNT(final_word) AS wc
-            FROM #{table}
-            WHERE syllables BETWEEN ? AND ?
-            GROUP BY rhyme, final_word
-          )
-          GROUP BY rhyme
-          HAVING count >= ?
-        SQL
-        sql[:la] = <<-SQL
-          SELECT line, syllables, final_word, rhyme
-          FROM #{table} WHERE rhyme = ?
-        SQL
-        sql[:las] = <<-SQL
-          SELECT line, syllables, final_word, rhyme
-          FROM #{table} WHERE rhyme = ?
-          AND syllables BETWEEN ? AND ?
-        SQL
-        sql
-      end
-
-      # Create the stored procedures in the database.
-      def create_sprocs
-        sprocs_sql_hash.each do |key, value|
-          @sproc[key] = db.prepare value
-        end
-      rescue
-        msg = "ERROR: Database table structure is invalid." +
-            "\n       Please manually DROP the corrupt table and recreate it."
-        raise Poefy::StructureInvalid.new(msg)
-      end
-
-      # Find rhymes and counts greater than a certain length.
-      def sproc_rhymes_by_count rhyme_count
-        @sproc[:rbc].reset!
-        @sproc[:rbc].bind_param(1, rhyme_count)
-        @sproc[:rbc].execute.to_a
-      end
-
-      # Also adds syllable selection.
-      def sproc_rhymes_by_count_syllables rhyme_count, syllable_min_max
-        @sproc[:rbcs].reset!
-        @sproc[:rbcs].bind_param(1, syllable_min_max[:min])
-        @sproc[:rbcs].bind_param(2, syllable_min_max[:max])
-        @sproc[:rbcs].bind_param(3, rhyme_count)
-        @sproc[:rbcs].execute.to_a
-      end
-
-      # Find all lines for a certain rhyme.
-      def sproc_lines_by_rhyme rhyme
-        @sproc[:la].reset!
-        @sproc[:la].bind_param(1, rhyme)
-        @sproc[:la].execute.to_a
-      end
-
-      # Also adds syllable selection.
-      def sproc_lines_by_rhyme_syllables rhyme, syllable_min_max
-        @sproc[:las].reset!
-        @sproc[:las].bind_param(1, rhyme)
-        @sproc[:las].bind_param(2, syllable_min_max[:min])
-        @sproc[:las].bind_param(3, syllable_min_max[:max])
-        @sproc[:las].execute.to_a
-      end
-
-  end
-
-end
-
-################################################################################
+#!/usr/bin/env ruby
+# Encoding: UTF-8
+
+################################################################################
+# Extend 'Database' class for connecting to a sqlite3 database.
+# These methods are specific to sqlite3.
+# Other databases should be implemented in separate gems.
+################################################################################
+
+require 'sqlite3'
+
+################################################################################
+
+module Poefy
+
+  class Database
+
+    # Open a connection, execute a query, close the connection.
+    def self.single_exec! database_name, sql
+      path = Database::path database_name
+      con = SQLite3::Database.open path
+      rs = con.execute sql
+      con.close
+      rs
+    end
+
+    # List all database files in the directory.
+    # Does not include databases used for testing.
+    def self.list
+      Dir[Poefy.root + '/data/*.db'].map do |i|
+        File.basename(i, '.db')
+      end.reject do |i|
+        i.start_with?('spec_')
+      end.sort - ['test']
+    end
+
+    # Get the description of a database.
+    def self.desc database_name
+      begin
+        sql = "SELECT comment FROM comment;"
+        Database::single_exec!(database_name, sql).flatten.first
+      rescue
+        ''
+      end
+    end
+
+    # List all database files and their descriptions.
+    def self.list_with_desc
+      Database::list.map do |i|
+        begin
+          [i, Database::desc(i)]
+        rescue
+          [i, '']
+        end
+      end.to_h
+    end
+
+    # Get the path of a database.
+    def self.path database_name
+      Poefy.root + '/data/' + File.basename(database_name, '.db') + '.db'
+    end
+
+    ############################################################################
+
+    # This is the type of database that is being used.
+    # It is also used as a signifier that a database has been specified.
+    def type
+      'sqlite3'
+    end
+
+    # Get/set the description of the database.
+    def desc
+      Database::desc @name
+    end
+    def desc=(description)
+      execute! "DELETE FROM comment;"
+      execute! "INSERT INTO comment VALUES ( ? );", description.to_s
+    end
+
+    # The number of lines in the table.
+    def count
+      return 0 unless exist?
+      sql = "SELECT COUNT(*) AS num FROM #{table};"
+      execute!(sql).first['num'].to_i
+    end
+
+    # See if the database file exists or not.
+    def exist?
+      File.exist?(db_file)
+    end
+
+    # Get all rhyming lines for the word.
+    def rhymes word, key = nil
+      return nil if word.nil?
+
+      sql = <<-SQL
+        SELECT rhyme, final_word, syllables, line
+        FROM lines
+        WHERE rhyme = ?
+        ORDER BY rhyme, final_word, syllables, line
+      SQL
+      output = word.to_phrase.rhymes.keys.map do |rhyme|
+        rs = execute!(sql, [rhyme]).to_a
+        rs.each{ |a| a.reject!{ |k| k.is_a? Numeric }}
+      end.flatten
+
+      if !key.nil? and %w[rhyme final_word syllables line].include?(key)
+        output.map!{ |i| i[key] }
+      end
+      output
+    end
+
+    private
+
+      # The name of the table.
+      def table
+        'lines'
+      end
+
+      # Create a new database.
+      def new_connection
+        File.delete(db_file) if File.exist?(db_file)
+        @db = SQLite3::Database.new(db_file)
+        @db.results_as_hash = true
+      end
+
+      # Open a connection to the database.
+      def open_connection
+        @db = SQLite3::Database.open(db_file)
+        @db.results_as_hash = true
+      end
+
+      # Execute a query.
+      def execute! sql, *args
+        db.execute sql, *args
+      end
+
+      # Insert an array of poefy-described lines.
+      def insert_lines table_name, rows
+        sql = "INSERT INTO #{table_name} VALUES ( ?, ?, ?, ? )"
+        db.transaction do |db_tr|
+          rows.each do |line|
+            db_tr.execute sql, line
+          end
+        end
+      end
+
+      ##########################################################################
+
+      # Find the correct database file.
+      # If local, just use the value.
+      # Else, use the database in /data/ directory.
+      def db_file
+        if @local
+          @name
+        elsif @db_file
+          @db_file
+        else
+          path = Poefy.root + '/data'
+          file = File.basename(@name, '.db')
+          @db_file = path + '/' + file + '.db'
+        end
+      end
+
+      ##########################################################################
+
+      # Create the table and the index.
+      def create_table table_name, description = nil
+        execute! <<-SQL
+          CREATE TABLE #{table_name} (
+            line        TEXT,
+            syllables   SMALLINT,
+            final_word  TEXT,
+            rhyme       TEXT
+          );
+        SQL
+        execute! <<-SQL
+          CREATE TABLE comment (
+            comment     TEXT
+          );
+        SQL
+        execute! <<-SQL
+          CREATE INDEX idx ON #{table_name} (
+            rhyme, final_word, line
+          );
+        SQL
+        self.desc = description
+      end
+
+      ##########################################################################
+
+      # Define SQL of the stored procedures.
+      def sprocs_sql_hash
+        sql = {}
+        sql[:rbc] = <<-SQL
+          SELECT rhyme, COUNT(rhyme) AS count
+          FROM (
+            SELECT rhyme, final_word, COUNT(final_word) AS wc
+            FROM #{table}
+            GROUP BY rhyme, final_word
+          )
+          GROUP BY rhyme
+          HAVING count >= ?
+        SQL
+        sql[:rbcs] = <<-SQL
+          SELECT rhyme, COUNT(rhyme) AS count
+          FROM (
+            SELECT rhyme, final_word, COUNT(final_word) AS wc
+            FROM #{table}
+            WHERE syllables BETWEEN ? AND ?
+            GROUP BY rhyme, final_word
+          )
+          GROUP BY rhyme
+          HAVING count >= ?
+        SQL
+        sql[:la] = <<-SQL
+          SELECT line, syllables, final_word, rhyme
+          FROM #{table} WHERE rhyme = ?
+        SQL
+        sql[:las] = <<-SQL
+          SELECT line, syllables, final_word, rhyme
+          FROM #{table} WHERE rhyme = ?
+          AND syllables BETWEEN ? AND ?
+        SQL
+        sql
+      end
+
+      # Create the stored procedures in the database.
+      def create_sprocs
+        sprocs_sql_hash.each do |key, value|
+          @sproc[key] = db.prepare value
+        end
+      rescue
+        msg = "ERROR: Database table structure is invalid." +
+            "\n       Please manually DROP the corrupt table and recreate it."
+        raise Poefy::StructureInvalid.new(msg)
+      end
+
+      # Find rhymes and counts greater than a certain length.
+      def sproc_rhymes_by_count rhyme_count
+        @sproc[:rbc].reset!
+        @sproc[:rbc].bind_param(1, rhyme_count)
+        @sproc[:rbc].execute.to_a
+      end
+
+      # Also adds syllable selection.
+      def sproc_rhymes_by_count_syllables rhyme_count, syllable_min_max
+        @sproc[:rbcs].reset!
+        @sproc[:rbcs].bind_param(1, syllable_min_max[:min])
+        @sproc[:rbcs].bind_param(2, syllable_min_max[:max])
+        @sproc[:rbcs].bind_param(3, rhyme_count)
+        @sproc[:rbcs].execute.to_a
+      end
+
+      # Find all lines for a certain rhyme.
+      def sproc_lines_by_rhyme rhyme
+        @sproc[:la].reset!
+        @sproc[:la].bind_param(1, rhyme)
+        @sproc[:la].execute.to_a
+      end
+
+      # Also adds syllable selection.
+      def sproc_lines_by_rhyme_syllables rhyme, syllable_min_max
+        @sproc[:las].reset!
+        @sproc[:las].bind_param(1, rhyme)
+        @sproc[:las].bind_param(2, syllable_min_max[:min])
+        @sproc[:las].bind_param(3, syllable_min_max[:max])
+        @sproc[:las].execute.to_a
+      end
+
+  end
+
+end
+
+################################################################################