Module: Gem::Deprecate

Included in:
BasicSpecification, Commands::QueryCommand, Commands::ServerCommand, DependencyInstaller, Installer, Specification, StreamUI, TestCase, Util
Defined in:
lib/rubygems/deprecate.rb

Overview

Provides a single method deprecate to be used to declare when something is going away.

class Legacy
  def self.klass_method
    # ...
  end

  def instance_method
    # ...
  end

  extend Gem::Deprecate
  deprecate :instance_method, "X.z", 2011, 4

  class << self
    extend Gem::Deprecate
    deprecate :klass_method, :none, 2011, 4
  end
end

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.next_rubygems_major_version ⇒ Object

:nodoc:



44
45
46
 
# File 'lib/rubygems/deprecate.rb', line 44

def self.next_rubygems_major_version # :nodoc:
  Gem::Version.new(Gem.rubygems_version.segments.first).bump
end

.rubygems_deprecate(name, replacement = :none) ⇒ Object

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.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# 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 ⇒ Object

Deprecation method to deprecate Rubygems commands



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# 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 ⇒ Object

:nodoc:



26
27
28
 
# File 'lib/rubygems/deprecate.rb', line 26

def self.skip # :nodoc:
  @skip ||= false
end

.skip=(v) ⇒ Object

:nodoc:



30
31
32
 
# File 'lib/rubygems/deprecate.rb', line 30

def self.skip=(v) # :nodoc:
  @skip = v
end

.skip_during ⇒ Object

Temporarily turn off warnings. Intended for tests only.



37
38
39
40
41
42
 
# 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

Instance Method Details

#deprecate(name, repl, year, month) ⇒ Object

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.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# 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