workers 0.2.1 → 0.2.2

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 ## Parallel Map
 
 Parallel map is the simplest way to get started with the Workers gem.
-It is similar to Ruby's built in Array#map method except each element is mapped in parallel.
+It is similar to Ruby's built-in Array#map method except each element is mapped in parallel.
 
     Workers.map([1, 2, 3, 4, 5]) { |i| i * i }
 
@@ -73,7 +73,7 @@ The main benefit is that you get to decide how you want to handle exceptions.
     group.tasks.each do |t|
       t.succeeded? # True or false (false if an exception occurred).
       t.failed?    # True or false (true if an exception occurred).
-      t.args       # Input arguments (the value of i in this example).
+      t.input      # Input value.
       t.result     # Output value (the result of i * i in this example).
       t.exception  # The exception if one exists.
       t.max_tries  # Maximum number of attempts.
@@ -168,8 +168,9 @@ This effectively gives you direct access to a single event-driven thread.
 
 ## Pools
 
-As shown above, pools effectively allow a group of workers to share a work queue.
-They have a few additional methods described below:
+Pools allow a group of workers to share a work queue.
+The Workers gem has a default pool (Workers.pool) with 20 workers so in most cases you won't need to create your own.
+Pools can be adjusted using the below methods:
 
     # Create a pool.
     pool = Workers::Pool.new
@@ -232,8 +233,9 @@ Timers provide a way to execute code in the future:
 ## Schedulers
 
 Schedulers are what trigger Timers to fire.
-The system has a global default scheduler which should meet most needs (Workers.scheduler).
-You can create additional or custom ones as necessary:
+The Workers gem has a default scheduler (Workers.scheduler) so in most cases you won't need to create your own.
+Schedulers execute timers using a pool of workers so make sure your timer block is thread safe.
+You can create additional schedulers as necessary:
 
     # Create a workers pool with a larger than default thread count (optional).
     pool = Workers::Pool.new(:size => 100)

data/lib/workers/task.rb

@@ -2,7 +2,7 @@ module Workers
   class Task
     include Workers::Helpers
 
-    attr_reader :args
+    attr_reader :input
     attr_reader :result
     attr_reader :exception
     attr_reader :state
@@ -11,7 +11,7 @@ module Workers
 
     def initialize(options = {})
       @logger = Workers::LogProxy.new(options[:logger])
-      @args = options[:args] || []
+      @input = options[:input] || []
       @perform = options[:perform] || raise('Perform callback is required.')
       @finished = options[:finished]
       @max_tries = options[:max_tries] || 1
@@ -32,7 +32,7 @@ module Workers
         @tries += 1
 
         begin
-          @result = @perform.call(*@args)
+          @result = @perform.call(@input)
           @state = :succeeded
           @exception = nil
         rescue Exception => e

data/lib/workers/task_group.rb

@@ -58,7 +58,7 @@ module Workers
 
     def map(inputs, options = {}, &block)
       inputs.each do |input|
-        add(:args => input, :max_tries => options[:max_tries]) do |i|
+        add(:input => input, :max_tries => options[:max_tries]) do |i|
           block.call(i)
         end
       end
@@ -66,7 +66,7 @@ module Workers
       run
 
       if (failure = failures[0])
-        a = failure.args.inspect
+        a = failure.input.inspect
         m = failure.exception.message
         b = failure.exception.backtrace.join("\n")
 

data/lib/workers/version.rb

@@ -1,3 +1,3 @@
 module Workers
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workers
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-02 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies: []
 description: Workers is a Ruby gem for performing work in background threads.
 email:
@@ -56,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Workers is a Ruby gem for performing work in background threads. Design goals