fiberpool 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.rvmrc
+.rspec
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/fiberpool.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fiberpool/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fiberpool"
+  s.version     = FiberPool::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jon Rowe"]
+  s.email       = ["hello@jonrowe.co.uk"]
+  s.homepage    = "http://github.com/jonrowe/fiberpool"
+  s.summary     = %q{A Fiberpool implementation for running tasks cooperatively}
+  s.description = %q{A Fiberpool implementation for running tasks cooperatively, allows throttling to max concurrency, best used with event machine and non blocking operations.}
+
+  s.rubyforge_project = "fiberpool"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'autotest-standalone'
+end

data/lib/fiberpool.rb

@@ -0,0 +1 @@
+require 'fiberpool/fiberpool'

data/lib/fiberpool/fiberpool.rb

@@ -0,0 +1,64 @@
+require 'fiber'
+class FiberPool
+  attr_accessor :fibers, :pool_size, :pool_fiber
+
+  def initialize(pool_size=10)
+    self.pool_size    = pool_size
+    self.fibers       = []
+    self.pool_fiber  = Fiber.current
+  end
+
+  def self.start(pool_size=10, finished_callback=nil, &block)
+    Fiber.new do
+      pool = FiberPool.new(pool_size)
+      yield pool
+      pool.drain
+      finished_callback.call() if finished_callback
+    end.resume
+  end
+
+  def add(&block)
+    fiber = Fiber.new do
+      f = Fiber.current
+      completion_callback = proc do
+        pool_fiber.transfer(f)
+      end
+      yield completion_callback
+    end
+    add_to_pool(fiber)
+  end
+
+  def add_to_pool(fiber)
+    wait_for_free_pool_space if over_capacity?
+    fibers << fiber
+    remove_fiber_from_pool fiber.resume
+  end
+
+  def wait_for_free_pool_space
+    remove_fiber_from_pool(wait_for_next_complete_fiber)
+  end
+
+  def wait_for_next_complete_fiber
+    Fiber.yield
+  end
+
+  def over_capacity?
+    fibers_in_use >= pool_size
+  end
+
+  def fibers_in_use
+    fibers.size
+  end
+
+  def fibers_left_to_process?
+    fibers_in_use > 0
+  end
+
+  def remove_fiber_from_pool(fiber)
+    fibers.delete(fiber)
+  end
+
+  def drain
+    wait_for_free_pool_space while fibers_left_to_process?
+  end
+end

data/lib/fiberpool/version.rb

@@ -0,0 +1,3 @@
+module FiberPool
+  VERSION = "0.0.1"
+end

data/spec/fiberpool_spec.rb

