Docs4dev
Docs
rails / 4.1 / activesupport / deprecation / methodwrapper.html

module ActiveSupport::Deprecation::MethodWrapper

Public Instance Methods

deprecate_methods(target_module, *method_names) Show source

Declare that a method has been deprecated.

module Fred
  extend self

  def foo; end
  def bar; end
  def baz; end
end

ActiveSupport::Deprecation.deprecate_methods(Fred, :foo, bar: :qux, baz: 'use Bar#baz instead')
# => [:foo, :bar, :baz]

Fred.foo
# => "DEPRECATION WARNING: foo is deprecated and will be removed from Rails 4.1."

Fred.bar
# => "DEPRECATION WARNING: bar is deprecated and will be removed from Rails 4.1 (use qux instead)."

Fred.baz
# => "DEPRECATION WARNING: baz is deprecated and will be removed from Rails 4.1 (use Bar#baz instead)."

# File activesupport/lib/active_support/deprecation/method_wrappers.rb, line 28
def deprecate_methods(target_module, *method_names)
  options = method_names.extract_options!
  deprecator = options.delete(:deprecator) || ActiveSupport::Deprecation.instance
  method_names += options.keys

  method_names.each do |method_name|
    target_module.alias_method_chain(method_name, :deprecation) do |target, punctuation|
      target_module.send(:define_method, "#{target}_with_deprecation#{punctuation}") do |*args, &block|
        deprecator.deprecation_warning(method_name, options[method_name])
        send(:"#{target}_without_deprecation#{punctuation}", *args, &block)
      end
    end
  end
end

© 2004–2016 David Heinemeier Hansson
Licensed under the MIT License.