module Gem::Deprecate
Bietet 3 Methoden, um zu deklarieren, wann etwas abgeschafft wird.
deprecate(name, repl, year, month):
Indicate something may be removed on/after a certain date.
rubygems_deprecate(name, replacement=:none):
Indicate something will be removed in the next major RubyGems version, and (optionally) a replacement for it.
Indicate a RubyGems command (in +lib/rubygems/commands/*.rb+) will be removed in the next RubyGems version.
Bietet auch skip_during zum vorübergehenden Deaktivieren von Deprecation-Warnungen. Dies ist für die Testsuite gedacht, damit Deprecation-Warnungen keine Testfehler verursachen, wenn Sie sicherstellen müssen, dass stderr ansonsten leer ist.
Beispielverwendung von deprecate und rubygems_deprecate
class Legacy def self.some_class_method # ... end def some_instance_method # ... end def some_old_method # ... end extend Gem::Deprecate deprecate :some_instance_method, "X.z", 2011, 4 rubygems_deprecate :some_old_method, "Modern#some_new_method" class << self extend Gem::Deprecate deprecate :some_class_method, :none, 2011, 4 end end
Beispielverwendung von rubygems_deprecate_command
class Gem::Commands::QueryCommand < Gem::Command extend Gem::Deprecate rubygems_deprecate_command # ... end
Beispielverwendung von skip_during
class TestSomething < Gem::Testcase def test_some_thing_with_deprecations Gem::Deprecate.skip_during do actual_stdout, actual_stderr = capture_output do Gem.something_deprecated end assert_empty actual_stdout assert_equal(expected, actual_stderr) end end end
Öffentliche Klassenmethoden
Source
# File lib/rubygems/deprecate.rb, line 129 def rubygems_deprecate(name, replacement = :none, version = nil) class_eval do old = "_deprecated_#{name}" alias_method old, name define_method name do |*args, &block| klass = is_a? Module target = klass ? "#{self}." : "#{self.class}#" version ||= Gem::Deprecate.next_rubygems_major_version msg = [ "NOTE: #{target}#{name} is deprecated", replacement == :none ? " with no replacement" : "; use #{replacement} instead", ". It will be removed in Rubygems #{version}", "\n#{target}#{name} called from #{Gem.location_of_caller.join(":")}", ] warn "#{msg.join}." unless Gem::Deprecate.skip send old, *args, &block end ruby2_keywords name if respond_to?(:ruby2_keywords, true) end end
Einfache Deprecation-Methode, die name durch Verpacken in eine Dummy-Methode deprecated. Sie warnt bei jedem Aufruf der Dummy-Methode und informiert den Benutzer über repl (es sei denn, repl ist :none) und die Rubygems-Version, dass sie abgeschafft werden soll.
Source
# File lib/rubygems/deprecate.rb, line 151 def rubygems_deprecate_command(version = nil) class_eval do define_method "deprecated?" do true end define_method "deprecation_warning" do version ||= Gem::Deprecate.next_rubygems_major_version msg = [ "#{command} command is deprecated", ". It will be removed in Rubygems #{version}.\n", ] alert_warning msg.join.to_s unless Gem::Deprecate.skip end end end
Deprecation-Methode zur Deprecating von Rubygems-Befehlen
Source
# File lib/rubygems/deprecate.rb, line 85 def skip_during original = Gem::Deprecate.skip Gem::Deprecate.skip = true yield ensure Gem::Deprecate.skip = original end
Warnungen vorübergehend deaktivieren. Nur für Tests vorgesehen.
Öffentliche Instanzmethoden
Source
# File lib/rubygems/deprecate.rb, line 103 def deprecate(name, repl, year, month) class_eval do old = "_deprecated_#{name}" alias_method old, name define_method name do |*args, &block| klass = is_a? Module target = klass ? "#{self}." : "#{self.class}#" msg = [ "NOTE: #{target}#{name} is deprecated", repl == :none ? " with no replacement" : "; use #{repl} instead", format(". It will be removed on or after %4d-%02d.", year, month), "\n#{target}#{name} called from #{Gem.location_of_caller.join(":")}", ] warn "#{msg.join}." unless Gem::Deprecate.skip send old, *args, &block end ruby2_keywords name if respond_to?(:ruby2_keywords, true) end end
Einfache Deprecation-Methode, die name durch Verpacken in eine Dummy-Methode deprecated. Sie warnt bei jedem Aufruf der Dummy-Methode und informiert den Benutzer über repl (es sei denn, repl ist :none) und das Jahr/Monat, dass sie abgeschafft werden soll.
Private Instanzmethoden
Source
# File lib/rubygems/deprecate.rb, line 129 def rubygems_deprecate(name, replacement = :none, version = nil) class_eval do old = "_deprecated_#{name}" alias_method old, name define_method name do |*args, &block| klass = is_a? Module target = klass ? "#{self}." : "#{self.class}#" version ||= Gem::Deprecate.next_rubygems_major_version msg = [ "NOTE: #{target}#{name} is deprecated", replacement == :none ? " with no replacement" : "; use #{replacement} instead", ". It will be removed in Rubygems #{version}", "\n#{target}#{name} called from #{Gem.location_of_caller.join(":")}", ] warn "#{msg.join}." unless Gem::Deprecate.skip send old, *args, &block end ruby2_keywords name if respond_to?(:ruby2_keywords, true) end end
Einfache Deprecation-Methode, die name durch Verpacken in eine Dummy-Methode deprecated. Sie warnt bei jedem Aufruf der Dummy-Methode und informiert den Benutzer über repl (es sei denn, repl ist :none) und die Rubygems-Version, dass sie abgeschafft werden soll.
Source
# File lib/rubygems/deprecate.rb, line 151 def rubygems_deprecate_command(version = nil) class_eval do define_method "deprecated?" do true end define_method "deprecation_warning" do version ||= Gem::Deprecate.next_rubygems_major_version msg = [ "#{command} command is deprecated", ". It will be removed in Rubygems #{version}.\n", ] alert_warning msg.join.to_s unless Gem::Deprecate.skip end end end
Deprecation-Methode zur Deprecating von Rubygems-Befehlen
Source
# File lib/rubygems/deprecate.rb, line 85 def skip_during original = Gem::Deprecate.skip Gem::Deprecate.skip = true yield ensure Gem::Deprecate.skip = original end
Warnungen vorübergehend deaktivieren. Nur für Tests vorgesehen.