kit 0.3.0 → 1.0.0

data/LICENCE.txt

@@ -1,21 +0,0 @@
-The MIT License
-
-Copyright (c) 2011 Evan Boyd Sosenko
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/lib/kit/bit.rb

@@ -1,173 +0,0 @@
-# Class to manage individual bits.
-class Bit < Kit
-
-	# Exceptions.
-
-	# Raised when element exists but was not expected.
-	class DuplicateElement < RuntimeError
-	end
-
-	# Raised when no element exists.
-	class NoElement < RuntimeError
-	end
-
-	# Raised when not enough info is given to perform the operation.
-	class MissingValues < RuntimeError
-	end
-
-	# Raised when an action runs but fails due to an invalid combination of options.
-	class InvalidAction < RuntimeError
-	end
-
-	# Raised when an action runs but encounters a fatal error.
-	class FailedAction < RuntimeError
-	end
-
-	attr_reader :id
-
-	# Loads all bit info from database, or attempts to add new bit to database.
-	# Raises a TypeError if not given an integer or hash.
-	# @param [Integer, Hash] info id of bit or info for new bit
-	def initialize info
-		@id = \
-			if info.is_a? Integer
-				info
-			elsif info.is_a? Hash
-				info.each do |key, value|
-					instance_variable_set "@#{key}", value
-				end
-				g = @group_name if @group_name
-				g = @group_id if @group_id
-				self.group = g, info
-				insert_new
-			else
-				fail TypeError
-			end
-		load_info
-	end
-
-	private
-
-	# Add support fot the dynamic instance variables.
-	class ::Array
-		# Makes a hash that maps symbols in the array to instance variable values.
-		# @param [Object] obj the object with the instance variables to use
-		# @param [Array] exclude instance variables named in this array as symbols are excluded from the hash
-		# @return [Hash] mapping of symbols in the array to instance variable values
-		def hash_ivars obj, exclude = []
-			h = {}
-			self.each do |x|
-				h[x] = obj.instance_variable_get "@#{x}" unless exclude.include? x
-			end
-			return h
-		end
-	end
-
-	# Set group by name or id.
-	# @param [Integer, String] group id or info for group
-	def group= group
-		@group_id = group if group.is_a? Integer
-		@group_name = group if group.is_a? String
-
-		if @group_id.nil?
-			g = @@db.select_info_by_name :groups, [ :rowid ], @group_name
-			@group_id = if g.nil? then insert_new_group else g[:rowid] end
-		end
-	end
-
-	# Inserts a new bit into the database using the availible instance variables.
-	# Raises a MissingValues if required values are not given.
-	# Raises a DuplicateElement if a bit with unique values already exists.
-	def insert_new
-		uniq = @@unique[:bits].hash_ivars self
-		uniq.each { |x| fail MissingValues if x.nil? }
-
-		fail DuplicateElement if ( lookup_id uniq ).first
-
-		data = @@info[:bits].hash_ivars self, [ :rowid ]
-		@@db.insert_info :bits, data
-	end
-
-	# (see #insert_new)
-	def insert_new_group
-		fail MissingValues if @group_name.nil?
-		fail DuplicateElement if @@db.select_info_by_name :groups, @@unique[:groups], @group_name
-
-		data = @@info[:groups].hash_ivars self, [ :rowid, :name ]
-		data[:name] = @group_name
-
-		@@db.insert_info :groups, data
-	end
-
-	# Loads all bit info from the database into instance variables.
-	def load_info
-		fail MissingValues if @id.nil?
-		info = @@db.select_info_by_id :bits, @@info[:bits], @id
-		fail NoElement unless info
-
-		group_info = @@db.select_info_by_id :groups, @@info[:groups], info[:group_id]
-		info[:group_name] = group_info[:name]
-		group_info.delete :rowid
-		group_info.delete :name
-
-		info.merge! group_info
-		info.delete :rowid
-
-		info.each do |key, value|
-			instance_variable_set "@#{key}", value
-			self.class.send :attr_reader, key
-			self.class.send :public, key
-		end
-	end
-
-	public
-	# Add a task to the array of pending tasks.
-	# @param [Hash] task info for task
-	def queue_task task
-		@tasks = [] unless @tasks
-		@tasks << task
-	end
-
-# 	def clear_task task
-# 		action = task[:action]
-# 		id = task[:rowid]
-#
-# 		@@db.delete_action_by_id action, id
-# 	end
-
-	# Runs all tasks in the list of pending tasks and returns the status of each run task.
-	# @return [Hash] key is task id
-	def run_all
-		tasks = @tasks
-		status = {}
-
-		tasks.each do |t|
-			a = t[:action]
-			id = t[:rowid]
-			status[a] ||= {}
-			begin
-				@@db.update_action_status a, id, { :status => :running }
-				self.send a, t
-				stat = :complete
-				msg = nil
-			rescue InvalidAction, FailedAction => e
-				stat = :failed
-				msg = "#{e.class}: #{e.message}"
-			ensure
-				s = { :status => stat, :message => msg }
-				status[a].merge! ( { id => s } )
-				@@db.update_action_status a, id, s
-			end
-		end
-		status
-	end
-
-	# Finds bit ids that match given criteria.
-	# @param [Hash] criteria field / value pairs that will be matched against
-	# @return [Array] bit ids that match criteria
-	def lookup_id criteria
-		@@db.select_info_by_criteria :bits, [:rowid], criteria
-	end
-
-end
-

