workers 0.0.1 → 0.0.2

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .rvmrc
+*.swp

data/README.md

@@ -1,6 +1,7 @@
 # Workers
 
-TODO: Write a gem description
+Workers is a Ruby gem for performing work in background threads.
+Design goals include high performance, low latency, simple API, and customizability.
 
 ## Installation
 
@@ -16,10 +17,68 @@ Or install it yourself as:
 
     $ gem install workers
 
-## Usage
+## Basic Usage
 
-TODO: Write usage instructions here
+    # Initialize a worker pool.
+    pool = Workers::Pool.new
+    
+    # Perform some work in the background.
+    100.times do
+      pool.perform do
+        sleep(rand(3))
+        puts "Hello world from thread #{Thread.current.object_id}"
+      end
+    end
+    
+    # Tell the workers to shutdown.
+    pool.shutdown do
+      puts "Worker thread #{Thread.current.object_id} is shutting down."
+    end
+    
+    # Wait for the workers to finish.
+    pool.join
 
+## Advanced Usage
+
+The Worker class is designed to be customized.
+
+    # Create a custom worker class that handles custom commands.
+    class CustomWorker < Workers::Worker
+      private
+      def process_event(event)
+        case event.command
+        when :my_custom
+          puts "Worker received custom event: #{event.data}"
+          sleep(1)
+        end
+      end
+    end
+    
+    # Create a pool that uses your custom worker class.
+    pool = Workers::Pool.new(:worker_class => CustomWorker)
+    
+    # Tell the workers to do some work using custom events.
+    100.times do |i|
+      pool.enqueue(:my_custom, i)
+    end
+    
+    # Tell the workers to shutdown.
+    pool.shutdown do
+      puts "Worker thread #{Thread.current.object_id} is shutting down."
+    end
+    
+    # Wait for it to finish working and shutdown.
+    pool.join
+    
+## Pool Options
+
+The pool class takes a few options (defaults below):
+
+    pool = Workers::Pool.new(
+      :size => 20,                     # Number of threads to create.
+      :logger => nil                   # Ruby Logger instance.
+      :worker_class => Workers::Worker # Class of worker to use for this pool.
+    
 ## Contributing
 
 1. Fork it

data/lib/workers/pool.rb

@@ -7,9 +7,17 @@ module Workers
     def initialize(options = {})
       @size = options[:size] || Workers::Pool::DEFAULT_POOL_SIZE
       @logger = Workers::LogProxy.new(options[:logger])
+      @worker_class = options[:worker_class] || Workers::Worker
+
       @input_queue = Queue.new
       @workers = []
-      @size.times { @workers << Workers::Worker.new(:input_queue => @input_queue) }
+      @size.times { @workers << @worker_class.new(:input_queue => @input_queue) }
+    end
+
+    def enqueue(command, data)
+      @input_queue.push(Event.new(command, data))
+
+      return nil
     end
 
     def perform(options = {}, &block)
@@ -27,11 +35,5 @@ module Workers
     def join(max_wait = nil)
       return @workers.map { |w| w.join(max_wait) }
     end
-
-    private
-
-    def enqueue(command, data)
-      @input_queue.push(Event.new(command, data))
-    end
   end
 end

data/lib/workers/version.rb

@@ -1,3 +1,3 @@
 module Workers
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/workers/worker.rb

@@ -5,9 +5,16 @@ module Workers
     def initialize(options = {})
       @logger = Workers::LogProxy.new(options[:logger])
       @input_queue = options[:input_queue] || Queue.new
+
       @thread = Thread.new { start_event_loop }
     end
 
+    def enqueue(command, data)
+      @input_queue.push(Event.new(command, data))
+
+      return nil
+    end
+
     def perform(options = {}, &block)
       enqueue(:perform, block)
 
@@ -30,10 +37,6 @@ module Workers
 
     private
 
-    def enqueue(command, data)
-      @input_queue.push(Event.new(command, data))
-    end
-
     def start_event_loop
       while true
         event = @input_queue.pop # Blocking.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -24,8 +24,6 @@ files:
 - README.md
 - Rakefile
 - lib/workers.rb
-- lib/workers/.pool.rb.swp
-- lib/workers/.worker.rb.swp
 - lib/workers/event.rb
 - lib/workers/helpers.rb
 - lib/workers/log_proxy.rb