instance method `deprecate`

Ruby on Rails 8.0.4

Since v3.0.20

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

deprecate(*method_names, deprecator:, **options)

deprecate :foo, deprecator: MyLib.deprecator

deprecate :foo, bar: "warning!", deprecator: MyLib.deprecator

A deprecator is typically an instance of ActiveSupport::Deprecation, but you can also pass any object that responds to deprecation_warning(deprecated_method_name, message, caller_backtrace) where you can implement your custom warning behavior.

class MyLib::Deprecator
  def deprecation_warning(deprecated_method_name, message, caller_backtrace = nil)
    message = "#{deprecated_method_name} is deprecated and will be removed from MyLibrary | #{message}"
    Kernel.warn message
  end
end

Parameters

method_names rest
deprecator keyreq
options keyrest

Source

# File activesupport/lib/active_support/core_ext/module/deprecation.rb, line 17
  def deprecate(*method_names, deprecator:, **options)
    if deprecator.is_a?(ActiveSupport::Deprecation)
      deprecator.deprecate_methods(self, *method_names, **options)
    elsif deprecator
      # we just need any instance to call deprecate_methods, but the deprecation will be emitted by deprecator
      ActiveSupport.deprecator.deprecate_methods(self, *method_names, **options, deprecator: deprecator)
    end
  end

Defined in activesupport/lib/active_support/core_ext/module/deprecation.rb line 17 · View on GitHub · Improve this page · Find usages on GitHub

Defined in Module

Signature

Parameters