Class: ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy

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

Overview

DeprecatedInstanceVariableProxy transforms an instance variable into a deprecated one. It takes an instance of a class, a method on that class, an instance variable, and a deprecator as the last argument.

Trying to use the deprecated instance variable will result in a deprecation warning, pointing to the method as a replacement.

class Example
  def initialize
    @request = ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :request, :@request, ActiveSupport::Deprecation.new)
    @_request = :special_request
  end

  def request
    @_request
  end

  def old_request
    @request
  end
end

example = Example.new
# => #<Example:0x007fb9b31090b8 @_request=:special_request, @request=:special_request>

example.old_request.to_s
# => DEPRECATION WARNING: @request is deprecated! Call request.to_s instead of
   @request.to_s
   (Backtrace information…)
   "special_request"

example.request.to_s
# => "special_request"

Instance Method Summary collapse

Methods inherited from DeprecationProxy

#inspect, new

Constructor Details

#initialize(instance, method, var = "@#{method}", deprecator = nil) ⇒ DeprecatedInstanceVariableProxy

Returns a new instance of DeprecatedInstanceVariableProxy.



89
90
91
92
93
94
95
 
# File 'activesupport/lib/active_support/deprecation/proxy_wrappers.rb', line 89

def initialize(instance, method, var = "@#{method}", deprecator = nil)
  @instance = instance
  @method = method
  @var = var
  ActiveSupport.deprecator.warn("DeprecatedInstanceVariableProxy without a deprecator is deprecated") unless deprecator
  @deprecator = deprecator || ActiveSupport::Deprecation._instance
end

Dynamic Method Handling

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