Add helper methods for deprecations

Author: pitr-ch

lib/concurrent/agent.rb

@@ -3,6 +3,7 @@
 require 'concurrent/observable'
 require 'concurrent/logging'
 require 'concurrent/executor/executor'
+require 'concurrent/utility/deprecation'
 
 module Concurrent
 
@@ -14,6 +15,7 @@ class Agent
     include Dereferenceable
     include Observable
     include Logging
+    include Deprecation
 
     attr_reader :timeout, :io_executor, :fast_executor
 
@@ -115,21 +117,21 @@ def post(&block)
     # @yieldreturn [Object] the new value
     # @return [true, nil] nil when no block is given
     def post_off(timeout = nil, &block)
-      warn '[DEPRECATED] post_off with timeout options is deprecated and will be removed'
       task = if timeout
-                lambda do |value|
-                  future = Future.execute do
-                    block.call(value)
-                  end
-                  if future.wait(timeout)
-                    future.value!
-                  else
-                    raise Concurrent::TimeoutError
-                  end
-                end
-              else
-                block
-              end
+               deprecated 'post_off with option timeout options is deprecated and will be removed'
+               lambda do |value|
+                 future = Future.execute do
+                   block.call(value)
+                 end
+                 if future.wait(timeout)
+                   future.value!
+                 else
+                   raise Concurrent::TimeoutError
+                 end
+               end
+             else
+               block
+             end
       post_on(@io_executor, &task)
     end
 

lib/concurrent/atomic/condition.rb

@@ -1,4 +1,5 @@
 require 'concurrent/utility/monotonic_time'
+require 'concurrent/utility/deprecation'
 
 module Concurrent
 
@@ -14,6 +15,7 @@ module Concurrent
   #
   # @deprecated
   class Condition
+    include Deprecation
 
     class Result
       def initialize(remaining_time)
@@ -39,7 +41,7 @@ def timed_out?
     end
 
     def initialize
-      warn '[DEPRECATED] Will be replaced with Synchronization::Object in v1.0.'
+      deprecated 'Will be replaced with Synchronization::Object in v1.0.'
       @condition = ConditionVariable.new
     end
 

lib/concurrent/configuration.rb

@@ -4,13 +4,14 @@
 require 'concurrent/at_exit'
 require 'concurrent/executors'
 require 'concurrent/utility/processor_count'
+require 'concurrent/utility/deprecation'
 
 module Concurrent
   extend Logging
+  extend Deprecation
 
   # Suppresses all output when used for logging.
   NULL_LOGGER = lambda { |level, progname, message = nil, &block| }
-  private_constant :NULL_LOGGER
 
   # @!visibility private
   GLOBAL_LOGGER = AtomicReference.new(NULL_LOGGER)
@@ -60,21 +61,21 @@ def self.disable_at_exit_hooks!
   end
 
   def self.disable_executor_auto_termination!
-    warn '[DEPRECATED] Use Concurrent.disable_at_exit_hooks! instead'
+    deprecated_method 'disable_executor_auto_termination!', 'disable_at_exit_hooks!'
     disable_at_exit_hooks!
   end
 
   # @return [true,false]
   # @see .disable_executor_auto_termination!
   def self.disable_executor_auto_termination?
-    warn '[DEPRECATED] Use Concurrent::AtExit.enabled? instead'
+    deprecated_method 'disable_executor_auto_termination?', 'Concurrent::AtExit.enabled?'
     AtExit.enabled?
   end
 
   # terminates all pools and blocks until they are terminated
   # @see .disable_executor_auto_termination!
   def self.terminate_pools!
-    warn '[DEPRECATED] Use Concurrent::AtExit.run instead'
+    deprecated_method 'terminate_pools!', 'Concurrent::AtExit.run'
     AtExit.run
   end
 
@@ -139,6 +140,7 @@ def self.new_io_executor(opts = {})
 
   # A gem-level configuration object.
   class Configuration
+    include Deprecation
 
     # Create a new configuration object.
     def initialize
@@ -148,6 +150,7 @@ def initialize
     # @deprecated Use Concurrent::NULL_LOGGER instead
     def no_logger
       warn '[DEPRECATED] Use Concurrent::NULL_LOGGER instead'
