Question

在Ruby中（甚至更多：Rails）它是easy to mark methods as deprecated。

但是如何将整个班级标记为已弃用？我想在每次使用课时发出警告：

class BillingMethod
end

BillingMethod.new #=> DEPRECATION WARNING: the class BillingMethod is deprecated. Use PaymentMethod instead.

或者在继承中使用它时：

class Sofort < BillingMethod
end

Sofort.new #=> DEPRECATION WARNING: the class BillingMethod is deprecated. Use PaymentMethod instead.

或者，在嵌套类中使用时：

class BillingMethod::Sofort < BillingMethod
end

BillingMethod::Sofort.new #=> DEPRECATION WARNING: the class BillingMethod is deprecated. Use PaymentMethod instead.

我认为class_eval - 块会成为发出警告的地方。这是正确的地方吗？或者有更好的方法吗？

Answer 1

您可能想看看Deprecate，这是Ruby标准库的一部分：

class BillingMethod
  extend Gem::Deprecate

  class << self
    deprecate :new, "PaymentMethod.new", 2016, 4
  end

  # Will be removed April 2016, use `PaymentMethod.new` instead
  def initialize 
    #...
  end
end

使用deprecated方法会产生如下警告：

BillingMethod.new
# => NOTE: BillingMethod#new is deprecated; use PaymentMethod.new instead. It will be removed on or after 2016-04-01.
# => BillingMethod#new called from file_name.rb:32.

Answer 2

您可以使用const_missing来弃用常量，并通过扩展来弃用类。

当引用未定义的常量时，将调用

const_missing。

module MyModule

  class PaymentMethod
    # ...
  end

  def self.const_missing(const_name)
    super unless const_name == :BillingMethod
    warn "DEPRECATION WARNING: the class MyModule::BillingMethod is deprecated. Use MyModule::PaymentMethod instead."
    PaymentMethod
  end
end

这允许引用MyModule::BillingMethod的现有代码继续工作，并警告用户他们使用已弃用的类。

这是我迄今为止因弃用课程目的而见过的最好的。

Answer 3

为什么不这样做：

def initialize(*args)
  warn "DEPRECATION WARNING: ..."
  super
end

如何在Ruby中将类标记为Deprecated？

3 个答案: