queue_to_the_future 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Devin Christensen
+
+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,20 @@
+= queue_to_the_future
+
+An easy way to create asynchronous execution paths in an unobtrusive way. Queue to the Future uses a managed pool of workers
+to keep overhead to a minimum.
+
+== Synopsis
+  f = Future(list, of, args) do |list, of, args|
+    sleep(1)
+    "done."
+  end
+  
+  # returns immediately
+  puts f.inspect            #=> #<QueueToTheFuture::Job:0x7ffa641c ... >
+  
+  # blocks until completed
+  puts f                    #=> done.
+
+== Copyright
+
+Copyright (c) 2010 Devin Christensen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "queue_to_the_future"
+    gem.summary = %Q{Futures for Ruby.}
+    gem.description = %Q{An easy way to create asynchronous execution paths in an unobtrusive way.}
+    gem.email = "devin@threetrieslater.com"
+    gem.homepage = "http://github.com/threetrieslater/queue_to_the_future"
+    gem.authors = ["Devin Christensen"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 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
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

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

data/lib/queue_to_the_future.rb

@@ -0,0 +1,28 @@
+require 'thread'
+
+require 'queue_to_the_future/coordinator'
+require 'queue_to_the_future/worker'
+require 'queue_to_the_future/job'
+
+module QueueToTheFuture
+  @@maximum_workers = 15
+  
+  def self.maximum_workers
+    @@maximum_workers
+  end
+  
+  def self.maximum_workers=(number)
+    raise StandardError.new("Bad workforce size: #{number}. Must be at least 1.") unless (number = number.to_i) >= 1
+    @@maximum_workers = number
+  end
+  
+  def self.schedule(job)
+    Coordinator.instance.schedule(job)
+  end
+end
+
+module Kernel
+  def Future(*args, &block)
+    QueueToTheFuture.schedule(QueueToTheFuture::Job.new(*args, &block))
+  end
+end

data/lib/queue_to_the_future/coordinator.rb

@@ -0,0 +1,46 @@
+require 'singleton'
+
+module QueueToTheFuture  
+  class Coordinator
+    include Singleton
+    
+    def initialize
+      @job_queue  = []
+      @workforce  = []
+      @lock       = Mutex.new
+    end
+    
+    def next_job
+      synchronize { @job_queue.shift }
+    end
+    
+    def job_count
+      synchronize { @job_queue.size }
+    end
+    
+    def workforce_size
+      synchronize { @workforce.size }
+    end
+    
+    def relieve(worker)
+      synchronize { @workforce -= [worker] }
+    end
+    
+    def schedule(job)
+      synchronize do
+        @job_queue.push(job)
+        
+        if @workforce.size < QueueToTheFuture.maximum_workers && @workforce.size < @job_queue.size
+          @workforce.push Worker.new(@workforce.size)
+        end
+      end
+      
+      job
+    end
+    
+    private
+    def synchronize(&block)
+      @lock.synchronize(&block)
+    end
+  end
+end

data/lib/queue_to_the_future/job.rb

@@ -0,0 +1,19 @@
+module QueueToTheFuture
+  class Job
+    (instance_methods - %w[__send__ __id__ object_id inspect]).each { |meth| undef_method(meth) }
+    
+    def initialize(*args, &block)
+      @args   = args
+      @block  = block
+    end
+    
+    def __execute__
+      @result = @block.call(*@args)
+    end
+    
+    def method_missing(*args, &block)
+      Thread.pass while !defined?(@result)
+      @result.send(*args, &block)
+    end
+  end
+end

data/lib/queue_to_the_future/worker.rb

@@ -0,0 +1,20 @@
+module QueueToTheFuture
+  class Worker
+    def initialize(index)
+      @index        = index
+      @coordinator  = Coordinator.instance
+      dispatch
+    end
+    
+    def dispatch
+      Thread.new(@index) do |index|
+        while index < QueueToTheFuture.maximum_workers && (work = @coordinator.next_job)
+          work.__execute__
+          Thread.pass()
+        end
+        
+        @coordinator.relieve(self)
+      end
+    end
+  end
+end

data/spec/queue_to_the_future_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "QueueToTheFuture" do
+  it "should work" do
+    start = Time.now.to_f
+    
+    f = Future(1, 2, 3) do |*args|
+      sleep(0.1); args
+    end
+    
+    QueueToTheFuture::Coordinator.instance.workforce_size.should be(1)
+    f.inspect.should match(/^#<QueueToTheFuture::Job/)
+    f.should eql([1,2,3])
+    (Time.now.to_f - start).should be_close(0.1, 0.001)
+    Thread.pass
+    QueueToTheFuture::Coordinator.instance.workforce_size.should be(0)
+  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 'queue_to_the_future'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: queue_to_the_future
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Devin Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An easy way to create asynchronous execution paths in an unobtrusive way.
+email: devin@threetrieslater.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/queue_to_the_future.rb
+- lib/queue_to_the_future/coordinator.rb
+- lib/queue_to_the_future/job.rb
+- lib/queue_to_the_future/worker.rb
+- spec/queue_to_the_future_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/threetrieslater/queue_to_the_future
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Futures for Ruby.
+test_files: 
+- spec/queue_to_the_future_spec.rb
+- spec/spec_helper.rb