Skip to Content Skip to Search

module ActiveSupport::Deprecation::MethodWrapper

Public instance methods

deprecate_methods(target_module, *method_names)

Declare that a method has been deprecated.

class Fred
  def aaa; end
  def bbb; end
  def ccc; end
  def ddd; end
  def eee; end
end

deprecator = ActiveSupport::Deprecation.new('next-release', 'MyGem')

deprecator.deprecate_methods(Fred, :aaa, bbb: :zzz, ccc: 'use Bar#ccc instead')
# => Fred

Fred.new.aaa
# DEPRECATION WARNING: aaa is deprecated and will be removed from MyGem next-release. (called from irb_binding at (irb):10)
# => nil

Fred.new.bbb
# DEPRECATION WARNING: bbb is deprecated and will be removed from MyGem next-release (use zzz instead). (called from irb_binding at (irb):11)
# => nil

Fred.new.ccc
# DEPRECATION WARNING: ccc is deprecated and will be removed from MyGem next-release (use Bar#ccc instead). (called from irb_binding at (irb):12)
# => nil
Source code GitHub 
# File activesupport/lib/active_support/deprecation/method_wrappers.rb, line 35
def deprecate_methods(target_module, *method_names)
  options = method_names.extract_options!
  deprecator = options.delete(:deprecator) || self
  method_names += options.keys
  mod = nil

  method_names.each do |method_name|
    message = options[method_name]
    if target_module.method_defined?(method_name) || target_module.private_method_defined?(method_name)
      method = target_module.instance_method(method_name)
      target_module.module_eval do
        redefine_method(method_name) do |*args, &block|
          deprecator.deprecation_warning(method_name, message)
          method.bind_call(self, *args, &block)
        end
        ruby2_keywords(method_name)
      end
    else
      mod ||= Module.new
      mod.module_eval do
        define_method(method_name) do |*args, &block|
          deprecator.deprecation_warning(method_name, message)
          super(*args, &block)
        end
        ruby2_keywords(method_name)
      end
    end
  end

  target_module.prepend(mod) if mod
end

Definition files