Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

file 81 lines (70 sloc) 2.128 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
##
# 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

module Gem
  module Deprecate

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

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

    def self.did_warn_about(name, for_caller)
      @did_warn_about ||= Hash.new { |h,k| h[k] = 0 }

      warning_count =
        @did_warn_about[[ name, for_caller ]] += 1

      warning_count > 1
    end

    ##
    # Temporarily turn off warnings. Intended for tests only.

    def skip_during
      Gem::Deprecate.skip, original = true, Gem::Deprecate.skip
      yield
    ensure
      Gem::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(":")}",
          ]
          unless (Deprecate.skip or Deprecate.did_warn_about(name, caller[0]))
            warn "#{msg.join}."
          end
          send old, *args, &block
        end
      }
    end

    module_function :deprecate, :skip_during
  end
end
Something went wrong with that request. Please try again.