sid_list 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcb011cca900e1071244d7ad7cc3b0190f4fadff
-  data.tar.gz: 364210567619c5d65854c032d93b49890430f61a
+  metadata.gz: a74f514b61e1880376746c2b727ed403b6cc67f2
+  data.tar.gz: 640a8460a5ef9a01115a32e5ef7e01252bde20c5
 SHA512:
-  metadata.gz: cdede409505f1ddba9077db2db90b1c4306d979ca1a966505ba5778505528246e855134cb237db800a9b7262a1476bea17fdc97d170962be5702b5b1887e5b42
-  data.tar.gz: 5ddc2432944f46dbd8b7b4cff6e60f32b5924d7352540b026b835985e344c5756b98ce1549dfd2b199482b41738537a9f7081be7646fa2bfdd3c78a1c74980f1
+  metadata.gz: 974a122ebb91220ef9b697a77c3a2fa8ce549d75e7118bf95604bb5e861f5df3e0c983f2aea19b734973d0f83418cae30735b76888904dec9389109a1d1c5f64
+  data.tar.gz: ae0ab79b7afb76706cecaafa35b5a7393eb199b8e403eda613669ed0815f9c2398fb4b4e8dca98cee953f6db4154dd29e71b20040892aec6319eb18311020e11

data/README.rdoc

@@ -8,25 +8,25 @@ Sid List is a list I created for one of the servers I developed. The idea behind
 
 As I had previously developed MdlSql (a modular sql gem), configuring the gem as I wanted proved itself clear and easy. For example, in case I wanted to make a list of instances which would be loaded from Mysql, it would go the following way:
 
-	require 'mdlsql'
-	class InstanceList < SidList
-		def load_hash	
-			results = MdlSql::select.from(:instances).where(:status, 1, '>').execute
-		end
-		def update_hash time
-			results = MdlSql::select.from(:instances).where("status > 1 AND updated_at > #{time}").execute
-		end
-		def new_obj obj_data
-			obj = Instance.new obj_data
-		end
-	end
+  require 'mdlsql'
+  class InstanceList < SidList
+    def load_hash	
+      results = MdlSql::select.from(:instances).where(:status, 1, '>').execute
+    end
+    def update_hash time
+      results = MdlSql::select.from(:instances).where("status > 1 AND updated_at > #{time}").execute
+    end
+    def new_obj obj_data
+      obj = Instance.new obj_data
+    end
+  end
 
 And with this I could just go straight to work with the list:
 
-	il = InstanceList.new
-	il.load
-	il.ready.first # Get the first of the 'ready' instance
-	il.update 
+  il = InstanceList.new
+  il.load
+  il.ready.first # Get the first of the 'ready' instance
+  il.update 
 
 == License
 
@@ -45,4 +45,4 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-In order to contact the author of this gem, please write to sikian@gmail.com.
+In order to contact the author of this gem, please write to sikian@gmail.com.

data/lib/sid_list/version.rb

@@ -1,3 +1,3 @@
 class SidList
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/sid_list.rb

@@ -16,23 +16,23 @@ class SidList
 	#
 	# @params values [Hash] Params. for search.
 	# @params values [Fixnum] Id.
-	def find values={}
+	def find values
 		found = Array.new
 
 		if values.is_a? Fixnum
 			return @list_by_id[values]
 			# values = {:id => values}
 		elsif !values.is_a? Hash
-			raise ArgumentError, 'argument must be a Hash or a Fixnum.'
+			raise ArgumentError, 'Argument must be a Hash or a Fixnum.'
 		end
 			
 		@list_by_status.each do |status, status_list|
 
 			status_list.each do |obj|
 
-				# Catch is now acting as an OR condition.
+				# Catch is now acting as an AND condition.
 				# Maybe it would be a good idea to do it an AND
-				# @todo change this to AND
+				# @todo make OR condition available
 				catch :not_equal do
 					values.each do |term, value|
 						if obj.send(term)!= value
@@ -45,10 +45,23 @@ class SidList
 			end
 		end
 
+		# if found.length == 1
+		# 	found = found.first
+		# end
+
+		# Return just an array, even if it's empty!
 		return found
 	end
 
+	def [] id
+		@list_by_id[id]
+	end
+
 	def add obj
+		if obj.is_a? Hash
+			obj = new_obj obj
+		end
+		
 		@list_by_id[obj.id] = obj # Add obj by id
 
 		# Add obj by status. ensure_status_in_list is called to make sure that the status
@@ -94,7 +107,7 @@ class SidList
 	# @todo better time options
 	# @todo find a way to move adding here without cycling again
 	def update opts={}
-		time = opts[:time]? opts[:time] : Time.now.utc
+		time = opts[:time]? opts[:time] : Time.now#.utc
 		update_objs time
 	end
 
@@ -119,16 +132,29 @@ class SidList
 
 		# Using opts[:old_status]
 		if opts[:old_status]
-			if @list_by_status[:old_status].delete(obj)
+			if @list_by_status[opts[:old_status]].delete(obj)
 				deleted = true
 			end
+
+			# Delete status in @list_by_status if it's empty
+			# Useful if status hasn't been already changed.
+			if @list_by_status[opts[:old_status]].length == 0
+				@list_by_status.delete opts[:old_status]
+			end
 		end
 
 		# Using obj.status
