diff options
Diffstat (limited to 'activesupport/lib/active_support/deprecation/proxy_wrappers.rb')
| -rw-r--r-- | activesupport/lib/active_support/deprecation/proxy_wrappers.rb | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/activesupport/lib/active_support/deprecation/proxy_wrappers.rb b/activesupport/lib/active_support/deprecation/proxy_wrappers.rb index 2b8282c34e..17e69c34a5 100644 --- a/activesupport/lib/active_support/deprecation/proxy_wrappers.rb +++ b/activesupport/lib/active_support/deprecation/proxy_wrappers.rb @@ -27,14 +27,13 @@ module ActiveSupport # This DeprecatedObjectProxy transforms object to depracated object. # - # Example # @old_object = DeprecatedObjectProxy.new(Object.new, "Don't use this object anymore!") - # Example with custom deprecator # @old_object = DeprecatedObjectProxy.new(Object.new, "Don't use this object anymore!", deprecator_instance) # - # When someone execute any method expect +inspect+ on proxy object this will trigger +warn+ method on +deprecator_instance+ + # When someone execute any method expect +inspect+ on proxy object this will + # trigger +warn+ method on +deprecator_instance+. # - # Default deprecator is ActiveSupport::Deprecation + # Default deprecator is <tt>ActiveSupport::Deprecation</tt> class DeprecatedObjectProxy < DeprecationProxy def initialize(object, message, deprecator = ActiveSupport::Deprecation.instance) @object = object @@ -52,28 +51,30 @@ module ActiveSupport end end - # This DeprecatedInstanceVariableProxy transforms instance variable to depracated instance variable. + # This DeprecatedInstanceVariableProxy transforms instance variable to + # depracated instance variable. # - # Example - # class Example - # def initialize(deprecator) - # @request = ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :request, :@request, deprecator) - # @_request = :a_request - # end + # class Example + # def initialize(deprecator) + # @request = ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :request, :@request, deprecator) + # @_request = :a_request + # end # - # def request + # def request # @_request # end # - # def old_request + # def old_request # @request - # end - # end + # 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. + # 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 ActiveSupport::Deprecation + # Default deprecator is <tt>ActiveSupport::Deprecation</tt>. class DeprecatedInstanceVariableProxy < DeprecationProxy def initialize(instance, method, var = "@#{method}", deprecator = ActiveSupport::Deprecation.instance) @instance = instance @@ -94,13 +95,13 @@ module ActiveSupport # This DeprecatedConstantProxy transforms constant to depracated constant. # - # Example # OLD_CONST = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('OLD_CONST', 'NEW_CONST') - # Example with custom deprecator # OLD_CONST = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('OLD_CONST', 'NEW_CONST', deprecator_instance) - # When someone use old constant this will trigger +warn+ method on +deprecator_instance+ # - # Default deprecator is ActiveSupport::Deprecation + # When someone use old constant this will trigger +warn+ method on + # +deprecator_instance+. + # + # Default deprecator is <tt>ActiveSupport::Deprecation</tt>. class DeprecatedConstantProxy < DeprecationProxy def initialize(old_const, new_const, deprecator = ActiveSupport::Deprecation.instance) @old_const = old_const |