thread 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b410457cd8caaa3227527d9365650d3a02f8203
-  data.tar.gz: 0430247c137897d69e59a88a6f57943cd58f46d5
+  metadata.gz: 6f1ac6a92f77e49dec38a35d8f17c607568f2702
+  data.tar.gz: 794e057cc2b9ea319f1051e13d7d69f7f61a92dd
 SHA512:
-  metadata.gz: c55851e31ce9cc4897006df956bb3e5cff13418e9a294f0168cfdcf36e1deb4ccdf51b3559c53a513ad8d63d6836c23374c46db4ae26e3f061a1089db55a1754
-  data.tar.gz: e91d1f1c0e483f2ed59bbe6966a1fd3604d2b8c082d6356e461d46233094c8d5c1415cf40b506ec22fd08027226af374d11a49621ebe0c74339021a5d7b857cc
+  metadata.gz: a8be737ccd11509f373d5a7c3d78a2e29fc1a0d6d414cac1a357ed4ee0472fa53f753de7f1cc4015cf453db34ddf42441f700c136566c8d17f65ce78a19ec810
+  data.tar.gz: 30461440ad2c050a41688c12e90bb7ce16df3bd706edb9f51d4bee4dd63dfa906f3e301da044f14be826f28a5ef740f9a2172495a17d6ab2122fb609d31fe2c5

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.1
   - ruby-head
   - jruby
-  - rbx
+  - rbx

data/README.md

@@ -174,7 +174,7 @@ require 'thread/pool'
 require 'thread/future'
 
 pool = Thread.pool 4
