Class: Spree::DeprecatedInstanceVariableProxy

Inherits:
ActiveSupport::Deprecation::DeprecationProxy
  • Object
show all
Defined in:
core/lib/spree/deprecation.rb

Overview

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.

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DeprecatedInstanceVariableProxy



36
37
38
39
40
41
42
# File 'core/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