+      deprecated_method 'Concurrent.configuration.no_logger', 'Concurrent::NULL_LOGGER'
       NULL_LOGGER
     end
 
@@ -156,7 +159,7 @@ def no_logger
     #
     # @deprecated Use Concurrent.global_logger instead
     def logger
-      warn '[DEPRECATED] Use Concurrent.global_logger instead'
+      deprecated_method 'Concurrent.configuration.logger', 'Concurrent.global_logger'
       Concurrent.global_logger.value
     end
 
@@ -165,65 +168,65 @@ def logger
     #
     # @deprecated Use Concurrent.global_logger instead
     def logger=(value)
-      warn '[DEPRECATED] Use Concurrent.global_logger instead'
+      deprecated_method 'Concurrent.configuration.logger=', 'Concurrent.global_logger='
       Concurrent.global_logger = value
     end
 
     # @deprecated Use Concurrent.global_io_executor instead
     def global_task_pool
-      warn '[DEPRECATED] Use Concurrent.global_io_executor instead'
+      deprecated_method 'Concurrent.configuration.global_task_pool', 'Concurrent.global_io_executor'
       Concurrent.global_io_executor
     end
 
     # @deprecated Use Concurrent.global_fast_executor instead
     def global_operation_pool
-      warn '[DEPRECATED] Use Concurrent.global_fast_executor instead'
+      deprecated_method 'Concurrent.configuration.global_operation_pool', 'Concurrent.global_fast_executor'
       Concurrent.global_fast_executor
     end
 
     # @deprecated Use Concurrent.global_timer_set instead
     def global_timer_set
-      warn '[DEPRECATED] Use Concurrent.global_timer_set instead'
+      deprecated_method 'Concurrent.configuration.global_timer_set', 'Concurrent.global_timer_set'
       Concurrent.global_timer_set
     end
 
     # @deprecated Replacing global thread pools is deprecated.
     #   Use the :executor constructor option instead.
     def global_task_pool=(executor)
-      warn '[DEPRECATED] Replacing global thread pools is deprecated. Use the :executor constructor option instead.'
+      deprecated 'Replacing global thread pools is deprecated. Use the :executor constructor option instead.'
       GLOBAL_IO_EXECUTOR.reconfigure { executor } or
           raise ConfigurationError.new('global task pool was already set')
     end
 
     # @deprecated Replacing global thread pools is deprecated.
     #   Use the :executor constructor option instead.
     def global_operation_pool=(executor)
-      warn '[DEPRECATED] Replacing global thread pools is deprecated. Use the :executor constructor option instead.'
+      deprecated 'Replacing global thread pools is deprecated. Use the :executor constructor option instead.'
       GLOBAL_FAST_EXECUTOR.reconfigure { executor } or
           raise ConfigurationError.new('global operation pool was already set')
     end
 
     # @deprecated Use Concurrent.new_io_executor instead
     def new_task_pool
-      warn '[DEPRECATED] Use Concurrent.new_io_executor instead'
+      deprecated_method 'Concurrent.configuration.new_task_pool', 'Concurrent.new_io_executor'
       Concurrent.new_io_executor
     end
 
     # @deprecated Use Concurrent.new_fast_executor instead
     def new_operation_pool
-      warn '[DEPRECATED] Use Concurrent.new_fast_executor instead'
+      deprecated_method 'Concurrent.configuration.new_operation_pool', 'Concurrent.new_fast_executor'
       Concurrent.new_fast_executor
     end
 
     # @deprecated Use Concurrent.disable_auto_termination_of_global_executors! instead
     def auto_terminate=(value)
-      warn '[DEPRECATED] Use Concurrent.disable_auto_termination_of_global_executors! instead'
+      deprecated_method 'Concurrent.configuration.auto_terminate=', 'Concurrent.disable_auto_termination_of_global_executors!'
       Concurrent.disable_auto_termination_of_global_executors! if !value
     end
 
     # @deprecated Use Concurrent.auto_terminate_global_executors? instead
     def auto_terminate
-      warn '[DEPRECATED] Use Concurrent.auto_terminate_global_executors? instead'
+      deprecated_method 'Concurrent.configuration.auto_terminate', 'Concurrent.auto_terminate_global_executors?'
       Concurrent.auto_terminate_global_executors?
     end
   end

