contender 0.1.1 → 0.2.0

data/spec/pool/executor_stress_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Contender
+  module Pool
+
+    describe PoolExecutor, stress: true do
+      it 'can handle many submissions' do
+        executor = Pool.fixed 4
+
+        x = 100_000
+
+        latch = CountdownLatch.new x
+        x.times do
+          executor.execute do
+            latch.countdown
+          end
+        end
+
+        latch.await
+
+        puts executor
+
+        executor.shutdown
+        executor.await_termination 5
+
+        executor.completed_tasks.should == x
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'rspec'
+require 'rr'
+require 'contender'
+
+require 'wait_helper'

data/spec/wait_helper.rb

@@ -0,0 +1,14 @@
+module WaitHelper
+  TimeoutError = Class.new RuntimeError
+
+  def wait_until(timeout = 5, interval = 0.1, &block)
+    start = Time.now
+
+    until block.call
+      elapsed = Time.now - start
+      raise TimeoutError unless elapsed < timeout
+
+      sleep interval
+    end
+  end
+end

metadata

@@ -1,57 +1,184 @@
 --- !ruby/object:Gem::Specification
 name: contender
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.1.1
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Ian Unruh
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
-dependencies: []
-description: Simple framework for managing in-process execution
+date: 2013-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: atomic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Collection of utilities for managing concurrency
 email: ianunruh@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/contender.rb
+- lib/contender/copy_on_write_array.rb
+- lib/contender/copy_on_write_set.rb
+- lib/contender/copy_on_write_structure.rb
 - lib/contender/countdown_latch.rb
+- lib/contender/counter.rb
 - lib/contender/direct_executor.rb
 - lib/contender/errors.rb
 - lib/contender/executor.rb
+- lib/contender/executor_service.rb
+- lib/contender/future.rb
+- lib/contender/future_task.rb
+- lib/contender/linked_queue.rb
+- lib/contender/pool/pool_executor.rb
+- lib/contender/pool/pool_worker.rb
+- lib/contender/pool/rejection_policy.rb
 - lib/contender/pool.rb
+- lib/contender/queue.rb
+- lib/contender/thread_factory.rb
 - lib/contender/version.rb
-- lib/contender/pool/pool_worker.rb
-- lib/contender/pool/task.rb
-- lib/contender/pool/task_queue.rb
-- lib/contender/pool/thread_pool_executor.rb
+- lib/contender.rb
+- spec/copy_on_write_array_spec.rb
+- spec/copy_on_write_set_spec.rb
+- spec/countdown_latch_spec.rb
+- spec/counter_spec.rb
+- spec/direct_executor_spec.rb
+- spec/future_task_spec.rb
+- spec/linked_queue_spec.rb
+- spec/pool/executor_spec.rb
+- spec/pool/executor_stress_spec.rb
+- spec/spec_helper.rb
+- spec/wait_helper.rb
 homepage: https://github.com/ianunruh/contender
 licenses:
 - Apache 2.0
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
 specification_version: 3
-summary: Simple framework for managing in-process execution
-test_files: []
-has_rdoc:
+summary: Collection of utilities for managing concurrency
+test_files:
+- spec/copy_on_write_array_spec.rb
+- spec/copy_on_write_set_spec.rb
+- spec/countdown_latch_spec.rb
+- spec/counter_spec.rb
+- spec/direct_executor_spec.rb
+- spec/future_task_spec.rb
+- spec/linked_queue_spec.rb
+- spec/pool/executor_spec.rb
+- spec/pool/executor_stress_spec.rb
+- spec/spec_helper.rb
+- spec/wait_helper.rb
+has_rdoc: 

data/lib/contender/pool/task.rb

@@ -1,52 +0,0 @@
-module Contender
-  module Pool
-    # Encapsulates a task that is either waiting for execution or has been executed
-    class Task
-      # @return [Array] The arguments that the block will be executed with
-      attr_reader :arguments
-
-      # @return [Proc] The block that will be executed by a pool worker
-      attr_reader :block
-
-      # @return [Exception] Exception that occured during task execution
-      attr_reader :exception
-
-      # @param [Proc] block
-      # @param [Array] arguments
-      # @return [undefined]
-      def initialize(block, arguments)
-        @block = block
-        @arguments = arguments
-        @executed = false
-      end
-
-      # Returns true if this task has been executed
-      #
-      # @api public
-      # @return [Boolean]
-      def executed?
-        @executed
-      end
-
-      # Returns true if the execution of this task resulted in an exception
-      #
-      # @api public
-      # @return [Boolean]
-      def failed?
-        !!@exception
-      end
-
-      # Executes the block with the provided arguments
-      # @return [undefined]
-      def execute
-        begin
-          @block.call *@arguments
-        rescue Exception => exception
-          @exception = exception
-        end
-
-        @executed = true
-      end
-    end # Task
-  end # Pool
-end

data/lib/contender/pool/task_queue.rb

