Improved specs and docs for ImmediateExecutor and PerThreadExecutor.

Author: jdantonio

lib/concurrent/executor/immediate_executor.rb

@@ -2,9 +2,14 @@
 require 'concurrent/executor/executor'
 
 module Concurrent
+
+  # An executor service which runs all operations on the current thread,
+  # blocking as necessary. Operations are performed in the order they are
+  # received and no two operations can be performed simultaneously.
   class ImmediateExecutor
     include SerialExecutor
 
+    # Creates a new executor
     def initialize
       @stopped = Concurrent::Event.new
     end

lib/concurrent/executor/per_thread_executor.rb

@@ -1,17 +1,21 @@
-require 'concurrent/atomic/event'
+require 'concurrent/atomics'
 require 'concurrent/executor/executor'
 
 module Concurrent
 
+  # An executor service in which every operation spawns a new,
+  # independently operating thread.
   class PerThreadExecutor
     include SerialExecutor
 
+    # Creates a new executor
     def initialize
       @running = Concurrent::AtomicBoolean.new(true)
       @stopped = Concurrent::Event.new
       @count = Concurrent::AtomicFixnum.new(0)
     end
 
+    # @!macro executor_method_post
     def self.post(*args)
       raise ArgumentError.new('no block given') unless block_given?
       Thread.new(*args) do
@@ -21,6 +25,13 @@ def self.post(*args)
       true
     end
 
+    # @!macro executor_method_left_shift
+    def self.<<(task)
+      post(&task)
+      self
+    end
+
+    # @!macro executor_method_post
     def post(*args, &task)
       raise ArgumentError.new('no block given') unless block_given?
       return false unless running?
@@ -36,6 +47,7 @@ def post(*args, &task)
       end
     end
 
+    # @!macro executor_method_left_shift
     def <<(task)
       post(&task)
       self

spec/concurrent/executor/per_thread_executor_spec.rb

@@ -11,6 +11,52 @@ module Concurrent
 
     context '#post' do
 
+      subject { PerThreadExecutor.new }
+
+      it 'creates a new thread for a call without arguments' do
+        thread = Thread.new{ nil }
+        Thread.should_receive(:new).with(no_args()).and_return(thread)
+        Concurrent.configuration.global_task_pool.should_not_receive(:post).with(any_args())
+        subject.post{ nil }
+      end
+
+      it 'executes a call without arguments' do
+        latch = CountDownLatch.new(1)
+        subject.post{ latch.count_down }
+        latch.wait(1).should be_true
+      end
+
+      it 'creates a new thread for a call with arguments' do
+        thread = Thread.new{ nil }
+        Thread.should_receive(:new).with(1,2,3).and_return(thread)
+        Concurrent.configuration.global_task_pool.should_not_receive(:post).with(any_args())
+        subject.post(1,2,3){ nil }
+      end
+
+      it 'executes a call with one argument' do
+        latch = CountDownLatch.new(3)
+        subject.post(3){|count| count.times{ latch.count_down } }
+        latch.wait(1).should be_true
+      end
+
+      it 'executes a call with multiple arguments' do
+        latch = CountDownLatch.new(10)
+        subject.post(1,2,3,4){|*count| count.reduce(:+).times{ latch.count_down } }
+        latch.wait(1).should be_true
+      end
+
+      it 'aliases #<<' do
+        thread = Thread.new{ nil }
+        Thread.should_receive(:new).with(no_args()).and_return(thread)
+        Concurrent.configuration.global_task_pool.should_not_receive(:post).with(any_args())
+        subject << proc{ nil }
+      end
+    end
+
+    context 'PerThreadExecutor.post' do
+
+      subject { PerThreadExecutor }
+
       it 'creates a new thread for a call without arguments' do
         thread = Thread.new{ nil }
         Thread.should_receive(:new).with(no_args()).and_return(thread)