Class: ActiveSupport::Deprecation

Relationships & Source Files
Namespace Children
Modules: `Behavior`, `DeprecatedConstantAccessor`, `Disallowed`, `MethodWrapper`, `Reporting`
Classes: `DeprecatedConstantProxy`, `DeprecatedInstanceVariableProxy`, `DeprecatedObjectProxy`, `Deprecators`
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `MethodWrapper`, `Disallowed`, `Reporting`, `Behavior`
Inherits:	Object
Defined in:	activesupport/lib/active_support/deprecation.rb, activesupport/lib/active_support/deprecation/behaviors.rb, activesupport/lib/active_support/deprecation/constant_accessor.rb, activesupport/lib/active_support/deprecation/deprecators.rb, activesupport/lib/active_support/deprecation/disallowed.rb, activesupport/lib/active_support/deprecation/instance_delegator.rb, activesupport/lib/active_support/deprecation/method_wrappers.rb, activesupport/lib/active_support/deprecation/proxy_wrappers.rb, activesupport/lib/active_support/deprecation/reporting.rb

Overview

Deprecation specifies the API used by Rails to deprecate methods, instance variables, objects, and constants. It’s also available for gems or applications.

For a gem, use .new to create a Deprecation object and store it in your module or class (in order for users to be able to configure it).

module MyLibrary
  def self.deprecator
    @deprecator ||= ActiveSupport::Deprecation.new("2.0", "MyLibrary")
  end
end

For a Railtie or Engine, you may also want to add it to the application’s deprecators, so that the application’s configuration can be applied to it.

module MyLibrary
  class Railtie < Rails::Railtie
    initializer "my_library.deprecator" do |app|
      app.deprecators[:my_library] = MyLibrary.deprecator
    end
  end
end

With the above initializer, configuration settings like the following will affect MyLibrary.deprecator:

# in config/environments/test.rb
config.active_support.deprecation = :raise

Constant Summary

DEFAULT_BEHAVIORS =

Default warning behaviors per Rails.env.

# File 'activesupport/lib/active_support/deprecation/behaviors.rb', line 13

{
  raise: ->(message, callstack, deprecator) do
    e = DeprecationException.new(message)
    e.set_backtrace(callstack.map(&:to_s))
    raise e
  end,

  stderr: ->(message, callstack, deprecator) do
    $stderr.puts(message)
    $stderr.puts callstack.join("\n  ") if deprecator.debug
  end,

  log: ->(message, callstack, deprecator) do
    logger =
        if defined?(Rails.logger) && Rails.logger
          Rails.logger
        else
          require "active_support/logger"
          ActiveSupport::Logger.new($stderr)
        end
    logger.warn message
    logger.debug callstack.join("\n  ") if deprecator.debug
  end,

  notify: ->(message, callstack, deprecator) do
    ActiveSupport::Notifications.instrument(
      "deprecation.#{deprecator.gem_name.underscore.tr("/", "_")}",
      message: message,
      callstack: callstack,
      gem_name: deprecator.gem_name,
      deprecation_horizon: deprecator.deprecation_horizon,
    )
  end,

  silence: ->(message, callstack, deprecator) { },

  report: ->(message, callstack, deprecator) do
    error = DeprecationException.new(message)
    error.set_backtrace(callstack.map(&:to_s))
    ActiveSupport.error_reporter.report(error)
  end
}

Class Method Summary

.new(deprecation_horizon = "7.2", gem_name = "Rails") ⇒ Deprecation constructor

It accepts two parameters on initialization.

Instance Attribute Summary

#deprecation_horizon rw

The version number in which the deprecated behavior will be removed, by default.

`Disallowed` - Included

#disallowed_warnings	Returns the configured criteria used to identify deprecation messages which should be treated as disallowed.
#disallowed_warnings=	Sets the criteria used to identify deprecation messages which should be disallowed.

`Reporting` - Included

#gem_name	Name of gem where method is deprecated.
#silenced,
#silenced=	Whether to print a message (silent mode).

`Behavior` - Included

#behavior	Returns the current behavior or if one isn’t set, defaults to `:stderr`.
#behavior=	Sets the behavior to the specified value.
#debug	Whether to print a backtrace along with the warning.
#disallowed_behavior	Returns the current behavior for disallowed deprecations or if one isn’t set, defaults to `:raise`.
#disallowed_behavior=	Sets the behavior for disallowed deprecations (those configured by `ActiveSupport::Deprecation#disallowed_warnings=`) to the specified value.

Instance Method Summary

`MethodWrapper` - Included

#deprecate_methods

Declare that a method has been deprecated.

`Reporting` - Included

#allow	Allow previously disallowed deprecation warnings within the block.
#deprecation_warning,
#silence	Silence deprecation warnings within the block.
#warn	Outputs a deprecation warning to the output configured by `ActiveSupport::Deprecation#behavior`.

Constructor Details

.new(deprecation_horizon = "7.2", gem_name = "Rails") ⇒ `Deprecation`

It accepts two parameters on initialization. The first is a version of library and the second is a library name.

ActiveSupport::Deprecation.new('2.0', 'MyLibrary')

[ GitHub ]

# File 'activesupport/lib/active_support/deprecation.rb', line 68


def initialize(deprecation_horizon = "7.2", gem_name = "Rails")
  self.gem_name = gem_name
  self.deprecation_horizon = deprecation_horizon
  # By default, warnings are not silenced and debugging is off.
  self.silenced = false
  self.debug = false
  @silence_counter = Concurrent::ThreadLocalVar.new(0)
  @explicitly_allowed_warnings = Concurrent::ThreadLocalVar.new(nil)
end

Instance Attribute Details

#deprecation_horizon (rw)

The version number in which the deprecated behavior will be removed, by default.

[ GitHub ]

# File 'activesupport/lib/active_support/deprecation.rb', line 62


attr_accessor :deprecation_horizon

Class: ActiveSupport::Deprecation

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Disallowed - Included

Reporting - Included

Behavior - Included

Instance Method Summary

MethodWrapper - Included

Reporting - Included

Constructor Details

.new(deprecation_horizon = "7.2", gem_name = "Rails") ⇒ Deprecation

Instance Attribute Details

#deprecation_horizon (rw)

`Disallowed` - Included

`Reporting` - Included

`Behavior` - Included

`MethodWrapper` - Included

`Reporting` - Included

.new(deprecation_horizon = "7.2", gem_name = "Rails") ⇒ `Deprecation`