lib/concurrent/executor/executor.rb

@@ -1,8 +1,10 @@
 require 'concurrent/executor/executor_service'
+require 'concurrent/utility/deprecation'
 
 module Concurrent
 
   module Executor
+    extend Deprecation
 
     # Get the requested `Executor` based on the values set in the options hash.
     #
@@ -25,12 +27,12 @@ def self.executor_from_options(opts = {}) # :nodoc:
         end
       when opts.key?(:operation) || opts.key?(:task)
         if opts[:operation] == true || opts[:task] == false
-          Kernel.warn '[DEPRECATED] use `executor: :fast` instead'
+          deprecated 'use `executor: :fast` instead'
           return Concurrent.global_fast_executor
         end
 
         if opts[:operation] == false || opts[:task] == true
-          Kernel.warn '[DEPRECATED] use `executor: :io` instead'
+          deprecated 'use `executor: :io` instead'
           return Concurrent.global_io_executor
         end
 
@@ -49,10 +51,10 @@ def self.executor(executor_identifier)
       when :immediate
         Concurrent.global_immediate_executor
       when :operation
-        Kernel.warn '[DEPRECATED] use `executor: :fast` instead'
+        deprecated 'use `executor: :fast` instead'
         Concurrent.global_fast_executor
       when :task
-        Kernel.warn '[DEPRECATED] use `executor: :io` instead'
+        deprecated 'use `executor: :io` instead'
         Concurrent.global_io_executor
       when Concurrent::ExecutorService
         executor_identifier

lib/concurrent/executor/executor_service.rb

@@ -3,11 +3,13 @@
 require 'concurrent/at_exit'
 require 'concurrent/atomic/event'
 require 'concurrent/synchronization'
+require 'concurrent/utility/deprecation'
 
 module Concurrent
 
   module ExecutorService
     include Logging
+    include Deprecation
 
     # @!macro [attach] executor_service_method_post
     #

lib/concurrent/executor/java_cached_thread_pool.rb

@@ -24,7 +24,7 @@ def initialize(opts = {})
 
       def ns_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)
+        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_POLICY_CLASSES.keys.include?(@fallback_policy)

lib/concurrent/executor/java_thread_pool_executor.rb

@@ -139,7 +139,7 @@ def ns_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)
+        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

@@ -135,7 +135,7 @@ def ns_initialize(opts)
       @max_queue       = opts.fetch(:max_queue, DEFAULT_MAX_QUEUE_SIZE).to_i
       @fallback_policy = opts.fetch(:fallback_policy, opts.fetch(:overflow_policy, :abort))
       raise ArgumentError.new("#{@fallback_policy} is not a valid fallback policy") unless FALLBACK_POLICIES.include?(@fallback_policy)
-      warn '[DEPRECATED] :overflow_policy is deprecated terminology, please use :fallback_policy instead' if opts.has_key?(:overflow_policy)
+      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/simple_executor_service.rb

@@ -102,7 +102,7 @@ def ns_initialize
   class PerThreadExecutor < SimpleExecutorService
 
     def initialize
-      warn '[DEPRECATED] use SimpleExecutorService instead'
+      deprecated 'use SimpleExecutorService instead'
       super
     end
   end

lib/concurrent/executor/timer_set.rb

@@ -5,6 +5,7 @@
 require 'concurrent/executor/executor_service'
 require 'concurrent/executor/single_thread_executor'
 require 'concurrent/utility/monotonic_time'
+require 'concurrent/utility/deprecation'
 
 module Concurrent
 
@@ -14,6 +15,7 @@ module Concurrent
   #
   # @!macro monotonic_clock_warning
   class TimerSet < RubyExecutorService
+    extend Deprecation
 
     # Create a new set of timed tasks.
     #
@@ -82,7 +84,7 @@ def kill
     # @!visibility private
     def self.calculate_delay!(delay)
       if delay.is_a?(Time)
-        warn '[DEPRECATED] Use an interval not a clock time; schedule is now based on a monotonic clock'
+        deprecated 'Use an interval not a clock time; schedule is now based on a monotonic clock'
         now = Time.now
         raise ArgumentError.new('schedule time must be in the future') if delay <= now
         delay.to_f - now.to_f