mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
71993c6f97
ActiveSupport::Deprecation is now a class rather than a module. You can
get instance of ActiveSupport::Deprecation calling #instance method.
ActiveSupport::Deprecation.instance
But when you need to get new object od ActiveSupport::Deprecation you
need to just call #new.
@instance = ActiveSupport::Deprecation.new
Since you can create a new object, you can change the version and the
name of the library where the deprecator concerned.
ActiveSupport::Deprecation.new('2.0', 'MyGem')
If you need use another deprecator instance you can select it in the
options of deprecate method.
deprecate :method, :deprecator => deprecator_instance
Documentation has been updated.
63 lines
2.2 KiB
Ruby
63 lines
2.2 KiB
Ruby
require "active_support/notifications"
|
|
|
|
module ActiveSupport
|
|
class Deprecation
|
|
# Default warning behaviors per Rails.env.
|
|
DEFAULT_BEHAVIORS = {
|
|
:stderr => Proc.new { |message, callstack|
|
|
$stderr.puts(message)
|
|
$stderr.puts callstack.join("\n ") if debug
|
|
},
|
|
:log => Proc.new { |message, callstack|
|
|
logger =
|
|
if defined?(Rails) && 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 => Proc.new { |message, callstack|
|
|
ActiveSupport::Notifications.instrument("deprecation.rails",
|
|
:message => message, :callstack => callstack)
|
|
},
|
|
:silence => Proc.new { |message, callstack| }
|
|
}
|
|
|
|
module Behavior
|
|
# Whether to print a backtrace along with the warning.
|
|
attr_accessor :debug
|
|
|
|
# Returns the current behavior or if one isn't set, defaults to +:stderr+
|
|
def behavior
|
|
@behavior ||= [DEFAULT_BEHAVIORS[:stderr]]
|
|
end
|
|
|
|
# Sets the behavior to the specified value. Can be a single value, array, or
|
|
# an object that responds to +call+.
|
|
#
|
|
# Available behaviors:
|
|
#
|
|
# [+stderr+] Log all deprecation warnings to +$stderr+.
|
|
# [+log+] Log all deprecation warnings to +Rails.logger+.
|
|
# [+notify+] Use +ActiveSupport::Notifications+ to notify +deprecation.rails+.
|
|
# [+silence+] Do nothing.
|
|
#
|
|
# Setting behaviors only affects deprecations that happen after boot time.
|
|
# Deprecation warnings raised by gems are not affected by this setting because
|
|
# they happen before Rails boots up.
|
|
#
|
|
# ActiveSupport::Deprecation.behavior = :stderr
|
|
# ActiveSupport::Deprecation.behavior = [:stderr, :log]
|
|
# ActiveSupport::Deprecation.behavior = MyCustomHandler
|
|
# ActiveSupport::Deprecation.behavior = proc { |message, callstack|
|
|
# # custom stuff
|
|
# }
|
|
def behavior=(behavior)
|
|
@behavior = Array(behavior).map { |b| DEFAULT_BEHAVIORS[b] || b }
|
|
end
|
|
end
|
|
end
|
|
end
|