bit.rb in kit-0.1.0

- old
+ new

@@ -1,47 +1,135 @@
+# 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
+
 	attr_reader :id
 
-	# Loads all bit info from database, or attempts to add new bit to database
+	# 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
 
-		@id = if info.is_a? Integer
-						info
-					else
-						make_ivars info
-						insert_new
-					end
+	private
 
-		load_info
+	# 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
 
-	# Sets instance variables for each key => value pair
-	def make_ivars hash
-		hash.each do |ivar, val|
-			self.class.send :attr_accessor, ivar unless respond_to? ivar
-			send "#{ivar}=", val
+	# 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
+
+		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
 
-	# Add a task to the array of pending tasks in @tasks.
+	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
+# 	def clear_task task
 # 		action = task[:action]
 # 		id = task[:rowid]
 #
 # 		@@db.delete_action_by_id action, id
-	end
+# 	end
 
-	# Runs all tasks in the list of pending tasks in @tasks and returns the status of each run task.
+	# 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 = {}
 
@@ -53,17 +141,16 @@
 			rescue
 				status[a] = "failed"
 			end
 			status
 		end
-
-
 	end
 
-	class DuplicateElement < RuntimeError
-	end
-
-	class NoElement < RuntimeError
+	# 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
 