module Gem::Deprecate - RDoc Documentation

Public Class Methods

rubygems_deprecate(name, replacement=:none) click to toggle source

Simple deprecation method that deprecates name by wrapping it up in a dummy method. It warns on each call to the dummy method telling the user of repl (unless repl is :none) and the Rubygems version that it is planned to go away.

# File lib/rubygems/deprecate.rb, line 79
def rubygems_deprecate(name, replacement=:none)
  class_eval do
    old = "_deprecated_#{name}"
    alias_method old, name
    define_method name do |*args, &block|
      klass = self.kind_of? Module
      target = klass ? "#{self}." : "#{self.class}#"
      msg = [ "NOTE: #{target}#{name} is deprecated",
              replacement == :none ? " with no replacement" : "; use #{replacement} instead",
              ". It will be removed in Rubygems #{Gem::Deprecate.next_rubygems_major_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

rubygems_deprecate_command() click to toggle source

Deprecation method to deprecate Rubygems commands

# File lib/rubygems/deprecate.rb, line 99
def rubygems_deprecate_command
  class_eval do
    define_method "deprecated?" do
      true
    end

    define_method "deprecation_warning" do
      msg = [ "#{self.command} command is deprecated",
              ". It will be removed in Rubygems #{Gem::Deprecate.next_rubygems_major_version}.\n",
      ]

      alert_warning "#{msg.join}" unless Gem::Deprecate.skip
    end
  end
end

skip_during() { || ... } click to toggle source

Temporarily turn off warnings. Intended for tests only.

# File lib/rubygems/deprecate.rb, line 37
def skip_during
  Gem::Deprecate.skip, original = true, Gem::Deprecate.skip
  yield
ensure
  Gem::Deprecate.skip = original
end

Public Instance Methods

deprecate(name, repl, year, month) click to toggle source

Simple deprecation method that deprecates name by wrapping it up in a dummy method. It warns on each call to the dummy method telling the user of repl (unless repl is :none) and the year/month that it is planned to go away.

# File lib/rubygems/deprecate.rb, line 54
def deprecate(name, repl, year, month)
  class_eval do
    old = "_deprecated_#{name}"
    alias_method old, name
    define_method name do |*args, &block|
      klass = self.kind_of? Module
      target = klass ? "#{self}." : "#{self.class}#"
      msg = [ "NOTE: #{target}#{name} is deprecated",
              repl == :none ? " with no replacement" : "; use #{repl} instead",
              ". 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

Private Instance Methods