floormanager 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Inge Jørgensen
+
+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,22 @@
+= floormanager: Handle threaded workers like a champ
+
+== Usage
+
+ require 'floormanager'
+
+ queue   = FloorManager::Queue.new('one', 'two', 'three', 'four', 'five')
+ workers = FloorManager::Workers.new(queue)
+
+ workers.perform(:threads => 3) do |item|
+   item.upcase
+ end
+
+ queue.each do |key, results|
+   puts "Key: #{key}, results: #{results}"
+ end
+
+See the examples for more advanced usage.
+
+== Copyright
+
+Copyright (c) 2010 Inge Jørgensen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "floormanager"
+    gem.summary = %Q{Handle threaded workers like a champ}
+    gem.description = %Q{Simple ruby library for handling threaded workers operating on a queue}
+    gem.email = "inge@elektronaut.no"
+    gem.homepage = "http://github.com/elektronaut/floormanager"
+    gem.authors = ["Inge Jørgensen"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "floormanager #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/floormanager.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{floormanager}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Inge J\303\270rgensen"]
+  s.date = %q{2010-05-14}
+  s.description = %q{Simple ruby library for handling threaded workers operating on a queue}
+  s.email = %q{inge@elektronaut.no}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "floormanager.gemspec",
+     "lib/floormanager.rb",
+     "lib/floormanager/queue.rb",
+     "lib/floormanager/workers.rb",
+     "spec/floormanager_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/elektronaut/floormanager}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Handle threaded workers like a champ}
+  s.test_files = [
+    "spec/floormanager_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+  end
+end
+

data/lib/floormanager.rb

@@ -0,0 +1,3 @@
+require 'thread'
+require 'floormanager/queue'
+require 'floormanager/workers'

data/lib/floormanager/queue.rb

@@ -0,0 +1,176 @@
+module FloorManager
+	class Queue
+		include Enumerable
+
+		# States
+		PENDING     = 0
+		CHECKED_OUT = 1
+		FAILED      = 2
+		SUCCESS     = 3
+	
+		def initialize(*args)
+			@queue = []
+			args.each{|a| self << a} if (args = *args)
+		end
+	
+		public
+
+			# Add an item to the queue
+			def add(item)
+				@queue << {
+					:item  => item,
+					:value => nil,
+					:state => PENDING
+				}
+			end
+			alias :<< :add
+	
+			# Get the value of an item in the queue
+			def get_value(key)
+				(item = get_item(key)) ? item[:value] : nil
+			end
+			alias :[] :get_value
+	
+			# Returns all the items in the queue
+			def keys
+				@queue.map{|i| i[:item]}
+			end
+
+			# Returns each item with value, hash style
+			def each
+				@queue.each{|item| yield item[:item], item[:value]}
+			end
+		
+			# Check out an item from the queue
+			def checkout
+				if pending?
+					item = pending_items.first
+					item[:state] = CHECKED_OUT
+					item[:item]
+				else
+					nil
+				end
+			end
+
+			# Check in an item with a new value, optionally with a state
+			# (which defaults to SUCCESS)
+			def checkin(item, value, state=SUCCESS)
+				if keys.include?(item)
+					item = get_item(item)
+					item[:value] = value
+					item[:state] = state
+				else
+					invalid_key!
+				end
+			end
+		
+			# Total queue length
+			def length
+				@queue.length
+			end
+
+			# Is the queue done?
+			def done?
+				(pending.length == 0 && checked_out.length == 0) ? true : false
+			end
+
+			# Does this queue have pending items?
+			def pending?
+				(pending.length > 0) ? true : false
+			end
+		
+			# Get pending items
+			def pending
+				pending_items.map{|i| i[:item]}
+			end
+		
+			# Get checked out items
+			def checked_out
+				checked_out_items.map{|i| i[:item]}
+			end
+
+			# Get completed items
+			def completed
+				completed_items.map{|i| i[:item]}
+			end
+
+			# Get successed items
+			def successed
+				successed_items.map{|i| i[:item]}
+			end
+
+			# Get failed items
+			def failed
+				failed_items.map{|i| i[:item]}
+			end
+
+			# Get the state of an item
+			def state(key)
+				(item = get_item(key)) ? item[:state] : invalid_key!
+			end
+
+			# Is this item processed?
+			def processed?(key)
+				state(key) > PENDING
+			end
+		
+			# Is this item checked out?
+			def checked_out?(key)
+				state(key) == CHECKED_OUT
+			end
+
+			# Did this item fail?
+			def failed?(key)
+				state(key) == FAILED
+			end
+
+			# Did this item succeed?
+			def success?(key)
+				state(key) == SUCCESS
+			end
+
+			# Is this item completed?
+			def completed?(key)
+				state(key) >= FAILED
+			end
+
+		private
+
+			# Handle invalid keys
+			def invalid_key!
+				raise ArgumentError, "Invalid key: #{item.inspect}"
+			end
+
+			# Get an item by key
+			def get_item(key)
+				matches = @queue.select{|i| i[:item] == key}
+				(matches.length > 0) ? matches.first : nil
+			end
+
+			# Get all pending items
+			def pending_items
+				@queue.select{|i| i[:state] == PENDING}
+			end
+
+			# Get all items which are checked out
+			def checked_out_items
+				@queue.select{|i| i[:state] == CHECKED_OUT}
+			end
+
+			# Get all completed items (both failed and successed)
+			def completed_items
+				@queue.select{|i| i[:state] >= FAILED}
+			end
+
+			# Get all failed items
+			def failed_items
+				@queue.select{|i| i[:state] == FAILED}
+			end
+
+			# Get all successed items
+			def successed_items
+				@queue.select{|i| i[:state] == SUCCESS}
+			end
+
+	end
+end

data/lib/floormanager/workers.rb

@@ -0,0 +1,42 @@
+module FloorManager
+	class Workers
+
+		def initialize(*queue)
+			queue = *queue
+			@queue = queue.kind_of?(FloorManager::Queue) ? queue : FloorManager::Queue.new(queue)
+			@mutex = Mutex.new
+		end
+		attr_reader :queue
+
+		def perform(options={})
+			options = {:threads => 1}.merge(options)
+			threads = (0...options[:threads]).to_a.map do |thread_id|
+				Thread.new do
+					until queue.done?
+						if item = checkout
+							value = yield(item)
+							checkin(item, value)
+						else
+							Thread.pass
+						end
+					end
+				end
+			end
+			threads.each{|t| t.join}
+			@queue
+		end
+
+		def checkout
+			@mutex.synchronize{@queue.checkout}
+		end
+
+		def checkin(*args)
+			@mutex.synchronize{@queue.checkin(*args)}
+		end
+
+		def synchronize
+			@mutex.synchronize{yield}
+		end
+		alias :exclusively :synchronize
+	end
+end

data/spec/floormanager_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Floormanager" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'floormanager'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: floormanager
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Inge J\xC3\xB8rgensen"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+description: Simple ruby library for handling threaded workers operating on a queue
+email: inge@elektronaut.no
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- floormanager.gemspec
+- lib/floormanager.rb
+- lib/floormanager/queue.rb
+- lib/floormanager/workers.rb
+- spec/floormanager_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/elektronaut/floormanager
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Handle threaded workers like a champ
+test_files: 
+- spec/floormanager_spec.rb
+- spec/spec_helper.rb