@@ -0,0 +1,227 @@
+require 'spec_helper'
+
+describe FiberPool do
+  let(:pool) { FiberPool.new }
+
+  describe ".start" do
+    let(:fiber) { mock "fiber", resume: nil }
+
+    before do
+      Fiber.stub(:new).and_return(fiber)
+    end
+
+    subject { FiberPool.start { |*args| @args = *args } }
+
+    it "should create a new fiber, which will become the pool fiber" do
+      Fiber.should_receive(:new).and_yield.and_return(fiber)
+      subject
+    end
+    it "should kick off the fiber" do
+      fiber.should_receive(:resume)
+      subject
+    end
+
+    context "within that fiber" do
+      let(:fake_pool) { mock "fake_pool", drain: nil }
+
+      before do
+        Fiber.stub(:new).and_yield.and_return(fiber)
+        FiberPool.stub(:new).and_return(fake_pool)
+      end
+
+      it "should create a new fiberpool" do
+        FiberPool.should_receive(:new).and_return(fake_pool)
+        subject
+      end
+      it "should yield the pool" do
+        subject
+        @args.should eq [fake_pool]
+      end
+      it "should drain the pool when done" do
+        fake_pool.should_receive(:drain)
+        subject
+      end
+
+      context "where pool size is specified" do
+        subject { FiberPool.start(20) { |args| 'lal block' } }
+
+        it "should create a new fiberpool of the correct size" do
+          FiberPool.should_receive(:new).with(20).and_return(fake_pool)
+          subject
+        end
+      end
+      context "were a callback is specified" do
+        let(:callback) { mock "callback" }
+
+        subject { FiberPool.start(10, callback) { |args| 'lal block' } }
+
+        it "should call the callback" do
+          callback.should_receive(:call)
+          subject
+        end
+      end
+    end
+  end
+
+  describe "#initialize" do
+    context "defaults" do
+      subject { pool }
+
+      its(:pool_size) { should eq 10 }
+      its(:fibers) { should eq [] }
+      its(:pool_fiber) { should = Fiber.current }
+    end
+    context "pool size specified" do
+      let(:pool_size) { mock "pool_size" }
+
+      subject { FiberPool.new pool_size }
+      its(:pool_size) { should eq pool_size }
+    end
+  end
+
+  describe "#add" do
+    let(:fiber) { mock "fiber" }
+    let(:completion_callback) { @callback }
+
+    before do
+      Fiber.stub(:new).and_yield.and_return(fiber)
+      pool.stub(:add_to_pool)
+    end
+
+    subject { pool.add { |callback| @callback = callback } }
+
+    it "should create a fiber" do
+      Fiber.should_receive(:new).and_yield.and_return(fiber)
+      subject
+    end
+    it "should yield a completion callback" do
+      subject
+      completion_callback.should be_a Proc
+    end
+    specify "the compleition callback should transfer the fiber back to the pool" do
+      Fiber.stub(:current).and_return(fiber)
+      subject
+      pool.pool_fiber.should_receive(:transfer).with(fiber)
+      completion_callback.call
+    end
+    it "should add the fiber to the pool" do
+      pool.should_receive(:add_to_pool).with(fiber)
+      subject
+    end
+  end
+
+  describe "#add_to_pool" do
+    let(:completed_fiber) { mock "completed_fiber" }
+    let(:fiber) { mock "fiber", resume: completed_fiber }
+
+    subject { pool.add_to_pool fiber }
+
+    context "where the pool is over capacity" do
+      before { pool.stub(:over_capacity?).and_return(true) }
+      it "should wait for free pool space" do
+        pool.should_receive(:wait_for_free_pool_space)
+        subject
+      end
+    end
+    it "should store the paused fiber in the pool" do
+      subject
+      pool.fibers.should == [fiber]
+      #note, normally the fiber would be removed at the end of the method
+      #but mocks are allowing this to be inspected
+    end
+    it "should kick off the fiber" do
+      fiber.should_receive(:resume).and_return(completed_fiber)
+      subject
+    end
+    it "should remove the fiber when finished" do
+      pool.should_receive(:remove_fiber_from_pool).with(completed_fiber)
+      subject
+    end
+  end
+
+  describe "#wait_for_free_pool_space" do
+    let(:completed_fiber) { mock "completed_fiber" }
+
+    before { pool.stub(:wait_for_next_complete_fiber).and_return(completed_fiber) }
+
+    subject { pool.wait_for_free_pool_space }
+
+    it "should wait for the next complete fiber" do
+      pool.should_receive(:wait_for_next_complete_fiber).and_return(completed_fiber)
+      subject
+    end
+    it "should remove that fiber from the pool" do
+      pool.should_receive(:remove_fiber_from_pool).with(completed_fiber)
+      subject
+    end
+  end
+
+  describe "#wait_for_next_complete_fiber" do
+    it "should yield back to the original calling context" do
+      Fiber.should_receive(:yield)
+      pool.wait_for_next_complete_fiber
+    end
+  end
+
+  describe "#over_capacity?" do
+    before { pool.fibers = [mock,mock,mock] }
+    subject { pool.over_capacity? }
+
+    context "where pool size equals fibers in use" do
+      before { pool.pool_size = pool.fibers.size }
+      it { should be_true }
+    end
+    context "where pool size is greater than fibers in use" do
+      before { pool.pool_size = pool.fibers.size + 1 }
+      it { should be_false }
+    end
+    context "where pool size is less than fibers in use" do
+      before { pool.pool_size = pool.fibers.size - 1 }
+      it { should be_true }
+    end
+  end
+
+  describe "#fibers_in_use" do
+    it "should return the size of the fibers array" do
+      pool.fibers = [mock,mock,mock]
+      pool.fibers_in_use.should eq 3
+    end
+  end
+
+  describe "#fibers_left_to_process" do
+    subject { pool.fibers_left_to_process? }
+
+    context "where there are fibers in use" do
+      before { pool.stub(:fibers_in_use).and_return(3) }
+      it { should be_true }
+    end
+    context "where there are no fibers left to process" do
+      before { pool.stub(:fibers_in_use).and_return(0) }
+      it { should be_false }
+    end
+  end
+
+  describe "#remove_fiber_from_pool" do
+    let(:fiber) { mock "fiber" }
+
+    before { pool.fibers = [fiber] }
+
+    it "should remove the fiber from the pool" do
+      pool.remove_fiber_from_pool fiber 
+      pool.fibers.should == []
+    end
+    it "should do nothing if it isnt in the pool" do
+      pool.remove_fiber_from_pool mock("not in the pool")
+      pool.fibers.should == [fiber]
+    end
+  end
+
+  describe "#drain" do
+    before { pool.stub(:fibers_left_to_process?).and_return(true,true,false) }
+
+    it "should wait for free pool space while there are fibers left to process" do
+      pool.should_receive(:wait_for_free_pool_space).exactly(:twice)
+      pool.drain
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'fiberpool'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: fiberpool
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jon Rowe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: autotest-standalone
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A Fiberpool implementation for running tasks cooperatively, allows throttling to max concurrency, best used with event machine and non blocking operations.
+email: 
+- hello@jonrowe.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- features/support/env.rb
+- fiberpool.gemspec
+- lib/fiberpool.rb
+- lib/fiberpool/fiberpool.rb
+- lib/fiberpool/version.rb
+- spec/fiberpool_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jonrowe/fiberpool
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: fiberpool
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: A Fiberpool implementation for running tasks cooperatively
+test_files: 
+- features/support/env.rb
+- spec/fiberpool_spec.rb
+- spec/spec_helper.rb