@@ -1,80 +0,0 @@
-module Contender
-  module Pool
-    # Simple thread-safe queue that holds tasks waiting for execution
-    class TaskQueue
-      # @return [undefined]
-      def initialize
-        @condition = ConditionVariable.new
-        @mutex = Mutex.new
-        @tasks = Array.new
-      end
-
-      # Performs a volatile read of the size of the task queue
-      #
-      # @api public
-      # @return [Integer]
-      def backlog
-        @tasks.size
-      end
-
-      # Returns true if the task queue is empty
-      #
-      # @api public
-      # @return [Boolean]
-      def empty?
-        @tasks.empty?
-      end
-
-      # Removes any tasks that are queued for execution
-      #
-      # @api public
-      # @return [undefined]
-      def purge
-        @mutex.synchronize do
-          @tasks.clear
-        end
-      end
-
-      # Enqueues the given task for execution
-      #
-      # @api public
-      # @param [Task] task
-      # @return [undefined]
-      def enqueue(task)
-        @mutex.synchronize do
-          @tasks.push task
-          @condition.signal
-        end
-      end
-
-      # Dequeues the first task in line
-      #
-      # If this operation is performed as non-blocking and the queue is empty, then the result
-      # of the dequeue will be +nil+.
-      #
-      # If this operation is performed as blocking, then it will wait until a task is added to the
-      # queue. In the case that the thread pool is shutdown during while a worker is waiting for
-      # the operation to complete, +nil+ will be returned immediately.
-      #
-      # @api public
-      # @param [Boolean] non_block
-      # @return [Task]
-      def dequeue(non_block = false)
-        @mutex.synchronize do
-          if @tasks.empty?
-            return if non_block
-            @condition.wait @mutex
-          end
-
-          @tasks.shift
-        end
-      end
-
-      # Wakes up any threads waiting for tasks to be queued
-      # @return [undefined]
-      def wakeup
-        @condition.broadcast
-      end
-    end # TaskQueue
-  end # Pool
-end

data/lib/contender/pool/thread_pool_executor.rb

@@ -1,167 +0,0 @@
-module Contender
-  module Pool
-    # Executor that uses a cached thread pool to execute tasks in the background
-    class ThreadPoolExecutor < Executor
-      extend Forwardable
-
-      # @param [Hash] options
-      # @return [undefined]
-      def initialize(options = Hash.new)
-        @queue = TaskQueue.new
-
-        @options = {
-          size: 2,
-          non_block: false
-        }.merge options
-
-        @workers = Array.new
-        @mutex = Mutex.new
-
-        @state = :inactive
-      end
-
-      # Defers the execution of the given block until it can be processed by a worker in the
-      # thread pool
-      #
-      # @api public
-      # @param [Object...] arguments
-      # @param [Proc] block
-      # @return [undefined]
-      def execute(*arguments, &block)
-        unless active?
-          raise 'Thread pool has not been started or is shutting down'
-        end
-
-        @queue.enqueue(Task.new(block, arguments))
-      end
-
-      # Returns true if this thread pool is inactive
-      #
-      # @api public
-      # @return [Boolean]
-      def inactive?
-        :inactive == @state
-      end
-
-      # Returns true if this thread pool is active and accepting tasks
-      #
-      # @api public
-      # @return [Boolean]
-      def active?
-        :active == @state
-      end
-
-      # Returns true if this thread pool is waiting to shutdown
-      #
-      # @api public
-      # @return [Boolean]
-      def shutdown?
-        :shutdown == @state
-      end
-
-      # Returns true if this thread pool is shutting down now
-      #
-      # @api public
-      # @return [Boolean]
-      def shutdown_now?
-        :shutdown_now == @state
-      end
-
-      # Starts the thread pool
-      #
-      # @api public
-      # @return [undefined]
-      def start
-        @mutex.synchronize do
-          return unless inactive?
-          @state = :starting
-        end
-
-        start_workers @options.fetch(:size)
-        @state = :active
-      end
-
-      # Blocks until all queued tasks have been executed, then shuts down the thread pool
-      #
-      # @api public
-      # @return [undefined]
-      def shutdown
-        @mutex.synchronize do
-          return unless active?
-          @state = :shutdown
-        end
-
-        # TODO This is not ideal
-        until @queue.empty?
-          # Wait until the task queue is empty
-          sleep 0.1
-        end
-
-        @state = :shutdown_now
-
-        @queue.wakeup
-        @workers.each do |worker|
-          worker.join
-        end
-
-        cleanup
-      end
-
-      # Shuts down the thread pool instantly, interrupting any executing tasks
-      #
-      # @api public
-      # @return [undefined]
-      def shutdown!
-        @mutex.synchronize do
-          return unless active?
-          @state = :shutdown_now
-        end
-
-        @workers.each do |worker|
-          worker.interrupt
-        end
-
-        cleanup
-      end
-
-      # @!method backlog
-      #   Performs a volatile read on the number of tasks in the queue
-      #   @return [Integer]
-      # @!method empty?
-      #   Returns true if the task queue is empty
-      #   @return [Boolean]
-      # @!method purge
-      #   Removes any tasks that are queued for execution
-      #   @return [undefined]
-      def_delegators :@queue, :backlog, :empty?, :purge
-
-    protected
-
-      # Cleans up pool workers and changes the executor state to inactive
-      # @return [undefined]
-      def cleanup
-        @workers.clear
-        @state = :inactive
-      end
-
-      # Starts the given number of worker threads
-      # @return [undefined]
-      def start_workers(count)
-        @mutex.synchronize do
-          count.times do
-            start_worker
-          end
-        end
-      end
-
-      # Starts a new worker and adds it to pool
-      # @return [undefined]
-      def start_worker
-        worker = PoolWorker.new self, @queue, @options.fetch(:non_block)
-        @workers.push worker
-
-        worker.start
-      end
-    end # ThreadPoolExecutor
-  end # Pool
-end