Rails 自定义弃用通知

Question

有没有办法为我计划删除并想要记录其使用情况的应用程序中的方法和/或关联创建自定义弃用通知？我的一个模型中有一个关系，我不想继续使用它，并计划稍后重构代码。我想在每次调用该方法时在我的开发日志中创建一个通知。

我在 Ruby/Rails 中看到了使用某些方法时的弃用通知，并且认为必须有一种简单的方法来做到这一点。

像...

irb(main):001:0> 1.id
(irb):1: warning: Object#id will be deprecated; use Object#object_id
=> 3

Answer 1

在 Rails 3 中，您可以使用：ActiveSupport 中的“deprecate”方法：

class Example
  def foo
  end

  deprecate :foo
end

它将为您的方法创建一个别名并输出带有堆栈跟踪的警告。您还可以直接使用此功能的一部分，例如：

ActiveSupport::Deprecation.warn("Message")

它将随消息一起输出堆栈跟踪。

Answer 2

也许：

def old_relationship
  warn "[DEPRECATION] old_relationship is deprecated."
  @old_relationship
end

def old_relationship=(object)
  warn "[DEPRECATION] old_relationship is deprecated."
  @old_relationship = object
end

对于一段关系来说，有些类似的东西。

Answer 3

在大多数情况下，您只需发出警告并调用新方法即可。

class Example
  # <b>DEPRECATED:</b> Please use <tt>good_method</tt> instead.
  def bad_method
    warn "`bad_method` is deprecated. Use `good_method` instead."
    good_method
  end

  def good_method
    # ...
  end
end

如果您需要或想要变得更高级，可以使用库或元编程，但总的来说，这不是实现如此简单的事情的好方法。您应该有充分的理由为如此简单的东西引入依赖项。

Answer 4

添加我的 2 美分：

如果您使用 Yard 而不是 rdoc，您的文档注释应如下所示：

# @deprecated Please use {#useful} instead

最后，如果您遵守 tomdoc，让您的评论如下所示：

# Deprecated: Please use `useful` instead

已弃用：表示该方法已弃用，并将在未来版本中删除。您应该使用它来记录公共方法，但将在下一个主要版本中删除。