data/lib/kit/db_sqlite3.rb

@@ -1,212 +0,0 @@
-require 'sqlite3'
-
-# Methods to make sqlite3 interation more concise.
-module SQLite3Tools
-
-	# Array methods.
-	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
-
-	# Integer methods.
-	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
-
-	# SQLite3 database methods.
-	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
-			end
-			result
-		end
-	end
-end
-
-# Backend abstracts database interactions.
-class Backend < Kit
-
-	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]
-			db_paths[key] = "#{dir}/#{name}"
-		end
-
-		@db_paths = db_paths
-
-		dbs = db_prepare @db_paths
-		@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
-
-		dbs = {}
-		db_paths.each do |type, path|
-			dbs[type] = [ ( File.exists? path ), ( SQLite3::Database.new path ) ]
-		end
-
-		# Set sqlite3 options here
-		dbs.each do |type, db|
-			db[1].type_translation = true
-		end
-
-		dbs.each do |type, db|
-			begin
-				( db_initialize type, db[1] ) unless db[0]
-			rescue
-				File.delete db_paths[type]
-			end
-		end
-
-		dbs.each do |type, db|
-			dbs[type] = db[1]
-		end
-
-		return dbs
-
-	end
-
-	public
-
-	# Deletes database files.
-	def delete
-		@db_paths.each do |key, f|
-			File.delete f
-		end
-	end
-
-	# Gets the row from an info table with the given id.
-	# @param [Symbol] table what database table to query
-	# @param [Array] fields list of column names to return
-	# @param [Integer] id rowid of record to return
-	# @return [Hash] first matched row with a key for each requested field
-	def select_info_by_id table, fields, id
-		info = @info_db.select fields, "FROM `#{table}` WHERE `rowid` = '#{id}'"
-		info.first
-	end
-
-	# Gets the rows from an info table with the given name.
-	# @param table (see #select_info_by_id)
-	# @param fields (see #select_info_by_id)
-	# @param [String] name of records to return
-	# @return (see #select_info_by_id)
-	def select_info_by_name table, fields, name
-		info = @info_db.select fields, "FROM `#{table}` WHERE `name` = '#{name}'"
-		info.first
-	end
-
-	# Gets the rows from an info table with the given criteria.
-	# @param table (see #select_info_by_id)
-	# @param fields (see #select_info_by_id)
-	# @param [Hash] criteria key / value pairs required to match
-	# @return [Array] hash for each returned row with a key for each requested field
-	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 "}"
-	end
-
-	# Inserts a new row into an info table.
-	# @param table (see #select_info_by_id)
-	# @param [Hash] data key / value pairs for new row
-	# @return [Integer] rowid of new row
-	def insert_info table, data
-		@info_db.execute "INSERT INTO #{table} ( `#{data.keys.join "`, `"}` ) VALUES ( #{data.length.make_placeholders} )", data.values
-		@info_db.last_insert_row_id
-	end
-
-	# Gets the rows from the action table with given status.
-	# @param table (see #select_info_by_id)
-	# @param fields (see #select_info_by_id)
-	# @param [Symbol] status name of status to match
-	# @return (see #select_info_by_id)
-	def select_all_actions_by_status table, fields, status
-		query = "FROM `#{table}` WHERE `status` = '#{status}'"
-		rows = @action_db.select fields, query
-
-		rows.map { |t| t.merge ( { :action => table, :status => t[:status].to_sym } ) }
-	end
-
-	# Inserts a new row into an action table.
-	# @param (see #insert_info)
-	# @return (see #insert_info)
-	def insert_action table, data
-		data.merge! ( { :status => :pending.to_s, :time => Time.now.to_i  } )
-		@action_db.execute "INSERT INTO #{table} ( `#{data.keys.join "`, `"}` ) VALUES ( #{data.length.make_placeholders} )", data.values
-		@action_db.last_insert_row_id
-	end
-
-	# Updates the status of a task in an action table.
-	# @param [Symbol] table name of the action table
-	# @param [Integer] action rowid to update
-	# @param [Hash] data key / value pairs to set
-	def update_action_status table, id, data
-		data.merge! ( { :status => data[:status].to_s, :time => Time.now.to_i } )
-		set = []
-		data.each do |key, value|
-			set << "`#{key}` = '#{value}'"
-		end
-
-		@action_db.execute "UPDATE #{table} SET #{set.join ", "} WHERE `rowid` = '#{id}'"
-	end
-
-	# 	def delete_action_by_id action, id
-	# 		puts "DELETE FROM `#{action}` WHERE `rowid` = #{id}"
-	# 	end
-
-end