lib/kit/db_sqlite3.rb in kit-0.0.5 vs lib/kit/db_sqlite3.rb in kit-0.0.6

@@ -1,25 +1,53 @@
 require 'sqlite3'
 
+# Methods to make sqlite3 interation more consice
 module SQLite3Tools
 	class ::Array
+		# Converts an array of symbols to a string of backquoted strings for use in SELECT statement
+		# @return [String]
+		# @example
+		#  a = [ :col_1, :col_2 ]
+		#  a.sqlite3_to_str #=> "`col_1`, `col_2`"
 		def sqlite3_to_str
 			self.map { |sym| "`" + sym.to_s + "`" }.join(", ")
 		end
+
+		# Converts an sqlite3 result array to a hash.
+		# @param keys [Array]
+		# @return [Hash]
+		# @example
+		#  a = [ "val_1", 42 ]
+		#  k = [ :col_1, :col_2 ]
+		#  a.to_hash k #=> { :col_1 => "val_1", :col_2 => 42 }
+		def to_hash keys
+			Hash[ *( 0...self.size ).inject( [] ) { |arr, ix| arr.push( keys[ix], self[ix] ) } ]
+		end
 	end
 
-	class ::Array
-		def to_hash other
-			Hash[ *( 0...self.size() ).inject( [] ) { |arr, ix| arr.push( other[ix], self[ix] ) } ]
+	class ::Integer
+		# Generates placeholder string for INSERT statements.
+		# @return String placeholder
+		# @example
+		#  3.make_placeholders #=> "?, ?, ?"
+		def make_placeholders
+			n = self - 1
+			placeholders = "?"
+			n.times { placeholders << ", ?" }
+			placeholders
 		end
 	end
 
 	class SQLite3::Database
+		# Selects given columns using given query and converts results to to hashes.
+		# @param [Array<Symbol>] columns names of columns to select
+		# @param [String] query sqlite3 query fragment to append to SELECT part of query
+		# @return [Array<Hash>] results with each row a hash in :col => value form
 		def select columns, query
 			result = [];
 			self.execute "SELECT #{columns.sqlite3_to_str} #{query}" do |row|
-				result.push ( row.to_hash columns )
+				result.push row.to_hash columns
 			end
 			result
 		end
 	end
 end
@@ -28,10 +56,11 @@
 
 	include SQLite3Tools
 
 	attr_reader :db_paths
 
+	# (see #db_prepare)
 	def initialize db_paths
 		db_paths.each do |key, db|
 			name = File.basename db
 			dir = File.dirname db
 			dir = @@config_path unless [ "/", "~" ].include? dir[0]
@@ -44,12 +73,17 @@
 		@info_db = dbs[:info]
 		@action_db = dbs[:actions]
 	end
 
 	private
+	# Loads existing database files or creates new ones with kit database schema
+	# @param [Hash] db_paths absolute or relitive paths to database files
 	def db_prepare db_paths
 
+		# Makes kit database schema
+		# @param [Symbol] type name of database
+		# @param db [SQLite3::Database] database object to load schema into
 		def db_initialize type, db
 			sql = File.read @@kit_path + "/sqlite3_#{type}.sql"
 			db.execute_batch sql
 		end
 
@@ -77,29 +111,22 @@
 
 		return dbs
 
 	end
 
-	private
-	def make_placeholders n
-		n = n - 1
-		placeholders = "?"
-		n.times { placeholders << ", ?" }
-		placeholders
-	end
-
 	public
 	def select_all_actions_by_status action, fields, status
 		query = "FROM `#{action}` WHERE `status` = '#{status}'"
 		rows = @action_db.select fields, query
 
 		h = { :action => action }
 		rows.map { |t| t.merge h }
 	end
 
 	def insert_action table, data
-		@action_db.execute "INSERT INTO #{table} VALUES ( ?, #{make_placeholders data.length} )", ( data.values.insert 1, "pending" )
+		data.merge! ( { :status => "pending" } )
+		@action_db.execute "INSERT INTO #{table} ( `#{data.keys.join "`, `"}` ) VALUES ( #{data.length.make_placeholders} )", data.values
 		@action_db.last_insert_row_id
 	end
 
 	def delete_action_by_id action, id
 # 		puts "DELETE FROM `#{action}` WHERE `rowid` = #{id}"
@@ -113,10 +140,21 @@
 	def select_info_by_name table, fields, name
 		info = @info_db.select fields, "FROM `#{table}` WHERE `name` = '#{name}'"
 		info.first
 	end
 
+	def select_info_by_criteria table, fields, criteria
+
+		q = []
+		criteria.each do |key, value|
+			q << "`#{key}` = '#{value}'"
+		end
+
+		info = @info_db.select fields, "FROM `#{table}` WHERE #{q.join " AND "}"
+		info.first
+	end
+
 	def insert_info table, data
-		@info_db.execute "INSERT INTO #{table} VALUES ( #{make_placeholders data.length} )", data.values
+		@info_db.execute "INSERT INTO #{table} ( `#{data.keys.join "`, `"}` ) VALUES ( #{data.length.make_placeholders} )", data.values
 		@info_db.last_insert_row_id
 	end
 end