-		unless deleted && obj.status == new_status 
-			if @list_by_status[obj.status].delete(obj) 
+		unless deleted || obj.status == new_status 
+			status = obj.status
+			# puts obj.status
+			if @list_by_status[status].delete(obj) 
 				deleted = true
 			end
+
+			# Delete status in @list_by_status if it's empty
+			if @list_by_status[status].length == 0
+				@list_by_status.delete status
+			end
 		end
 
 		# Search through @list_by_status
@@ -138,6 +164,11 @@ class SidList
 					if status_list.include? obj
 						@list_by_status[status].delete obj
 						deleted = true
+
+						# Delete status in @list_by_status if it's empty
+						if @list_by_status[status].length == 0
+							@list_by_status.delete status
+						end
 						throw :deleted
 					end
 				end
@@ -155,6 +186,35 @@ class SidList
 		return deleted
 	end
 
+	def count
+		@list_by_id.compact.count
+	end
+
+	def first
+		i = @list_by_id.find_index { |x| x }
+		@list_by_id[i]
+	end
+
+	def compact
+		@list_by_id.compact
+	end
+
+	def list_status *values
+		@list_by_status.each do |stat, arr|
+			puts "#{stat}:"
+			arr.each do |obj|
+				print "\t [#{obj.id}]"
+				values.each do |v|
+					print "\t #{obj.send v}" if obj.respond_to? v
+				end
+				print "\n"
+			end
+		end
+		return nil
+	end
+
+	alias_method :to_s, :list_status
+
 	private 
 
 	###
@@ -166,21 +226,23 @@ class SidList
 
 	# @return [Array] data to be loaded into list
 	# @note This method must be overwritten to configure the list.
-	def load_hash
+	def load_data
 		raise 'StatusList#load_hash() has not been overwritten to allow data to be loaded into the list.'
 		
 		return Array.new
 	end
+	alias_method :load_hash, :load_data
 
-	# @return [Hash] values to be updated/added. Please see example to see how this hash should be.
+	# @return [Array] values to be updated/added. Please see example to see how this hash should be.
 	# @example update_hash's return
-	# 	update_hash(now) # => {:created => [{:id => 1, ...}, ...], :updated => [{:id => 10, ...}, ...]}
+	# 	update_hash(now) # => [{:id => 1, ...}, ...]
 	# @note This method must be overwritten to configure the list.
-	def update_hash time
+	def update_data time
 		raise 'StatusList#update_hash() has not been overwritten to allow data in the list to be updated.'
 
-		return Hash.new
+		return Array.new
 	end
+	alias_method :update_hash, :update_data
 
 	# @param obj_data [Hash] data to be loaded to the Object.
 	# @return [Object] new Object the list is composed of.
@@ -190,7 +252,7 @@ class SidList
 	end
 
 	def load_objs
-		list_data = load_hash()
+		list_data = load_data()
 		obj_array = Array.new()
 
 		list_data.each do |obj_data|
@@ -201,24 +263,37 @@ class SidList
 	end
 
 	# Uses #update_hash to get all objects to be added or edited.
+	# @since 0.0.4 no longer need :updated and :created
 	# @param time [Time] time to pass to update_hash in order to get new changes.
-	# @note update_hash must return a Hash with keys :created and :updated (see #update_hash).
 	
 	def update_objs time
-		list_data = update_hash(time)
-		created_obj_array = Array.new()
-		updated_obj_array = Array.new()
+		list_data = update_data(time)
 
-		if list_data[:created]
-			list_data[:created].each do |obj_data|
-				add new_obj obj_data
-			end
-		end
-		if list_data[:updated]
-			list_data[:updated].each do |obj_data|
-				edit_obj obj_data
+		# @note the update can be taken care of in update_data if it returns nil.
+
+		if list_data
+			created_obj_array = Array.new()
+			updated_obj_array = Array.new()
+
+			list_data.each do |obj_data|
+				if find obj_data[:id]
+					edit_obj obj_data
+				else
+					add new_obj obj_data
+				end
 			end
 		end
+
+		# if list_data[:created]
+		# 	list_data[:created].each do |obj_data|
+		# 		add new_obj obj_data
+		# 	end
+		# end
+		# if list_data[:updated]
+		# 	list_data[:updated].each do |obj_data|
+		# 		edit_obj obj_data
+		# 	end
+		# end
 	end
 
 	# Updates/Edits an object that already exists.
@@ -230,8 +305,12 @@ class SidList
 		obj = @list_by_id[obj_data[:id]]
 
 		if obj
-			obj_data.each do |key,value|
-				obj.send("#{key}=", value)
+			if obj.respond_to? 'update_with_hash'
+				obj.update_with_hash obj_data
+			else
+				obj_data.each do |key,value|
+					obj.send("#{key}=", value) if obj.respond_to? key
+				end
 			end
 		end
 
@@ -247,13 +326,14 @@ class SidList
 		unless @list_by_status[status].is_a? Array
 			@list_by_status[status] = Array.new
 		end
+		if !(status.is_a? Symbol || status.is_a?(String))
+			raise "Object's status has no name (status #{status} was passed)."
+		end
 		unless self.respond_to?(status)
-			puts 'i dont respond'
 			self.class.send(:define_method, status) do 
 				@list_by_status[status] 
 			end
 		end
-
 		return @list_by_status[status]
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sid_list
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2013-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler