Class: ActiveSupport::Deprecation::DeprecatedConstantProxy

Inherits:
DeprecationProxy show all
Defined in:
activesupport/lib/active_support/deprecation/proxy_wrappers.rb

Overview

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"]

Instance Method Summary collapse

Methods inherited from DeprecationProxy

#inspect, new

Constructor Details

#initialize(old_const, new_const, deprecator = ActiveSupport::Deprecation.instance) ⇒ DeprecatedConstantProxy

Returns a new instance of DeprecatedConstantProxy.


124
125
126
127
128
# File 'activesupport/lib/active_support/deprecation/proxy_wrappers.rb', line 124

def initialize(old_const, new_const, deprecator = ActiveSupport::Deprecation.instance)
  @old_const = old_const
  @new_const = new_const
  @deprecator = deprecator
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActiveSupport::Deprecation::DeprecationProxy

Instance Method Details

#classObject

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

135
136
137
# File 'activesupport/lib/active_support/deprecation/proxy_wrappers.rb', line 135

def class
  target.class
end