-f    = pool {
+f    = pool.future {
   sleep 5
   42
 }
@@ -226,4 +226,4 @@ end
 3. Verify new and old specs are green (`rake`)
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
-6. Create a new Pull Request
+6. Create a new Pull Request

data/lib/thread/channel.rb

@@ -16,7 +16,7 @@ require 'thread'
 # messages are safe to be consumed.
 class Thread::Channel
 	# Create a channel with optional initial messages and optional channel guard.
-	def initialize (messages = [], &block)
+	def initialize(messages = [], &block)
 		@messages = []
 		@mutex    = Mutex.new
 		@check    = block
@@ -30,7 +30,7 @@ class Thread::Channel
 	#
 	# If there's a guard, the value is passed to it, if the guard returns a falsy value
 	# an ArgumentError exception is raised and the message is not sent.
-	def send (what)
+	def send(what)
 		if @check && !@check.call(what)
 			raise ArgumentError, 'guard mismatch'
 		end
@@ -47,7 +47,7 @@ class Thread::Channel
 	# Receive a message, if there are none the call blocks until there's one.
 	#
 	# If a block is passed, it's used as guard to match to a message.
-	def receive (&block)
+	def receive(&block)
 		message = nil
 		found   = false
 
@@ -83,7 +83,7 @@ class Thread::Channel
 	# Receive a message, if there are none the call returns nil.
 	#
 	# If a block is passed, it's used as guard to match to a message.
-	def receive! (&block)
+	def receive!(&block)
 		if block
 			@messages.delete_at(@messages.find_index(&block))
 		else
@@ -91,7 +91,7 @@ class Thread::Channel
 		end
 	end
 
-	private
+private
 	def cond?
 		instance_variable_defined? :@cond
 	end
@@ -103,7 +103,7 @@ end
 
 class Thread
 	# Helper to create a channel.
-	def self.channel (*args, &block)
+	def self.channel(*args, &block)
 		Thread::Channel.new(*args, &block)
 	end
 end

data/lib/thread/every.rb

@@ -18,7 +18,7 @@ class Thread::Every
 	Restart = Class.new(Exception)
 
 	# Create an every with the given seconds and block.
-	def initialize (every, &block)
+	def initialize(every, &block)
 		raise ArgumentError, 'no block given' unless block
 
 		@every  = every
@@ -67,14 +67,14 @@ class Thread::Every
 	end
 
 	# @private
-	def self.finalizer (thread)
+	def self.finalizer(thread)
 		proc {
 			thread.raise Cancel.new
 		}
 	end
 
 	# Change the number of seconds between each call.
-	def every (seconds)
+	def every(seconds)
 		@every = seconds
 
 		restart
@@ -144,7 +144,7 @@ class Thread::Every
 	end
 
 	# Gets the current every value.
-	def value (timeout = nil)
+	def value(timeout = nil)
 		@mutex.synchronize {
 			if @old
 				cond.wait(@mutex, *timeout)
@@ -172,7 +172,7 @@ class Thread::Every
 		}
 	end
 
-	private
+private
 	def cond?
 		instance_variable_defined? :@cond
 	end
@@ -184,14 +184,14 @@ end
 
 class Thread
 	# Helper to create an every
-	def self.every (every, &block)
+	def self.every(every, &block)
 		Thread::Every.new(every, &block)
 	end
 end
 
 module Kernel
 	# Helper to create an every
-	def every (every, &block)
+	def every(every, &block)
 		Thread::Every.new(every, &block)
 	end
 end

data/lib/thread/future.rb

@@ -17,7 +17,7 @@ class Thread::Future
 	Cancel = Class.new(Exception)
 
 	# Create a future with the passed block and optionally using the passed pool.
-	def initialize (pool = nil, &block)
+	def initialize(pool = nil, &block)
 		raise ArgumentError, 'no block given' unless block
 
 		@mutex = Mutex.new
@@ -38,7 +38,7 @@ class Thread::Future
 	end
 
 	# @private
-	def self.finalizer (thread)
+	def self.finalizer(thread)
 		proc {
 			thread.raise Cancel.new
 		}
@@ -92,7 +92,7 @@ class Thread::Future
 	#
 	# An optional timeout can be passed which will return nil if nothing has been
 	# delivered.
-	def value (timeout = nil)
+	def value(timeout = nil)
 		raise @exception if exception?
 
 		return @value if delivered?
@@ -111,7 +111,7 @@ class Thread::Future
 	alias ~ value
 
 	# Do the same as {#value}, but return nil in case of exception.
-	def value! (timeout = nil)
+	def value!(timeout = nil)
 		begin
 			value(timeout)
 		rescue Exception
@@ -121,7 +121,7 @@ class Thread::Future
 
 	alias ! value!
 
-	private
+private
 	def cond?
 		instance_variable_defined? :@cond
 	end
@@ -145,20 +145,20 @@ end
 
 class Thread
 	# Helper to create a future
-	def self.future (pool = nil, &block)
+	def self.future(pool = nil, &block)
 		Thread::Future.new(pool, &block)
 	end
 end
 
 module Kernel
 	# Helper to create a future.
-	def future (pool = nil, &block)
+	def future(pool = nil, &block)
 		Thread::Future.new(pool, &block)
 	end
 end
 
 class Thread::Pool
-	def future (&block)
+	def future(&block)
 		Thread.future self, &block
 	end
 end

data/lib/thread/pipe.rb

@@ -20,7 +20,7 @@ class Thread::Pipe
 
 		# Create a Task which will call the passed function and get input
 		# from the optional parameter and put output in the optional parameter.
-		def initialize (func, input = Queue.new, output = Queue.new)
+		def initialize(func, input = Queue.new, output = Queue.new)
 			@input    = input
 			@output   = output
 			@handling = false
@@ -54,7 +54,7 @@ class Thread::Pipe
 	# output queue.
 	#
 	# The objects must respond to #enq and #deq, and block on #deq.
-	def initialize (input = Queue.new, output = Queue.new)
+	def initialize(input = Queue.new, output = Queue.new)
 		@tasks = []
 
 		@input  = input
@@ -64,7 +64,7 @@ class Thread::Pipe
 	end
 
 	# @private
-	def self.finalizer (tasks)
+	def self.finalizer(tasks)
 		proc {
 			tasks.each(&:kill)
 		}
@@ -72,7 +72,7 @@ class Thread::Pipe
 
 	# Add a task to the pipe, it must respond to #call and #arity,
 	# and #arity must return 1.
-	def | (func)
+	def |(func)
 		if func.arity != 1
 			raise ArgumentError, 'wrong arity'
 		end
@@ -91,7 +91,7 @@ class Thread::Pipe
 	end
 
 	# Insert data in the pipe.
-	def enq (data)
+	def enq(data)
 		return if @tasks.empty?
 
 		@input.enq data
@@ -103,7 +103,7 @@ class Thread::Pipe
 	alias <<   enq
 
 	# Get an element from the output queue.
-	def deq (non_block = false)
+	def deq(non_block = false)
 		@output.deq(non_block)
 	end
 
@@ -113,7 +113,7 @@ end
 
 class Thread
 	# Helper to create a pipe.
-	def self.| (func)
+	def self.|(func)
 		Pipe.new | func
 	end
 end

data/lib/thread/pool.rb

@@ -22,11 +22,11 @@ class Thread::Pool
 		Timeout = Class.new(Exception)
 		Asked   = Class.new(Exception)
 
-		attr_reader :pool, :timeout, :exception, :thread, :started_at
+		attr_reader :pool, :timeout, :exception, :thread, :started_at, :result
 
 		# Create a task in the given pool which will pass the arguments to the
 		# block.
-		def initialize (pool, *args, &block)
+		def initialize(pool, *args, &block)
 			@pool      = pool
 			@arguments = args
 			@block     = block
@@ -37,23 +37,34 @@ class Thread::Pool
 			@terminated = false
 		end
 
-		def running?;    @running;   end
-		def finished?;   @finished;   end
-		def timeout?;    @timedout;   end
-		def terminated?; @terminated; end
+		def running?
+			@running
+		end
+
+		def finished?
+			@finished
+		end
+
+		def timeout?
+			@timedout
+		end
+
+		def terminated?
+			@terminated
+		end
 
-		# Execute the task in the given thread.
-		def execute (thread)
+		# Execute the task.
+		def execute
 			return if terminated? || running? || finished?
 
-			@thread     = thread
+			@thread     = Thread.current
 			@running    = true
 			@started_at = Time.now
 
 			pool.__send__ :wake_up_timeout
 
 			begin
-				@block.call(*@arguments)
+				@result = @block.call(*@arguments)
 			rescue Exception => reason
 				if reason.is_a? Timeout
 					@timedout = true
@@ -71,12 +82,12 @@ class Thread::Pool
 		end
 
 		# Raise an exception in the thread used by the task.
-		def raise (exception)
+		def raise(exception)
 			@thread.raise(exception)
 		end
 
 		# Terminate the exception with an optionally given exception.
-		def terminate! (exception = Asked)
+		def terminate!(exception = Asked)
 			return if terminated? || finished? || timeout?
 
 			@terminated = true
@@ -92,10 +103,10 @@ class Thread::Pool
 		end
 
 		# Timeout the task after the given time.
-		def timeout_after (time)
+		def timeout_after(time)
 			@timeout = time
 
-			pool.timeout_for self, time
+			pool.__send__ :timeout_for, self, time
 
 			self
 		end
@@ -110,7 +121,7 @@ class Thread::Pool
 	#
 	# A default block can be passed, which will be used to {#process} the passed
 	# data.
-	def initialize (min, max = nil, &block)
+	def initialize(min, max = nil, &block)
 		@min   = min
 		@max   = max || min
 		@block = block
@@ -140,7 +151,9 @@ class Thread::Pool
 	end
 
 	# Check if the pool has been shut down.
-	def shutdown?; !!@shutdown; end
+	def shutdown?
+		!!@shutdown
+	end
 
 	# Check if auto trimming is enabled.
 	def auto_trim?
@@ -151,11 +164,15 @@ class Thread::Pool
 	# is reached.
 	def auto_trim!
 		@auto_trim = true
+
+		self
 	end
 
 	# Disable auto trimming.
 	def no_auto_trim!
 		@auto_trim = false
+
+		self
 	end
 
 	# Check if idle trimming is enabled.
@@ -167,15 +184,19 @@ class Thread::Pool
 	# The minimum number of threads is respeced.
 	def idle_trim!(timeout)
 		@idle_trim = timeout
+
+		self
 	end
 
 	# Turn of idle trimming.
 	def no_idle_trim!
 		@idle_trim = nil
+
+		self
 	end
 
 	# Resize the pool with the passed arguments.
-	def resize (min, max = nil)
+	def resize(min, max = nil)
 		@min = min
 		@max = max || min
 
@@ -200,9 +221,9 @@ class Thread::Pool
 	def wait(what = :idle)
 		case what
 		when :done
-			loop do
+			until done?
 				@done_mutex.synchronize {
-					return self if _done?
+					break if _done?
 
 					@done.wait @done_mutex
 				}
@@ -233,15 +254,7 @@ class Thread::Pool
 	#
 	# If no block is passed the default block will be used if present, an
 	# ArgumentError will be raised otherwise.
-	def process (*args, &block)
-		unless block || @block
-			raise ArgumentError, 'you must pass a block'
-		end
-
-		wait.process!(*args, &block)
-	end
-
-	def process! (*args, &block)
+	def process(*args, &block)
 		unless block || @block
 			raise ArgumentError, 'you must pass a block'
 		end
@@ -263,11 +276,11 @@ class Thread::Pool
 		task
 	end
 
-	alias << process!
+	alias << process
 
 	# Trim the unused threads, if forced threads will be trimmed even if there
 	# are tasks waiting.
-	def trim (force = false)
+	def trim(force = false)
 		@mutex.synchronize {
 			if (force || @waiting > 0) && @spawned - @trim_requests > @min
 				@trim_requests += 1
@@ -302,52 +315,28 @@ class Thread::Pool
 			@cond.broadcast
 		}
 
-		join
-
-		if @timeout
-			@shutdown = :now
-
-			wake_up_timeout
-
-			@timeout.join
-		end
-
-		self
-	end
-
-	# Join on all threads in the pool.
-	def join
 		until @workers.empty?
 			if worker = @workers.first
 				worker.join
 			end
 		end
 
-		self
-	end
-
-	# Define a timeout for a task.
-	def timeout_for (task, timeout)
-		unless @timeout
-			spawn_timeout_thread
-		end
-
-		@mutex.synchronize {
-			@timeouts[task] = timeout
+		if @timeout
+			@shutdown = :now
 
 			wake_up_timeout
-		}
+
+			@timeout.join
+		end
 	end
 
 	# Shutdown the pool after a given amount of time.
-	def shutdown_after (timeout)
+	def shutdown_after(timeout)
 		Thread.new {
 			sleep timeout
 
 			shutdown
 		}
-
-		self
 	end
 
 	class << self
@@ -358,6 +347,18 @@ class Thread::Pool
 	end
 
 private
+	def timeout_for(task, timeout)
+		unless @timeout
+			spawn_timeout_thread
+		end
+
+		@mutex.synchronize {
+			@timeouts[task] = timeout
+
+			wake_up_timeout
+		}
+	end
+
 	def wake_up_timeout
 		if defined? @pipes
 			@pipes.last.write_nonblock 'x' rescue nil
@@ -401,7 +402,7 @@ private
 					@todo.shift
 				} or break
 
