Come contrassegnare una classe come deprecata in Ruby?

Question

In Ruby (e ancora di più: Rails) È easy to mark methods as deprecated.

ma come posso segnare un'intera classe come deprecato? Voglio sollevare un avviso ogni volta che si utilizza una classe:

class BillingMethod 
end 

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

O quando viene utilizzato in eredità:

class Sofort < BillingMethod 
end 

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

Oppure, se usato in classi nidificate:

class BillingMethod::Sofort < BillingMethod 
end 

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

I penseremmo che un blocco-class_eval sarebbe il posto in cui attaccare un tale avvertimento. È il posto giusto? O ci sono metodi migliori?

Answer 1

È possibile utilizzare const_missing deprecare costanti, e, per estensione, le classi.

const_missing sia invocata quando un costante indefinito viene fatto riferimento.

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 

In questo modo il codice esistente che fa riferimento a MyModule::BillingMethod di continuare a lavorare, e avvisa l'utente circa il loro uso della classe deprecato.

E 'il migliore che ho visto finora al fine di classe di disapprovazione.

Answer 2

perché non farlo in questo modo:

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

Answer 3

Si consiglia di dare un'occhiata a Deprecate che fa parte della libreria standard di 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 

Utilizzando il metodo deprecated si tradurrebbe in un avvertimento come questo:

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.