class Spree::DeprecatedInstanceVariableProxy

This DeprecatedInstanceVariableProxy transforms instance variable to deprecated instance variable.

It differs from ActiveSupport::DeprecatedInstanceVariableProxy since it allows to define a custom message.

class Example
  def initialize(deprecator)
    @request = Spree::DeprecatedInstanceVariableProxy.new(self, :request, :@request, deprecator, "Please, do not use this thing.")
    @_request = :a_request
  end

  def request
    @_request
  end

  def old_request
    @request
  end
end

When someone execute any method on @request variable this will trigger warn method on deprecator_instance and will fetch @_request variable via request method and execute the same method on non-proxy instance variable.

Default deprecator is Spree::Deprecation.

Public Class Methods

new(instance, method, var = "@ click to toggle source
# File lib/spree/deprecation.rb, line 36
def initialize(instance, method, var = "@#{method}", deprecator = Spree::Deprecation, message = nil)
  @instance = instance
  @method = method
  @var = var
  @deprecator = deprecator
  @message = message
end

Private Instance Methods

target() click to toggle source
# File lib/spree/deprecation.rb, line 46
def target
  @instance.__send__(@method)
end
warn(callstack, called, args) click to toggle source
# File lib/spree/deprecation.rb, line 50
def warn(callstack, called, args)
  message = @message || "#{@var} is deprecated! Call #{@method}.#{called} instead of #{@var}.#{called}."
  message = [message, "Args: #{args.inspect}"].join(" ")

  @deprecator.warn(message, callstack)
end