-				task.execute(thread)
+				task.execute
 
 				break if @shutdown == :now
 
@@ -471,7 +472,7 @@ end
 
 class Thread
 	# Helper to create a pool.
-	def self.pool (*args, &block)
+	def self.pool(*args, &block)
 		Thread::Pool.new(*args, &block)
 	end
 end

data/lib/thread/process.rb

@@ -17,20 +17,20 @@ class Thread::Process
 		@@processes ||= {}
 	end
 
-	def self.register (name, process)
+	def self.register(name, process)
 		all[name] = process
 	end
 
-	def self.unregister (name)
+	def self.unregister(name)
 		all.delete(name)
 	end
 
-	def self.[] (name)
+	def self.[](name)
 		all[name]
 	end
 
 	# Create a new process executing the block.
-	def initialize (&block)
+	def initialize(&block)
 		@channel = Thread::Channel.new
 
 		Thread.new {
@@ -41,7 +41,7 @@ class Thread::Process
 	end
 
 	# Send a message to the process.
-	def send (what)
+	def send(what)
 		unless @channel
 			raise RuntimeError, 'the process has terminated'
 		end
@@ -53,7 +53,7 @@ class Thread::Process
 
 	alias << send
 
-	private
+private
 	def receive
 		@channel.receive
 	end
@@ -65,7 +65,7 @@ end
 
 class Thread
 	# Helper to create a process.
-	def self.process (&block)
+	def self.process(&block)
 		Thread::Process.new(&block)
 	end
 end

data/lib/thread/promise.rb

@@ -27,7 +27,7 @@ class Thread::Promise
 	alias realized? delivered?
 
 	# Deliver a value.
-	def deliver (value)
+	def deliver(value)
 		return self if delivered?
 
 		@mutex.synchronize {
@@ -46,7 +46,7 @@ class Thread::Promise
 	#
 	# An optional timeout can be passed which will return nil if nothing has been
 	# delivered.
-	def value (timeout = nil)
+	def value(timeout = nil)
 		return @value if delivered?
 
 		@mutex.synchronize {
@@ -58,7 +58,7 @@ class Thread::Promise
 
 	alias ~ value
 
-	private
+private
 	def cond?
 		instance_variable_defined? :@cond
 	end

data/spec/thread/pool_spec.rb

@@ -0,0 +1,78 @@
+require 'thread/pool'
+
+describe Thread::Pool do
+	it 'creates a new pool with the given amount of threads' do
+		pool = Thread.pool(4)
+
+		expect(pool.spawned).to eq(4)
+
+		pool.shutdown
+	end
+
+	it 'creates a new pool with the given amount of threads without spawning more than min' do
+		pool = Thread.pool(4, 8)
+
+		expect(pool.spawned).to eq(4)
+
+		pool.shutdown
+	end
+
+	it 'properly reports the backlog length' do
+		pool = Thread.pool(2)
+
+		pool.process { sleep 0.5 }
+		pool.process { sleep 0.5 }
+		pool.process { sleep 0.5 }
+
+		sleep 0.25
+
+		expect(pool.backlog).to eq(1)
+
+		pool.shutdown
+	end
+
+	it 'properly reports the pool is done' do
+		pool = Thread.pool(2)
+
+		pool.process { sleep 0.25 }
+		pool.process { sleep 0.25 }
+		pool.process { sleep 0.25 }
+
+		expect(pool.done?).to be(false)
+
+		sleep 0.75
+
+		expect(pool.done?).to be(true)
+
+		pool.shutdown
+	end
+
+	it 'properly reports the pool is idle' do
+		pool = Thread.pool(2)
+
+		pool.process { sleep 0.25 }
+		pool.process { sleep 0.5 }
+
+		expect(pool.idle?).to be(false)
+
+		sleep 0.30
+
+		expect(pool.idle?).to be(true)
+
+		pool.shutdown
+	end
+
+	it 'properly shutdowns the pool' do
+		result = []
+		pool   = Thread.pool(4)
+
+		pool.process { sleep 0.1; result << 1 }
+		pool.process { sleep 0.2; result << 2 }
+		pool.process { sleep 0.3; result << 3 }
+		pool.process { sleep 0.4; result << 4 }
+
+		pool.shutdown
+
+		expect(result).to eq([1, 2, 3, 4])
+	end
+end

data/thread.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "thread"
-  spec.version       = "0.1.7"
+  spec.version       = "0.2.0"
   spec.authors       = ["meh."]
   spec.email         = ["meh@schizofreni.co"]
   spec.summary       = %q{Various extensions to the base thread library.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thread
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - meh.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -67,6 +67,7 @@ files:
 - spec/thread/every_spec.rb
 - spec/thread/future_spec.rb
 - spec/thread/pipe_spec.rb
+- spec/thread/pool_spec.rb
 - spec/thread/promise_spec.rb
 - thread.gemspec
 homepage: http://github.com/meh/ruby-thread
@@ -99,5 +100,6 @@ test_files:
 - spec/thread/every_spec.rb
 - spec/thread/future_spec.rb
 - spec/thread/pipe_spec.rb
+- spec/thread/pool_spec.rb
 - spec/thread/promise_spec.rb
 has_rdoc: