2010-06-29 15:18:17 -04:00
|
|
|
require "active_support/notifications"
|
|
|
|
|
2009-04-18 00:29:30 -04:00
|
|
|
module ActiveSupport
|
2013-08-12 19:23:21 -04:00
|
|
|
class DeprecationException < StandardError
|
|
|
|
end
|
|
|
|
|
2012-09-13 02:38:34 -04:00
|
|
|
class Deprecation
|
2010-06-29 15:18:17 -04:00
|
|
|
# Default warning behaviors per Rails.env.
|
2009-04-18 00:29:30 -04:00
|
|
|
DEFAULT_BEHAVIORS = {
|
2013-08-12 19:38:48 -04:00
|
|
|
raise: ->(message, callstack) {
|
2013-08-12 19:23:21 -04:00
|
|
|
e = DeprecationException.new(message)
|
|
|
|
e.set_backtrace(callstack)
|
|
|
|
raise e
|
|
|
|
},
|
|
|
|
|
|
|
|
stderr: ->(message, callstack) {
|
2011-07-25 15:05:06 -04:00
|
|
|
$stderr.puts(message)
|
|
|
|
$stderr.puts callstack.join("\n ") if debug
|
|
|
|
},
|
2013-08-12 19:23:21 -04:00
|
|
|
|
|
|
|
log: ->(message, callstack) {
|
2012-09-13 02:38:34 -04:00
|
|
|
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
|
|
|
|
},
|
2013-08-12 19:23:21 -04:00
|
|
|
|
|
|
|
notify: ->(message, callstack) {
|
2012-09-13 02:38:34 -04:00
|
|
|
ActiveSupport::Notifications.instrument("deprecation.rails",
|
|
|
|
:message => message, :callstack => callstack)
|
|
|
|
},
|
2013-08-12 19:23:21 -04:00
|
|
|
|
|
|
|
silence: ->(message, callstack) {},
|
2009-04-18 00:29:30 -04:00
|
|
|
}
|
2012-09-13 02:38:34 -04:00
|
|
|
|
|
|
|
module Behavior
|
|
|
|
# Whether to print a backtrace along with the warning.
|
|
|
|
attr_accessor :debug
|
|
|
|
|
2012-09-14 23:28:56 -04:00
|
|
|
# Returns the current behavior or if one isn't set, defaults to +:stderr+.
|
2012-09-13 02:38:34 -04:00
|
|
|
def behavior
|
|
|
|
@behavior ||= [DEFAULT_BEHAVIORS[:stderr]]
|
|
|
|
end
|
|
|
|
|
2012-09-14 23:28:56 -04:00
|
|
|
# Sets the behavior to the specified value. Can be a single value, array,
|
|
|
|
# or an object that responds to +call+.
|
2012-09-13 02:38:34 -04:00
|
|
|
#
|
|
|
|
# Available behaviors:
|
|
|
|
#
|
2013-08-12 19:38:48 -04:00
|
|
|
# [+raise+] Raise <tt>ActiveSupport::DeprecationException</tt>.
|
2012-09-13 02:38:34 -04:00
|
|
|
# [+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.
|
2012-09-14 23:28:56 -04:00
|
|
|
# Deprecation warnings raised by gems are not affected by this setting
|
|
|
|
# because they happen before Rails boots up.
|
2012-09-13 02:38:34 -04:00
|
|
|
#
|
|
|
|
# ActiveSupport::Deprecation.behavior = :stderr
|
|
|
|
# ActiveSupport::Deprecation.behavior = [:stderr, :log]
|
|
|
|
# ActiveSupport::Deprecation.behavior = MyCustomHandler
|
2013-08-12 19:23:21 -04:00
|
|
|
# ActiveSupport::Deprecation.behavior = ->(message, callstack) {
|
2012-09-13 02:38:34 -04:00
|
|
|
# # custom stuff
|
|
|
|
# }
|
|
|
|
def behavior=(behavior)
|
|
|
|
@behavior = Array(behavior).map { |b| DEFAULT_BEHAVIORS[b] || b }
|
|
|
|
end
|
|
|
|
end
|
2009-04-18 00:29:30 -04:00
|
|
|
end
|
|
|
|
end
|