2011-05-31 23:45:05 -04:00
|
|
|
##
|
|
|
|
# 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
|
|
|
|
#
|
2011-10-03 18:15:47 -04:00
|
|
|
# extend Gem::Deprecate
|
2011-05-31 23:45:05 -04:00
|
|
|
# deprecate :instance_method, "X.z", 2011, 4
|
|
|
|
#
|
|
|
|
# class << self
|
2011-10-03 18:15:47 -04:00
|
|
|
# extend Gem::Deprecate
|
2011-05-31 23:45:05 -04:00
|
|
|
# deprecate :klass_method, :none, 2011, 4
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
|
2012-11-29 01:52:18 -05:00
|
|
|
module Gem::Deprecate
|
2011-05-31 23:45:05 -04:00
|
|
|
|
2012-11-29 01:52:18 -05:00
|
|
|
def self.skip # :nodoc:
|
|
|
|
@skip ||= false
|
|
|
|
end
|
2011-05-31 23:45:05 -04:00
|
|
|
|
2012-11-29 01:52:18 -05:00
|
|
|
def self.skip= v # :nodoc:
|
|
|
|
@skip = v
|
|
|
|
end
|
2011-05-31 23:45:05 -04:00
|
|
|
|
2012-11-29 01:52:18 -05:00
|
|
|
##
|
|
|
|
# Temporarily turn off warnings. Intended for tests only.
|
2011-05-31 23:45:05 -04:00
|
|
|
|
2012-11-29 01:52:18 -05:00
|
|
|
def skip_during
|
|
|
|
Gem::Deprecate.skip, original = true, Gem::Deprecate.skip
|
|
|
|
yield
|
|
|
|
ensure
|
|
|
|
Gem::Deprecate.skip = original
|
|
|
|
end
|
2011-05-31 23:45:05 -04:00
|
|
|
|
2012-11-29 01:52:18 -05:00
|
|
|
##
|
|
|
|
# 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.
|
2011-05-31 23:45:05 -04:00
|
|
|
|
2012-11-29 01:52:18 -05:00
|
|
|
def deprecate name, repl, year, month
|
|
|
|
class_eval {
|
|
|
|
old = "_deprecated_#{name}"
|
|
|
|
alias_method old, name
|
2014-01-06 20:19:28 -05:00
|
|
|
define_method name do |*args, &block|
|
2012-11-29 01:52:18 -05:00
|
|
|
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-01." % [year, month],
|
|
|
|
"\n#{target}#{name} called from #{Gem.location_of_caller.join(":")}",
|
|
|
|
]
|
|
|
|
warn "#{msg.join}." unless Gem::Deprecate.skip
|
|
|
|
send old, *args, &block
|
|
|
|
end
|
|
|
|
}
|
2011-10-03 18:15:47 -04:00
|
|
|
end
|
2012-11-29 01:52:18 -05:00
|
|
|
|
|
|
|
module_function :deprecate, :skip_during
|
|
|
|
|
2011-05-31 23:45:05 -04:00
|
|
|
end
|
2012-11-29 01:52:18 -05:00
|
|
|
|