method

deprecate_methods

v4.2.7 - Show latest stable - 0 notes - Class: MethodWrapper

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2 (0)
4.1.8 (0)
4.2.1 (0)
4.2.7 (0)
4.2.9 (0)
5.0.0.1 (38)
5.1.7 (-1)
5.2.3 (0)
6.0.0 (0)
6.1.3.1 (0)
6.1.7.7 (0)
7.0.0 (0)
7.1.3.2 (-28)
7.1.3.4 (0)
What's this?

deprecate_methods(target_module, *method_names) public

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)."

Show source

# 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

deprecate_methods

Related methods