sid_list 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcb011cca900e1071244d7ad7cc3b0190f4fadff
+  data.tar.gz: 364210567619c5d65854c032d93b49890430f61a
+SHA512:
+  metadata.gz: cdede409505f1ddba9077db2db90b1c4306d979ca1a966505ba5778505528246e855134cb237db800a9b7262a1476bea17fdc97d170962be5702b5b1887e5b42
+  data.tar.gz: 5ddc2432944f46dbd8b7b4cff6e60f32b5924d7352540b026b835985e344c5756b98ce1549dfd2b199482b41738537a9f7081be7646fa2bfdd3c78a1c74980f1

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+md
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Configs and tests
+test.rb
+*.yml
+*.yaml
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Linux generated files #
+#########################
+*~
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+Icon?
+ehthumbs.db
+Thumbs.db
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sid_list.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    sid_list (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  sid_list!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sikian
+
+MIT License
+
+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/README.rdoc

@@ -0,0 +1,48 @@
+= Sid List
+
+List containing any type of Object intenteded to be indexed by status and id, making it easy to select all Objects for a given status, update the list, etc.
+
+== Introduction
+
+Sid List is a list I created for one of the servers I developed. The idea behind it was to provide a list that could easily manage any type of objects and index them by status & id and be able to load and update itself with just a command once it had been extended.
+
+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
+
+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 
+
+== License
+
+Copyright (C) 2013 Sid List contributers
+
+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.
+
+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.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/git.pub

@@ -0,0 +1 @@
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDXjQe85FC6wXxk9xCeI6qb7rqeoBIErMlPpXIokBQgtdlzH8JJcWdKsUjvJpEU0DW5SP+wsLDsiDruFqzgVV4KsNp/akCcK4FDd/6zAeVF7z8fODTGs+NQl5/yGbYUJ3u7M26unrLg8HwH/NjjTX2b2PQq83MY3pnZjncuQc5ZBKL+9Kv8j5dCzxVhQfbSc/xEUZzWt6KR0ABxlM8fZcGacfClI0t970NSXBpmsJOZAL4wRq94ZfSeSqcnCnsFyN/jDe1oyWiRoV2IGyV6Gp75mBb0BJtesybwddlRQn8xenDvVmGvOha2+NdUmQ9K3zLFXVRzcYKzI0p4YY3IHknP owl@arch

data/lib/sid_list/version.rb

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

data/lib/sid_list.rb

@@ -0,0 +1,259 @@
+require "sid_list/version"
+
+class SidList
+	# Creates a list of objects (jobs, instances, etc.) indexed by id & status
+	attr_accessor :list_by_status, :list_by_id
+
+	def initialize
+		@list_by_id = Array.new()
+		@list_by_status = Hash.new()
+	end
+
+	# Finds objecst in the list based on any of its accessible attributes. 
+	# If only a Fixnum is passed, it will be interpreted as an id search.
+	# @note the Object must respond to obj#attribute().
+	# @return [Array] Objects found.
+	#
+	# @params values [Hash] Params. for search.
+	# @params values [Fixnum] Id.
+	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.'
+		end
+			
+		@list_by_status.each do |status, status_list|
+
+			status_list.each do |obj|
+
+				# Catch is now acting as an OR condition.
+				# Maybe it would be a good idea to do it an AND
+				# @todo change this to AND
+				catch :not_equal do
+					values.each do |term, value|
+						if obj.send(term)!= value
+							throw :not_equal
+						end
+					end
+					found << obj
+				end
+
+			end
+		end
+
+		return found
+	end
+
+	def add obj
+		@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
+		#  has an array in @list_by_status.
+		ensure_status_in_list(obj.status) << obj 
+
+		return self
+	end
+
+	# @overload delete(obj)
+	# 	Deletes an object from the list.
+	# 	@param [Object] obj Object to be deleted.
+	#
+	# @overload delete(id)
+	# 	Deletes an object from the list using its id.
+	# 	@param [Fixnum] id Object's id.
+	#
+	# @todo revise first part to get an optimum algorithm.
+	def delete value
+		if value.is_a? Fixnum
+			id = value
+			obj = @list_by_id[value]
+		else
+			obj = value
+			id = obj.id
+			value = nil
+		end
+
+		@list_by_id.delete_at(id)
+		@list_by_status[obj.status].delete obj
+
+		return self
+	end
+
+	# Loads objects into list.
+	# Objects must be able to receive data in initialization, i.e. Object.new(:name => '', :id => '', ...)
+	def load
+		load_objs.each do |obj|
+			add obj
+		end
+	end
+
+	# @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
+		update_objs time
+	end
+
+	# @option opts [Symbol] :noforce
+	# @option opts [Symbol] :old_status
+	def change_status obj, new_status, opts={}
+		if obj.is_a? Fixnum
+			id = obj
+			obj = self.find(id).first
+		end
+
+		# Delete Object from old_status
+		# If old_status is given, it's easily done. 
+		# Otherwise, the object's status must be check to see if it's not the new one (and supose it's the old one).
+		# If the status has already been changed, the Object is looked for in @list_by_status.
+		# 
+		# In any case, we will proceed to the next method if the Object is not found and deleted.
+		#
+		# Maybe it would be easier just to delete and re-add the Object, but the status may have already changed.
+		
+		deleted = nil
+
+		# Using opts[:old_status]
+		if opts[:old_status]
+			if @list_by_status[:old_status].delete(obj)
+				deleted = true
+			end
+		end
+
+		# Using obj.status
+		unless deleted && obj.status == new_status 
+			if @list_by_status[obj.status].delete(obj) 
+				deleted = true
+			end
+		end
+
+		# Search through @list_by_status
+		unless deleted			
+			catch :deleted do
+				@list_by_status.each do |status, status_list|
+					if status_list.include? obj
+						@list_by_status[status].delete obj
+						deleted = true
+						throw :deleted
+					end
+				end
+			end
+		end
+
+		# Force status, avoidable with :noforce
+		obj.status = new_status unless obj.status == new_status || opts[:noforce]
+
+		# Only add again if deleted?
+		# Maybe should add anyway. Or be strict and just allow adding with #add
+		ensure_status_in_list(new_status) << obj if deleted
+
+		# Return nil if it has not been deleted (and therefore, not added).
+		return deleted
+	end
+
+	private 
+
+	###
+	# The following methods must be overwritten to configure the list:
+	# load_hash
+	# update_hash
+	# new_obj
+	#
+
+	# @return [Array] data to be loaded into list
+	# @note This method must be overwritten to configure the list.
+	def load_hash
+		raise 'StatusList#load_hash() has not been overwritten to allow data to be loaded into the list.'
+		
+		return Array.new
+	end
+
+	# @return [Hash] 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, ...}, ...]}
+	# @note This method must be overwritten to configure the list.
+	def update_hash time
+		raise 'StatusList#update_hash() has not been overwritten to allow data in the list to be updated.'
+
+		return Hash.new
+	end
+
+	# @param obj_data [Hash] data to be loaded to the Object.
+	# @return [Object] new Object the list is composed of.
+	# @note This method must be overwritten to configure the list.
+	def new_obj obj_data
+		raise 'StatusList#new_obj(obj_data)has not been overwritten to allow new objects to be created.'
+	end
+
+	def load_objs
+		list_data = load_hash()
+		obj_array = Array.new()
+
+		list_data.each do |obj_data|
+			obj_array << new_obj(obj_data)
+		end
+
+		return obj_array
+	end
+
+	# Uses #update_hash to get all objects to be added or edited.
+	# @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()
+
+		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.
+	# @note Object must respond to the hash's keys. Otherwise an exception will be raised.
+	# @param obj_data [Hash] new values for the object.
+	# @return obj [Object] edited Object.
+	# @return obj [NilClass] nil if no Object was found to be edited.
+	def edit_obj obj_data
+		obj = @list_by_id[obj_data[:id]]
+
+		if obj
+			obj_data.each do |key,value|
+				obj.send("#{key}=", value)
+			end
+		end
+
+		return obj
+	end
+
+	# Returns the list for a given status. If there is no such status in list, it is added 
+	# (as a new array). It also defines the method #{status}, that calls all the objects with that status,
+	# if it hasn't been already been defined.
+	# @note if a status has the same name as any of the methods defined in the class, it wont be overwritten.
+	# @param status [Symbol] 
+	def ensure_status_in_list status
+		unless @list_by_status[status].is_a? Array
+			@list_by_status[status] = Array.new
+		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

data/sid_list.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sid_list/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sid_list"
+  spec.version       = SidList::VERSION
+  spec.authors       = ["Sikian"]
+  spec.email         = ["sikian@gmail.com"]
+  spec.description   = %q{List containing any type of Object intenteded to be indexed by status and id, making it easy to select all Objects for a given status, update the list, etc.}
+  spec.summary       = %q{List indexed by status & id.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/testclass.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "sid_list"
+
+
+class List < SidList
+
+	def update_hash time
+		hash = {:updated => [{:id => 3, :name=>'meou'}]}
+		return hash
+	end
+end
+
+class Job
+	attr_accessor :id, :name, :status, :date
+	
+	def initialize values={}
+		@id = values[:id]
+		@name = values[:name]
+		@status = values[:status]
+		@date = values[:date]
+	end
+end
+
+jobs = List.new
+
+jobs.add Job.new :id => 1, :name => 'aaa', :status => :new, :date => '2013-03-25 16:24:58'
+jobs.add Job.new :id => 2, :name => 'bbb', :status => :new, :date => '2013-03-25 16:24:58'
+jobs.add Job.new :id => 3, :name => 'ccc', :status => :old, :date => '2013-03-25 16:24:58'
+jobs.add Job.new :id => 4, :name => 'aaa', :status => :old, :date => '2013-03-25 16:24:58'
+jobs.add Job.new :id => 5, :name => 'bbb', :status => :new, :date => '2013-03-25 16:24:58'
+
+# puts "found: #{jobs.find :name => 'aaa', :id => 3}"
+# puts jobs.list_by_status.inspect
+
+# puts jobs.find(:name => 'aaa', :status => :new).inspect
+# jobs.change_status(1, :old)
+# puts jobs.list_by_status.inspect
+
+puts jobs.update
+puts jobs.find(3).inspect
+puts jobs.old

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sid_list
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: List containing any type of Object intenteded to be indexed by status
+  and id, making it easy to select all Objects for a given status, update the list,
+  etc.
+email:
+- sikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- git.pub
+- lib/sid_list.rb
+- lib/sid_list/version.rb
+- sid_list.gemspec
+- test/testclass.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: List indexed by status & id.
+test_files:
+- test/testclass.rb
+has_rdoc: