Best Practice, um veralteten Code in Ruby zu markieren?

Question

Ich möchte eine Methode als veraltet markieren, damit Benutzer, die sie verwenden, ihren Code einfach überprüfen und aufholen können. In Java setzen Sie @Deprecated und jeder weiß, was das bedeutet.

Gibt es also einen bevorzugten Weg (oder sogar Tools) zu markieren und auf Abwertungen in Ruby zu überprüfen?

Answer 1

Für fast alle Fälle, abhängig von einer Bibliothek oder Metaprogrammierung für eine Abwertung ist Overkill. Fügen Sie einfach einen Kommentar zum rdoc hinzu und rufen Sie die Methode Kernel#warn auf. Zum Beispiel:

class 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 

---

Wenn Sie mit Yard statt rdoc, sollte Ihr doc Kommentar wie folgt aussehen:

# @deprecated Please use {#useful} instead 

Schließlich, wenn Sie zu tomdoc halten, um Ihren Kommentar Look wie folgt:

# Deprecated: Please use `useful` instead 

Veraltet: Gibt an, dass die Methode veraltet ist und in einer zukünftigen Version entfernt wird. Sie sollten dies verwenden, um Methoden zu dokumentieren, die öffentlich waren, aber bei der nächsten Hauptversion entfernt werden.

---

Auch vergessen Sie nicht, die veraltete Methode in einem zukünftigen (und richtig semver ‚d) lösen zu entfernen. Machen Sie nicht die gleichen Fehler wie die Java-Bibliotheken.

Answer 2

Sie haben libdeprecated-ruby (2010-2012 Buch nicht rubygem in 2015)

Eine kleine Bibliothek sollte Entwickler mit veraltetem Code arbeiten unterstützen.
Die Idee stammt aus der Programmiersprache '', in der Entwickler bestimmten Code als veraltet markieren und dann die Ausführung von veraltetem Code zulassen/verbieten können.

Answer 3

Wenn Sie bösartig sein wollen (unter dem Vorwand, hilfreich zu sein), können Sie während einer Warnung die erste Zeile des Callstacks ausdrucken, damit die Entwickler wissen, wo sie einen veralteten Anruf verwenden.

Das ist gemein, weil Ich bin mir ziemlich sicher, dass es ein Performance-Hit ist.

warn Kernel.caller.first + " whatever deprecation message here" 

Bei richtiger Anwendung, wird dies den absoluten Pfad zu der Datei und Zeile enthalten, in dem die veralteten Aufruf verwendet wurde. Weitere Informationen über Kernel :: Anrufer ist verfügbar here

Answer 4

Canivete ist ein Juwel, mit dem Sie Ihre Methoden auf einfache und elegante Weise ablehnen können. Ein wenig mehr darüber here.

Answer 5

Sie können Klasse Macros Muster verwenden und so etwas schreiben:

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 

Answer 6

Wenn Schienen verwenden, können Sie das Modul # deprecate Methode haben.

Answer 7

Sie können auch ActiveSupport::Deprecation (in der Version 4.0 oder höher) verwenden, wie zum Beispiel:

require '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) 

Answer 8

Ruby-Standardbibliothek ein Modul mit der Warnung Logik: http://ruby-doc.org/stdlib-1.9.3/libdoc/rubygems/rdoc/Gem/Deprecate.html. Ich neige dazu, es zu bevorzugen meine deprecation Nachrichten in einer „Standard“ Art und Weise zu erhalten:

# 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. 

Beachten Sie, dass mit diesem Ansatz, den Sie kostenlos Informationen gewinnen, wo der Anruf stattfand.

Answer 9

Ich landete ein leichtes Verfahren werfen zusammen:

def deprecate(msg) 
    method = caller_locations(1, 1).first.label 
    source = caller(2, 1).first 
    warn "#{method} is deprecated: #{msg}\ncalled at #{source}" 
end 

Dann, ein Verfahren verbitten einen Anruf bei dem Verfahren Körper einsetzen (oder einen Konstruktor für eine Klasse)

def foo 
    deprecate 'prefer bar, will be removed in version 3' 
    ... 
end 

Es ist ziemlich deklarative und bietet Protokollierung mit relevanten Informationen. Ich bin nicht viel von einem Rubyist, also kann es etwas zwicken/YMMV benötigen.

Answer 10

Mit Active:

class Player < ActiveRecord::Base 
    def to_s 
    ActiveSupport::Deprecation.warn('Use presenter instead') 
    partner_uid 
    end 
end 

Warnungen werden in der Produktionsumgebung standardmäßig