class ActiveSupport::Deprecation::DeprecatedConstantProxy
DeprecatedConstantProxy
transforms a constant into a deprecated one. It takes the names of an old (deprecated) constant and of a new constant (both in string form) and optionally a deprecator. The deprecator defaults to ActiveSupport::Deprecator
if none is specified. The deprecated constant now returns the value of the new one.
PLANETS = %w(mercury venus earth mars jupiter saturn uranus neptune pluto) # (In a later update, the original implementation of `PLANETS` has been removed.) PLANETS_POST_2006 = %w(mercury venus earth mars jupiter saturn uranus neptune) PLANETS = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('PLANETS', 'PLANETS_POST_2006') PLANETS.map { |planet| planet.capitalize } # => DEPRECATION WARNING: PLANETS is deprecated! Use PLANETS_POST_2006 instead. (Backtrace information…) ["Mercury", "Venus", "Earth", "Mars", "Jupiter", "Saturn", "Uranus", "Neptune"]
Public Class Methods
new(*args, **options, &block)
click to toggle source
Calls superclass method
# File lib/active_support/deprecation/proxy_wrappers.rb, line 124 def self.new(*args, **options, &block) object = args.first return object unless object super end
new(old_const, new_const, deprecator = ActiveSupport::Deprecation.instance, message: "
click to toggle source
# File lib/active_support/deprecation/proxy_wrappers.rb, line 131 def initialize(old_const, new_const, deprecator = ActiveSupport::Deprecation.instance, message: "#{old_const} is deprecated! Use #{new_const} instead.") Kernel.require "active_support/inflector/methods" @old_const = old_const @new_const = new_const @deprecator = deprecator @message = message end
Public Instance Methods
class()
click to toggle source
Returns the class of the new constant.
PLANETS_POST_2006 = %w(mercury venus earth mars jupiter saturn uranus neptune) PLANETS = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('PLANETS', 'PLANETS_POST_2006') PLANETS.class # => Array
# File lib/active_support/deprecation/proxy_wrappers.rb, line 157 def class target.class end
inspect()
click to toggle source
Don't give a deprecation warning on inspect since test/unit and error logs rely on it for diagnostics.
# File lib/active_support/deprecation/proxy_wrappers.rb, line 144 def inspect target.inspect end
Private Instance Methods
const_missing(name)
click to toggle source
# File lib/active_support/deprecation/proxy_wrappers.rb, line 166 def const_missing(name) @deprecator.warn(@message, caller_locations) target.const_get(name) end
method_missing(called, *args, &block)
click to toggle source
# File lib/active_support/deprecation/proxy_wrappers.rb, line 171 def method_missing(called, *args, &block) @deprecator.warn(@message, caller_locations) target.__send__(called, *args, &block) end
target()
click to toggle source
# File lib/active_support/deprecation/proxy_wrappers.rb, line 162 def target ActiveSupport::Inflector.constantize(@new_const.to_s) end