mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
10754f79f3
This allows deprecation messages to be matched by substring, symbol (treated as substring), or regular expression. If a warning is matched, the behaviors configured for disallowed deprecations will be used. The default behavior for disallowed deprecation warnings is `:raise`. Also adds `ActiveSupport::Deprecation.allow` for thread-local, block level ignoring of deprecation warnings which would otherwise be disallowed by ActiveSupport::Deprecation.disallowed_warnings.
51 lines
2 KiB
Ruby
51 lines
2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "singleton"
|
|
|
|
module ActiveSupport
|
|
# \Deprecation specifies the API used by Rails to deprecate methods, instance
|
|
# variables, objects and constants.
|
|
class Deprecation
|
|
# active_support.rb sets an autoload for ActiveSupport::Deprecation.
|
|
#
|
|
# If these requires were at the top of the file the constant would not be
|
|
# defined by the time their files were loaded. Since some of them reopen
|
|
# ActiveSupport::Deprecation its autoload would be triggered, resulting in
|
|
# a circular require warning for active_support/deprecation.rb.
|
|
#
|
|
# So, we define the constant first, and load dependencies later.
|
|
require "active_support/deprecation/instance_delegator"
|
|
require "active_support/deprecation/behaviors"
|
|
require "active_support/deprecation/reporting"
|
|
require "active_support/deprecation/disallowed"
|
|
require "active_support/deprecation/constant_accessor"
|
|
require "active_support/deprecation/method_wrappers"
|
|
require "active_support/deprecation/proxy_wrappers"
|
|
require "active_support/core_ext/module/deprecation"
|
|
require "concurrent/atomic/thread_local_var"
|
|
|
|
include Singleton
|
|
include InstanceDelegator
|
|
include Behavior
|
|
include Reporting
|
|
include Disallowed
|
|
include MethodWrapper
|
|
|
|
# The version number in which the deprecated behavior will be removed, by default.
|
|
attr_accessor :deprecation_horizon
|
|
|
|
# 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')
|
|
def initialize(deprecation_horizon = "6.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
|
|
@silenced_thread = Concurrent::ThreadLocalVar.new(false)
|
|
@explicitly_allowed_warnings = Concurrent::ThreadLocalVar.new(nil)
|
|
end
|
|
end
|
|
end
|