summaryrefslogtreecommitdiff
path: root/lib/rubygems/deprecate.rb
diff options
context:
space:
mode:
authorryan <ryan@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-06-01 03:45:05 +0000
committerryan <ryan@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2011-06-01 03:45:05 +0000
commitd22130922e7842226d38d59680e4bbb48a28a5f0 (patch)
tree39594d3a14641dd5488a99a5e633239296fa5742 /lib/rubygems/deprecate.rb
parent4752539e3f3e563d559732c52424206bd6f12dbd (diff)
Import rubygems 1.8.5 (released @ 137c80f)
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31885 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rubygems/deprecate.rb')
-rw-r--r--lib/rubygems/deprecate.rb74
1 files changed, 74 insertions, 0 deletions
diff --git a/lib/rubygems/deprecate.rb b/lib/rubygems/deprecate.rb
new file mode 100644
index 0000000000..948538da96
--- /dev/null
+++ b/lib/rubygems/deprecate.rb
@@ -0,0 +1,74 @@
+######################################################################
+# This file is imported from the rubygems project.
+# DO NOT make modifications in this repo. They _will_ be reverted!
+# File a patch instead and assign it to Ryan Davis or Eric Hodel.
+######################################################################
+
+##
+# 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 Deprecate
+# deprecate :instance_method, "X.z", 2011, 4
+#
+# class << self
+# extend Deprecate
+# deprecate :klass_method, :none, 2011, 4
+# end
+# end
+
+module Deprecate
+
+ def self.skip # :nodoc:
+ @skip ||= false
+ end
+
+ def self.skip= v # :nodoc:
+ @skip = v
+ end
+
+ ##
+ # Temporarily turn off warnings. Intended for tests only.
+
+ def skip_during
+ Deprecate.skip, original = true, Deprecate.skip
+ yield
+ ensure
+ Deprecate.skip = original
+ end
+
+ ##
+ # 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.
+
+ def deprecate name, repl, year, month
+ class_eval {
+ old = "_deprecated_#{name}"
+ alias_method old, name
+ define_method name do |*args, &block| # TODO: really works on 1.8.7?
+ klass = self.kind_of? Module
+ target = klass ? "#{self}." : "#{self.class}#"
+ msg = [ "NOTE: #{target}#{name} is deprecated",
+ repl == :none ? " with no replacement" : ", use #{repl}",
+ ". 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 Deprecate.skip
+ send old, *args, &block
+ end
+ }
+ end
+
+ module_function :deprecate, :skip_during
+end