我想将一个方法标记为已弃用，以便使用它的人可以轻松检查他们的代码并跟上。在 Java 中，你设置了 @Deprecated，每个人都知道这意味着什么。
那么有没有一种首选方法（甚至工具）来标记和检查 Ruby 中的弃用？
对于几乎所有情况，依赖库或元编程来弃用是过度的。只需向 rdoc 添加注释并调用
Kernel#warnclass Foo
# <b>DEPRECATED:</b> Please use <tt>useful</tt> instead.
def useless
warn "[DEPRECATION] `useless` is deprecated. Please use `useful` instead."
useful
end
def useful
# ...
end
end
如果您使用 Yard 而不是 rdoc，您的文档注释应如下所示：
# @deprecated Please use {#useful} instead
最后，如果您坚持tomdoc，请使您的评论如下所示：
# Deprecated: Please use `useful` instead
Deprecated：表示该方法已被弃用，并将在未来版本中删除。您应该使用它来记录公共方法，但将在下一个主要版本中删除。
另外，不要忘记在未来的某个版本（并且正确地semver'd）中删除已弃用的方法。不要犯 Java 库所犯的同样错误。
Ruby 标准库有一个带有警告逻辑的模块：https://ruby-doc.org/core-3.1.2/Gem/Deprecate.html。我倾向于更喜欢它以“标准”方式维护我的弃用消息：
# my_file.rb
class MyFile
extend Gem::Deprecate
def no_more
close
end
deprecate :no_more, :close, 2015, 5
def close
# new logic here
end
end
MyFile.new.no_more
# => NOTE: MyFile#no_more is deprecated; use close instead. It will be removed on or after 2015-05-01.
# => MyFile#no_more called from my_file.rb:16.
请注意，通过这种方法，您将免费获得有关通话地点的信息。
使用
ActiveSupportclass Player < ActiveRecord::Base
def to_s
ActiveSupport::Deprecation.warn('Use presenter instead')
partner_uid
end
end
生产环境默认关闭警告。
如果你想表现得刻薄（打着乐于助人的幌子），你可以在警告期间打印出调用堆栈的第一行，让开发人员知道他们在哪里使用了已弃用的调用。
这很卑鄙，因为我很确定这会影响性能。
warn Kernel.caller.first + " whatever deprecation message here"
正确使用时，这将包括文件的绝对路径以及使用已弃用调用的行。有关 Kernel::caller 的更多信息请参见此处
您还可以使用
ActiveSupport::Deprecationrequire 'active_support/deprecation'
require 'active_support/core_ext/module/deprecation'
class MyGem
def self.deprecator
ActiveSupport::Deprecation.new('2.0', 'MyGem')
end
def old_method
end
def new_method
end
deprecate old_method: :new_method, deprecator: deprecator
end
MyGem.new.old_method
# => DEPRECATION WARNING: old_method is deprecated and will be removed from MyGem 2.0 (use new_method instead). (called from <main> at file.rb:18)
libdeprecated-ruby一个小型库，旨在帮助开发人员使用已弃用的代码。
这个想法来自“
Drequire 'lib/deprecated.rb'
require 'test/unit'
# this class is used to test the deprecate functionality
class DummyClass
def monkey
return true
end
deprecate :monkey
end
# we want exceptions for testing here.
Deprecate.set_action(:throw)
class DeprecateTest < Test::Unit::TestCase
def test_set_action
assert_raise(DeprecatedError) { raise StandardError.new unless DummyClass.new.monkey }
Deprecate.set_action(proc { |msg| raise DeprecatedError.new("#{msg} is deprecated.") })
assert_raise(DeprecatedError) { raise StandardError.new unless DummyClass.new.monkey }
# set to warn and make sure our return values are getting through.
Deprecate.set_action(:warn)
assert_nothing_raised(DeprecatedError) { raise StandardError.new unless DummyClass.new.monkey }
end
end
您可以使用类宏模式并编写如下内容：
class Module
def deprecate(old_method, new_method)
define_method(old_method) do |*args, &block|
warn "Method #{old_method}() depricated. Use #{new_method}() instead"
send(new_method, *args, &block)
end
end
end
class Test
def my_new_method
p "My method"
end
deprecate :my_old_method, :my_method
end
使用 Rails 时，您可以使用 Module#deprecate 方法。
我最终组合了一个轻量级方法：
def deprecate(msg)
method = caller_locations(1, 1).first.label
source = caller(2, 1).first
warn "#{method} is deprecated: #{msg}\ncalled at #{source}"
end
然后要弃用方法，请在方法主体中插入调用（或类的构造函数）
def foo
deprecate 'prefer bar, will be removed in version 3'
...
end
它具有相当的声明性，并提供相关信息的日志记录。我不太喜欢 Rubyist，所以可能需要一些调整/YMMV。
我们可以使用内部宏方法。 示例：
class Foo
def get_a; puts "I'm an A" end
def get_b; puts "I'm an B" end
def get_c; puts "I'm an C" enddef self.deprecate(old_method, new_method)
define_method(old_method) do |*args, &block|
puts "Warning: #{old_method} is deprecated! Use #{new_method} instead"
send(new_method, *args, &block)
结束 结束
弃用 :a, :get_a 弃用 :b, :get_b 弃用 :c, :get_c 结束
o = Foo.new p o.a