Merge pull request #202 from ruby-concurrency/refactor/changelog-and-warnings

Warnings when using deprecated :overflow_policy thread pool option

Author: jdantonio

CHANGELOG.md

@@ -1,3 +1,10 @@
+### Next Release v0.7.2 (TBD)
+
+* Renamed `:overflow_policy` on thread pools to `:fallback_policy`
+* Thread pools still accept the `:overflow_policy` option but display a warning
+* Thread pools now implement `fallback_policy` behavior when not running (rather than universally rejecting tasks)
+* Test now run on new Travis build environment
+
 ## Current Release v0.7.1 (4 December 2014)
 
 Please see the [roadmap](https://github.com/ruby-concurrency/concurrent-ruby/issues/142) for more information on the next planned release.

lib/concurrent/configuration.rb

@@ -102,7 +102,7 @@ def new_task_pool
           max_threads:     [20, Concurrent.processor_count * 15].max,
           idletime:        2 * 60, # 2 minutes
           max_queue:       0, # unlimited
-          overflow_policy: :abort # raise an exception
+          fallback_policy: :abort # raise an exception
       )
     end
 
@@ -112,7 +112,7 @@ def new_operation_pool
           max_threads:     [2, Concurrent.processor_count].max,
           idletime:        10 * 60, # 10 minutes
           max_queue:       [20, Concurrent.processor_count * 15].max,
-          overflow_policy: :abort # raise an exception
+          fallback_policy: :abort # raise an exception
       )
     end
   end

lib/concurrent/executor/java_cached_thread_pool.rb

@@ -17,6 +17,7 @@ class JavaCachedThreadPool < JavaThreadPoolExecutor
       # @see http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executors.html#newCachedThreadPool--
       def initialize(opts = {})
         @fallback_policy = opts.fetch(:fallback_policy, opts.fetch(:overflow_policy, :abort))
+        warn '[DEPRECATED] :overflow_policy is deprecated terminology, please use :fallback_policy instead' if opts.has_key?(:overflow_policy)
         @max_queue = 0
 
         raise ArgumentError.new("#{@fallback_policy} is not a valid fallback policy") unless FALLBACK_POLICIES.keys.include?(@fallback_policy)

lib/concurrent/executor/java_fixed_thread_pool.rb

@@ -24,16 +24,6 @@ def initialize(num_threads, opts = {})
         }.merge(opts)
         super(opts)
 
-
-        #@fallback_policy = opts.fetch(:fallback_policy, :abort)
-        #@max_queue = 0
-        #
-        #raise ArgumentError.new('number of threads must be greater than zero') if num_threads < 1
-        #raise ArgumentError.new("#{@fallback_policy} is not a valid fallback policy") unless FALLBACK_POLICIES.keys.include?(@fallback_policy)
-        #
-        #@executor = java.util.concurrent.Executors.newFixedThreadPool(num_threads)
-        #@executor.setRejectedExecutionHandler(FALLBACK_POLICIES[@FALLBACK_policy].new)
-
         set_shutdown_hook
       end
     end

lib/concurrent/executor/java_thread_pool_executor.rb

@@ -57,6 +57,7 @@ def initialize(opts = {})
         idletime = opts.fetch(:idletime, DEFAULT_THREAD_IDLETIMEOUT).to_i
         @max_queue = opts.fetch(:max_queue, DEFAULT_MAX_QUEUE_SIZE).to_i
         @fallback_policy = opts.fetch(:fallback_policy, opts.fetch(:overflow_policy, :abort))
+        warn '[DEPRECATED] :overflow_policy is deprecated terminology, please use :fallback_policy instead' if opts.has_key?(:overflow_policy)
 
         raise ArgumentError.new('max_threads must be greater than zero') if max_length <= 0
         raise ArgumentError.new('min_threads cannot be less than zero') if min_length < 0

lib/concurrent/executor/ruby_thread_pool_executor.rb

@@ -75,6 +75,7 @@ def initialize(opts = {})
       @idletime        = opts.fetch(:idletime, DEFAULT_THREAD_IDLETIMEOUT).to_i
       @max_queue       = opts.fetch(:max_queue, DEFAULT_MAX_QUEUE_SIZE).to_i
       @fallback_policy = opts.fetch(:fallback_policy, opts.fetch(:overflow_policy, :abort))
+      warn '[DEPRECATED] :overflow_policy is deprecated terminology, please use :fallback_policy instead' if opts.has_key?(:overflow_policy)
 
       raise ArgumentError.new('max_threads must be greater than zero') if @max_length <= 0
       raise ArgumentError.new('min_threads cannot be less than zero') if @min_length < 0

spec/concurrent/executor/thread_pool_executor_shared.rb

@@ -342,16 +342,16 @@
     end
   end
 
-  context '#overflow_policy' do
-    context ':caller_runs is honoured even if the old overflow_policy arg is used' do
+  context '#fallback_policy' do
+    context ':caller_runs is honoured even if the old fallback_policy arg is used' do
 
       subject do
         described_class.new(
           min_threads: 1,
           max_threads: 1,
           idletime: 60,
           max_queue: 1,
-          overflow_policy: :caller_runs
+          fallback_policy: :caller_runs
         )
       end