breeder 0.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.0.1 / 2011-10-19
+
+* Initial Release

data/LICENSE.txt

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

@@ -0,0 +1,3 @@
+h1. Breeder
+
+Currently does not spawn or reap.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:rspec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :rspec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/breeder/core.rb

@@ -0,0 +1,83 @@
+module Breeder
+  class Core
+    # the poll interval in seconds
+    attr_accessor :interval
+
+    # an instance with spawn? and reap? methods to determine when to spawn and reap
+    attr_reader :watcher
+
+    # number of workers to start with
+    attr_accessor :initial_workers
+    
+    def initialize
+      @workers = []
+      @threads = []
+      self.interval = 5
+      self.initial_workers = 4
+    end
+
+    def watcher=(watcher)
+      unless watcher.respond_to?(:spawn?) && watcher.respond_to?(:reap?)
+        raise "Watcher must implement spawn? and reap?"
+      end
+      
+      @watcher = watcher
+    end
+
+    def worker_factory(&block)
+      raise "No block supplied to worker_factory" unless !!block
+      @worker_factory = block
+    end
+
+    def task(&block)
+      raise ArgumentError("No block supplied") if block.nil?
+      worker = Breeder::Worker.new
+      worker.__metaclass__.class_eval do
+        define_method(:do_work, block)
+      end
+      worker_factory { worker }
+    end
+
+    def run
+      # start the workers
+      self.initial_workers.times { spawn! }
+
+      # catch Ctrl+C and cleanup
+      trap('INT') do
+        puts 'INTERRUPT caught, killing threads and exiting...'
+        @threads.each { |thread| thread.kill }
+      end
+
+      # wait for the workers to finish
+      @threads.each { |thread| thread.join }
+    end
+
+    def create_worker
+      raise "No worker factory specified" unless !!@worker_factory
+      worker = @worker_factory.call
+      unless [:run, :stop!, :stop?].all? { |method| worker.respond_to?(method) }
+        raise "object from worker factory doesn't quack like a worker"
+      end
+      worker
+    end
+
+    private
+
+    def spawn!
+      worker = create_worker
+      @workers << worker
+      @threads << Thread.new { worker.run }
+    end
+
+    def reap!
+      if @threads.size >= 1
+        thread = @threads.pop
+        worker = @workers.pop
+        worker.stop!
+        sleep 1
+        thread.kill
+      end
+    end
+
+  end
+end

data/lib/breeder/watcher.rb

@@ -0,0 +1,16 @@
+module Breeder
+
+  # A watcher has a spawn? and reap? method that indicate when to 
+  # spawn and reap more threads
+  class Watcher
+
+    def spawn?(num_workers)
+      raise NotImplementedError
+    end
+
+    def reap?(num_workers)
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/breeder/worker.rb

@@ -0,0 +1,25 @@
+module Breeder
+  class Worker
+    attr_accessor :should_stop
+
+    def stop?
+      @should_stop
+    end
+
+    def stop!
+      @should_stop = true
+    end
+
+    def run
+      until stop?
+        do_work
+      end
+    end
+
+    # User-defined worker should override this
+    def do_work
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/breeder.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'metaclass'
+require 'breeder/core'
+require 'breeder/watcher'
+require 'breeder/worker'
+
+module Breeder 
+  # Create a Breeder::Core and take a block to configure it
+  def self.create
+    core = Breeder::Core.new
+    yield core if block_given?
+    core
+  end
+
+  # Configure and run a Breeder::Core
+  def self.breed(&block)
+    core = Breeder::Core.new
+    yield core
+    core.run
+  end
+end

data/spec/breeder_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Breeder do
+  describe '.create' do
+    it 'returns a Breeder::Core' do
+      Breeder.create.should be_a(Breeder::Core)
+    end
+
+    it 'takes a block to configure the Core' do
+      @mock_core = mock('core')
+      Breeder::Core.stub!(:new).and_return(@mock_core)
+      @mock_core.should_receive(:interval=).with(5)
+      breeder = Breeder.create do |core|
+        core.interval = 5 
+      end
+      breeder.should == @mock_core
+    end
+  end
+
+  describe '.breed' do
+    before(:each) do
+      @mock_core = mock('core')
+      Breeder::Core.stub!(:new).and_return(@mock_core)
+    end
+
+    it 'runs the Core after configuration' do
+      @mock_core.should_receive(:interval=).with(5).ordered
+      @mock_core.should_receive(:run).ordered
+      Breeder.breed do |core|
+        core.interval = 5
+      end
+    end
+  end
+end

data/spec/core_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module Breeder
+  describe Core do
+    before(:each) do
+      @core = Breeder.create
+    end
+
+    describe '#watcher=' do
+      context 'when the argument is not a valid watcher' do
+        it 'raises an exception' do
+          lambda { @core.watcher = 42 }.should raise_error
+        end
+      end
+
+      context 'when the argument is a valid watcher' do
+        it 'sets the watcher' do
+          watcher = Breeder::Watcher.new
+          @core.watcher = watcher
+          @core.watcher.should == watcher
+        end
+      end
+    end
+
+    describe '#worker=' do
+      context 'when the argument is not a valid worker' do
+        it 'raises an error' do
+          lambda { @core.worker= 42 }.should raise_error
+        end
+      end
+
+      context 'when the argument is a valid worker' do
+        it 'sets the worker' do
+          test_worker = Breeder::Worker.new
+          @core.worker_factory { test_worker }
+          @core.create_worker.should == test_worker
+        end
+      end
+    end
+
+    describe '#task' do
+      context 'when no block is supplied' do
+        it 'raises an error' do
+          lambda { @core.task }.should raise_error
+        end
+      end
+
+      context 'when a block of work is supplied' do
+        it 'creates a worker with the block as its workload' do
+          task_done = false
+          @core.task { task_done = true }
+          @core.create_worker.do_work
+          task_done.should == true
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+require 'breeder'

data/spec/worker_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module Breeder
+  describe Worker do
+
+    let(:worker) { Worker.new }
+
+    describe '#stop?' do
+      context 'if the worker should stop' do
+        it 'returns true' do
+          worker.stop!
+          worker.stop?.should be_true
+        end
+      end
+      context 'if the worker should not stop' do
+        it 'returns false' do
+          worker.stop?.should be_false
+        end
+      end
+    end
+
+    describe '#stop!' do
+      it 'makes #stop? return true' do
+        worker.stop?.should be_false
+        worker.stop!
+        worker.stop?.should be_true
+      end
+    end
+
+    describe '#do_work' do
+      context 'when the user has not overridden it' do
+        it 'raises an error' do
+          expect { worker.do_work }.to raise_error
+        end
+      end
+    end
+
+    describe '#run' do
+
+      class MyWorker < Worker
+        attr_reader :value
+        def initialize
+          @value = 0
+        end
+        def do_work
+          @value += 1
+          stop! if @value >= 3
+        end
+      end
+
+      it 'does work until told to stop' do
+        worker = MyWorker.new
+        worker.run
+        worker.value.should == 3
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: breeder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Kite
+- Scott Reis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-19 00:00:00.000000000Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- VERSION
+- LICENSE.txt
+- CHANGELOG.rdoc
+- README.md
+- Rakefile
+- lib/breeder.rb
+- lib/breeder/worker.rb
+- lib/breeder/core.rb
+- lib/breeder/watcher.rb
+- spec/worker_spec.rb
+- spec/core_spec.rb
+- spec/breeder_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/chriskite/breeder
+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: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Process spawning and reaping
+test_files:
+- spec/worker_spec.rb
+- spec/core_spec.rb
+- spec/breeder_spec.rb
+- spec/spec_helper.rb