floormanager 0.2.1 → 0.3.0

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  shoulda

data/Rakefile

@@ -1,45 +1,52 @@
-require 'rubygems'
-require 'rake'
+# encoding: utf-8
 
+require 'rubygems'
+require 'bundler'
 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"
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
+require 'rake'
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  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"]
+  # dependencies defined in Gemfile
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
 end
 
-task :spec => :check_dependencies
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
 
-task :default => :spec
+task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "floormanager #{version}"
+  rdoc.title = "mygem #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/examples/twitter.rb

@@ -36,13 +36,13 @@ class Twitter
 		workers.perform(:threads => @concurrency) do |query_string|
 			retries = 0
 			begin
-				results = self.class.get('/search.json', :query => {:q => "\"#{query_string}\""})
+				results = self.class.get('/search.json', :query => {:q => "#{query_string}"})
 				# Handle rate limiting
 				if results.code == 420                          
 					if result.headers['retry-after']
 						retry_delay = result.headers['retry-after'].first.to_i
 					else
-						retry_delay = 60
+						retry_delay = @retry_delay
 					end
 					workers.halt(retry_delay) # Halt all workers for the retry delay
 					retry

data/floormanager.gemspec

@@ -1,61 +1,64 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{floormanager}
-  s.version = "0.2.1"
+  s.version = "0.3.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.date = %q{2011-06-17}
   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"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "examples/twitter.rb",
-     "floormanager.gemspec",
-     "lib/floormanager.rb",
-     "lib/floormanager/queue.rb",
-     "lib/floormanager/result.rb",
-     "lib/floormanager/states.rb",
-     "lib/floormanager/workers.rb",
-     "spec/floormanager_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/twitter.rb",
+    "floormanager.gemspec",
+    "lib/floormanager.rb",
+    "lib/floormanager/queue.rb",
+    "lib/floormanager/result.rb",
+    "lib/floormanager/states.rb",
+    "lib/floormanager/workers.rb",
+    "test/helper.rb",
+    "test/test_floormanager.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.rubygems_version = %q{1.3.7}
   s.summary = %q{Handle threaded workers like a champ}
-  s.test_files = [
-    "spec/floormanager_spec.rb",
-     "spec/spec_helper.rb",
-     "examples/twitter.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"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

data/lib/floormanager/queue.rb

@@ -14,22 +14,18 @@ module FloorManager
 				@queue << {
 					:item  => item,
 					:value => nil,
-					:state => States::PENDING
+					:state => States::PENDING,
+					:index => @queue.length
 				}
 			end
 			alias :<< :add
 	
-			# Get the value of an item in the queue
-			def get_value(key)
-				(item = get_item(key)) ? item[:value] : nil
+			# Get an item in the queue
+			def get_item(index)
+				@queue[index]
 			end
-			alias :[] :get_value
+			alias :[] :get_item
 	
-			# 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]}
@@ -40,7 +36,7 @@ module FloorManager
 				if pending?
 					item = pending_items.first
 					item[:state] = States::CHECKED_OUT
-					item[:item]
+					item
 				else
 					nil
 				end
@@ -48,13 +44,11 @@ module FloorManager
 
 			# Check in an item with a new value, optionally with a state
 			# (which defaults to SUCCESS)
-			def checkin(item, value, state=States::SUCCESS)
-				if keys.include?(item)
-					item = get_item(item)
-					item[:value] = value
-					item[:state] = state
+			def checkin(item, state=States::SUCCESS)
+				if item.kind_of?(Hash) && @queue[item[:index]][:item] == item[:item]
+					@queue[item[:index]] = item.merge({:state => state})
 				else
-					invalid_key!
+					invalid_item!
 				end
 			end
 		
@@ -98,41 +92,11 @@ module FloorManager
 				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) > States::PENDING
-			end
-		
-			# Is this item checked out?
-			def checked_out?(key)
-				state(key) == States::CHECKED_OUT
-			end
-
-			# Did this item fail?
-			def failed?(key)
-				state(key) == States::FAILED
-			end
-
-			# Did this item succeed?
-			def success?(key)
-				state(key) == States::SUCCESS
-			end
-
-			# Is this item completed?
-			def completed?(key)
-				state(key) >= States::FAILED
-			end
-
 		private
 
 			# Handle invalid keys
-			def invalid_key!
-				raise ArgumentError, "Invalid key: #{item.inspect}"
+			def invalid_item!
+				raise ArgumentError, "Invalid item: #{item.inspect}"
 			end
 
 			# Get an item by key

data/lib/floormanager/workers.rb

@@ -9,21 +9,26 @@ module FloorManager
 		attr_reader :queue
 
 		def perform(options={})
-			options = {:threads => 1}.merge(options)
+			options = {:threads => 1, :timeout => false}.merge(options)
 			threads = (0...options[:threads]).to_a.map do |thread_id|
 				Thread.new do
 					until queue.done?
 						if item = checkout
-							result = yield(item)
+							result = yield(item[:item])
 							result = Result.new(result, (result.state rescue States::SUCCESS))
-							checkin(item, result, result.state)
+							item[:value] = result
+							checkin(item, result.state)
 						else
 							Thread.pass
 						end
 					end
 				end
 			end
-			threads.each{|t| t.join}
+			if options[:timeout]
+				threads.each{|t| t.join(options[:timeout])}
+			else
+				threads.each{|t| t.join}
+			end
 			@queue
 		end
 

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'floormanager'
+
+class Test::Unit::TestCase
+end

data/test/test_floormanager.rb

@@ -0,0 +1,32 @@
+require 'helper'
+
+class TestFloorManager < Test::Unit::TestCase
+
+	context "a processed queue" do
+		setup do
+			workers = FloorManager::Workers.new([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
+			@results = workers.perform(:threads => 5) do |number|
+				number * 10
+			end
+		end
+
+		should "process a queue" do
+			@results.each do |original, result|
+				assert_equal (original * 10), result
+			end
+		end
+	end
+
+	context 'a queue with non-unique items' do
+		setup do
+			@queue = FloorManager::Queue.new(['a', 'a', 'b', 'c'])
+		end
+		
+		should "not hang" do
+			FloorManager::Workers.new(@queue).perform(:threads => 5) do |item|
+			end
+			assert true # The processes will simply hang here if not
+		end
+	end
+
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: floormanager
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Inge J\xC3\xB8rgensen"
@@ -14,23 +15,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-14 00:00:00 +02:00
+date: 2011-06-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
-        - 3
         - 0
-        version: 1.3.0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
 description: Simple ruby library for handling threaded workers operating on a queue
 email: inge@elektronaut.no
 executables: []
@@ -42,7 +89,8 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -54,40 +102,41 @@ files:
 - lib/floormanager/result.rb
 - lib/floormanager/states.rb
 - lib/floormanager/workers.rb
-- spec/floormanager_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- test/helper.rb
+- test/test_floormanager.rb
 has_rdoc: true
 homepage: http://github.com/elektronaut/floormanager
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Handle threaded workers like a champ
-test_files: 
-- spec/floormanager_spec.rb
-- spec/spec_helper.rb
-- examples/twitter.rb
+test_files: []
+

data/.gitignore

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

data/spec/floormanager_spec.rb

@@ -1,7 +0,0 @@
-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

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

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-$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