Sha256: cd58265321621717217a77d6f5fd8083ee0911b95186661d8f6d109ffaadc625

Contents?: true

Size: 1.68 KB

Versions: 33

Compression:

Stored size: 1.68 KB

Contents

# frozen_string_literal: true

require 'active_support/deprecation'

module Spree
  Deprecation = ActiveSupport::Deprecation.new('3.0', 'Solidus')

  # 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 <tt>@_request</tt>
  # variable via +request+ method and execute the same method on non-proxy
  # instance variable.
  #
  # Default deprecator is <tt>Spree::Deprecation</tt>.
  class DeprecatedInstanceVariableProxy < ActiveSupport::Deprecation::DeprecationProxy
    def initialize(instance, method, var = "@#{method}", deprecator = Spree::Deprecation, message = nil)
      @instance = instance
      @method = method
      @var = var
      @deprecator = deprecator
      @message = message
    end

    private

    def target
      @instance.__send__(@method)
    end

    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
  end
end

Version data entries

33 entries across 33 versions & 1 rubygems

Version Path
solidus_core-2.11.17 lib/spree/deprecation.rb
solidus_core-2.11.16 lib/spree/deprecation.rb
solidus_core-2.11.15 lib/spree/deprecation.rb
solidus_core-2.11.14 lib/spree/deprecation.rb
solidus_core-2.11.13 lib/spree/deprecation.rb
solidus_core-2.11.12 lib/spree/deprecation.rb
solidus_core-2.11.11 lib/spree/deprecation.rb
solidus_core-2.10.5 lib/spree/deprecation.rb
solidus_core-2.11.10 lib/spree/deprecation.rb
solidus_core-2.11.9 lib/spree/deprecation.rb
solidus_core-2.11.8 lib/spree/deprecation.rb
solidus_core-2.11.7 lib/spree/deprecation.rb
solidus_core-2.11.6 lib/spree/deprecation.rb
solidus_core-3.0.0.rc2 lib/spree/deprecation.rb
solidus_core-2.11.5 lib/spree/deprecation.rb
solidus_core-2.11.4 lib/spree/deprecation.rb
solidus_core-2.11.3 lib/spree/deprecation.rb
solidus_core-2.11.2 lib/spree/deprecation.rb
solidus_core-2.11.1 lib/spree/deprecation.rb
solidus_core-2.10.3 lib/spree/deprecation.rb