Class: ActiveSupport::Deprecation

Relationships & Source Files
Namespace Children
Modules: Behavior, MethodWrapper, Reporting
Classes: DeprecatedConstantProxy, DeprecatedInstanceVariableProxy, DeprecatedObjectProxy
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, MethodWrapper, Reporting, Behavior, Singleton
Inherits:	Object
Defined in:	activesupport/lib/active_support/deprecation.rb, activesupport/lib/active_support/deprecation/behaviors.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.

Constant Summary

DEFAULT_BEHAVIORS =

Default warning behaviors per Rails.env.

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

{
  raise: ->(message, callstack) {
    e = DeprecationException.new(message)
    e.set_backtrace(callstack)
    raise e
  },

  stderr: ->(message, callstack) {
    $stderr.puts(message)
    $stderr.puts callstack.join("\n  ") if debug
  },

  log: ->(message, callstack) {
    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 debug
  },

  notify: ->(message, callstack) {
    ActiveSupport::Notifications.instrument("deprecation.rails",
                                            :message => message, :callstack => callstack)
  },

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

Class Method Summary

.new(deprecation_horizon = '5.0', 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.

Reporting - Included

#gem_name	Name of gem where method is deprecated.
#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.

Instance Method Summary

MethodWrapper - Included

#deprecate_methods

Declare that a method has been deprecated.

Reporting - Included

#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 = '5.0', 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 35


def initialize(deprecation_horizon = '5.0', 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
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 29


attr_accessor :deprecation_horizon

Class: ActiveSupport::Deprecation

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Reporting - Included

Behavior - Included

Instance Method Summary

MethodWrapper - Included

Reporting - Included

Constructor Details

.new(deprecation_horizon = '5.0', gem_name = 'Rails') ⇒ Deprecation

Instance Attribute Details

#deprecation_horizon (rw)

.new(deprecation_horizon = '5.0', gem_name = 'Rails') ⇒ `Deprecation`